@3sixty/api-models 0.0.0-stage → 0.20.0-next.1

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -0,0 +1,134 @@
+# Interface: IBaseRouteProcessor\<T, R\>
+
+The definition for a base processor for handling REST routes.
+
+## Extends
+
+- `IComponent`
+
+## Extended by
+
+- [`IRestRouteProcessor`](IRestRouteProcessor.md)
+- [`ISocketRouteProcessor`](ISocketRouteProcessor.md)
+
+## Type Parameters
+
+### T {#t}
+
+`T` = [`IBaseRoute`](IBaseRoute.md)
+
+### R {#r}
+
+`R` = [`IHttpServerRequest`](IHttpServerRequest.md)
+
+## Methods
+
+### pre()? {#pre}
+
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`R`
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+`T` \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### post()? {#post}
+
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`R`
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+`T` \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IBaseSocketClientConfig.md

@@ -0,0 +1,35 @@
+# Interface: IBaseSocketClientConfig
+
+Definition for the configuration of a socket service.
+
+## Properties
+
+### basePath? {#basepath}
+
+> `optional` **basePath?**: `string`
+
+Base path for the socket service, defaults to /socket.
+
+***
+
+### endpoint {#endpoint}
+
+> **endpoint**: `string`
+
+The endpoint where the api is hosted.
+
+***
+
+### pathPrefix? {#pathprefix}
+
+> `optional` **pathPrefix?**: `string`
+
+The prefix to the routes.
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `IHttpHeaders`
+
+The headers to include in requests.

package/docs/reference/interfaces/IConflictResponse.md

@@ -0,0 +1,19 @@
+# Interface: IConflictResponse
+
+The request resulted in a conflicting operation, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `409`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/ICreatedResponse.md

@@ -0,0 +1,25 @@
+# Interface: ICreatedResponse
+
+The rest request ended in created response.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `201`
+
+Response status code.
+
+***
+
+### headers {#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}
+
+> **statusCode**: `403`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IHealth.md

@@ -0,0 +1,71 @@
+# Interface: IHealth
+
+Provides health information for a component.
+
+## Properties
+
+### source {#source}
+
+> **source**: `string`
+
+The source of the health information.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+The description of the component as an i18n key.
+
+***
+
+### category? {#category}
+
+> `optional` **category?**: [`HealthCategory`](../type-aliases/HealthCategory.md)
+
+The category of the health check.
+
+***
+
+### status {#status}
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The overall status of the component, the entries can also report their own health.
+
+***
+
+### error? {#error}
+
+> `optional` **error?**: `IError`
+
+The error details when the status is not Ok.
+
+***
+
+### message? {#message}
+
+> `optional` **message?**: `string`
+
+The message for the status if there are further details to provide as an i18n key.
+
+***
+
+### data? {#data}
+
+> `optional` **data?**: `object`
+
+Data to substitute in the i18n key for the message.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+***
+
+### grouped? {#grouped}
+
+> `optional` **grouped?**: `IHealth`[]
+
+The grouped child components, if any.

package/docs/reference/interfaces/IHealthComponent.md

@@ -0,0 +1,21 @@
+# Interface: IHealthComponent
+
+The health component for the server.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### healthStatus() {#healthstatus}
+
+> **healthStatus**(): `Promise`\<\{ `status`: [`HealthStatus`](../type-aliases/HealthStatus.md); `components`: [`IHealth`](IHealth.md)[]; \}\>
+
+Get the server health.
+
+#### Returns
+
+`Promise`\<\{ `status`: [`HealthStatus`](../type-aliases/HealthStatus.md); `components`: [`IHealth`](IHealth.md)[]; \}\>
+
+The service health.

package/docs/reference/interfaces/IHealthProviderComponent.md

