Class FoundationApiClient

Base client for every OpenCDE REST API mounted under {baseUrl}/{version} with a sibling /versions resource (Foundation API §2.1). Implements the three services the Foundation API itself defines — versions, /auth discovery and /current-user — plus the URL building and JSON request plumbing that BcfApiClient (and any future OpenCDE service client built the same way) extends with its own resources.

Hierarchy (View Summary)

FoundationHttpClient
- FoundationApiClient
  - BcfApiClient

Index

Constructors

constructor

new FoundationApiClient(
options: FoundationApiClientOptions,
): FoundationApiClient
Parameters
- options: FoundationApiClientOptions
Returns FoundationApiClient

Overrides FoundationHttpClient.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

getAuthInfo

getAuthInfo(): Promise<BcfAuthInfo>

Returns Promise<BcfAuthInfo>

getCurrentUser

getCurrentUser(): Promise<BcfCurrentUser>

Returns Promise<BcfCurrentUser>

getVersions

getVersions(): Promise<ApiVersion[]>

This API's own {base}/versions listing; see getFoundationVersions for the server-wide one.

Returns Promise<ApiVersion[]>

`Protected`requestJson

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

Inherited from FoundationHttpClient.requestJson

`Protected`requestJsonAt

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

`Protected`send

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

`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 FoundationHttpClient.sendRequest

Class FoundationApiClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FoundationApiClient

Properties

Protected ReadonlybaseUrl

Protected ReadonlyerrorLabel

Protected ReadonlyerrorNamespace

Protected ReadonlyfetchFn

Protected Optional ReadonlygetAccessToken

Protected Readonlyversion

Methods

ProtectedbuildUrl

Parameters

Returns string

getAuthInfo

Returns Promise<BcfAuthInfo>

getCurrentUser

Returns Promise<BcfCurrentUser>

getVersions

Returns Promise<ApiVersion[]>

ProtectedrequestJson

Type Parameters

Parameters

Returns Promise<T>

ProtectedrequestJsonAt

Type Parameters

Parameters

Returns Promise<T>

Protectedsend

Parameters

Returns Promise<Response>

ProtectedsendRequest

Parameters

Returns Promise<Response>

Settings

On This Page

`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