@twin.org/api-models 0.0.1-next.1

package/docs/reference/classes/HttpErrorHelper.md

@@ -0,0 +1,71 @@
+# Class: HttpErrorHelper
+
+Class to help with processing http errors.
+
+## Constructors
+
+### new HttpErrorHelper()
+
+> **new HttpErrorHelper**(): [`HttpErrorHelper`](HttpErrorHelper.md)
+
+#### Returns
+
+[`HttpErrorHelper`](HttpErrorHelper.md)
+
+## Methods
+
+### processError()
+
+> `static` **processError**(`err`, `includeStack`?): `object`
+
+Process the errors from the routes.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The error to process.
+
+• **includeStack?**: `boolean`
+
+Should the stack be included in the error.
+
+#### Returns
+
+`object`
+
+The status code and additional error data.
+
+##### error
+
+> **error**: `IError`
+
+##### httpStatusCode
+
+> **httpStatusCode**: `HttpStatusCode`
+
+***
+
+### buildResponse()
+
+> `static` **buildResponse**(`response`, `error`, `statusCode`): `void`
+
+Build an error response.
+
+#### Parameters
+
+• **response**: [`IHttpResponse`](../interfaces/IHttpResponse.md)\<`any`\>
+
+The response to build the error into.
+
+• **error**: `IError`
+
+The error to build the response for.
+
+• **statusCode**: `HttpStatusCode`
+
+The status code to use for the error.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,53 @@
+# @twin.org/api-models
+
+## Classes
+
+- [HttpErrorHelper](classes/HttpErrorHelper.md)
+
+## Interfaces
+
+- [IServerHealthResponse](interfaces/IServerHealthResponse.md)
+- [IServerInfoResponse](interfaces/IServerInfoResponse.md)
+- [IServerSpecResponse](interfaces/IServerSpecResponse.md)
+- [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
+- [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)
+- [IHttpRequest](interfaces/IHttpRequest.md)
+- [IHttpRequestContext](interfaces/IHttpRequestContext.md)
+- [IHttpRequestIdentity](interfaces/IHttpRequestIdentity.md)
+- [IHttpRequestPathParams](interfaces/IHttpRequestPathParams.md)
+- [IHttpRequestQuery](interfaces/IHttpRequestQuery.md)
+- [IHttpResponse](interfaces/IHttpResponse.md)
+- [IHttpServerRequest](interfaces/IHttpServerRequest.md)
+- [INoContentRequest](interfaces/INoContentRequest.md)
+- [IBadRequestResponse](interfaces/IBadRequestResponse.md)
+- [IConflictResponse](interfaces/IConflictResponse.md)
+- [IForbiddenResponse](interfaces/IForbiddenResponse.md)
+- [IInternalServerErrorResponse](interfaces/IInternalServerErrorResponse.md)
+- [INotFoundResponse](interfaces/INotFoundResponse.md)
+- [IUnauthorizedResponse](interfaces/IUnauthorizedResponse.md)
+- [IUnprocessableEntityResponse](interfaces/IUnprocessableEntityResponse.md)
+- [IAcceptedResponse](interfaces/IAcceptedResponse.md)
+- [ICreatedResponse](interfaces/ICreatedResponse.md)
+- [INoContentResponse](interfaces/INoContentResponse.md)
+- [IOkResponse](interfaces/IOkResponse.md)
+- [IBaseRoute](interfaces/IBaseRoute.md)
+- [IRestRoute](interfaces/IRestRoute.md)
+- [IRestRouteEntryPoint](interfaces/IRestRouteEntryPoint.md)
+- [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
+- [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
+- [ISocketRoute](interfaces/ISocketRoute.md)
+- [ITag](interfaces/ITag.md)
+- [IHttpRestRouteProcessor](interfaces/IHttpRestRouteProcessor.md)
+- [IWebServer](interfaces/IWebServer.md)
+- [IWebServerOptions](interfaces/IWebServerOptions.md)
+- [IHealthInfo](interfaces/IHealthInfo.md)
+- [IInformationComponent](interfaces/IInformationComponent.md)
+- [IServerInfo](interfaces/IServerInfo.md)
+
+## Type Aliases
+
+- [HealthStatus](type-aliases/HealthStatus.md)
+
+## Variables
+
+- [HealthStatus](variables/HealthStatus.md)

package/docs/reference/interfaces/IAcceptedResponse.md

@@ -0,0 +1,25 @@
+# Interface: IAcceptedResponse
+
+The rest request ended in accepted response.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `202`
+
+Response status code.
+
+***
+
+### headers
+
+> **headers**: `object`
+
+Additional response headers.
+
+#### location
+
+> **location**: `string`
+
+The location where the resource was accepted.

package/docs/reference/interfaces/IBadRequestResponse.md

@@ -0,0 +1,19 @@
+# Interface: IBadRequestResponse
+
+The server cannot process the request, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `400`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IBaseRestClientConfig.md

@@ -0,0 +1,43 @@
+# Interface: IBaseRestClientConfig
+
+Definition for the configuration of a rest client.
+
+## Properties
+
+### endpoint
+
+> **endpoint**: `string`
+
+The endpoint where the api is hosted.
+
+***
+
+### pathPrefix?
+
+> `optional` **pathPrefix**: `string`
+
+The prefix to the routes.
+
+***
+
+### headers?
+
+> `optional` **headers**: `IHttpHeaders`
+
+The headers to include in requests.
+
+***
+
+### timeout?
+
+> `optional` **timeout**: `number`
+
+Timeout for requests in ms.
+
+***
+
+### includeCredentials?
+
+> `optional` **includeCredentials**: `boolean`
+
+Include credentials in the request, defaults to true.

package/docs/reference/interfaces/IBaseRoute.md

@@ -0,0 +1,32 @@
+# Interface: IBaseRoute
+
+Interface which defines a route.
+
+## Extended by
+
+- [`IRestRoute`](IRestRoute.md)
+- [`ISocketRoute`](ISocketRoute.md)
+
+## Properties
+
+### operationId
+
+> **operationId**: `string`
+
+The id of the operation.
+
+***
+
+### path
+
+> **path**: `string`
+
+The path to use for routing.
+
+***
+
+### skipAuth?
+
+> `optional` **skipAuth**: `boolean`
+
+Skips the authentication for this route.

package/docs/reference/interfaces/IBaseSocketClientConfig.md

@@ -0,0 +1,27 @@
+# Interface: IBaseSocketClientConfig
+
+Definition for the configuration of a socket service.
+
+## Properties
+
+### endpoint
+
+> **endpoint**: `string`
+
+The endpoint where the api is hosted.
+
+***
+
+### pathPrefix?
+
+> `optional` **pathPrefix**: `string`
+
+The prefix to the routes.
+
+***
+
+### headers?
+
+> `optional` **headers**: `IHttpHeaders`
+
+The headers to include in requests.

package/docs/reference/interfaces/IConflictResponse.md

@@ -0,0 +1,27 @@
+# Interface: IConflictResponse
+
+The request resulted in a conflicting operation, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `409`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError` & `object`
+
+The body which contains the error.
+
+#### Type declaration
+
+##### conflicts
+
+> **conflicts**: `string`[]
+
+The conflicting items.

package/docs/reference/interfaces/ICreatedResponse.md

@@ -0,0 +1,25 @@
+# Interface: ICreatedResponse
+
+The rest request ended in created response.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `201`
+
+Response status code.
+
+***
+
+### headers
+
+> **headers**: `object`
+
+Additional response headers.
+
+#### Location
+
+> **Location**: `string`
+
+The location where the resource was created.

package/docs/reference/interfaces/IForbiddenResponse.md

@@ -0,0 +1,19 @@
+# Interface: IForbiddenResponse
+
+The operation that you tried to perform is not possible, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `403`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IHealthInfo.md

@@ -0,0 +1,19 @@
+# Interface: IHealthInfo
+
+The status of the server.
+
+## Properties
+
+### status
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The status.
+
+***
+
+### components?
+
+> `optional` **components**: `object`[]
+
+The status of the components.

package/docs/reference/interfaces/IHttpRequest.md

@@ -0,0 +1,44 @@
+# Interface: IHttpRequest\<T\>
+
+Model for the standard parameters for an http request.
+
+## Extended by
+
+- [`IHttpServerRequest`](IHttpServerRequest.md)
+- [`INoContentRequest`](INoContentRequest.md)
+
+## Type Parameters
+
+• **T** = `any`
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `IHttpHeaders`
+
+Incoming Http Headers.
+
+***
+
+### pathParams?
+
+> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+
+The path parameters.
+
+***
+
+### query?
+
+> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+
+The query parameters.
+
+***
+
+### body?
+
+> `optional` **body**: `T`
+
+Data to return send as the body.

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -0,0 +1,51 @@
+# Interface: IHttpRequestContext
+
+Context data from the HTTP request.
+
+## Extends
+
+- [`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+
+## Properties
+
+### serverRequest
+
+> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)\<`any`\>
+
+The raw HTTP request.
+
+***
+
+### processorState
+
+> **processorState**: `object`
+
+The state handed through the processors.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`
+
+***
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The identity of the node the request is being performed on.
+
+#### Inherited from
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md).[`nodeIdentity`](IHttpRequestIdentity.md#nodeidentity)
+
+***
+
+### userIdentity?
+
+> `optional` **userIdentity**: `string`
+
+The identity of the requestor if there is an authenticated user.
+
+#### Inherited from
+
+[`IHttpRequestIdentity`](IHttpRequestIdentity.md).[`userIdentity`](IHttpRequestIdentity.md#useridentity)

package/docs/reference/interfaces/IHttpRequestIdentity.md

@@ -0,0 +1,23 @@
+# Interface: IHttpRequestIdentity
+
+Context data from the HTTP request identity.
+
+## Extended by
+
+- [`IHttpRequestContext`](IHttpRequestContext.md)
+
+## Properties
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The identity of the node the request is being performed on.
+
+***
+
+### userIdentity?
+
+> `optional` **userIdentity**: `string`
+
+The identity of the requestor if there is an authenticated user.

package/docs/reference/interfaces/IHttpRequestPathParams.md

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

package/docs/reference/interfaces/IHttpRequestQuery.md

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

package/docs/reference/interfaces/IHttpResponse.md

@@ -0,0 +1,31 @@
+# Interface: IHttpResponse\<T\>
+
+Model for the standard parameters for an http response.
+
+## Type Parameters
+
+• **T** = `any`
+
+## Properties
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### headers?
+
+> `optional` **headers**: `IHttpHeaders`
+
+Response headers.
+
+***
+
+### body?
+
+> `optional` **body**: `T`
+
+Data to return as the main payload.

package/docs/reference/interfaces/IHttpRestRouteProcessor.md

@@ -0,0 +1,115 @@
+# Interface: IHttpRestRouteProcessor
+
+The definition for a processor for handling REST routes.
+
+## Extends
+
+- `IComponent`
+
+## 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` \| [`IRestRoute`](IRestRoute.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.
+
+***
+
+### process()?
+
+> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `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` \| [`IRestRoute`](IRestRoute.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.
+
+***
+
+### 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` \| [`IRestRoute`](IRestRoute.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.