@twin.org/api-models 0.0.1-next.11 → 0.0.1-next.13

package/dist/types/index.d.ts

@@ -34,7 +34,10 @@ export * from "./models/routes/IRestRouteResponseExample";
 export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
 export * from "./models/routes/ITag";
-export * from "./models/server/IHttpRestRouteProcessor";
+export * from "./models/server/IRestRouteProcessor";
+export * from "./models/server/IMimeTypeProcessor";
+export * from "./models/server/IBaseRouteProcessor";
+export * from "./models/server/ISocketRouteProcessor";
 export * from "./models/server/IWebServer";
 export * from "./models/server/IWebServerOptions";
 export * from "./models/services/healthStatus";

package/dist/types/models/config/IBaseSocketClientConfig.d.ts

@@ -3,6 +3,10 @@ import type { IHttpHeaders } from "@twin.org/web";
  * Definition for the configuration of a socket service.
  */
 export interface IBaseSocketClientConfig {
+    /**
+     * Base path for the socket service, defaults to /socket.
+     */
+    basePath?: string;
     /**
      * The endpoint where the api is hosted.
      */

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

@@ -1,9 +1,11 @@
 import type { IBaseRoute } from "./IBaseRoute";
+import type { IHttpRequest } from "../protocol/IHttpRequest";
 import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
+import type { IHttpResponse } from "../protocol/IHttpResponse";
 /**
  * Interface which defines a socket route.
  */
-export interface ISocketRoute extends IBaseRoute {
+export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpResponse = any> extends IBaseRoute {
     /**
      * The handler module.
      */
@@ -12,16 +14,12 @@ export interface ISocketRoute extends IBaseRoute {
      * The request context.
      */
     httpRequestContext: IHttpRequestContext, 
-    /**
-     * The id of the socket the request is arriving on.
-     */
-    socketId: string, 
     /**
      * The request object.
      */
-    request: unknown, 
+    request: T, 
     /**
-     * Method to emit data on the socket.
+     * The function to emit a message.
      */
-    emitter: (topic: string, response?: unknown) => Promise<void>) => Promise<void>;
+    emit: (response: U) => Promise<void>) => void;
 }

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

@@ -0,0 +1,34 @@
+import type { IComponent } from "@twin.org/core";
+import type { IHttpRequestIdentity } from "../protocol/IHttpRequestIdentity";
+import type { IHttpResponse } from "../protocol/IHttpResponse";
+import type { IHttpServerRequest } from "../protocol/IHttpServerRequest";
+import type { IBaseRoute } from "../routes/IBaseRoute";
+/**
+ * The definition for a base processor for handling REST routes.
+ */
+export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The request to handle.
+     * @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.
+     * @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: {
+        [id: string]: unknown;
+    }): Promise<void>;
+    /**
+     * Post process the REST request for the specified route.
+     * @param request The request to handle.
+     * @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.
+     * @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: {
+        [id: string]: unknown;
+    }): Promise<void>;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * The definition for a handler for a specific MIME type.
+ */
+export interface IMimeTypeProcessor {
+    /**
+     * 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/models/server/IRestRouteProcessor.d.ts

@@ -0,0 +1,22 @@
+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 { IRestRoute } from "../routes/IRestRoute";
+/**
+ * The definition for a processor for handling REST routes.
+ */
+export interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {
+    /**
+     * Process the REST request for the specified route.
+     * @param request The request to handle.
+     * @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.
+     * @param processorState The state handed through the processors.
+     * @returns Promise that resolves when the request is processed.
+     */
+    process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+}

package/dist/types/models/server/{IHttpRestRouteProcessor.d.ts → ISocketRouteProcessor.d.ts}

@@ -1,46 +1,43 @@
-import type { IComponent } from "@twin.org/core";
+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 { IRestRoute } from "../routes/IRestRoute";
+import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
- * The definition for a processor for handling REST routes.
+ * The definition for a processor for handling socket routes.
  */
-export interface IHttpRestRouteProcessor extends IComponent {
+export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute> {
     /**
-     * Pre process the REST request for the specified route.
+     * Process the connected event.
      * @param request The request to handle.
-     * @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.
      * @param processorState The state handed through the processors.
      * @returns Promise that resolves when the request is processed.
      */
-    pre?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    connected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
     /**
-     * Process the REST request for the specified route.
+     * Process the disconnected event.
      * @param request The request to handle.
-     * @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.
      * @param processorState The state handed through the processors.
      * @returns Promise that resolves when the request is processed.
      */
-    process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    disconnected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
     /**
-     * Post process the REST request for the specified route.
+     * Process the REST request for the specified route.
      * @param request The request to handle.
      * @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.
      * @param processorState The state handed through the processors.
+     * @param responseEmitter The function to emit a response.
      * @returns Promise that resolves when the request is processed.
      */
-    post?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    process?(request: IHttpServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }): Promise<void>;
+    }, responseEmitter: (response: IHttpResponse) => Promise<void>): Promise<void>;
 }

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

