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

package/dist/cjs/index.cjs

@@ -11,10 +11,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.
      */
@@ -120,10 +116,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 +132,54 @@ 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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    async connected(request, route) {
+        if (route?.connected) {
+            try {
+                const req = {
+                    pathParams: request.pathParams,
+                    query: request.query,
+                    body: request.body
+                };
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: req,
+                    processorState: {}
+                };
+                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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    async disconnected(request, route) {
+        if (route?.disconnected) {
+            try {
+                const req = {
+                    pathParams: request.pathParams,
+                    query: request.query,
+                    body: request.body
+                };
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: req,
+                    processorState: {}
+                };
+                await route.disconnected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -169,11 +209,13 @@ class SocketRouteProcessor {
                         query: request.query,
                         body: request.body
                     };
-                    await route.handler({
+                    const socketRequestContext = {
                         ...requestIdentity,
+                        socketId: request.socketId,
                         serverRequest: request,
                         processorState
-                    }, req, async (topic, restRouteResponse) => {
+                    };
+                    await route.handler(socketRequestContext, req, async (topic, restRouteResponse) => {
                         response.headers = restRouteResponse?.headers;
                         response.body = restRouteResponse?.body;
                         response.statusCode =
@@ -194,10 +236,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.
      */
@@ -234,10 +272,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,10 +310,6 @@ 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.
      */
@@ -441,10 +471,6 @@ class LoggingProcessor {
  * Process the JSON-LD mime type.
  */
 class JsonLdMimeTypeProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "json-ld";
     /**
      * Runtime name for the class.
      */
@@ -474,10 +500,6 @@ class JsonLdMimeTypeProcessor {
  * Process the JWT mime type.
  */
 class JwtMimeTypeProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "jwt";
     /**
      * Runtime name for the class.
      */

package/dist/esm/index.mjs

@@ -9,10 +9,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.
      */
@@ -118,10 +114,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 +130,54 @@ 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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    async connected(request, route) {
+        if (route?.connected) {
+            try {
+                const req = {
+                    pathParams: request.pathParams,
+                    query: request.query,
+                    body: request.body
+                };
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: req,
+                    processorState: {}
+                };
+                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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    async disconnected(request, route) {
+        if (route?.disconnected) {
+            try {
+                const req = {
+                    pathParams: request.pathParams,
+                    query: request.query,
+                    body: request.body
+                };
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: req,
+                    processorState: {}
+                };
+                await route.disconnected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -167,11 +207,13 @@ class SocketRouteProcessor {
                         query: request.query,
                         body: request.body
                     };
-                    await route.handler({
+                    const socketRequestContext = {
                         ...requestIdentity,
+                        socketId: request.socketId,
                         serverRequest: request,
                         processorState
-                    }, req, async (topic, restRouteResponse) => {
+                    };
+                    await route.handler(socketRequestContext, req, async (topic, restRouteResponse) => {
                         response.headers = restRouteResponse?.headers;
                         response.body = restRouteResponse?.body;
                         response.statusCode =
@@ -192,10 +234,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.
      */
@@ -232,10 +270,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,10 +308,6 @@ 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.
      */
@@ -439,10 +469,6 @@ class LoggingProcessor {
  * Process the JSON-LD mime type.
  */
 class JsonLdMimeTypeProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "json-ld";
     /**
      * Runtime name for the class.
      */
@@ -472,10 +498,6 @@ class JsonLdMimeTypeProcessor {
  * Process the JWT mime type.
  */
 class JwtMimeTypeProcessor {
-    /**
-     * The namespace supported by the processor.
-     */
-    static NAMESPACE = "jwt";
     /**
      * Runtime name for the class.
      */

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

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,20 @@ 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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    connected(request: ISocketServerRequest, route: ISocketRoute | undefined): 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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    disconnected(request: ISocketServerRequest, route: ISocketRoute | undefined): Promise<void>;
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.
@@ -26,7 +36,7 @@ export declare class SocketRouteProcessor implements ISocketRouteProcessor {
      * @param processorState The state handed through the processors.
      * @param responseEmitter The function to emit a response.
      */
-    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>;
 }

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

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

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

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/docs/changelog.md

@@ -1,5 +1,20 @@
 # @twin.org/api-processors - Changelog
 
+## [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)
 
 

package/docs/reference/classes/JsonLdMimeTypeProcessor.md

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

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`

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`

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,6 +40,70 @@ Runtime name for the class.
 
 ## Methods
 
+### connected()
+
+> **connected**(`request`, `route`): `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`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Implementation of
+
+`ISocketRouteProcessor.connected`
+
+***
+
+### disconnected()
+
+> **disconnected**(`request`, `route`): `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`\>
+
+#### 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`\>
@@ -58,7 +114,7 @@ Process the REST request for the specified route.
 
 ##### request
 
-`IHttpServerRequest`
+`ISocketServerRequest`
 
 The incoming request.
 

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

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-processors",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.3",
 	"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.2",
+		"@twin.org/api-models": "0.0.2-next.3",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",