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

package/docs/reference/interfaces/IRestRouteResponseExample.md

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

package/docs/reference/interfaces/IRestRouteResponseOptions.md

@@ -0,0 +1,11 @@
+# Interface: IRestRouteResponseOptions
+
+Interface which defines a REST route response.
+
+## Properties
+
+### attachment? {#attachment}
+
+> `optional` **attachment?**: [`IRestRouteResponseAttachmentOptions`](IRestRouteResponseAttachmentOptions.md)
+
+Additional options that can be used to control the response.

package/docs/reference/interfaces/IServerFavIconResponse.md

@@ -0,0 +1,33 @@
+# Interface: IServerFavIconResponse
+
+The favicon for the server.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+Additional response headers.
+
+#### content-type?
+
+> `optional` **content-type?**: `string`
+
+The content type for the response.
+
+***
+
+### statusCode? {#statuscode}
+
+> `optional` **statusCode?**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `Uint8Array`\<`ArrayBufferLike`\>
+
+The favicon for the server.

package/docs/reference/interfaces/IServerHealthResponse.md

@@ -0,0 +1,19 @@
+# Interface: IServerHealthResponse
+
+The health of the server.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The health for the server.
+
+#### status
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+#### components
+
+> **components**: [`IHealth`](IHealth.md)[]

package/docs/reference/interfaces/IServerInfo.md

@@ -0,0 +1,19 @@
+# Interface: IServerInfo
+
+The information about the server.
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The application name.
+
+***
+
+### version {#version}
+
+> **version**: `string`
+
+The version of the server.

package/docs/reference/interfaces/IServerInfoResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServerInfoResponse
+
+The information about the server.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IServerInfo`](IServerInfo.md)
+
+The information for the server.

package/docs/reference/interfaces/IServerLivezResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerLivezResponse
+
+The livez of the server.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
+
+> **body**: `"alive"` \| `"dead"`
+
+The livez information for the server.

package/docs/reference/interfaces/IServerReadyzResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerReadyzResponse
+
+The readyz of the server.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
+
+> **body**: `"ready"` \| `"not ready"`
+
+The readyz information for the server.

package/docs/reference/interfaces/IServerRootResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerRootResponse
+
+The root text for the server.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
+
+> **body**: `string`
+
+The root text for the server.

package/docs/reference/interfaces/IServerSpecResponse.md

@@ -0,0 +1,19 @@
+# Interface: IServerSpecResponse
+
+The OpenAPI spec for the endpoints.
+
+## Properties
+
+### statusCode? {#statuscode}
+
+> `optional` **statusCode?**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `unknown`
+
+The spec for the server.

package/docs/reference/interfaces/ISocketRequestContext.md

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

package/docs/reference/interfaces/ISocketRoute.md

@@ -0,0 +1,162 @@
+# Interface: ISocketRoute\<T, U\>
+
+Interface which defines a socket route.
+
+## Extends
+
+- [`IBaseRoute`](IBaseRoute.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
+
+### U
+
+`U` *extends* [`IHttpResponse`](IHttpResponse.md) = `any`
+
+## Properties
+
+### operationId {#operationid}
+
+> **operationId**: `string`
+
+The id of the operation.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`operationId`](IBaseRoute.md#operationid)
+
+***
+
+### path {#path}
+
+> **path**: `string`
+
+The path to use for routing.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`path`](IBaseRoute.md#path)
+
+***
+
+### skipAuth? {#skipauth}
+
+> `optional` **skipAuth?**: `boolean`
+
+Skips the authentication requirement for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
+
+***
+
+### skipTenant? {#skiptenant}
+
+> `optional` **skipTenant?**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
+
+***
+
+### requiredScope? {#requiredscope}
+
+> `optional` **requiredScope?**: `string`[]
+
+The user must have one of the specified scopes to access the route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+
+***
+
+### disableTenantOverride? {#disabletenantoverride}
+
+> `optional` **disableTenantOverride?**: `boolean`
+
+Set to true to prevent callers from using the overrideTenant query parameter on this route.
+Tenant override is allowed by default, but you must hold the escalated privilege scope to use it.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`disableTenantOverride`](IBaseRoute.md#disabletenantoverride)
+
+***
+
+### handler {#handler}
+
+> **handler**: (`socketRequestContext`, `request`, `emit`) => `Promise`\<`void`\>
+
+The handler module.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+##### request
+
+`T`
+
+The request object.
+
+##### emit
+
+(`event`, `response`) => `Promise`\<`void`\>
+
+The function to emit an event.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### connected? {#connected}
+
+> `optional` **connected?**: (`socketRequestContext`) => `Promise`\<`void`\>
+
+The connected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### disconnected? {#disconnected}
+
+> `optional` **disconnected?**: (`socketRequestContext`) => `Promise`\<`void`\>
+
+The disconnected handler.
+
+#### Parameters
+
+##### socketRequestContext
+
+[`ISocketRequestContext`](ISocketRequestContext.md)
+
+The request context.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -0,0 +1,261 @@
+# Interface: ISocketRouteProcessor
+
+The definition for a processor for handling socket routes.
+
+## Extends
+
+- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md), [`ISocketServerRequest`](ISocketServerRequest.md)\>
+
+## Methods
+
+### features()? {#features}
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
+### pre()? {#pre}
+
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+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.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`pre`](IBaseRouteProcessor.md#pre)
+
+***
+
+### post()? {#post}
+
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The request to handle.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+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.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`post`](IBaseRouteProcessor.md#post)
+
+***
+
+### connected()? {#connected}
+
+> `optional` **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the connected event.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### disconnected()? {#disconnected}
+
+> `optional` **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the disconnected event.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### process()? {#process}
+
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+[`ISocketServerRequest`](ISocketServerRequest.md)
+
+The server request object containing the socket id and other parameters.
+
+##### response
+
+[`IHttpResponse`](IHttpResponse.md)
+
+The response data to send if any.
+
+##### route
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### processorState
+
+The state handed through the processors.
+
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
+
+The function to emit a response.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.