@@ -0,0 +1,76 @@
+# Interface: IHealthProviderComponent
+
+The health provider component for the server.
+
+## Methods
+
+### health()? {#health}
+
+> `optional` **health**(): `Promise`\<[`IHealth`](IHealth.md)[]\>
+
+Returns the health status of the component.
+
+#### Returns
+
+`Promise`\<[`IHealth`](IHealth.md)[]\>
+
+The health status of the component, can return multiple entries for elements within the component.
+
+***
+
+### healthApplicationInit()? {#healthapplicationinit}
+
+> `optional` **healthApplicationInit**(`contextIds`): `Promise`\<`void`\>
+
+Initialize the application health processing for a component.
+
+#### Parameters
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs provisioned during the init pass.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the initialization is complete.
+
+***
+
+### healthApplication()? {#healthapplication}
+
+> `optional` **healthApplication**(`callback`): `Promise`\<[`IHealth`](IHealth.md)[] \| `undefined`\>
+
+Returns the application health status of the component, context IDs from init are set in the current context.
+Returns undefined when the result will be provided asynchronously via the callback.
+
+#### Parameters
+
+##### callback
+
+[`HealthApplicationCallback`](../type-aliases/HealthApplicationCallback.md)
+
+The callback to invoke when a deferred health result is ready.
+
+#### Returns
+
+`Promise`\<[`IHealth`](IHealth.md)[] \| `undefined`\>
+
+The health status, or undefined if the result will be provided via the callback.
+
+***
+
+### healthApplicationTeardown()? {#healthapplicationteardown}
+
+> `optional` **healthApplicationTeardown**(): `Promise`\<`void`\>
+
+Teardown the application health processing for a component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the teardown is complete.

package/docs/reference/interfaces/IHttpRequest.md

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

package/docs/reference/interfaces/IHttpRequestContext.md

@@ -0,0 +1,35 @@
+# Interface: IHttpRequestContext
+
+Context data from the HTTP request.
+
+## Extended by
+
+- [`ISocketRequestContext`](ISocketRequestContext.md)
+
+## Properties
+
+### serverRequest {#serverrequest}
+
+> **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
+
+The raw HTTP request.
+
+***
+
+### processorState {#processorstate}
+
+> **processorState**: `object`
+
+The state handed through the processors.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+***
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+Logging component type for the request.

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`

package/docs/reference/interfaces/IHttpRequestQuery.md

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

package/docs/reference/interfaces/IHttpResponse.md

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

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -0,0 +1,81 @@
+# Interface: IHttpServerRequest\<T\>
+
+Model for the standard parameters for an http request.
+
+## Extends
+
+- [`IHttpRequest`](IHttpRequest.md)\<`T`\>
+
+## Extended by
+
+- [`ISocketServerRequest`](ISocketServerRequest.md)
+
+## Type Parameters
+
+### T {#t}
+
+`T` = `any`
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `IHttpHeaders`
+
+Incoming Http Headers.
+
+#### Inherited from
+
+[`IHttpRequest`](IHttpRequest.md).[`headers`](IHttpRequest.md#headers)
+
+***
+
+### pathParams? {#pathparams}
+
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+
+The path parameters.
+
+#### Inherited from
+
+[`IHttpRequest`](IHttpRequest.md).[`pathParams`](IHttpRequest.md#pathparams)
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+
+The query parameters.
+
+#### Inherited from
+
+[`IHttpRequest`](IHttpRequest.md).[`query`](IHttpRequest.md#query)
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `T`
+
+Data to return send as the body.
+
+#### Inherited from
+
+[`IHttpRequest`](IHttpRequest.md).[`body`](IHttpRequest.md#body)
+
+***
+
+### url {#url}
+
+> **url**: `string`
+
+The request url.
+
+***
+
+### method? {#method}
+
+> `optional` **method?**: `HttpMethod`
+
+The request method.

package/docs/reference/interfaces/IInformationComponent.md

@@ -0,0 +1,91 @@
+# Interface: IInformationComponent
+
+The information component for the server.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### root() {#root}
+
+> **root**(): `Promise`\<`string`\>
+
+Get the root information.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root information.
+
+***
+
+### info() {#info}
+
+> **info**(): `Promise`\<[`IServerInfo`](IServerInfo.md)\>
+
+Get the server information.
+
+#### Returns
+
+`Promise`\<[`IServerInfo`](IServerInfo.md)\>
+
+The service information.
+
+***
+
+### favicon() {#favicon}
+
+> **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
+
+Get the favicon.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
+
+The favicon.
+
+***
+
+### spec() {#spec}
+
+> **spec**(): `Promise`\<`unknown`\>
+
+Get the OpenAPI spec.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The OpenAPI spec.
+
+***
+
+### livez() {#livez}
+
+> **livez**(): `Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
+
+Is the server live.
+
+#### Returns
+
+`Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
+
+The livez status of the server.
+
+***
+
+### readyz() {#readyz}
+
+> **readyz**(): `Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
+
+Is the server ready.
+
+#### Returns
+
+`Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
+
+The readyz status of the server.