@twin.org/api-models 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/classes/HttpUrlHelper.md

@@ -0,0 +1,169 @@
+# Class: HttpUrlHelper
+
+Class to help with handling http URLs.
+
+## Constructors
+
+### Constructor
+
+> **new HttpUrlHelper**(): `HttpUrlHelper`
+
+#### Returns
+
+`HttpUrlHelper`
+
+## Methods
+
+### extractOrigin()
+
+> `static` **extractOrigin**(`url`): `string` \| `undefined`
+
+Extract the origin from the url which includes protocol,host,port.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the origin from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted origin.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/API/URL/origin
+
+***
+
+### extractPath()
+
+> `static` **extractPath**(`url`): `string` \| `undefined`
+
+Extract the path from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the path from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted path.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname
+
+***
+
+### extractSearch()
+
+> `static` **extractSearch**(`url`): `string` \| `undefined`
+
+Extract the search from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the search from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted search.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/API/URL/search
+
+***
+
+### extractPathAndSearch()
+
+> `static` **extractPathAndSearch**(`url`): `string` \| `undefined`
+
+Extract the path and search from the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to extract the path and search from.
+
+#### Returns
+
+`string` \| `undefined`
+
+The extracted path and search.
+
+***
+
+### combineParts()
+
+> `static` **combineParts**(`origin`, `pathAndSearch`): `string` \| `undefined`
+
+Combine the urls parts.
+
+#### Parameters
+
+##### origin
+
+`string`
+
+The origin to combine.
+
+##### pathAndSearch
+
+`string`
+
+The path and search to combine.
+
+#### Returns
+
+`string` \| `undefined`
+
+The combined parts.
+
+***
+
+### replaceOrigin()
+
+> `static` **replaceOrigin**(`url`, `newOrigin?`): `string`
+
+Replace the origin in the url.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url to replace the origin in.
+
+##### newOrigin?
+
+`string`
+
+The new origin to use.
+
+#### Returns
+
+`string`
+
+The url with the replaced origin.

package/docs/reference/index.md

@@ -4,15 +4,16 @@
 
 - [HttpErrorHelper](classes/HttpErrorHelper.md)
 - [HttpParameterHelper](classes/HttpParameterHelper.md)
+- [HttpUrlHelper](classes/HttpUrlHelper.md)
 
 ## Interfaces
 
 - [IServerFavIconResponse](interfaces/IServerFavIconResponse.md)
 - [IServerHealthResponse](interfaces/IServerHealthResponse.md)
 - [IServerInfoResponse](interfaces/IServerInfoResponse.md)
+- [IServerLivezResponse](interfaces/IServerLivezResponse.md)
 - [IServerRootResponse](interfaces/IServerRootResponse.md)
 - [IServerSpecResponse](interfaces/IServerSpecResponse.md)
