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

package/docs/reference/classes/HttpParameterHelper.md

@@ -0,0 +1,109 @@
+# Class: HttpParameterHelper
+
+Class to help with handling http parameters.
+
+## Constructors
+
+### new HttpParameterHelper()
+
+> **new HttpParameterHelper**(): [`HttpParameterHelper`](HttpParameterHelper.md)
+
+#### Returns
+
+[`HttpParameterHelper`](HttpParameterHelper.md)
+
+## Methods
+
+### arrayFromString()
+
+> `static` **arrayFromString**\<`T`\>(`values`?): `undefined` \| `T`[]
+
+Convert list query to array.
+
+#### Type Parameters
+
+• **T** = `string`
+
+#### Parameters
+
+• **values?**: `string`
+
+The values query string.
+
+#### Returns
+
+`undefined` \| `T`[]
+
+The array of values.
+
+***
+
+### arrayToString()
+
+> `static` **arrayToString**\<`T`\>(`values`?): `undefined` \| `string`
+
+Convert array of values to query string.
+
+#### Type Parameters
+
+• **T** = `string`
+
+#### Parameters
+
+• **values?**: `T`[]
+
+The values to combine string.
+
+#### Returns
+
+`undefined` \| `string`
+
+The combined.
+
+***
+
+### objectFromString()
+
+> `static` **objectFromString**\<`T`\>(`value`?): `undefined` \| `T`
+
+Convert object string to object.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **value?**: `string`
+
+The value query string.
+
+#### Returns
+
+`undefined` \| `T`
+
+The object.
+
+***
+
+### objectToString()
+
+> `static` **objectToString**\<`T`\>(`value`?): `undefined` \| `string`
+
+Convert object to query string.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **value?**: `T`
+
+The value to convert to a string.
+
+#### Returns
+
+`undefined` \| `string`
+
+The converted object.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [HttpErrorHelper](classes/HttpErrorHelper.md)
+- [HttpParameterHelper](classes/HttpParameterHelper.md)
 
 ## Interfaces
 
@@ -31,13 +32,19 @@
 - [INoContentResponse](interfaces/INoContentResponse.md)
 - [IOkResponse](interfaces/IOkResponse.md)
 - [IBaseRoute](interfaces/IBaseRoute.md)
+- [IBaseRouteEntryPoint](interfaces/IBaseRouteEntryPoint.md)
 - [IRestRoute](interfaces/IRestRoute.md)
-- [IRestRouteEntryPoint](interfaces/IRestRouteEntryPoint.md)
+- [IRestRouteExample](interfaces/IRestRouteExample.md)
+- [IRestRouteRequestExample](interfaces/IRestRouteRequestExample.md)
 - [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
+- [IRestRouteResponseExample](interfaces/IRestRouteResponseExample.md)
 - [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)
@@ -46,8 +53,13 @@
 
 ## Type Aliases
 
+- [IRestRouteEntryPoint](type-aliases/IRestRouteEntryPoint.md)
+- [ISocketRouteEntryPoint](type-aliases/ISocketRouteEntryPoint.md)
 - [HealthStatus](type-aliases/HealthStatus.md)
 
 ## Variables
 
+- [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
+- [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
+- [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)
 - [HealthStatus](variables/HealthStatus.md)

package/docs/reference/interfaces/IBaseRouteEntryPoint.md

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

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/ICreatedResponse.md

@@ -18,8 +18,8 @@ Response status code.
 
 Additional response headers.
 
-#### Location
+#### location
 
-> **Location**: `string`
+> **location**: `string`
 
 The location where the resource was created.

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -0,0 +1,41 @@
+# Interface: IMimeTypeProcessor
+
+The definition for a handler for a specific MIME type.
+
+## Extends
+
+- `IComponent`
+
+## 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/IRestRoute.md

@@ -116,7 +116,7 @@ The mime type of the request, defaults to "application/json" if there is a body.
 
 #### examples?
 
-> `optional` **examples**: `object`[]
+> `optional` **examples**: [`IRestRouteRequestExample`](IRestRouteRequestExample.md)\<`T`\>[]
 
 Example objects for the request.
 

package/docs/reference/interfaces/IRestRouteExample.md

@@ -0,0 +1,24 @@
+# Interface: IRestRouteExample
+
+Interface which defines a REST route example.
+
+## Extended by
+
+- [`IRestRouteRequestExample`](IRestRouteRequestExample.md)
+- [`IRestRouteResponseExample`](IRestRouteResponseExample.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.

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/IRestRouteRequestExample.md

@@ -0,0 +1,43 @@
+# Interface: IRestRouteRequestExample\<T\>
+
+Interface which defines a REST route request example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### request
+
+> **request**: `T`
+
+The example request object.

package/docs/reference/interfaces/IRestRouteResponseExample.md

@@ -0,0 +1,43 @@
+# Interface: IRestRouteResponseExample\<T\>
+
+Interface which defines a REST route response example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### response
+
+> **response**: `T`
+
+The example response object.

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`