@twin.org/api-models 0.0.2-next.1 → 0.0.2-next.3

package/dist/types/index.d.ts

@@ -15,6 +15,8 @@ export * from "./models/protocol/IHttpRequestPathParams";
 export * from "./models/protocol/IHttpRequestQuery";
 export * from "./models/protocol/IHttpResponse";
 export * from "./models/protocol/IHttpServerRequest";
+export * from "./models/protocol/ISocketRequestContext";
+export * from "./models/protocol/ISocketServerRequest";
 export * from "./models/requests/INoContentRequest";
 export * from "./models/responses/errors/IBadRequestResponse";
 export * from "./models/responses/errors/IConflictResponse";

package/dist/types/models/protocol/ISocketRequestContext.d.ts

@@ -0,0 +1,10 @@
+import type { IHttpRequestContext } from "./IHttpRequestContext";
+/**
+ * Context data from the socket request.
+ */
+export interface ISocketRequestContext extends IHttpRequestContext {
+    /**
+     * The id of the socket.
+     */
+    socketId: string;
+}

package/dist/types/models/protocol/ISocketServerRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IHttpServerRequest } from "./IHttpServerRequest";
+/**
+ * Model for the standard parameters for an http request.
+ */
+export interface ISocketServerRequest<T = any> extends IHttpServerRequest<T> {
+    /**
+     * The socket id.
+     */
+    socketId: string;
+}

package/dist/types/models/routes/ISocketRoute.d.ts

@@ -1,7 +1,7 @@
 import type { IBaseRoute } from "./IBaseRoute";
 import type { IHttpRequest } from "../protocol/IHttpRequest";
-import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
 import type { IHttpResponse } from "../protocol/IHttpResponse";
+import type { ISocketRequestContext } from "../protocol/ISocketRequestContext";
 /**
  * Interface which defines a socket route.
  */
@@ -13,7 +13,7 @@ export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpRespo
     /**
      * The request context.
      */
-    httpRequestContext: IHttpRequestContext, 
+    socketRequestContext: ISocketRequestContext, 
     /**
      * The request object.
      */
@@ -22,4 +22,20 @@ export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpRespo
      * The function to emit an event.
      */
     emit: (event: string, response: U) => Promise<void>) => void;
+    /**
+     * The connected handler.
+     */
+    connected?: (
+    /**
+     * The request context.
+     */
+    socketRequestContext: ISocketRequestContext) => void;
+    /**
+     * The disconnected handler.
+     */
+    disconnected?: (
+    /**
+     * The request context.
+     */
+    socketRequestContext: ISocketRequestContext) => void;
 }

package/dist/types/models/server/IBaseRouteProcessor.d.ts

@@ -6,7 +6,7 @@ import type { IBaseRoute } from "../routes/IBaseRoute";
 /**
  * The definition for a base processor for handling REST routes.
  */
