Class BcfApiClient

Typed client for the buildingSMART BCF API (OpenCDE) REST services. Implements the BCF API 2.1 routes; the version option exists because 3.0 servers share these shapes and paths for everything the client uses.

Extends FoundationApiClient: URL building, Bearer token injection, and error mapping, plus getVersions/getAuthInfo/getCurrentUser, are the Foundation API's own and are inherited rather than reimplemented here.

Hierarchy (View Summary)

FoundationApiClient
- BcfApiClient

Constructors

constructor

new BcfApiClient(options: BcfApiClientOptions): BcfApiClient
Parameters
- options: BcfApiClientOptions
Returns BcfApiClient

Overrides FoundationApiClient.constructor

Properties

`Protected` `Readonly`baseUrl

baseUrl: string

`Protected` `Readonly`errorLabel

errorLabel: string

`Protected` `Readonly`errorNamespace

errorNamespace: string | undefined

`Protected` `Readonly`fetchFn

fetchFn: FetchLike

`Protected` `Optional` `Readonly`getAccessToken

getAccessToken?: BcfTokenProvider

`Protected` `Readonly`version

version: string

Methods

`Protected`buildUrl

buildUrl(
path: string,
query?: Record<string, string | number | undefined>,
): string
Parameters
- path: string
- Optionalquery: Record<string, string | number | undefined>
Returns string

Inherited from FoundationApiClient.buildUrl

createComment

createComment(
    projectId: string,
    topicGuid: string,
    comment: BcfCommentWriteDto,
    request?: BcfRequestOptions,
): Promise<BcfCommentDto>
Parameters
- projectId: string
- topicGuid: string
- comment: BcfCommentWriteDto
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfCommentDto>

createTopic

createTopic(
    projectId: string,
    topic: BcfTopicWriteDto,
    request?: BcfRequestOptions,
): Promise<BcfTopicDto>
Parameters
- projectId: string
- topic: BcfTopicWriteDto
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfTopicDto>

createViewpoint

createViewpoint(
    projectId: string,
    topicGuid: string,
    viewpoint: BcfViewpointDto,
    request?: BcfRequestOptions,
): Promise<BcfViewpointDto>
Parameters
- projectId: string
- topicGuid: string
- viewpoint: BcfViewpointDto
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfViewpointDto>

getAuthInfo

getAuthInfo(): Promise<BcfAuthInfo>

Returns Promise<BcfAuthInfo>

Inherited from FoundationApiClient.getAuthInfo

getComments

getComments(
    projectId: string,
    topicGuid: string,
    request?: BcfRequestOptions,
): Promise<BcfCommentDto[]>
Parameters
- projectId: string
- topicGuid: string
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfCommentDto[]>

getCurrentUser

getCurrentUser(): Promise<BcfCurrentUser>

Returns Promise<BcfCurrentUser>

Inherited from FoundationApiClient.getCurrentUser

getExtensions

getExtensions(
projectId: string,
request?: BcfRequestOptions,
): Promise<BcfExtensionsDto>
Parameters
- projectId: string
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfExtensionsDto>

getProject

getProject(
projectId: string,
request?: BcfRequestOptions,
): Promise<BcfProjectDto>
Parameters
- projectId: string
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfProjectDto>

getProjects

getProjects(): Promise<BcfProjectDto[]>

Returns Promise<BcfProjectDto[]>

getTopic

getTopic(
    projectId: string,
    topicGuid: string,
    request?: BcfRequestOptions,
): Promise<BcfTopicDto>
Parameters
- projectId: string
- topicGuid: string
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfTopicDto>

getTopics

getTopics(
    projectId: string,
    options?: TopicQueryOptions,
    request?: BcfRequestOptions,
): Promise<BcfTopicDto[]>
Parameters
- projectId: string
- Optionaloptions: TopicQueryOptions
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfTopicDto[]>

getVersions

getVersions(): Promise<BcfApiVersion[]>

BCF's /versions listing, typed as it always was. Its entries carry no api_id; that field belongs to /foundation/versions (#5438 review).

Returns Promise<BcfApiVersion[]>

Overrides FoundationApiClient.getVersions

getViewpoint

getViewpoint(
    projectId: string,
    topicGuid: string,
    viewpointGuid: string,
    request?: BcfRequestOptions,
): Promise<BcfViewpointDto>
Parameters
- projectId: string
- topicGuid: string
- viewpointGuid: string
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfViewpointDto>

getViewpointColoring

getViewpointColoring(
    projectId: string,
    topicGuid: string,
    viewpointGuid: string,
): Promise<BcfColoringResponse>
Parameters
- projectId: string
- topicGuid: string
- viewpointGuid: string
Returns Promise<BcfColoringResponse>

getViewpoints

