@twin.org/api-processors 0.0.2-next.8 → 0.0.3-next.1

package/docs/changelog.md

@@ -1,5 +1,101 @@
 # @twin.org/api-processors - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-processors-v0.0.3-next.0...api-processors-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* 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))
+* logging naming consistency ([a4a6ef2](https://github.com/twinfoundation/api/commit/a4a6ef2de5049045589eb78b177ff62e744bde9d))
+* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* 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 shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.12...api-processors-v0.0.2-next.13) (2025-10-09)
+
+
+### Miscellaneous Chores
+
+* **api-processors:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.12 to 0.0.2-next.13
+
+## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.11...api-processors-v0.0.2-next.12) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.11 to 0.0.2-next.12
+
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.10...api-processors-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.9...api-processors-v0.0.2-next.10) (2025-09-23)
+
+
+### Miscellaneous Chores
+
+* **api-processors:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.8...api-processors-v0.0.2-next.9) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
 ## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.7...api-processors-v0.0.2-next.8) (2025-08-21)
 
 

package/docs/reference/classes/{NodeIdentityProcessor.md → ContextIdProcessor.md}

@@ -1,6 +1,6 @@
-# Class: NodeIdentityProcessor
+# Class: ContextIdProcessor
 
-Adds a node identity to the request identity.
+Adds an id to the request context ids.
 
 ## Implements
 
@@ -10,40 +10,58 @@ Adds a node identity to the request identity.
 
 ### Constructor
 
-> **new NodeIdentityProcessor**(): `NodeIdentityProcessor`
+> **new ContextIdProcessor**(`options`): `ContextIdProcessor`
+
+Create a new instance of ContextIdProcessor.
+
+#### Parameters
+
+##### options
+
+[`IContextIdProcessorConstructorOptions`](../interfaces/IContextIdProcessorConstructorOptions.md)
+
+Options for the processor.
 
 #### Returns
 
-`NodeIdentityProcessor`
+`ContextIdProcessor`
 
 ## Properties
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IBaseRouteProcessor.CLASS_NAME`
+`IBaseRouteProcessor.className`
 
-## Methods
+***
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingComponentType?`): `Promise`\<`void`\>
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
 #### Parameters
 
-##### nodeIdentity
-
-`string`
-
-The identity of the node.
-
 ##### nodeLoggingComponentType?
 
 `string`
@@ -64,7 +82,7 @@ Nothing.
 
 ### pre()
 
-> **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -86,13 +104,13 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `IBaseRoute`
+`IBaseRoute` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-`IHttpRequestIdentity`
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 

package/docs/reference/classes/JsonLdMimeTypeProcessor.md

@@ -20,15 +20,29 @@ Process the JSON-LD mime type.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IMimeTypeProcessor.CLASS_NAME`
+`IMimeTypeProcessor.className`
 
-## Methods
+***
 
 ### getTypes()
 

package/docs/reference/classes/JwtMimeTypeProcessor.md

@@ -20,15 +20,29 @@ Process the JWT mime type.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IMimeTypeProcessor.CLASS_NAME`
+`IMimeTypeProcessor.className`
 
-## Methods
+***
 
 ### getTypes()
 

package/docs/reference/classes/LoggingProcessor.md

@@ -30,19 +30,33 @@ Options for the processor.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IBaseRouteProcessor.CLASS_NAME`
+`IBaseRouteProcessor.className`
 
-## Methods
+***
 
 ### pre()
 
-> **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -64,13 +78,13 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `IBaseRoute`
+`IBaseRoute` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-`IHttpRequestIdentity`
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -88,7 +102,7 @@ The state handed through the processors.
 
 ### post()
 
-> **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> **post**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -110,13 +124,13 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `IBaseRoute`
+`IBaseRoute` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-`IHttpRequestIdentity`
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 

package/docs/reference/classes/RestRouteProcessor.md

@@ -30,19 +30,33 @@ Options for the processor.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IRestRouteProcessor.CLASS_NAME`
+`IRestRouteProcessor.className`
 
-## Methods
+***
 
 ### process()
 
-> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> **process**(`request`, `response`, `route`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -64,13 +78,7 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `IRestRoute`\<`any`, `any`\>
-
-##### requestIdentity
-
-`IHttpRequestIdentity`
-
-The identity context for the request.
+`IRestRoute`\<`any`, `any`\> | `undefined`
 
 ##### processorState
 

package/docs/reference/classes/SocketRouteProcessor.md

@@ -30,15 +30,29 @@ Options for the processor.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`ISocketRouteProcessor.CLASS_NAME`
+`ISocketRouteProcessor.className`
 
-## Methods
+***
 
 ### connected()
 
@@ -58,7 +72,7 @@ The server request object containing the socket id and other parameters.
 
 The route being requested, if a matching one was found.
 
-`undefined` | `ISocketRoute`\<`any`, `any`\>
+`ISocketRoute`\<`any`, `any`\> | `undefined`
 
 ##### loggingComponentType?
 
@@ -96,7 +110,7 @@ The server request object containing the socket id and other parameters.
 
 The route being requested, if a matching one was found.
 
-`undefined` | `ISocketRoute`\<`any`, `any`\>
+`ISocketRoute`\<`any`, `any`\> | `undefined`
 
 ##### loggingComponentType?
 
@@ -118,9 +132,9 @@ Promise that resolves when the request is processed.
 
 ### process()
 
-> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
+> **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
-Process the REST request for the specified route.
+Process the socket request for the specified route.
 
 #### Parameters
 
@@ -140,13 +154,7 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `ISocketRoute`\<`any`, `any`\>
-
-##### requestIdentity
-
-`IHttpRequestIdentity`
-
-The identity context for the request.
+`ISocketRoute`\<`any`, `any`\> | `undefined`
 
 ##### processorState
 

package/docs/reference/classes/StaticContextIdProcessor.md

@@ -0,0 +1,99 @@
+# Class: StaticContextIdProcessor
+
+Adds a static context id to the request context.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new StaticContextIdProcessor**(`options`): `StaticContextIdProcessor`
+
+Create a new instance of StaticContextIdProcessor.
+
+#### Parameters
+
+##### options
+
+[`IStaticContextIdProcessorConstructorOptions`](../interfaces/IStaticContextIdProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`StaticContextIdProcessor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre()
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+The route to process.
+
+`IBaseRoute` | `undefined`
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`

package/docs/reference/index.md

@@ -4,18 +4,20 @@
 
 - [RestRouteProcessor](classes/RestRouteProcessor.md)
 - [SocketRouteProcessor](classes/SocketRouteProcessor.md)
-- [NodeIdentityProcessor](classes/NodeIdentityProcessor.md)
-- [StaticUserIdentityProcessor](classes/StaticUserIdentityProcessor.md)
+- [ContextIdProcessor](classes/ContextIdProcessor.md)
+- [StaticContextIdProcessor](classes/StaticContextIdProcessor.md)
 - [LoggingProcessor](classes/LoggingProcessor.md)
 - [JsonLdMimeTypeProcessor](classes/JsonLdMimeTypeProcessor.md)
 - [JwtMimeTypeProcessor](classes/JwtMimeTypeProcessor.md)
 
 ## Interfaces
 
+- [IContextIdProcessorConfig](interfaces/IContextIdProcessorConfig.md)
+- [IContextIdProcessorConstructorOptions](interfaces/IContextIdProcessorConstructorOptions.md)
 - [ILoggingProcessorConfig](interfaces/ILoggingProcessorConfig.md)
 - [ILoggingProcessorConstructorOptions](interfaces/ILoggingProcessorConstructorOptions.md)
 - [IRestRouteProcessorConstructorOptions](interfaces/IRestRouteProcessorConstructorOptions.md)
 - [IRouteProcessorConfig](interfaces/IRouteProcessorConfig.md)
 - [ISocketRouteProcessorConstructorOptions](interfaces/ISocketRouteProcessorConstructorOptions.md)
-- [IStaticUserIdentityProcessorConfig](interfaces/IStaticUserIdentityProcessorConfig.md)
-- [IStaticUserIdentityProcessorConstructorOptions](interfaces/IStaticUserIdentityProcessorConstructorOptions.md)
+- [IStaticContextIdProcessorConfig](interfaces/IStaticContextIdProcessorConfig.md)
+- [IStaticContextIdProcessorConstructorOptions](interfaces/IStaticContextIdProcessorConstructorOptions.md)

package/docs/reference/interfaces/IContextIdProcessorConfig.md

@@ -0,0 +1,19 @@
+# Interface: IContextIdProcessorConfig
+
+Configuration for the context id processor.
+
+## Properties
+
+### key
+
+> **key**: `string`
+
+The fixed identity key for request context.
+
+***
+
+### authOnly?
+
+> `optional` **authOnly**: `boolean`
+
+Only add the identity if the request is authenticated.

package/docs/reference/interfaces/IContextIdProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IContextIdProcessorConstructorOptions
+
+Options for the ContextIdProcessor constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IContextIdProcessorConfig`](IContextIdProcessorConfig.md)
+
+The configuration for the processor.

package/docs/reference/interfaces/IStaticContextIdProcessorConfig.md

@@ -0,0 +1,27 @@
+# Interface: IStaticContextIdProcessorConfig
+
+Configuration for the static id processor.
+
+## Properties
+
+### key
+
+> **key**: `string`
+
+The fixed identity key for request context.
+
+***
+
+### value
+
+> **value**: `string`
+
+The fixed identity value for request context.
+
+***
+
+### authOnly?
+
+> `optional` **authOnly**: `boolean`
+
+Only add the identity if the request is authenticated.

package/docs/reference/interfaces/IStaticContextIdProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IStaticContextIdProcessorConstructorOptions
+
+Options for the StaticContextIdProcessor constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IStaticContextIdProcessorConfig`](IStaticContextIdProcessorConfig.md)
+
+The configuration for the processor.

package/locales/en.json

@@ -6,11 +6,6 @@
 		"socketRouteProcessor": {
 			"routeNotFound": "The web server could not find the socket route \"{notFoundId}\""
 		},
-		"jwtIdentityProcessor": {
-			"jwtMissing": "The JSON Web token could not be found in the authorization header or a cookie",
-			"jwtSignatureInvalid": "The JSON Web token signature could not be validated",
-			"jwtExpired": "The JSON Web token has expired"
-		},
 		"jsonLdMimeTypeProcessor": {
 			"invalidJsonLd": "The JSON-LD content is invalid or missing '@context'."
 		}