@twin.org/api-models 0.0.3-next.3 → 0.0.3-next.30

package/docs/reference/interfaces/IBaseRestClientConfig.md

@@ -4,7 +4,7 @@ Definition for the configuration of a rest client.
 
 ## Properties
 
-### endpoint
+### endpoint {#endpoint}
 
 > **endpoint**: `string`
 
@@ -12,32 +12,80 @@ The endpoint where the api is hosted.
 
 ***
 
-### pathPrefix?
+### pathPrefix? {#pathprefix}
 
-> `optional` **pathPrefix**: `string`
+> `optional` **pathPrefix?**: `string`
 
 The prefix to the routes.
 
 ***
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 The headers to include in requests.
 
 ***
 
-### timeout?
+### timeout? {#timeout}
 
-> `optional` **timeout**: `number`
+> `optional` **timeout?**: `number`
 
 Timeout for requests in ms.
 
 ***
 
-### includeCredentials?
+### includeCredentials? {#includecredentials}
 
-> `optional` **includeCredentials**: `boolean`
+> `optional` **includeCredentials?**: `boolean`
 
 Include credentials in the request, defaults to true.
+
+***
+
+### customHeaders? {#customheaders}
+
+> `optional` **customHeaders?**: () => `Promise`\<`IHttpHeaders`\>
+
+Hook to provide headers asynchronously.
+
+#### Returns
+
+`Promise`\<`IHttpHeaders`\>
+
+A promise that resolves to the headers.
+
+***
+
+### customAuthHeader? {#customauthheader}
+
+> `optional` **customAuthHeader?**: () => `Promise`\<`string`\>
+
+Hook to provide an authorization header value asynchronously.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the authorization header value.
+
+***
+
+### onAuthFailure? {#onauthfailure}
+
+> `optional` **onAuthFailure?**: (`err`) => `Promise`\<`void`\>
+
+Hook to handle authorization failures asynchronously.
+
+#### Parameters
+
+##### err
+
+`IError`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the auth failure handling is complete.

package/docs/reference/interfaces/IBaseRoute.md

@@ -9,7 +9,7 @@ Interface which defines a route.
 
 ## Properties
 
-### operationId
+### operationId {#operationid}
 
 > **operationId**: `string`
 
@@ -17,7 +17,7 @@ The id of the operation.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -25,25 +25,41 @@ The path to use for routing.
 
 ***
 
-### skipAuth?
+### skipAuth? {#skipauth}
 
-> `optional` **skipAuth**: `boolean`
+> `optional` **skipAuth?**: `boolean`
 
-Skips the authentication for this route.
+Skips the authentication requirement for this route.
 
 ***
 
-### processorFeatures?
+### skipTenant? {#skiptenant}
 
-> `optional` **processorFeatures**: `string`[]
+> `optional` **skipTenant?**: `boolean`
+
+Skips the tenant requirement for this route.
+
+***
+
+### requiredScope? {#requiredscope}
+
+> `optional` **requiredScope?**: `string`[]
+
+The user must have one of the specified scopes to access the route.
+
+***
+
+### processorFeatures? {#processorfeatures}
+
+> `optional` **processorFeatures?**: `string`[]
 
 The features supported by additional processors to run for this route.
 
 ***
 
-### processorData?
+### processorData? {#processordata}
 
-> `optional` **processorData**: `object`
+> `optional` **processorData?**: `object`
 
 The data for additional processors to run for this route.
 

package/docs/reference/interfaces/IBaseRouteEntryPoint.md

@@ -10,7 +10,7 @@ Route entry points are used for exposing the routes from a package.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -18,7 +18,7 @@ The name of the routes.
 
 ***
 
-### defaultBaseRoute
+### defaultBaseRoute {#defaultbaseroute}
 
 > **defaultBaseRoute**: `string`
 
@@ -26,7 +26,7 @@ The default base route name for the routes.
 
 ***
 
-### tags
+### tags {#tags}
 
 > **tags**: [`ITag`](ITag.md)[]
 
@@ -34,7 +34,7 @@ The tags for the routes.
 
 ***
 
-### generateRoutes()
+### generateRoutes {#generateroutes}
 
 > **generateRoutes**: (`baseRouteName`, `componentName`) => `T`[]
 

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -23,7 +23,7 @@ The definition for a base processor for handling REST routes.
 
 ## Methods
 
-### features()?
+### features()? {#features}
 
 > `optional` **features**(): `string`[]
 
@@ -39,9 +39,9 @@ The features supported by this processor.
 
 ***
 
-### pre()?
+### pre()? {#pre}
 
-> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -61,9 +61,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+`T` \| `undefined`
 
-`T` | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -75,11 +75,21 @@ The context IDs of the request.
 
 The state handed through the processors.
 
-##### loggingComponentType?
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+###### hostingComponentType?
 
 `string`
 
-The logging component type for the request.
+The hosting component type.
 
 #### Returns
 
@@ -89,9 +99,9 @@ Promise that resolves when the request is processed.
 
 ***
 
-### post()?
+### post()? {#post}
 
-> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -111,9 +121,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+`T` \| `undefined`
 
-`T` | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -125,11 +135,21 @@ The context IDs of the request.
 
 The state handed through the processors.
 
-##### loggingComponentType?
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+###### hostingComponentType?
 
 `string`
 
-The logging component type for the request.
+The hosting component type.
 
 #### Returns
 

