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

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
 
@@ -16,23 +16,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
 
 The request to handle.
 
-• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
 
 The response data to send if any.
 
-• **route**: `undefined` \| [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+##### route
 
 The route being requested, if a matching one was found.
 
-• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`undefined` | [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+
+##### requestIdentity
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -42,33 +50,45 @@ 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
 
-• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
 
 The request to handle.
 
-• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
 
 The response data to send if any.
 
-• **route**: `undefined` \| [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+##### route
 
 The route being requested, if a matching one was found.
 
-• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`undefined` | [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+
+##### requestIdentity
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -78,33 +98,45 @@ 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
 
-• **request**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+##### request
+
+[`IHttpServerRequest`](IHttpServerRequest.md)
 
 The request to handle.
 
-• **response**: [`IHttpResponse`](IHttpResponse.md)\<`any`\>
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
 
 The response data to send if any.
 
-• **route**: `undefined` \| [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+##### route
 
 The route being requested, if a matching one was found.
 
-• **requestIdentity**: [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`undefined` | [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>
+
+##### requestIdentity
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 

package/docs/reference/interfaces/IRestRouteRequestExample.md

@@ -8,7 +8,9 @@ Interface which defines a REST route request example.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Properties
 

package/docs/reference/interfaces/IRestRouteResponseExample.md

@@ -8,7 +8,9 @@ Interface which defines a REST route response example.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Properties
 

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,16 @@ Interface which defines a socket route.
 
 - [`IBaseRoute`](IBaseRoute.md)
 
+## Type Parameters
+
+### T
+
+`T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+### U
+
+`U` *extends* [`IHttpResponse`](IHttpResponse.md) = `any`
+
 ## Properties
 
 ### operationId
@@ -46,28 +56,30 @@ Skips the authentication for this route.
 
 ### handler()
 
-> **handler**: (`httpRequestContext`, `socketId`, `request`, `emitter`) => `Promise`\<`void`\>
+> **handler**: (`httpRequestContext`, `request`, `emit`) => `void`
 
 The handler module.
 
 #### Parameters
 
-• **httpRequestContext**: [`IHttpRequestContext`](IHttpRequestContext.md)
+##### httpRequestContext
 
-The request context.
+[`IHttpRequestContext`](IHttpRequestContext.md)
 
-• **socketId**: `string`
+The request context.
 
-The id of the socket the request is arriving on.
+##### request
 
-• **request**: `unknown`
+`T`
 
 The request object.
 
-• **emitter**
+##### emit
+
+(`event`, `response`) => `Promise`\<`void`\>
 
-Method to emit data on the socket.
+The function to emit an event.
 
 #### Returns
 
-`Promise`\<`void`\>
+`void`

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -0,0 +1,217 @@
+# 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)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+The route being requested, if a matching one was found.
+
+`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+##### 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)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+The route being requested, if a matching one was found.
+
+`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+##### 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)
+
+The request to handle.
+
+##### route
+
+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`\>
+
+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)
+
+The request to handle.
+
+##### route
+
+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`\>
+
+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)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+The route being requested, if a matching one was found.
+
+`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+
+##### requestIdentity
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+The identity context for the request.
+
+##### processorState
+
+The state handed through the processors.
+
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
+
+The function to emit a response.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IWebServer.md

@@ -4,7 +4,9 @@ Interface describing a web server.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Methods
 
@@ -24,21 +26,39 @@ 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.
 
-• **options?**: [`IWebServerOptions`](IWebServerOptions.md)
+##### 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/HealthStatus.md

@@ -1,5 +1,5 @@
 # Type Alias: HealthStatus
 
-> **HealthStatus**: *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
+> **HealthStatus** = *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
 
 The health status of the component.

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.9",
+	"version": "0.0.2-next.1",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -23,9 +23,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [

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`\>[]