-- [IAuthenticationGenerator](interfaces/IAuthenticationGenerator.md)
 - [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
 - [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)
 - [IHttpRequest](interfaces/IHttpRequest.md)
@@ -51,9 +52,13 @@
 - [ISocketRouteProcessor](interfaces/ISocketRouteProcessor.md)
 - [IWebServer](interfaces/IWebServer.md)
 - [IWebServerOptions](interfaces/IWebServerOptions.md)
+- [IHealthComponentInfo](interfaces/IHealthComponentInfo.md)
 - [IHealthInfo](interfaces/IHealthInfo.md)
+- [IHostingComponent](interfaces/IHostingComponent.md)
 - [IInformationComponent](interfaces/IInformationComponent.md)
 - [IServerInfo](interfaces/IServerInfo.md)
+- [ITenant](interfaces/ITenant.md)
+- [ITenantAdminComponent](interfaces/ITenantAdminComponent.md)
 
 ## Type Aliases
 
@@ -63,7 +68,6 @@
 
 ## Variables
 
-- [AuthenticationGeneratorFactory](variables/AuthenticationGeneratorFactory.md)
 - [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
 - [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
 - [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)

package/docs/reference/interfaces/IBaseRoute.md

@@ -29,7 +29,23 @@ The path to use for routing.
 
 > `optional` **skipAuth**: `boolean`
 
-Skips the authentication for this route.
+Skips the authentication requirement for this route.
+
+***
+
+### skipTenant?
+
+> `optional` **skipTenant**: `boolean`
+
+Skips the tenant requirement for this route.
+
+***
+
+### requiredScope?
+
+> `optional` **requiredScope**: `string`[]
+
+The user must have one of the specified scopes to access the route.
 
 ***
 

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -41,7 +41,7 @@ The features supported by this processor.
 
 ### 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.
 
@@ -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
 
@@ -91,7 +101,7 @@ Promise that resolves when the request is processed.
 
 ### 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.
 
@@ -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/IHealthComponentInfo.md

@@ -0,0 +1,27 @@
+# Interface: IHealthComponentInfo
+
+The health component information.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+The name of the component.
+
+***
+
+### status
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The status of the component.
+
+***
+
+### details?
+
+> `optional` **details**: `string`
+
+The details for the status.

package/docs/reference/interfaces/IHealthInfo.md

@@ -14,24 +14,6 @@ The status.
 
 ### components?
 
-> `optional` **components**: `object`[]
+> `optional` **components**: [`IHealthComponentInfo`](IHealthComponentInfo.md)[]
 
 The status of the components.
-
-#### name
-
-> **name**: `string`
-
-The name of the component.
-
-#### status
-
-> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
-
-The status of the component.
-
-#### details?
-
-> `optional` **details**: `string`
-
-The details for the status.

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**(`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**(`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**(`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/IHttpRequestContext.md

@@ -33,3 +33,11 @@ The state handed through the processors.
 > `optional` **loggingComponentType**: `string`
 
 Logging component type for the request.
+
+***
+
+### 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/IHttpServerRequest.md

@@ -66,16 +66,16 @@ Data to return send as the body.
 
 ***
 
-### method?
+### url
 
-> `optional` **method**: `HttpMethod`
+> **url**: `string`
 
-The request method.
+The request url.
 
 ***
 
-### url?
+### method?
 
-> `optional` **url**: `string`
+> `optional` **method**: `HttpMethod`
 
-The request url.
+The request method.

package/docs/reference/interfaces/IInformationComponent.md

@@ -64,6 +64,20 @@ The OpenAPI spec.
 
 ***
 
+### livez()
+
+> **livez**(): `Promise`\<`boolean`\>
+
+Is the server live.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the server is live.
+
+***
+
 ### health()
 
 > **health**(): `Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
@@ -80,7 +94,7 @@ The service health.
 
 ### setComponentHealth()
 
-> **setComponentHealth**(`name`, `status`, `details?`): `Promise`\<`void`\>
+> **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
 
 Set the status of a component.
 
@@ -104,6 +118,12 @@ The status of the component.
 
 The details for the status.
 
+##### tenantId?
+
+`string`
+
+The tenant id, optional if the health status is not tenant specific.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -114,7 +134,7 @@ Nothing.
 
 ### removeComponentHealth()
 
-> **removeComponentHealth**(`name`): `Promise`\<`void`\>
+> **removeComponentHealth**(`name`, `tenantId?`): `Promise`\<`void`\>
 
 Remove the status of a component.
 
@@ -126,6 +146,12 @@ Remove the status of a component.
 
 The component name.
 
+##### tenantId?
+
+`string`
+
+The tenant id, optional if the health status is not tenant specific.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IRestRoute.md

@@ -46,7 +46,7 @@ The path to use for routing.
 
 > `optional` **skipAuth**: `boolean`
 
-Skips the authentication for this route.
+Skips the authentication requirement for this route.
 
 #### Inherited from
 
@@ -54,6 +54,30 @@ Skips the authentication for this route.
 
 ***
 
+### skipTenant?
+
+> `optional` **skipTenant**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
+
+***
+
+### requiredScope?
+
+> `optional` **requiredScope**: `string`[]
+
+The user must have one of the specified scopes to access the route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+
+***
+
 ### processorFeatures?
 
 > `optional` **processorFeatures**: `string`[]

package/docs/reference/interfaces/IRestRouteProcessor.md

@@ -30,7 +30,7 @@ The features supported by this processor.
 
 ### 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.
 
@@ -64,11 +64,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 for the request.
+The logging component type.
+
+###### hostingComponentType?
+
+`string`
+
+The hosting component type.
 
 #### Returns
 
@@ -84,7 +94,7 @@ Promise that resolves when the request is processed.
 
 ### 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.
 
@@ -118,11 +128,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
 
@@ -138,7 +158,7 @@ Promise that resolves when the request is processed.
 
 ### process()?
 
-> `optional` **process**(`request`, `response`, `route`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -166,11 +186,21 @@ The route being requested, if a matching one was found.
 
 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/IServerLivezResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerLivezResponse
+
+The livez of the server.
+
+## Properties
+
+### headers
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body
+
+> **body**: `"ok"` \| `"failed"`
+
+The livez information for the server.