@@ -1,6 +1,8 @@
-import type { IHttpRestRouteProcessor } from "./IHttpRestRouteProcessor";
+import type { IRestRouteProcessor } from "./IRestRouteProcessor";
+import type { ISocketRouteProcessor } from "./ISocketRouteProcessor";
 import type { IWebServerOptions } from "./IWebServerOptions";
 import type { IRestRoute } from "../routes/IRestRoute";
+import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
  * Interface describing a web server.
  */
@@ -12,12 +14,14 @@ export interface IWebServer<T> {
     getInstance(): T;
     /**
      * Build the server.
-     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param restRouteProcessors The processors for incoming requests over REST.
      * @param restRoutes The REST routes.
+     * @param socketRouteProcessors The processors for incoming requests over Sockets.
+     * @param socketRoutes The socket routes.
      * @param options Options for building the server.
      * @returns Nothing.
      */
-    build(restRouteProcessors: IHttpRestRouteProcessor[], restRoutes: IRestRoute[], options?: IWebServerOptions): Promise<void>;
+    build(restRouteProcessors?: IRestRouteProcessor[], restRoutes?: IRestRoute[], socketRouteProcessors?: ISocketRouteProcessor[], socketRoutes?: ISocketRoute[], options?: IWebServerOptions): Promise<void>;
     /**
      * Start the server.
      * @returns Nothing.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.11
+## v0.0.1-next.13
 
 - Initial Release

package/docs/reference/index.md

@@ -41,7 +41,10 @@
 - [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
 - [ITag](interfaces/ITag.md)
-- [IHttpRestRouteProcessor](interfaces/IHttpRestRouteProcessor.md)
+- [IBaseRouteProcessor](interfaces/IBaseRouteProcessor.md)
+- [IMimeTypeProcessor](interfaces/IMimeTypeProcessor.md)
+- [IRestRouteProcessor](interfaces/IRestRouteProcessor.md)
+- [ISocketRouteProcessor](interfaces/ISocketRouteProcessor.md)
 - [IWebServer](interfaces/IWebServer.md)
 - [IWebServerOptions](interfaces/IWebServerOptions.md)
 - [IHealthInfo](interfaces/IHealthInfo.md)

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -0,0 +1,88 @@
+# Interface: IBaseRouteProcessor\<T\>
+
+The definition for a base processor for handling REST routes.
+
+## Extends
+
+- `IComponent`
+
+## Extended by
+
+- [`IRestRouteProcessor`](IRestRouteProcessor.md)
+- [`ISocketRouteProcessor`](ISocketRouteProcessor.md)
+
+## Type Parameters
+
+• **T** = [`IBaseRoute`](IBaseRoute.md)
+
+## Methods
+
+### pre()?
+
+> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+
+The response data to send if any.
+
+• **route**: `undefined` \| `T`
+
+The route being requested, if a matching one was found.
+
+• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### post()?
+
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+
+The response data to send if any.
+
+• **route**: `undefined` \| `T`
+
+The route being requested, if a matching one was found.
+
+• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IBaseSocketClientConfig.md

@@ -4,6 +4,14 @@ Definition for the configuration of a socket service.
 
 ## Properties
 
+### basePath?
+
+> `optional` **basePath**: `string`
+
+Base path for the socket service, defaults to /socket.
+
+***
+
 ### endpoint
 
 > **endpoint**: `string`

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -0,0 +1,37 @@
+# Interface: IMimeTypeProcessor
+
+The definition for a handler for a specific MIME type.
+
+## Methods
+
+### getTypes()
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+***
+
+### handle()
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+• **body**: `Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.

package/docs/reference/interfaces/{IHttpRestRouteProcessor.md → IRestRouteProcessor.md}

@@ -1,10 +1,10 @@
-# Interface: IHttpRestRouteProcessor
+# Interface: IRestRouteProcessor
 
 The definition for a processor for handling REST routes.
 
 ## Extends
 
-- `IComponent`
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`IRestRoute`](IRestRoute.md)\>
 
 ## Methods
 
@@ -42,13 +42,17 @@ The state handed through the processors.
 
 Promise that resolves when the request is processed.
 
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`pre`](IBaseRouteProcessor.md#pre)
+
 ***
 
-### process()?
+### post()?
 
-> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
 
-Process the REST request for the specified route.
+Post process the REST request for the specified route.
 
 #### Parameters
 
@@ -78,13 +82,17 @@ The state handed through the processors.
 
 Promise that resolves when the request is processed.
 
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`post`](IBaseRouteProcessor.md#post)
+
 ***
 
-### post()?
+### process()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
 
-Post process the REST request for the specified route.
+Process the REST request for the specified route.
 
 #### Parameters
 

package/docs/reference/interfaces/ISocketRoute.md

@@ -1,4 +1,4 @@
-# Interface: ISocketRoute
+# Interface: ISocketRoute\<T, U\>
 
 Interface which defines a socket route.
 
@@ -6,6 +6,12 @@ Interface which defines a socket route.
 
 - [`IBaseRoute`](IBaseRoute.md)
 
+## Type Parameters
+
+• **T** *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+• **U** *extends* [`IHttpResponse`](IHttpResponse.md) = `any`
+
 ## Properties
 
 ### operationId
@@ -46,7 +52,7 @@ Skips the authentication for this route.
 
 ### handler()
 
-> **handler**: (`httpRequestContext`, `socketId`, `request`, `emitter`) => `Promise`\<`void`\>
+> **handler**: (`httpRequestContext`, `request`, `emit`) => `void`
 
 The handler module.
 
@@ -56,18 +62,14 @@ The handler module.
 
 The request context.
 
-• **socketId**: `string`
-
-The id of the socket the request is arriving on.
-
-• **request**: `unknown`
+• **request**: `T`
 
 The request object.
 
-• **emitter**
+• **emit**
 
-Method to emit data on the socket.
+The function to emit a message.
 
 #### Returns
 
-`Promise`\<`void`\>
+`void`

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -0,0 +1,183 @@
+# Interface: ISocketRouteProcessor
+
+The definition for a processor for handling socket routes.
+
+## Extends
+
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md)\>
+
+## Methods
+
+### pre()?
+
+> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+
+The response data to send if any.
+
+• **route**: `undefined` \| [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+The route being requested, if a matching one was found.
+
+• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`pre`](IBaseRouteProcessor.md#pre)
+
+***
+
+### post()?
+
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+
+The response data to send if any.
+
+• **route**: `undefined` \| [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+The route being requested, if a matching one was found.
+
+• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`post`](IBaseRouteProcessor.md#post)
+
+***
+
+### connected()?
+
+> `optional` **connected**(`request`, `route`, `processorState`): `Promise`\<`void`\>
+
+Process the connected event.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **route**: `undefined` \| [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+The route being requested, if a matching one was found.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### disconnected()?
+
+> `optional` **disconnected**(`request`, `route`, `processorState`): `Promise`\<`void`\>
+
+Process the disconnected event.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **route**: `undefined` \| [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+The route being requested, if a matching one was found.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### process()?
+
+> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The request to handle.
+
+• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+
+The response data to send if any.
+
+• **route**: `undefined` \| [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+The route being requested, if a matching one was found.
+
+• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+• **responseEmitter**
+
+The function to emit a response.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IWebServer.md

@@ -24,20 +24,28 @@ The web server instance.
 
 ### build()
 
-> **build**(`restRouteProcessors`, `restRoutes`, `options`?): `Promise`\<`void`\>
+> **build**(`restRouteProcessors`?, `restRoutes`?, `socketRouteProcessors`?, `socketRoutes`?, `options`?): `Promise`\<`void`\>
 
 Build the server.
 
 #### Parameters
 
-• **restRouteProcessors**: [`IHttpRestRouteProcessor`](IHttpRestRouteProcessor.md)[]
+• **restRouteProcessors?**: [`IRestRouteProcessor`](IRestRouteProcessor.md)[]
 
-The hooks to process the incoming requests.
+The processors for incoming requests over REST.
 
-• **restRoutes**: [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
+• **restRoutes?**: [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
 
 The REST routes.
 
+• **socketRouteProcessors?**: [`ISocketRouteProcessor`](ISocketRouteProcessor.md)[]
+
+The processors for incoming requests over Sockets.
+
+• **socketRoutes?**: [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>[]
+
+The socket routes.
+
 • **options?**: [`IWebServerOptions`](IWebServerOptions.md)
 
 Options for building the server.

package/package.json

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