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

package/dist/types/models/server/IRestRouteProcessor.d.ts

@@ -1,8 +1,7 @@
-import type { IBaseRouteProcessor } from "./IBaseRouteProcessor";
-import type { IHttpRequestIdentity } from "../protocol/IHttpRequestIdentity";
-import type { IHttpResponse } from "../protocol/IHttpResponse";
-import type { IHttpServerRequest } from "../protocol/IHttpServerRequest";
-import type { IRestRoute } from "../routes/IRestRoute";
+import type { IBaseRouteProcessor } from "./IBaseRouteProcessor.js";
+import type { IHttpResponse } from "../protocol/IHttpResponse.js";
+import type { IHttpServerRequest } from "../protocol/IHttpServerRequest.js";
+import type { IRestRoute } from "../routes/IRestRoute.js";
 /**
  * The definition for a processor for handling REST routes.
  */
@@ -12,12 +11,11 @@ export interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {
      * @param request The request to handle.
      * @param response The response data to send if any.
      * @param route The route being requested, if a matching one was found.
-     * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, processorState: {
         [id: string]: unknown;
     }, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/models/server/ISocketRouteProcessor.d.ts

@@ -1,8 +1,7 @@
-import type { IBaseRouteProcessor } from "./IBaseRouteProcessor";
-import type { IHttpRequestIdentity } from "../protocol/IHttpRequestIdentity";
-import type { IHttpResponse } from "../protocol/IHttpResponse";
-import type { ISocketServerRequest } from "../protocol/ISocketServerRequest";
-import type { ISocketRoute } from "../routes/ISocketRoute";
+import type { IBaseRouteProcessor } from "./IBaseRouteProcessor.js";
+import type { IHttpResponse } from "../protocol/IHttpResponse.js";
+import type { ISocketServerRequest } from "../protocol/ISocketServerRequest.js";
+import type { ISocketRoute } from "../routes/ISocketRoute.js";
 /**
  * The definition for a processor for handling socket routes.
  */
@@ -28,13 +27,12 @@ export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute,
      * @param request The server request object containing the socket id and other parameters.
      * @param response The response data to send if any.
      * @param route The route being requested, if a matching one was found.
-     * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      * @param responseEmitter The function to emit a response.
      * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    process?(request: ISocketServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    process?(request: ISocketServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, processorState: {
         [id: string]: unknown;
     }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/models/server/IWebServer.d.ts

@@ -1,8 +1,8 @@
-import type { IRestRouteProcessor } from "./IRestRouteProcessor";
-import type { ISocketRouteProcessor } from "./ISocketRouteProcessor";
-import type { IWebServerOptions } from "./IWebServerOptions";
-import type { IRestRoute } from "../routes/IRestRoute";
-import type { ISocketRoute } from "../routes/ISocketRoute";
+import type { IRestRouteProcessor } from "./IRestRouteProcessor.js";
+import type { ISocketRouteProcessor } from "./ISocketRouteProcessor.js";
+import type { IWebServerOptions } from "./IWebServerOptions.js";
+import type { IRestRoute } from "../routes/IRestRoute.js";
+import type { ISocketRoute } from "../routes/ISocketRoute.js";
 /**
  * Interface describing a web server.
  */

package/dist/types/models/services/IHealthInfo.d.ts

@@ -1,4 +1,4 @@
-import type { HealthStatus } from "./healthStatus";
+import type { HealthStatus } from "./healthStatus.js";
 /**
  * The status of the server.
  */

package/dist/types/models/services/IInformationComponent.d.ts

@@ -1,7 +1,7 @@
 import type { IComponent } from "@twin.org/core";
-import type { HealthStatus } from "./healthStatus";
-import type { IHealthInfo } from "./IHealthInfo";
-import type { IServerInfo } from "./IServerInfo";
+import type { HealthStatus } from "./healthStatus.js";
+import type { IHealthInfo } from "./IHealthInfo.js";
+import type { IServerInfo } from "./IServerInfo.js";
 /**
  * The information component for the server.
  */

package/docs/changelog.md

@@ -1,5 +1,52 @@
 # @twin.org/api-models - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-models-v0.0.3-next.0...api-models-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add authentication generators and process features option ([a67edf1](https://github.com/twinfoundation/api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+
+## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.12...api-models-v0.0.2-next.13) (2025-10-09)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.11...api-models-v0.0.2-next.12) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.10...api-models-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.9...api-models-v0.0.2-next.10) (2025-09-23)
+
+
+### Features
+
+* add authentication generators and process features option ([a67edf1](https://github.com/twinfoundation/api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.8...api-models-v0.0.2-next.9) (2025-08-29)
 
 

package/docs/reference/classes/HttpParameterHelper.md

@@ -16,7 +16,7 @@ Class to help with handling http parameters.
 
 ### arrayFromString()
 
-> `static` **arrayFromString**\<`T`\>(`values?`): `undefined` \| `T`[]
+> `static` **arrayFromString**\<`T`\>(`values?`): `T`[] \| `undefined`
 
 Convert list query to array.
 
@@ -36,7 +36,7 @@ The values query string.
 
 #### Returns
 
-`undefined` \| `T`[]
+`T`[] \| `undefined`
 
 The array of values.
 
@@ -44,7 +44,7 @@ The array of values.
 
 ### arrayToString()
 
-> `static` **arrayToString**\<`T`\>(`values?`): `undefined` \| `string`
+> `static` **arrayToString**\<`T`\>(`values?`): `string` \| `undefined`
 
 Convert array of values to query string.
 
@@ -64,7 +64,7 @@ The values to combine string.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The combined.
 
@@ -72,7 +72,7 @@ The combined.
 
 ### objectFromString()
 
-> `static` **objectFromString**\<`T`\>(`value?`): `undefined` \| `T`
+> `static` **objectFromString**\<`T`\>(`value?`): `T` \| `undefined`
 
 Convert object string to object.
 
@@ -92,7 +92,7 @@ The value query string.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The object.
 
@@ -100,7 +100,7 @@ The object.
 
 ### objectToString()
 
-> `static` **objectToString**\<`T`\>(`value?`): `undefined` \| `string`
+> `static` **objectToString**\<`T`\>(`value?`): `string` \| `undefined`
 
 Convert object to query string.
 
@@ -120,6 +120,6 @@ The value to convert to a string.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The converted object.

package/docs/reference/index.md

@@ -12,11 +12,11 @@
 - [IServerInfoResponse](interfaces/IServerInfoResponse.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)
 - [IHttpRequestContext](interfaces/IHttpRequestContext.md)
-- [IHttpRequestIdentity](interfaces/IHttpRequestIdentity.md)
 - [IHttpRequestPathParams](interfaces/IHttpRequestPathParams.md)
 - [IHttpRequestQuery](interfaces/IHttpRequestQuery.md)
 - [IHttpResponse](interfaces/IHttpResponse.md)
@@ -63,6 +63,7 @@
 
 ## Variables
 
+- [AuthenticationGeneratorFactory](variables/AuthenticationGeneratorFactory.md)
 - [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
 - [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
 - [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)

package/docs/reference/interfaces/IAuthenticationGenerator.md

@@ -0,0 +1,35 @@
+# Interface: IAuthenticationGenerator
+
+Definition for the authentication generator component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### addAuthentication()
+
+> **addAuthentication**(`requestHeaders`, `authData?`): `Promise`\<`void`\>
+
+Adds authentication information to the request headers.
+
+#### Parameters
+
+##### requestHeaders
+
+`IHttpHeaders`
+
+The request headers to add authentication information to.
+
+##### authData?
+
+`unknown`
+
+Optional authentication data passed from the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the authentication information has been added.

package/docs/reference/interfaces/IBaseRoute.md

@@ -30,3 +30,23 @@ The path to use for routing.
 > `optional` **skipAuth**: `boolean`
 
 Skips the authentication for this route.
+
+***
+
+### processorFeatures?
+
+> `optional` **processorFeatures**: `string`[]
+
+The features supported by additional processors to run for this route.
+
+***
+
+### processorData?
+
+> `optional` **processorData**: `object`
+
+The data for additional processors to run for this route.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -23,9 +23,25 @@ The definition for a base 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.
+
+***
+
 ### 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.
 
@@ -47,13 +63,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | `T`
+`T` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -75,7 +91,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.
 
@@ -97,13 +113,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | `T`
+`T` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 

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

package/docs/reference/interfaces/IRestRoute.md

@@ -54,6 +54,34 @@ Skips the authentication for this route.
 
 ***
 
+### 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/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

@@ -54,6 +54,34 @@ Skips the authentication for this route.
 
 ***
 
+### 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`