@twin.org/api-models 0.0.2-next.9 → 0.0.3-next.10

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

@@ -2,10 +2,6 @@
 
 Context data from the HTTP request.
 
-## Extends
-
-- [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
-
 ## Extended by
 
 - [`ISocketRequestContext`](ISocketRequestContext.md)
@@ -37,27 +33,3 @@ The state handed through the processors.
 > `optional` **loggingComponentType**: `string`
 
 Logging component type for the request.
-
-***
-
-### nodeIdentity?
-
-> `optional` **nodeIdentity**: `string`
-
-The identity of the node the request is being performed on.
-
-#### Inherited from
-
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md).[`nodeIdentity`](IHttpRequestIdentity.md#nodeidentity)
-
-***
-
-### userIdentity?
-
-> `optional` **userIdentity**: `string`
-
-The identity of the requestor if there is an authenticated user.
-
-#### Inherited from
-
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md).[`userIdentity`](IHttpRequestIdentity.md#useridentity)

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/IInformationComponent.md

@@ -38,13 +38,13 @@ The service information.
 
 ### favicon()
 
-> **favicon**(): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+> **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 Get the favicon.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 The favicon.
 
@@ -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,46 @@ 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)
+
+***
+
+### processorFeatures?
+
+> `optional` **processorFeatures**: `string`[]
+
+The features supported by additional processors to run for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`processorFeatures`](IBaseRoute.md#processorfeatures)
+
+***
+
+### processorData?
+
+> `optional` **processorData**: `object`
+
+The data for additional processors to run for this route.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`processorData`](IBaseRoute.md#processordata)
+
+***
+
 ### summary
 
 > **summary**: `string`

package/docs/reference/interfaces/IRestRouteProcessor.md

@@ -8,9 +8,29 @@ The definition for a processor for handling REST routes.
 
 ## Methods
 
+### features()?
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -32,13 +52,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -64,7 +84,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -86,13 +106,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -118,7 +138,7 @@ Promise that resolves when the request is processed.
 
 ### process()?
 
-> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -140,13 +160,7 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
-
-##### requestIdentity
-
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
-
-The identity context for the request.
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### processorState
 

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.

package/docs/reference/interfaces/IServerRootResponse.md

@@ -4,6 +4,18 @@ The root text for the server.
 
 ## Properties
 
+### headers
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
 ### body
 
 > **body**: `string`

package/docs/reference/interfaces/ISocketRequestContext.md

@@ -48,30 +48,6 @@ Logging component type for the request.
 
 ***
 
-### nodeIdentity?
-
-> `optional` **nodeIdentity**: `string`
-
-The identity of the node the request is being performed on.
-
-#### Inherited from
-
-[`IHttpRequestContext`](IHttpRequestContext.md).[`nodeIdentity`](IHttpRequestContext.md#nodeidentity)
-
-***
-
-### userIdentity?
-
-> `optional` **userIdentity**: `string`
-
-The identity of the requestor if there is an authenticated user.
-
-#### Inherited from
-
-[`IHttpRequestContext`](IHttpRequestContext.md).[`userIdentity`](IHttpRequestContext.md#useridentity)
-
-***
-
 ### socketId
 
 > **socketId**: `string`

package/docs/reference/interfaces/ISocketRoute.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,46 @@ 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)
+
+***
+
+### processorFeatures?
+
+> `optional` **processorFeatures**: `string`[]
+
+The features supported by additional processors to run for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`processorFeatures`](IBaseRoute.md#processorfeatures)
+
+***
+
+### processorData?
+
+> `optional` **processorData**: `object`
+
+The data for additional processors to run for this route.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`processorData`](IBaseRoute.md#processordata)
+
+***
+
 ### handler()
 
 > **handler**: (`socketRequestContext`, `request`, `emit`) => `void`

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -8,9 +8,29 @@ The definition for a processor for handling socket routes.
 
 ## Methods
 
+### features()?
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -32,13 +52,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -64,7 +84,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -86,13 +106,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -134,7 +154,7 @@ The server request object containing the socket id and other parameters.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### loggingComponentType?
 
@@ -168,7 +188,7 @@ The server request object containing the socket id and other parameters.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### loggingComponentType?
 
@@ -186,7 +206,7 @@ Promise that resolves when the request is processed.
 
 ### process()?
 
-> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -208,13 +228,7 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
-
-##### requestIdentity
-
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
-
-The identity context for the request.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### processorState
 

package/docs/reference/variables/AuthenticationGeneratorFactory.md

@@ -0,0 +1,5 @@
+# Variable: AuthenticationGeneratorFactory
+
+> `const` **AuthenticationGeneratorFactory**: `Factory`\<[`IAuthenticationGenerator`](../interfaces/IAuthenticationGenerator.md)\>
+
+Factory for creating implementation of authentication generator types.

package/locales/en.json

@@ -1,9 +1 @@
-{
-	"error": {
-		"baseRestClient": {
-			"missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
-			"decodingFailed": "Decoding JSON failed for route \"{route}\"",
-			"failureStatusText": "The request to the API failed: \"{statusText}\""
-		}
-	}
-}
+{}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.10",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -14,25 +14,40 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"models",
+		"types",
+		"interfaces",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
 }