@twin.org/api-models 0.0.1-next.2 → 0.0.1-next.20

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/docs/reference/type-aliases/IRestRouteEntryPoint.md

@@ -0,0 +1,5 @@
+# Type Alias: IRestRouteEntryPoint
+
+> **IRestRouteEntryPoint**: [`IBaseRouteEntryPoint`](../interfaces/IBaseRouteEntryPoint.md)\<[`IRestRoute`](../interfaces/IRestRoute.md)\>
+
+Route entry points are used for exposing the REST routes from a package.

package/docs/reference/type-aliases/ISocketRouteEntryPoint.md

@@ -0,0 +1,5 @@
+# Type Alias: ISocketRouteEntryPoint
+
+> **ISocketRouteEntryPoint**: [`IBaseRouteEntryPoint`](../interfaces/IBaseRouteEntryPoint.md)\<[`ISocketRoute`](../interfaces/ISocketRoute.md)\>
+
+Route entry points are used for exposing the socket routes from a package.

package/docs/reference/variables/MimeTypeProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: MimeTypeProcessorFactory
+
+> `const` **MimeTypeProcessorFactory**: `Factory`\<[`IMimeTypeProcessor`](../interfaces/IMimeTypeProcessor.md)\>
+
+Factory for creating implementation of mime type processor types.

package/docs/reference/variables/RestRouteProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: RestRouteProcessorFactory
+
+> `const` **RestRouteProcessorFactory**: `Factory`\<[`IRestRouteProcessor`](../interfaces/IRestRouteProcessor.md)\>
+
+Factory for creating implementation of REST route processor types.

package/docs/reference/variables/SocketRouteProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: SocketRouteProcessorFactory
+
+> `const` **SocketRouteProcessorFactory**: `Factory`\<[`ISocketRouteProcessor`](../interfaces/ISocketRouteProcessor.md)\>
+
+Factory for creating implementation of socket route processor types.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.20",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -13,38 +13,11 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"@types/node": "22.5.5",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",

package/docs/reference/interfaces/IRestRouteEntryPoint.md

@@ -1,45 +0,0 @@
-# Interface: IRestRouteEntryPoint
-
-Route entry points are used for exposing the REST routes from a package.
-
-## Properties
-
-### name
-
-> **name**: `string`
-
-The name of the REST routes.
-
-***
-
-### defaultBaseRoute
-
-> **defaultBaseRoute**: `string`
-
-The default base route name for the REST routes.
-
-***
-
-### tags
-
-> **tags**: [`ITag`](ITag.md)[]
-
-The tags for the REST routes.
-
-***
-
-### generateRoutes()
-
-> **generateRoutes**: (`baseRouteName`, `componentName`) => [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
-
-The method to generate the REST routes.
-
-#### Parameters
-
-• **baseRouteName**: `string`
-
-• **componentName**: `string`
-
-#### Returns
-
-[`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]