@twin.org/api-processors 0.0.1-next.8 → 0.0.1

package/docs/changelog.md

@@ -1,5 +1,89 @@
 # @twin.org/api-processors - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-processors-v0.0.1-next.35...api-processors-v0.0.1-next.36) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **api-processors:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-processors-v0.0.1-next.34...api-processors-v0.0.1-next.35) (2025-06-11)
+
+
+### Features
+
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-processors-v0.0.1-next.33...api-processors-v0.0.1-next.34) (2025-05-27)
+
+
+### Miscellaneous Chores
+
+* **api-processors:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-processors-v0.0.1-next.32...api-processors-v0.0.1-next.33) (2025-04-17)
+
+
+### Features
+
+* 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.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-processors-v0.0.1-next.31...api-processors-v0.0.1-next.32) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **api-processors:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## v0.0.1-next.31
 
 - Initial Release

package/docs/reference/classes/JwtMimeTypeProcessor.md

@@ -0,0 +1,81 @@
+# Class: JwtMimeTypeProcessor
+
+Process the JWT mime type.
+
+## Implements
+
+- `IMimeTypeProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new JwtMimeTypeProcessor**(): `JwtMimeTypeProcessor`
+
+#### Returns
+
+`JwtMimeTypeProcessor`
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"jwt"`
+
+The namespace supported by the processor.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IMimeTypeProcessor.CLASS_NAME`
+
+## Methods
+
+### getTypes()
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+#### Implementation of
+
+`IMimeTypeProcessor.getTypes`
+
+***
+
+### handle()
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+##### body
+
+`Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.
+
+#### Implementation of
+
+`IMimeTypeProcessor.handle`

package/docs/reference/classes/LoggingProcessor.md

@@ -4,37 +4,37 @@ Process the REST request and log its information.
 
 ## Implements
 
-- `IHttpRestRouteProcessor`
+- `IBaseRouteProcessor`
 
 ## Constructors
 
-### new LoggingProcessor()
+### Constructor
 
-> **new LoggingProcessor**(`options`?): [`LoggingProcessor`](LoggingProcessor.md)
+> **new LoggingProcessor**(`options?`): `LoggingProcessor`
 
-Create a new instance of RequestLoggingProcessor.
+Create a new instance of LoggingProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-Options for the processor.
+[`ILoggingProcessorConstructorOptions`](../interfaces/ILoggingProcessorConstructorOptions.md)
 
-• **options.loggingConnectorType?**: `string`
+Options for the processor.
 
-The type for the logging connector, defaults to "logging".
+#### Returns
 
-• **options.config?**: [`IRequestLoggingProcessorConfig`](../interfaces/IRequestLoggingProcessorConfig.md)
+`LoggingProcessor`
 
-The configuration for the processor.
+## Properties
 
-#### Returns
+### NAMESPACE
 
-[`LoggingProcessor`](LoggingProcessor.md)
+> `readonly` `static` **NAMESPACE**: `string` = `"logging"`
 
-Promise that resolves when the processor is initialized.
+The namespace supported by the processor.
 
-## Properties
+***
 
 ### CLASS\_NAME
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.CLASS_NAME`
+`IBaseRouteProcessor.CLASS_NAME`
 
 ## Methods
 
@@ -56,23 +56,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -82,7 +90,7 @@ The state handed through the processors.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.pre`
+`IBaseRouteProcessor.pre`
 
 ***
 
@@ -94,23 +102,31 @@ Post process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -120,4 +136,4 @@ The state handed through the processors.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.post`
+`IBaseRouteProcessor.post`

package/docs/reference/classes/NodeIdentityProcessor.md

@@ -4,20 +4,28 @@ Adds a node identity to the request identity.
 
 ## Implements
 
-- `IHttpRestRouteProcessor`
+- `IBaseRouteProcessor`
 
 ## Constructors
 
-### new NodeIdentityProcessor()
+### Constructor
 
-> **new NodeIdentityProcessor**(): [`NodeIdentityProcessor`](NodeIdentityProcessor.md)
+> **new NodeIdentityProcessor**(): `NodeIdentityProcessor`
 
 #### Returns
 
-[`NodeIdentityProcessor`](NodeIdentityProcessor.md)
+`NodeIdentityProcessor`
 
 ## Properties
 
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"node-identity"`
+
+The namespace supported by the processor.
+
+***
+
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -26,23 +34,27 @@ Runtime name for the class.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.CLASS_NAME`
+`IBaseRouteProcessor.CLASS_NAME`
 
 ## Methods
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> **start**(`nodeIdentity`, `nodeLoggingConnectorType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
 #### Parameters
 
-• **nodeIdentity**: `string`
+##### nodeIdentity
+
+`string`
 
 The identity of the node.
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -54,7 +66,7 @@ Nothing.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.start`
+`IBaseRouteProcessor.start`
 
 ***
 
@@ -66,23 +78,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -92,4 +112,4 @@ The state handed through the processors.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.pre`
+`IBaseRouteProcessor.pre`

package/docs/reference/classes/{RouteProcessor.md → RestRouteProcessor.md}

@@ -1,36 +1,40 @@
-# Class: RouteProcessor
+# Class: RestRouteProcessor
 
 Process the REST request and hands it on to the route handler.
 
 ## Implements
 
-- `IHttpRestRouteProcessor`
+- `IRestRouteProcessor`
 
 ## Constructors
 
-### new RouteProcessor()
+### Constructor
 
-> **new RouteProcessor**(`options`?): [`RouteProcessor`](RouteProcessor.md)
+> **new RestRouteProcessor**(`options?`): `RestRouteProcessor`
 
 Create a new instance of RouteProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
+
+[`IRestRouteProcessorConstructorOptions`](../interfaces/IRestRouteProcessorConstructorOptions.md)
 
 Options for the processor.
 
-• **options.config?**: [`IRouteProcessorConfig`](../interfaces/IRouteProcessorConfig.md)
+#### Returns
 
-The configuration for the processor.
+`RestRouteProcessor`
 
-#### Returns
+## Properties
 
-[`RouteProcessor`](RouteProcessor.md)
+### NAMESPACE
 
-Promise that resolves when the processor is initialized.
+> `readonly` `static` **NAMESPACE**: `string` = `"rest-route"`
 
-## Properties
+The namespace supported by the processor.
+
+***
 
 ### CLASS\_NAME
 
@@ -40,7 +44,7 @@ Runtime name for the class.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.CLASS_NAME`
+`IRestRouteProcessor.CLASS_NAME`
 
 ## Methods
 
@@ -52,23 +56,31 @@ Process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IRestRoute`\<`any`, `any`\>
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -78,4 +90,4 @@ The state handed through the processors.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.process`
+`IRestRouteProcessor.process`

package/docs/reference/classes/SocketRouteProcessor.md

@@ -0,0 +1,99 @@
+# Class: SocketRouteProcessor
+
+Process the socket request and hands it on to the route handler.
+
+## Implements
+
+- `ISocketRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new SocketRouteProcessor**(`options?`): `SocketRouteProcessor`
+
+Create a new instance of SocketRouteProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ISocketRouteProcessorConstructorOptions`](../interfaces/ISocketRouteProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`SocketRouteProcessor`
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"socket-route"`
+
+The namespace supported by the processor.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`ISocketRouteProcessor.CLASS_NAME`
+
+## Methods
+
+### process()
+
+> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+The route to process.
+
+`undefined` | `ISocketRoute`\<`any`, `any`\>
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
+
+The identity context for the request.
+
+##### processorState
+
+The state handed through the processors.
+
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
+
+The function to emit a response.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`ISocketRouteProcessor.process`