@twin.org/api-processors 0.0.1 → 0.0.2-next.10

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.
@@ -11,10 +10,6 @@ var loggingModels = require('@twin.org/logging-models');
  * Process the REST request and hands it on to the route handler.
  */
 class RestRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "rest-route";
     /**
      * Runtime name for the class.
      */
@@ -38,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)) {
@@ -62,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 ?? {};
@@ -83,7 +80,7 @@ class RestRouteProcessor {
                         // instead of the default application/json
                         headers[web.HeaderTypes.ContentType] =
                             restRouteResponse?.attachment?.mimeType ??
-                                response.headers?.[web.HeaderTypes.ContentType] ??
+                                restRouteResponse.headers?.[web.HeaderTypes.ContentType] ??
                                 `${web.MimeTypes.Json}; charset=utf-8`;
                         // If there are filename or inline options set then add the content disposition
                         if (core.Is.stringValue(restRouteResponse?.attachment?.filename) ||
@@ -120,10 +117,6 @@ class RestRouteProcessor {
  * Process the socket request and hands it on to the route handler.
  */
 class SocketRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "socket-route";
     /**
      * Runtime name for the class.
      */
@@ -140,6 +133,48 @@ class SocketRouteProcessor {
     constructor(options) {
         this._includeErrorStack = options?.config?.includeErrorStack ?? false;
     }
+    /**
+     * 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, loggingComponentType) {
+        if (route?.connected) {
+            try {
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
+                };
+                await route.connected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
+    /**
+     * 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, loggingComponentType) {
+        if (route?.disconnected) {
+            try {
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
+                };
+                await route.disconnected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -148,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)) {
@@ -169,11 +205,14 @@ class SocketRouteProcessor {
                         query: request.query,
                         body: request.body
                     };
-                    await route.handler({
+                    const socketRequestContext = {
                         ...requestIdentity,
+                        socketId: request.socketId,
                         serverRequest: request,
-                        processorState
-                    }, req, async (topic, restRouteResponse) => {
+                        processorState,
+                        loggingComponentType
+                    };
+                    await route.handler(socketRequestContext, req, async (topic, restRouteResponse) => {
                         response.headers = restRouteResponse?.headers;
                         response.body = restRouteResponse?.body;
                         response.statusCode =
@@ -194,10 +233,6 @@ class SocketRouteProcessor {
  * Adds a node identity to the request identity.
  */
 class NodeIdentityProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "node-identity";
     /**
      * Runtime name for the class.
      */
@@ -210,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;
     }
@@ -234,10 +269,6 @@ class NodeIdentityProcessor {
  * Adds a static user identity to the request context.
  */
 class StaticUserIdentityProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "static-user-identity";
     /**
      * Runtime name for the class.
      */
@@ -276,19 +307,15 @@ class StaticUserIdentityProcessor {
  * Process the REST request and log its information.
  */
 class LoggingProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "logging";
     /**
      * Runtime name for the class.
      */
     CLASS_NAME = "LoggingProcessor";
     /**
-     * The connector for logging the information.
+     * The component for logging the information.
      * @internal
      */
-    _loggingConnector;
+    _logging;
     /**
      * Include the body objects when logging the information.
      * @internal
@@ -309,7 +336,7 @@ class LoggingProcessor {
      * @param options Options for the processor.
      */
     constructor(options) {
-        this._loggingConnector = loggingModels.LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");
+        this._logging = core.ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
         this._includeBody = options?.config?.includeBody ?? false;
         this._fullBase64 = options?.config?.fullBase64 ?? false;
         this._obfuscateProperties = options?.config?.obfuscateProperties ?? ["password"];
@@ -326,9 +353,7 @@ class LoggingProcessor {
         const now = process.hrtime.bigint();
         processorState.requestStart = now;
         const contentType = request.headers?.[web.HeaderTypes.ContentType];
-        const isJson = core.Is.stringValue(contentType)
-            ? contentType.includes(web.MimeTypes.Json) || contentType.includes(web.MimeTypes.JsonLd)
-            : false;
+        const isJson = this.isMimeJson(contentType);
         let requestUrl = "";
         if (core.Is.stringValue(request.url)) {
             // Socket paths do not have a prefix so just use the whole url.
@@ -339,7 +364,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._logging?.log({
             level: "info",
             source: this.CLASS_NAME,
             ts: Date.now(),
@@ -361,9 +386,7 @@ class LoggingProcessor {
         let data;
         if (this._includeBody) {
             const contentType = response.headers?.[web.HeaderTypes.ContentType];
-            const isJson = core.Is.stringValue(contentType)
-                ? contentType.includes(web.MimeTypes.Json) || contentType.includes(web.MimeTypes.JsonLd)
-                : false;
+            const isJson = this.isMimeJson(contentType);
             const contentLength = response.headers?.[web.HeaderTypes.ContentLength];
             if (isJson) {
                 data = {
@@ -399,7 +422,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._logging?.log({
             level: core.Is.number(response.statusCode) && response.statusCode >= web.HttpStatusCode.badRequest
                 ? "error"
                 : "info",
@@ -435,16 +458,52 @@ class LoggingProcessor {
         }
         return propValue;
     }
+    /**
+     * Check if the content type is JSON.
+     * @param contentType The content type to check.
+     * @returns True if the content type is JSON, false otherwise.
+     * @internal
+     */
+    isMimeJson(contentType) {
+        return core.Is.stringValue(contentType)
+            ? contentType.includes(web.MimeTypes.Json) || contentType.includes(web.MimeTypes.JsonLd)
+            : false;
+    }
 }
 
 /**
- * Process the JWT mime type.
+ * Process the JSON-LD mime type.
  */
-class JwtMimeTypeProcessor {
+class JsonLdMimeTypeProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "JsonLdMimeTypeProcessor";
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [web.MimeTypes.JsonLd];
+    }
     /**
-     * The namespace supported by the processor.
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
      */
-    static NAMESPACE = "jwt";
+    async handle(body) {
+        const json = core.ObjectHelper.fromBytes(body);
+        if (core.Is.empty(json) || core.Is.empty(json["@context"])) {
+            throw new core.GeneralError(this.CLASS_NAME, "invalidJsonLd");
+        }
+        return json;
+    }
+}
+
+/**
+ * Process the JWT mime type.
+ */
+class JwtMimeTypeProcessor {
     /**
      * Runtime name for the class.
      */
@@ -466,6 +525,7 @@ class JwtMimeTypeProcessor {
     }
 }
 
+exports.JsonLdMimeTypeProcessor = JsonLdMimeTypeProcessor;
 exports.JwtMimeTypeProcessor = JwtMimeTypeProcessor;
 exports.LoggingProcessor = LoggingProcessor;
 exports.NodeIdentityProcessor = NodeIdentityProcessor;

package/dist/esm/index.mjs

@@ -1,7 +1,6 @@
 import { HttpErrorHelper } from '@twin.org/api-models';
-import { Is, NotFoundError, Guards, ObjectHelper, Coerce, 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.
@@ -9,10 +8,6 @@ import { LoggingConnectorFactory } from '@twin.org/logging-models';
  * Process the REST request and hands it on to the route handler.
  */
 class RestRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "rest-route";
     /**
      * Runtime name for the class.
      */
@@ -36,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)) {
@@ -60,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 ?? {};
@@ -81,7 +78,7 @@ class RestRouteProcessor {
                         // instead of the default application/json
                         headers[HeaderTypes.ContentType] =
                             restRouteResponse?.attachment?.mimeType ??
-                                response.headers?.[HeaderTypes.ContentType] ??
+                                restRouteResponse.headers?.[HeaderTypes.ContentType] ??
                                 `${MimeTypes.Json}; charset=utf-8`;
                         // If there are filename or inline options set then add the content disposition
                         if (Is.stringValue(restRouteResponse?.attachment?.filename) ||
@@ -118,10 +115,6 @@ class RestRouteProcessor {
  * Process the socket request and hands it on to the route handler.
  */
 class SocketRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "socket-route";
     /**
      * Runtime name for the class.
      */
@@ -138,6 +131,48 @@ class SocketRouteProcessor {
     constructor(options) {
         this._includeErrorStack = options?.config?.includeErrorStack ?? false;
     }
+    /**
+     * 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, loggingComponentType) {
+        if (route?.connected) {
+            try {
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
+                };
+                await route.connected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
+    /**
+     * 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, loggingComponentType) {
+        if (route?.disconnected) {
+            try {
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
+                };
+                await route.disconnected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -146,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)) {
@@ -167,11 +203,14 @@ class SocketRouteProcessor {
                         query: request.query,
                         body: request.body
                     };
-                    await route.handler({
+                    const socketRequestContext = {
                         ...requestIdentity,
+                        socketId: request.socketId,
                         serverRequest: request,
-                        processorState
-                    }, req, async (topic, restRouteResponse) => {
+                        processorState,
+                        loggingComponentType
+                    };
+                    await route.handler(socketRequestContext, req, async (topic, restRouteResponse) => {
                         response.headers = restRouteResponse?.headers;
                         response.body = restRouteResponse?.body;
                         response.statusCode =
@@ -192,10 +231,6 @@ class SocketRouteProcessor {
  * Adds a node identity to the request identity.
  */
 class NodeIdentityProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "node-identity";
     /**
      * Runtime name for the class.
      */
@@ -208,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;
     }
@@ -232,10 +267,6 @@ class NodeIdentityProcessor {
  * Adds a static user identity to the request context.
  */
 class StaticUserIdentityProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "static-user-identity";
     /**
      * Runtime name for the class.
      */
@@ -274,19 +305,15 @@ class StaticUserIdentityProcessor {
  * Process the REST request and log its information.
  */
 class LoggingProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "logging";
     /**
      * Runtime name for the class.
      */
     CLASS_NAME = "LoggingProcessor";
     /**
-     * The connector for logging the information.
+     * The component for logging the information.
      * @internal
      */
-    _loggingConnector;
+    _logging;
     /**
      * Include the body objects when logging the information.
      * @internal
@@ -307,7 +334,7 @@ class LoggingProcessor {
      * @param options Options for the processor.
      */
     constructor(options) {
-        this._loggingConnector = LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
         this._includeBody = options?.config?.includeBody ?? false;
         this._fullBase64 = options?.config?.fullBase64 ?? false;
         this._obfuscateProperties = options?.config?.obfuscateProperties ?? ["password"];
@@ -324,9 +351,7 @@ class LoggingProcessor {
         const now = process.hrtime.bigint();
         processorState.requestStart = now;
         const contentType = request.headers?.[HeaderTypes.ContentType];
-        const isJson = Is.stringValue(contentType)
-            ? contentType.includes(MimeTypes.Json) || contentType.includes(MimeTypes.JsonLd)
-            : false;
+        const isJson = this.isMimeJson(contentType);
         let requestUrl = "";
         if (Is.stringValue(request.url)) {
             // Socket paths do not have a prefix so just use the whole url.
@@ -337,7 +362,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._logging?.log({
             level: "info",
             source: this.CLASS_NAME,
             ts: Date.now(),
@@ -359,9 +384,7 @@ class LoggingProcessor {
         let data;
         if (this._includeBody) {
             const contentType = response.headers?.[HeaderTypes.ContentType];
-            const isJson = Is.stringValue(contentType)
-                ? contentType.includes(MimeTypes.Json) || contentType.includes(MimeTypes.JsonLd)
-                : false;
+            const isJson = this.isMimeJson(contentType);
             const contentLength = response.headers?.[HeaderTypes.ContentLength];
             if (isJson) {
                 data = {
@@ -397,7 +420,7 @@ class LoggingProcessor {
                 requestUrl = request.url;
             }
         }
-        await this._loggingConnector.log({
+        await this._logging?.log({
             level: Is.number(response.statusCode) && response.statusCode >= HttpStatusCode.badRequest
                 ? "error"
                 : "info",
@@ -433,16 +456,52 @@ class LoggingProcessor {
         }
         return propValue;
     }
+    /**
+     * Check if the content type is JSON.
+     * @param contentType The content type to check.
+     * @returns True if the content type is JSON, false otherwise.
+     * @internal
+     */
+    isMimeJson(contentType) {
+        return Is.stringValue(contentType)
+            ? contentType.includes(MimeTypes.Json) || contentType.includes(MimeTypes.JsonLd)
+            : false;
+    }
 }
 
 /**
- * Process the JWT mime type.
+ * Process the JSON-LD mime type.
  */
-class JwtMimeTypeProcessor {
+class JsonLdMimeTypeProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "JsonLdMimeTypeProcessor";
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [MimeTypes.JsonLd];
+    }
     /**
-     * The namespace supported by the processor.
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
      */
-    static NAMESPACE = "jwt";
+    async handle(body) {
+        const json = ObjectHelper.fromBytes(body);
+        if (Is.empty(json) || Is.empty(json["@context"])) {
+            throw new GeneralError(this.CLASS_NAME, "invalidJsonLd");
+        }
+        return json;
+    }
+}
+
+/**
+ * Process the JWT mime type.
+ */
+class JwtMimeTypeProcessor {
     /**
      * Runtime name for the class.
      */
@@ -464,4 +523,4 @@ class JwtMimeTypeProcessor {
     }
 }
 
-export { JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, RestRouteProcessor, SocketRouteProcessor, StaticUserIdentityProcessor };
+export { JsonLdMimeTypeProcessor, JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, RestRouteProcessor, SocketRouteProcessor, StaticUserIdentityProcessor };

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

@@ -4,10 +4,6 @@ import type { IRestRouteProcessorConstructorOptions } from "../models/IRestRoute
  * Process the REST request and hands it on to the route handler.
  */
 export declare class RestRouteProcessor implements IRestRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -24,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

@@ -1,13 +1,9 @@
-import { type IHttpRequestIdentity, type IHttpResponse, type IHttpServerRequest, type ISocketRoute, type ISocketRouteProcessor } from "@twin.org/api-models";
+import { type IHttpRequestIdentity, type IHttpResponse, type ISocketRoute, type ISocketRouteProcessor, type ISocketServerRequest } from "@twin.org/api-models";
 import type { ISocketRouteProcessorConstructorOptions } from "../models/ISocketRouteProcessorConstructorOptions";
 /**
  * Process the socket request and hands it on to the route handler.
  */
 export declare class SocketRouteProcessor implements ISocketRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -17,6 +13,22 @@ export declare class SocketRouteProcessor implements ISocketRouteProcessor {
      * @param options Options for the processor.
      */
     constructor(options?: ISocketRouteProcessorConstructorOptions);
+    /**
+     * 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, 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, loggingComponentType?: string): Promise<void>;
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -25,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: IHttpServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    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

@@ -3,10 +3,6 @@ import type { IBaseRoute, IBaseRouteProcessor, IHttpRequestIdentity, IHttpRespon
  * Adds a node identity to the request identity.
  */
 export declare class NodeIdentityProcessor implements IBaseRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -14,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/identity/staticUserIdentityProcessor.d.ts

@@ -4,10 +4,6 @@ import type { IStaticUserIdentityProcessorConstructorOptions } from "../models/I
  * Adds a static user identity to the request context.
  */
 export declare class StaticUserIdentityProcessor implements IBaseRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ export * from "./data/socketRouteProcessor";
 export * from "./identity/nodeIdentityProcessor";
 export * from "./identity/staticUserIdentityProcessor";
 export * from "./logging/loggingProcessor";
+export * from "./mimeType/jsonLdMimeTypeProcessor";
 export * from "./mimeType/jwtMimeTypeProcessor";
 export * from "./models/ILoggingProcessorConfig";
 export * from "./models/ILoggingProcessorConstructorOptions";

package/dist/types/logging/loggingProcessor.d.ts

@@ -4,10 +4,6 @@ import type { ILoggingProcessorConstructorOptions } from "../models/ILoggingProc
  * Process the REST request and log its information.
  */
 export declare class LoggingProcessor implements IBaseRouteProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */

package/dist/types/mimeType/jsonLdMimeTypeProcessor.d.ts

@@ -0,0 +1,21 @@
+import type { IMimeTypeProcessor } from "@twin.org/api-models";
+/**
+ * Process the JSON-LD mime type.
+ */
+export declare class JsonLdMimeTypeProcessor implements IMimeTypeProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes(): string[];
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    handle(body: Uint8Array): Promise<unknown>;
+}

package/dist/types/mimeType/jwtMimeTypeProcessor.d.ts

@@ -3,10 +3,6 @@ import type { IMimeTypeProcessor } from "@twin.org/api-models";
  * Process the JWT mime type.
  */
 export declare class JwtMimeTypeProcessor implements IMimeTypeProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */

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,153 @@
 # @twin.org/api-processors - Changelog
 
+## [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)
+
+
+### Features
+
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.6...api-processors-v0.0.2-next.7) (2025-08-20)
+
+
+### Features
+
+* logging naming consistency ([a4a6ef2](https://github.com/twinfoundation/api/commit/a4a6ef2de5049045589eb78b177ff62e744bde9d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [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)
+
+
+### Features
+
+* 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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.1...api-processors-v0.0.2-next.2) (2025-07-17)
+
+
+### 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.1 to 0.0.2-next.2
+
+## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-processors-v0.0.2-next.0...api-processors-v0.0.2-next.1) (2025-07-08)
+
+
+### Features
+
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* 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.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-03)
 
 

package/docs/reference/classes/JsonLdMimeTypeProcessor.md

@@ -0,0 +1,73 @@
+# Class: JsonLdMimeTypeProcessor
+
+Process the JSON-LD mime type.
+
+## Implements
+
+- `IMimeTypeProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new JsonLdMimeTypeProcessor**(): `JsonLdMimeTypeProcessor`
+
+#### Returns
+
+`JsonLdMimeTypeProcessor`
+
+## Properties
+
+### 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/JwtMimeTypeProcessor.md

@@ -18,14 +18,6 @@ Process the JWT mime type.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"jwt"`
-
-The namespace supported by the processor.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`

package/docs/reference/classes/LoggingProcessor.md

@@ -28,14 +28,6 @@ Options for the processor.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"logging"`
-
-The namespace supported by the processor.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`

package/docs/reference/classes/NodeIdentityProcessor.md

@@ -18,14 +18,6 @@ Adds a node identity to the request identity.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"node-identity"`
-
-The namespace supported by the processor.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -40,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.
 
@@ -52,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

@@ -28,14 +28,6 @@ Options for the processor.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"rest-route"`
-
-The namespace supported by the processor.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -50,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.
 
@@ -84,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

@@ -28,14 +28,6 @@ Options for the processor.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"socket-route"`
-
-The namespace supported by the processor.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -48,9 +40,85 @@ Runtime name for the class.
 
 ## Methods
 
+### connected()
+
+> **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the connected event.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+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`\>
+
+Promise that resolves when the request is processed.
+
+#### Implementation of
+
+`ISocketRouteProcessor.connected`
+
+***
+
+### disconnected()
+
+> **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the disconnected event.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+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`\>
+
+Promise that resolves when the request is processed.
+
+#### Implementation of
+
+`ISocketRouteProcessor.disconnected`
+
+***
+
 ### 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.
 
@@ -58,7 +126,7 @@ Process the REST request for the specified route.
 
 ##### request
 
-`IHttpServerRequest`
+`ISocketServerRequest`
 
 The incoming request.
 
@@ -90,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/classes/StaticUserIdentityProcessor.md

@@ -28,14 +28,6 @@ Options for the processor.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"static-user-identity"`
-
-The namespace supported by the processor.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`

package/docs/reference/index.md

@@ -7,6 +7,7 @@
 - [NodeIdentityProcessor](classes/NodeIdentityProcessor.md)
 - [StaticUserIdentityProcessor](classes/StaticUserIdentityProcessor.md)
 - [LoggingProcessor](classes/LoggingProcessor.md)
+- [JsonLdMimeTypeProcessor](classes/JsonLdMimeTypeProcessor.md)
 - [JwtMimeTypeProcessor](classes/JwtMimeTypeProcessor.md)
 
 ## Interfaces

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/locales/en.json

@@ -10,6 +10,9 @@
 			"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'."
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-processors",
-	"version": "0.0.1",
+	"version": "0.0.2-next.10",
 	"description": "Route processors for use with API servers",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "^0.0.1",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/entity": "^0.0.1",
-		"@twin.org/entity-storage-models": "^0.0.1-next.2",
-		"@twin.org/logging-models": "^0.0.1-next.2",
-		"@twin.org/nameof": "^0.0.1",
-		"@twin.org/web": "^0.0.1"
+		"@twin.org/api-models": "0.0.2-next.10",
+		"@twin.org/core": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",