-export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
+export interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> extends IComponent {
     /**
      * Pre process the REST request for the specified route.
      * @param request The request to handle.
@@ -16,7 +16,7 @@ export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
      * @param processorState The state handed through the processors.
      * @returns Promise that resolves when the request is processed.
      */
-    pre?(request: IHttpServerRequest, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    pre?(request: R, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
     /**
@@ -28,7 +28,7 @@ export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
      * @param processorState The state handed through the processors.
      * @returns Promise that resolves when the request is processed.
      */
-    post?(request: IHttpServerRequest, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    post?(request: R, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
 }

package/dist/types/models/server/ISocketRouteProcessor.d.ts

@@ -1,35 +1,29 @@
 import type { IBaseRouteProcessor } from "./IBaseRouteProcessor";
 import type { IHttpRequestIdentity } from "../protocol/IHttpRequestIdentity";
 import type { IHttpResponse } from "../protocol/IHttpResponse";
-import type { IHttpServerRequest } from "../protocol/IHttpServerRequest";
+import type { ISocketServerRequest } from "../protocol/ISocketServerRequest";
 import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
  * The definition for a processor for handling socket routes.
  */
-export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute> {
+export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute, ISocketServerRequest> {
     /**
      * Process the connected event.
-     * @param request The request to handle.
+     * @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 processorState The state handed through the processors.
      * @returns Promise that resolves when the request is processed.
      */
-    connected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
-        [id: string]: unknown;
-    }): Promise<void>;
+    connected?(request: ISocketServerRequest, route: ISocketRoute | undefined): Promise<void>;
     /**
      * Process the disconnected event.
-     * @param request The request to handle.
+     * @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 processorState The state handed through the processors.
      * @returns Promise that resolves when the request is processed.
      */
-    disconnected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
-        [id: string]: unknown;
-    }): Promise<void>;
+    disconnected?(request: ISocketServerRequest, route: ISocketRoute | undefined): Promise<void>;
     /**
      * Process the REST request for the specified route.
-     * @param request The request to handle.
+     * @param request The server request object containing the socket id and other parameters.
      * @param response The response data to send if any.
      * @param route The route being requested, if a matching one was found.
      * @param requestIdentity The identity context for the request.
@@ -37,7 +31,7 @@ export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute>
      * @param responseEmitter The function to emit a response.
      * @returns Promise that resolves when the request is processed.
      */
-    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/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/api-models - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.2...api-models-v0.0.2-next.3) (2025-07-24)
+
+
+### Features
+
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+
+## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.1...api-models-v0.0.2-next.2) (2025-07-17)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.0...api-models-v0.0.2-next.1) (2025-07-08)
 
 

package/docs/reference/index.md

@@ -19,6 +19,8 @@
 - [IHttpRequestQuery](interfaces/IHttpRequestQuery.md)
 - [IHttpResponse](interfaces/IHttpResponse.md)
 - [IHttpServerRequest](interfaces/IHttpServerRequest.md)
+- [ISocketRequestContext](interfaces/ISocketRequestContext.md)
+- [ISocketServerRequest](interfaces/ISocketServerRequest.md)
 - [INoContentRequest](interfaces/INoContentRequest.md)
 - [IBadRequestResponse](interfaces/IBadRequestResponse.md)
 - [IConflictResponse](interfaces/IConflictResponse.md)

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -1,4 +1,4 @@
-# Interface: IBaseRouteProcessor\<T\>
+# Interface: IBaseRouteProcessor\<T, R\>
 
 The definition for a base processor for handling REST routes.
 
@@ -17,6 +17,10 @@ The definition for a base processor for handling REST routes.
 
 `T` = [`IBaseRoute`](IBaseRoute.md)
 
+### R
+
+`R` = [`IHttpServerRequest`](IHttpServerRequest.md)
+
 ## Methods
 
 ### pre()?
@@ -29,7 +33,7 @@ Pre process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+`R`
 
 The request to handle.
 
@@ -73,7 +77,7 @@ Post process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+`R`
 
 The request to handle.
 

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -6,6 +6,10 @@ Context data from the HTTP request.
 
 - [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
 
+## Extended by
+
+- [`ISocketRequestContext`](ISocketRequestContext.md)
+
 ## Properties
 
 ### serverRequest

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -6,6 +6,10 @@ Model for the standard parameters for an http request.
 
 - [`IHttpRequest`](IHttpRequest.md)\<`T`\>
 
+## Extended by
+
+- [`ISocketServerRequest`](ISocketServerRequest.md)
+
 ## Type Parameters
 
 ### T

package/docs/reference/interfaces/ISocketRequestContext.md

@@ -0,0 +1,67 @@
+# Interface: ISocketRequestContext
+
+Context data from the socket request.
+
+## Extends
+
+- [`IHttpRequestContext`](IHttpRequestContext.md)
+
+## Properties
+
+### serverRequest
+
+> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
+
+The raw HTTP request.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`serverRequest`](IHttpRequestContext.md#serverrequest)
+
+***
+
+### processorState
+
+> **processorState**: `object`
+
+The state handed through the processors.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`processorState`](IHttpRequestContext.md#processorstate)
+
+***
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The identity of the node the request is being performed on.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`nodeIdentity`](IHttpRequestContext.md#nodeidentity)
+
+***
+
+### userIdentity?
+
+> `optional` **userIdentity**: `string`
+
+The identity of the requestor if there is an authenticated user.
+
+#### Inherited from
+
+[`IHttpRequestContext`](IHttpRequestContext.md).[`userIdentity`](IHttpRequestContext.md#useridentity)
+
+***
+
+### socketId
+
+> **socketId**: `string`
+
+The id of the socket.

package/docs/reference/interfaces/ISocketRoute.md

@@ -56,15 +56,15 @@ Skips the authentication for this route.
 
 ### handler()
 
-> **handler**: (`httpRequestContext`, `request`, `emit`) => `void`
+> **handler**: (`socketRequestContext`, `request`, `emit`) => `void`
 
 The handler module.
 
 #### Parameters
 
-##### httpRequestContext
+##### socketRequestContext
 
-[`IHttpRequestContext`](IHttpRequestContext.md)
+[`ISocketRequestContext`](ISocketRequestContext.md)
 
 The request context.
 
@@ -83,3 +83,43 @@ The function to emit an event.
 #### Returns
 
 `void`
+
+***
+
+### connected()?
+
+> `optional` **connected**: (`socketRequestContext`) => `void`
+
+The connected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`void`
+
+***
+
+### disconnected()?
+
+> `optional` **disconnected**: (`socketRequestContext`) => `void`
+
+The disconnected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`void`

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -4,7 +4,7 @@ The definition for a processor for handling socket routes.
 
 ## Extends
 
-- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md)\>
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md), [`ISocketServerRequest`](ISocketServerRequest.md)\>
 
 ## Methods
 
@@ -18,7 +18,7 @@ Pre process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
 The request to handle.
 
@@ -66,7 +66,7 @@ Post process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
 The request to handle.
 
@@ -106,7 +106,7 @@ Promise that resolves when the request is processed.
 
 ### connected()?
 
-> `optional` **connected**(`request`, `route`, `processorState`): `Promise`\<`void`\>
+> `optional` **connected**(`request`, `route`): `Promise`\<`void`\>
 
 Process the connected event.
 
@@ -114,9 +114,9 @@ Process the connected event.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
-The request to handle.
+The server request object containing the socket id and other parameters.
 
 ##### route
 
@@ -124,10 +124,6 @@ The route being requested, if a matching one was found.
 
 `undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
 
-##### processorState
-
-The state handed through the processors.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -138,7 +134,7 @@ Promise that resolves when the request is processed.
 
 ### disconnected()?
 
-> `optional` **disconnected**(`request`, `route`, `processorState`): `Promise`\<`void`\>
+> `optional` **disconnected**(`request`, `route`): `Promise`\<`void`\>
 
 Process the disconnected event.
 
@@ -146,9 +142,9 @@ Process the disconnected event.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
-The request to handle.
+The server request object containing the socket id and other parameters.
 
 ##### route
 
@@ -156,10 +152,6 @@ The route being requested, if a matching one was found.
 
 `undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
 
-##### processorState
-
-The state handed through the processors.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -178,9 +170,9 @@ Process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+[`ISocketServerRequest`](ISocketServerRequest.md)
 
-The request to handle.
+The server request object containing the socket id and other parameters.
 
 ##### response
 

package/docs/reference/interfaces/ISocketServerRequest.md

@@ -0,0 +1,93 @@
+# Interface: ISocketServerRequest\<T\>
+
+Model for the standard parameters for an http request.
+
+## Extends
+
+- [`IHttpServerRequest`](IHttpServerRequest.md)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` = `any`
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `IHttpHeaders`
+
+Incoming Http Headers.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`headers`](IHttpServerRequest.md#headers)
+
+***
+
+### pathParams?
+
+> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+
+The path parameters.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`pathParams`](IHttpServerRequest.md#pathparams)
+
+***
+
+### query?
+
+> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+
+The query parameters.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`query`](IHttpServerRequest.md#query)
+
+***
+
+### body?
+
+> `optional` **body**: `T`
+
+Data to return send as the body.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`body`](IHttpServerRequest.md#body)
+
+***
+
+### method?
+
+> `optional` **method**: `HttpMethod`
+
+The request method.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`method`](IHttpServerRequest.md#method)
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+The request url.
+
+#### Inherited from
+
+[`IHttpServerRequest`](IHttpServerRequest.md).[`url`](IHttpServerRequest.md#url)
+
+***
+
+### socketId
+
+> **socketId**: `string`
+
+The socket id.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.3",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",