package/docs/reference/interfaces/IBaseSocketClientConfig.md

@@ -4,15 +4,15 @@ Definition for the configuration of a socket service.
 
 ## Properties
 
-### basePath?
+### basePath? {#basepath}
 
-> `optional` **basePath**: `string`
+> `optional` **basePath?**: `string`
 
 Base path for the socket service, defaults to /socket.
 
 ***
 
-### endpoint
+### endpoint {#endpoint}
 
 > **endpoint**: `string`
 
@@ -20,16 +20,16 @@ The endpoint where the api is hosted.
 
 ***
 
-### pathPrefix?
+### pathPrefix? {#pathprefix}
 
-> `optional` **pathPrefix**: `string`
+> `optional` **pathPrefix?**: `string`
 
 The prefix to the routes.
 
 ***
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 The headers to include in requests.

package/docs/reference/interfaces/IConflictResponse.md

@@ -4,7 +4,7 @@ The request resulted in a conflicting operation, see the content for more detail
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `409`
 
@@ -12,16 +12,8 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
-> **body**: `IError` & `object`
+> **body**: `IError`
 
 The body which contains the error.
-
-#### Type Declaration
-
-##### conflicts
-
-> **conflicts**: `string`[]
-
-The conflicting items.

package/docs/reference/interfaces/ICreatedResponse.md

@@ -4,7 +4,7 @@ The rest request ended in created response.
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `201`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 

package/docs/reference/interfaces/IForbiddenResponse.md

@@ -4,7 +4,7 @@ The operation that you tried to perform is not possible, see the content for mor
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `403`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IHealthComponent.md

@@ -0,0 +1,21 @@
+# Interface: IHealthComponent
+
+The health component for the server.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### healthStatus() {#healthstatus}
+
+> **healthStatus**(): `Promise`\<\{ `status`: `HealthStatus`; `components`: `IHealth`[]; \}\>
+
+Get the server health.
+
+#### Returns
+
+`Promise`\<\{ `status`: `HealthStatus`; `components`: `IHealth`[]; \}\>
+
+The service health.

package/docs/reference/interfaces/IHostingComponent.md

@@ -0,0 +1,73 @@
+# Interface: IHostingComponent
+
+The information about the hosting of the API.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### getPublicOrigin() {#getpublicorigin}
+
+> **getPublicOrigin**(`serverRequestUrl?`): `Promise`\<`string`\>
+
+Get the public origin for the hosting.
+
+#### Parameters
+
+##### serverRequestUrl?
+
+`string`
+
+The url of the current server request if there is one.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The public origin.
+
+***
+
+### getTenantOrigin() {#gettenantorigin}
+
+> **getTenantOrigin**(`tenantId`): `Promise`\<`string` \| `undefined`\>
+
+Get the public origin for the tenant if one exists.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The tenant identifier.
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+The public origin for the tenant.
+
+***
+
+### buildPublicUrl() {#buildpublicurl}
+
+> **buildPublicUrl**(`url`): `Promise`\<`string`\>
+
+Build a public url based on the public origin and the url provided.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to build upon the public origin.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The full url based on the public origin.

package/docs/reference/interfaces/IHttpRequest.md

@@ -15,32 +15,32 @@ Model for the standard parameters for an http request.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
 
 The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
 
 The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return send as the body.

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -8,7 +8,7 @@ Context data from the HTTP request.
 
 ## Properties
 
-### serverRequest
+### serverRequest {#serverrequest}
 
 > **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
 
@@ -16,7 +16,7 @@ The raw HTTP request.
 
 ***
 
-### processorState
+### processorState {#processorstate}
 
 > **processorState**: `object`
 
@@ -28,8 +28,16 @@ The state handed through the processors.
 
 ***
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 Logging component type for the request.
+
+***
+
+### hostingComponentType? {#hostingcomponenttype}
+
+> `optional` **hostingComponentType?**: `string`
+
+Hosting component type for the request.

package/docs/reference/interfaces/IHttpRequestPathParams.md

@@ -4,4 +4,4 @@ Model for the standard parameters for an http request.
 
 ## Indexable
 
-\[`id`: `string`\]: `string` \| `number` \| `boolean`
+> \[`id`: `string`\]: `string`

package/docs/reference/interfaces/IHttpRequestQuery.md

@@ -4,4 +4,4 @@ Model used for Http request query parameters.
 
 ## Indexable
 
-\[`id`: `string`\]: `string` \| `number` \| `boolean`
+> \[`id`: `string`\]: `string`

package/docs/reference/interfaces/IHttpResponse.md

@@ -10,24 +10,24 @@ Model for the standard parameters for an http response.
 
 ## Properties
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 
 ***
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Response headers.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return as the main payload.

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -18,9 +18,9 @@ Model for the standard parameters for an http request.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Incoming Http Headers.
 
@@ -30,9 +30,9 @@ Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
 
 The path parameters.
 
@@ -42,9 +42,9 @@ The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
 
 The query parameters.
 
@@ -54,9 +54,9 @@ The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return send as the body.
 
@@ -66,16 +66,16 @@ Data to return send as the body.
 
 ***
 
-### method?
+### url {#url}
 
-> `optional` **method**: `HttpMethod`
+> **url**: `string`
 
-The request method.
+The request url.
 
 ***
 
-### url?
+### method? {#method}
 
-> `optional` **url**: `string`
+> `optional` **method?**: `HttpMethod`
 
-The request url.
+The request method.