@twin.org/api-processors 0.0.2-next.3 → 0.0.2-next.6

package/dist/cjs/index.cjs

@@ -3,7 +3,6 @@
 var apiModels = require('@twin.org/api-models');
 var core = require('@twin.org/core');
 var web = require('@twin.org/web');
-var loggingModels = require('@twin.org/logging-models');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -34,8 +33,9 @@ class RestRouteProcessor {
      * @param route The route to process.
      * @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.
      */
-    async process(request, response, route, requestIdentity, processorState) {
+    async process(request, response, route, requestIdentity, processorState, loggingComponentType) {
         // Don't handle the route if another processor has already set the response
         // status code e.g. from an auth processor
         if (core.Is.empty(response.statusCode)) {
@@ -58,7 +58,8 @@ class RestRouteProcessor {
                     const restRouteResponse = await route.handler({
                         ...requestIdentity,
                         serverRequest: request,
-                        processorState
+                        processorState,
+                        loggingComponentType
                     }, req);
                     let statusCode = restRouteResponse.statusCode ?? response.statusCode ?? web.HttpStatusCode.ok;
                     const headers = restRouteResponse?.headers ?? {};
@@ -136,20 +137,17 @@ class SocketRouteProcessor {
      * Process the connected event.
      * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    async connected(request, route) {
+    async connected(request, route, loggingComponentType) {
         if (route?.connected) {
             try {
-                const req = {
-                    pathParams: request.pathParams,
-                    query: request.query,
-                    body: request.body
-                };
                 const socketRequestContext = {
                     socketId: request.socketId,
-                    serverRequest: req,
-                    processorState: {}
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
                 };
                 await route.connected(socketRequestContext);
             }
@@ -160,20 +158,17 @@ class SocketRouteProcessor {
      * Process the disconnected event.
      * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    async disconnected(request, route) {
+    async disconnected(request, route, loggingComponentType) {
         if (route?.disconnected) {
             try {
-                const req = {
-                    pathParams: request.pathParams,
-                    query: request.query,
-                    body: request.body
-                };
                 const socketRequestContext = {
                     socketId: request.socketId,
-                    serverRequest: req,
-                    processorState: {}
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
                 };
                 await route.disconnected(socketRequestContext);
             }
@@ -188,8 +183,9 @@ class SocketRouteProcessor {
      * @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.
      */
-    async process(request, response, route, requestIdentity, processorState, responseEmitter) {
+    async process(request, response, route, requestIdentity, processorState, responseEmitter, loggingComponentType) {
         // Don't handle the route if another processor has already set the response
         // status code e.g. from an auth processor
         if (core.Is.empty(response.statusCode)) {
@@ -213,7 +209,8 @@ class SocketRouteProcessor {
                         ...requestIdentity,
                         socketId: request.socketId,
                         serverRequest: request,
-                        processorState
+                        processorState,
+                        loggingComponentType
                     };
                     await route.handler(socketRequestContext, req, async (topic, restRouteResponse) => {
                         response.headers = restRouteResponse?.headers;
@@ -248,10 +245,10 @@ class NodeIdentityProcessor {
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeIdentity The identity of the node.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns Nothing.
      */
-    async start(nodeIdentity, nodeLoggingConnectorType) {
+    async start(nodeIdentity, nodeLoggingComponentType) {
         core.Guards.string(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         this._nodeIdentity = nodeIdentity;
     }
@@ -315,10 +312,10 @@ class LoggingProcessor {
      */
     CLASS_NAME = "LoggingProcessor";
     /**
-     * The connector for logging the information.
+     * The component for logging the information.
      * @internal
      */
-    _loggingConnector;
+    _loggingComponent;
     /**
      * Include the body objects when logging the information.
      * @internal
@@ -339,7 +336,7 @@ class LoggingProcessor {
      * @param options Options for the processor.
      */
     constructor(options) {
-        this._loggingConnector = loggingModels.LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");
+        this._loggingComponent = core.ComponentFactory.get(options?.loggingComponentType ?? "logging");
         this._includeBody = options?.config?.includeBody ?? false;
         this._fullBase64 = options?.config?.fullBase64 ?? false;
         this._obfuscateProperties = options?.config?.obfuscateProperties ?? ["password"];
@@ -369,7 +366,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._loggingComponent.log({
             level: "info",
             source: this.CLASS_NAME,
             ts: Date.now(),
@@ -429,7 +426,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._loggingComponent.log({
             level: core.Is.number(response.statusCode) && response.statusCode >= web.HttpStatusCode.badRequest
                 ? "error"
                 : "info",

package/dist/esm/index.mjs

@@ -1,7 +1,6 @@
 import { HttpErrorHelper } from '@twin.org/api-models';
-import { Is, NotFoundError, Guards, ObjectHelper, Coerce, GeneralError, Converter } from '@twin.org/core';
+import { Is, NotFoundError, Guards, ComponentFactory, ObjectHelper, Coerce, GeneralError, Converter } from '@twin.org/core';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
-import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -32,8 +31,9 @@ class RestRouteProcessor {
      * @param route The route to process.
      * @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.
      */
-    async process(request, response, route, requestIdentity, processorState) {
+    async process(request, response, route, requestIdentity, processorState, loggingComponentType) {
         // Don't handle the route if another processor has already set the response
         // status code e.g. from an auth processor
         if (Is.empty(response.statusCode)) {
@@ -56,7 +56,8 @@ class RestRouteProcessor {
                     const restRouteResponse = await route.handler({
                         ...requestIdentity,
                         serverRequest: request,
-                        processorState
+                        processorState,
+                        loggingComponentType
                     }, req);
                     let statusCode = restRouteResponse.statusCode ?? response.statusCode ?? HttpStatusCode.ok;
                     const headers = restRouteResponse?.headers ?? {};
@@ -134,20 +135,17 @@ class SocketRouteProcessor {
      * Process the connected event.
      * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    async connected(request, route) {
+    async connected(request, route, loggingComponentType) {
         if (route?.connected) {
             try {
-                const req = {
-                    pathParams: request.pathParams,
-                    query: request.query,
-                    body: request.body
-                };
                 const socketRequestContext = {
                     socketId: request.socketId,
-                    serverRequest: req,
-                    processorState: {}
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
                 };
                 await route.connected(socketRequestContext);
             }
@@ -158,20 +156,17 @@ class SocketRouteProcessor {
      * Process the disconnected event.
      * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    async disconnected(request, route) {
+    async disconnected(request, route, loggingComponentType) {
         if (route?.disconnected) {
             try {
-                const req = {
-                    pathParams: request.pathParams,
-                    query: request.query,
-                    body: request.body
-                };
                 const socketRequestContext = {
                     socketId: request.socketId,
-                    serverRequest: req,
-                    processorState: {}
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
                 };
                 await route.disconnected(socketRequestContext);
             }
@@ -186,8 +181,9 @@ class SocketRouteProcessor {
      * @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.
      */
-    async process(request, response, route, requestIdentity, processorState, responseEmitter) {
+    async process(request, response, route, requestIdentity, processorState, responseEmitter, loggingComponentType) {
         // Don't handle the route if another processor has already set the response
         // status code e.g. from an auth processor
         if (Is.empty(response.statusCode)) {
@@ -211,7 +207,8 @@ class SocketRouteProcessor {
                         ...requestIdentity,
                         socketId: request.socketId,
                         serverRequest: request,
-                        processorState
+                        processorState,
+                        loggingComponentType
                     };
                     await route.handler(socketRequestContext, req, async (topic, restRouteResponse) => {
                         response.headers = restRouteResponse?.headers;
@@ -246,10 +243,10 @@ class NodeIdentityProcessor {
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeIdentity The identity of the node.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns Nothing.
      */
-    async start(nodeIdentity, nodeLoggingConnectorType) {
+    async start(nodeIdentity, nodeLoggingComponentType) {
         Guards.string(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         this._nodeIdentity = nodeIdentity;
     }
@@ -313,10 +310,10 @@ class LoggingProcessor {
      */
     CLASS_NAME = "LoggingProcessor";
     /**
-     * The connector for logging the information.
+     * The component for logging the information.
      * @internal
      */
-    _loggingConnector;
+    _loggingComponent;
     /**
      * Include the body objects when logging the information.
      * @internal
@@ -337,7 +334,7 @@ class LoggingProcessor {
      * @param options Options for the processor.
      */
     constructor(options) {
-        this._loggingConnector = LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");
+        this._loggingComponent = ComponentFactory.get(options?.loggingComponentType ?? "logging");
         this._includeBody = options?.config?.includeBody ?? false;
         this._fullBase64 = options?.config?.fullBase64 ?? false;
         this._obfuscateProperties = options?.config?.obfuscateProperties ?? ["password"];
@@ -367,7 +364,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._loggingComponent.log({
             level: "info",
             source: this.CLASS_NAME,
             ts: Date.now(),
@@ -427,7 +424,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._loggingComponent.log({
             level: Is.number(response.statusCode) && response.statusCode >= HttpStatusCode.badRequest
                 ? "error"
                 : "info",

package/dist/types/data/restRouteProcessor.d.ts

@@ -20,8 +20,9 @@ export declare class RestRouteProcessor implements IRestRouteProcessor {
      * @param route The route to process.
      * @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.
      */
     process(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }): Promise<void>;
+    }, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/data/socketRouteProcessor.d.ts

@@ -17,16 +17,18 @@ export declare class SocketRouteProcessor implements ISocketRouteProcessor {
      * Process the connected event.
      * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    connected(request: ISocketServerRequest, route: ISocketRoute | undefined): Promise<void>;
+    connected(request: ISocketServerRequest, route: ISocketRoute | undefined, loggingComponentType?: string): Promise<void>;
     /**
      * Process the disconnected event.
      * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    disconnected(request: ISocketServerRequest, route: ISocketRoute | undefined): Promise<void>;
+    disconnected(request: ISocketServerRequest, route: ISocketRoute | undefined, loggingComponentType?: string): Promise<void>;
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -35,8 +37,9 @@ export declare class SocketRouteProcessor implements ISocketRouteProcessor {
      * @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.
      */
     process(request: ISocketServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>): Promise<void>;
+    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/identity/nodeIdentityProcessor.d.ts

@@ -10,10 +10,10 @@ export declare class NodeIdentityProcessor implements IBaseRouteProcessor {
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeIdentity The identity of the node.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns Nothing.
      */
-    start(nodeIdentity: string, nodeLoggingConnectorType?: string): Promise<void>;
+    start(nodeIdentity: string, nodeLoggingComponentType?: string): Promise<void>;
     /**
      * Pre process the REST request for the specified route.
      * @param request The incoming request.

package/dist/types/models/ILoggingProcessorConstructorOptions.d.ts

@@ -4,12 +4,11 @@ import type { ILoggingProcessorConfig } from "./ILoggingProcessorConfig";
  */
 export interface ILoggingProcessorConstructorOptions {
     /**
-     * The type for the logging connector.
-     * @default logging
+     * The type for the logging component.
      */
-    loggingConnectorType?: string;
+    loggingComponentType?: string;
     /**
-     *
+     * The configuration for the logging processor.
      */
     config?: ILoggingProcessorConfig;
 }

package/docs/changelog.md

@@ -1,5 +1,52 @@
 # @twin.org/api-processors - Changelog
 
+## [0.0.2-next.6](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.5...api-processors-v0.0.2-next.6) (2025-08-19)
+
+
+### Features
+
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.4...api-processors-v0.0.2-next.5) (2025-07-25)
+
+
+### Features
+
+* 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 socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* 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.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.3...api-processors-v0.0.2-next.4) (2025-07-25)
+
+
+### Features
+
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.2...api-processors-v0.0.2-next.3) (2025-07-24)
 
 

package/docs/reference/classes/NodeIdentityProcessor.md

@@ -32,7 +32,7 @@ Runtime name for the class.
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingConnectorType?`): `Promise`\<`void`\>
+> **start**(`nodeIdentity`, `nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
@@ -44,11 +44,11 @@ The service needs to be started when the application is initialized.
 
 The identity of the node.
 
-##### nodeLoggingConnectorType?
+##### nodeLoggingComponentType?
 
 `string`
 
-The node logging connector type, defaults to "node-logging".
+The node logging component type.
 
 #### Returns
 

package/docs/reference/classes/RestRouteProcessor.md

@@ -42,7 +42,7 @@ Runtime name for the class.
 
 ### process()
 
-> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -76,6 +76,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/classes/SocketRouteProcessor.md

@@ -42,7 +42,7 @@ Runtime name for the class.
 
 ### connected()
 
-> **connected**(`request`, `route`): `Promise`\<`void`\>
+> **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the connected event.
 
@@ -60,6 +60,12 @@ The route being requested, if a matching one was found.
 
 `undefined` | `ISocketRoute`\<`any`, `any`\>
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -74,7 +80,7 @@ Promise that resolves when the request is processed.
 
 ### disconnected()
 
-> **disconnected**(`request`, `route`): `Promise`\<`void`\>
+> **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the disconnected event.
 
@@ -92,6 +98,12 @@ The route being requested, if a matching one was found.
 
 `undefined` | `ISocketRoute`\<`any`, `any`\>
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -106,7 +118,7 @@ Promise that resolves when the request is processed.
 
 ### process()
 
-> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`): `Promise`\<`void`\>
+> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -146,6 +158,12 @@ The state handed through the processors.
 
 The function to emit a response.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/ILoggingProcessorConstructorOptions.md

@@ -4,20 +4,16 @@ Options for the LoggingProcessor constructor.
 
 ## Properties
 
-### loggingConnectorType?
+### loggingComponentType?
 
-> `optional` **loggingConnectorType**: `string`
+> `optional` **loggingComponentType**: `string`
 
-The type for the logging connector.
-
-#### Default
-
-```ts
-logging
-```
+The type for the logging component.
 
 ***
 
 ### config?
 
 > `optional` **config**: [`ILoggingProcessorConfig`](ILoggingProcessorConfig.md)
+
+The configuration for the logging processor.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-processors",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.6",
 	"description": "Route processors for use with API servers",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.2-next.3",
+		"@twin.org/api-models": "0.0.2-next.6",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",