@twin.org/api-models 0.0.1-next.3 → 0.0.1-next.31

package/docs/reference/classes/HttpParameterHelper.md

@@ -0,0 +1,117 @@
+# 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,53 @@
+# 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,104 @@
+# 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)
+
+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` | `T`
+
+##### 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)
+
+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` | `T`
+
+##### 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/IHealthInfo.md

@@ -17,3 +17,21 @@ The status.
 > `optional` **components**: `object`[]
 
 The status of the components.
+
+#### name
+
+> **name**: `string`
+
+The name of the component.
+
+#### status
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The status of the component.
+
+#### details?
+
+> `optional` **details**: `string`
+
+The details for the status.

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -10,7 +10,7 @@ Context data from the HTTP request.
 
 ### serverRequest
 
-> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
 
 The raw HTTP request.
 
@@ -24,7 +24,7 @@ The state handed through the processors.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 ***
 

package/docs/reference/interfaces/IHttpRequestPathParams.md

@@ -4,4 +4,4 @@ Model for the standard parameters for an http request.
 
 ## Indexable
 
- \[`id`: `string`\]: `string` \| `number` \| `boolean`
+\[`id`: `string`\]: `string` \| `number` \| `boolean`

package/docs/reference/interfaces/IHttpRequestQuery.md

@@ -4,4 +4,4 @@ Model used for Http request query parameters.
 
 ## Indexable
 
- \[`id`: `string`\]: `string` \| `number` \| `boolean`
+\[`id`: `string`\]: `string` \| `number` \| `boolean`

package/docs/reference/interfaces/IInformationComponent.md

@@ -58,15 +58,21 @@ Set the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.
 
-• **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+##### status
+
+[`HealthStatus`](../type-aliases/HealthStatus.md)
 
 The status of the component.
 
-• **details?**: `string`
+##### details?
+
+`string`
 
 The details for the status.
 
@@ -86,7 +92,9 @@ Remove the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.
 

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -0,0 +1,43 @@
+# 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

@@ -82,11 +82,15 @@ The handler module.
 
 #### Parameters
 
-• **httpRequestContext**: [`IHttpRequestContext`](IHttpRequestContext.md)
+##### httpRequestContext
+
+[`IHttpRequestContext`](IHttpRequestContext.md)
 
 The http request context.
 
-• **request**: `T`
+##### request
+
+`T`
 
 The request object, combined query param, path params and body.
 
@@ -116,7 +120,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.
 
@@ -128,6 +132,24 @@ Example objects for the request.
 
 The type of the response object.
 
+#### type
+
+> **type**: `string`
+
+The object type of the response.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the response, defaults to "application/json" if there is a body.
+
+#### examples?
+
+> `optional` **examples**: [`IRestRouteResponseExample`](IRestRouteResponseExample.md)\<`U`\>[]
+
+Example objects of the response.
+
 ***
 
 ### excludeFromSpec?

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.