getViewpoints(projectId: string, topicGuid: string): Promise<BcfViewpointDto[]>
Parameters
- projectId: string
- topicGuid: string
Returns Promise<BcfViewpointDto[]>

getViewpointSelection

getViewpointSelection(
    projectId: string,
    topicGuid: string,
    viewpointGuid: string,
): Promise<BcfSelectionResponse>
Parameters
- projectId: string
- topicGuid: string
- viewpointGuid: string
Returns Promise<BcfSelectionResponse>

getViewpointSnapshot

getViewpointSnapshot(
    projectId: string,
    topicGuid: string,
    viewpointGuid: string,
): Promise<Blob>
Snapshot image (PNG/JPEG) of a viewpoint, as served by the server.
Parameters
- projectId: string
- topicGuid: string
- viewpointGuid: string
Returns Promise<Blob>

getViewpointVisibility

getViewpointVisibility(
    projectId: string,
    topicGuid: string,
    viewpointGuid: string,
): Promise<BcfVisibilityResponse>
Parameters
- projectId: string
- topicGuid: string
- viewpointGuid: string
Returns Promise<BcfVisibilityResponse>

`Protected`requestJson

requestJson<T>(url: string, options?: HttpRequestOptions): Promise<T>
Type Parameters
- T
Parameters
- url: string
- Optionaloptions: HttpRequestOptions
Returns Promise<T>

Inherited from FoundationApiClient.requestJson

`Protected`requestJsonAt

requestJsonAt<T>(path: string, options?: FoundationRequestOptions): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optionaloptions: FoundationRequestOptions
Returns Promise<T>

Inherited from FoundationApiClient.requestJsonAt

`Protected`send

send(path: string, options: FoundationRequestOptions): Promise<Response>
Parameters
- path: string
- options: FoundationRequestOptions
Returns Promise<Response>

Inherited from FoundationApiClient.send

`Protected`sendRequest

sendRequest(url: string, options?: HttpRequestOptions): Promise<Response>
Send a request to an already-fully-qualified URL and validate the response.
Parameters
- url: string
- Optionaloptions: HttpRequestOptions
Returns Promise<Response>

Inherited from FoundationApiClient.sendRequest

updateTopic

updateTopic(
    projectId: string,
    topicGuid: string,
    topic: BcfTopicWriteDto,
    request?: BcfRequestOptions,
): Promise<BcfTopicDto>
Parameters
- projectId: string
- topicGuid: string
- topic: BcfTopicWriteDto
- Optionalrequest: BcfRequestOptions
Returns Promise<BcfTopicDto>

Class BcfApiClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BcfApiClient

Properties

Protected ReadonlybaseUrl

Protected ReadonlyerrorLabel

Protected ReadonlyerrorNamespace

Protected ReadonlyfetchFn

Protected Optional ReadonlygetAccessToken

Protected Readonlyversion

Methods

ProtectedbuildUrl

Parameters

Returns string

createComment

Parameters

Returns Promise<BcfCommentDto>

createTopic

Parameters

Returns Promise<BcfTopicDto>

createViewpoint

Parameters

Returns Promise<BcfViewpointDto>

getAuthInfo

Returns Promise<BcfAuthInfo>

getComments

Parameters

Returns Promise<BcfCommentDto[]>

getCurrentUser

Returns Promise<BcfCurrentUser>

getExtensions

Parameters

Returns Promise<BcfExtensionsDto>

getProject

Parameters

Returns Promise<BcfProjectDto>

getProjects

Returns Promise<BcfProjectDto[]>

getTopic

Parameters

Returns Promise<BcfTopicDto>

getTopics

Parameters

Returns Promise<BcfTopicDto[]>

getVersions

Returns Promise<BcfApiVersion[]>

getViewpoint

Parameters

Returns Promise<BcfViewpointDto>

getViewpointColoring

Parameters

Returns Promise<BcfColoringResponse>

getViewpoints

Parameters

Returns Promise<BcfViewpointDto[]>

getViewpointSelection

Parameters

Returns Promise<BcfSelectionResponse>

getViewpointSnapshot

Parameters

Returns Promise<Blob>

getViewpointVisibility

Parameters

Returns Promise<BcfVisibilityResponse>

ProtectedrequestJson

Type Parameters

Parameters

Returns Promise<T>

ProtectedrequestJsonAt

Type Parameters

Parameters

Returns Promise<T>

Protectedsend

`Protected` `Readonly`baseUrl

`Protected` `Readonly`errorLabel

`Protected` `Readonly`errorNamespace

`Protected` `Readonly`fetchFn

`Protected` `Optional` `Readonly`getAccessToken

`Protected` `Readonly`version

`Protected`buildUrl

`Protected`requestJson

`Protected`requestJsonAt

`Protected`send

`Protected`sendRequest