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

package/docs/reference/interfaces/ISocketServerRequest.md

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

package/docs/reference/interfaces/ITag.md

@@ -0,0 +1,19 @@
+# Interface: ITag
+
+Tag for routes used to generate OpenAPI information.
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the tag.
+
+***
+
+### description {#description}
+
+> **description**: `string`
+
+Description for the tag.

package/docs/reference/interfaces/ITenant.md

@@ -0,0 +1,67 @@
+# Interface: ITenant
+
+Model defining the tenant.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The unique identifier for the tenant.
+
+***
+
+### apiKey {#apikey}
+
+> **apiKey**: `string`
+
+The api key for the tenant.
+
+***
+
+### label {#label}
+
+> **label**: `string`
+
+The label of the tenant.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date the tenant was created.
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+The date the tenant was modified.
+
+***
+
+### publicOrigin? {#publicorigin}
+
+> `optional` **publicOrigin?**: `string`
+
+The public origin available to the public for accessing the API.
+
+***
+
+### organizationId {#organizationid}
+
+> **organizationId**: `string`
+
+The organization id for the tenant.
+
+***
+
+### organizationIdLegacy? {#organizationidlegacy}
+
+> `optional` **organizationIdLegacy?**: `string`[]
+
+Optional list of organization aliases that can are used for legacy lookups.

package/docs/reference/interfaces/ITenantAdminComponent.md

@@ -0,0 +1,227 @@
+# Interface: ITenantAdminComponent
+
+Configuration for the tenant admin component
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`tenant`): `Promise`\<`string`\>
+
+Create a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Omit`\<[`ITenant`](ITenant.md), `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
+
+The tenant to store.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The tenant id.
+
+***
+
+### update() {#update}
+
+> **update**(`tenant`): `Promise`\<`void`\>
+
+Update a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Partial`\<`Omit`\<[`ITenant`](ITenant.md), `"dateCreated"` \| `"dateModified"`\>\>
+
+The tenant to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the tenant has been updated.
+
+***
+
+### get() {#get}
+
+> **get**(`tenantId`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### getByApiKey() {#getbyapikey}
+
+> **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its api key.
+
+#### Parameters
+
+##### apiKey
+
+`string`
+
+The api key of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### getByPublicOrigin() {#getbypublicorigin}
+
+> **getByPublicOrigin**(`publicOrigin`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its public origin.
+
+#### Parameters
+
+##### publicOrigin
+
+`string`
+
+The origin of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### remove() {#remove}
+
+> **remove**(`tenantId`): `Promise`\<`void`\>
+
+Remove a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the tenant has been removed.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### getTenantByOrganizationId() {#gettenantbyorganizationid}
+
+> **getTenantByOrganizationId**(`organizationId`, `includeLegacy?`): `Promise`\<[`ITenant`](ITenant.md)\>
+
+Get a tenant by its organization id, optionally searching legacy ids.
+
+#### Parameters
+
+##### organizationId
+
+`string`
+
+The organization id of the tenant.
+
+##### includeLegacy?
+
+`boolean`
+
+Whether to also search the legacy organization id array.
+
+#### Returns
+
+`Promise`\<[`ITenant`](ITenant.md)\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+***
+
+### query() {#query}
+
+> **query**(`conditions?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
+
+Query tenants with pagination.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<[`ITenant`](ITenant.md)\>
+
+The conditions to filter the tenants.
+
+##### properties?
+
+keyof [`ITenant`](ITenant.md)[]
+
+The properties to include in the returned tenants.
+
+##### cursor?
+
+`string`
+
+The cursor to start from.
+
+##### limit?
+
+`number`
+
+The maximum number of tenants to return.
+
+#### Returns
+
+`Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
+
+The tenants and the next cursor if more tenants are available.

package/docs/reference/interfaces/ITooManyRequestsResponse.md

@@ -0,0 +1,19 @@
+# Interface: ITooManyRequestsResponse
+
+The request resulted in too many requests, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `429`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IUnauthorizedResponse.md

@@ -0,0 +1,19 @@
+# Interface: IUnauthorizedResponse
+
+You are not authorized to use the API or no credentials were supplied, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `401`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IUnprocessableEntityResponse.md

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

package/docs/reference/interfaces/IWebServer.md

@@ -0,0 +1,109 @@
+# Interface: IWebServer\<T\>
+
+Interface describing a web server.
+
+## Extends
+
+- `IComponent`
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Methods
+
+### getInstance() {#getinstance}
+
+> **getInstance**(): `T`
+
+Get the web server instance.
+
+#### Returns
+
+`T`
+
+The web server instance.
+
+***
+
+### build() {#build}
+
+> **build**(`restRouteProcessors?`, `restRoutes?`, `socketRouteProcessors?`, `socketRoutes?`, `options?`): `Promise`\<`void`\>
+
+Build the server.
+
+#### Parameters
+
+##### restRouteProcessors?
+
+[`IRestRouteProcessor`](IRestRouteProcessor.md)[]
+
+The processors for incoming requests over REST.
+
+##### restRoutes?
+
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
+
+The REST routes.
+
+##### socketRouteProcessors?
+
+[`ISocketRouteProcessor`](ISocketRouteProcessor.md)[]
+
+The processors for incoming requests over Sockets.
+
+##### socketRoutes?
+
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>[]
+
+The socket routes.
+
+##### options?
+
+[`IWebServerOptions`](IWebServerOptions.md)
+
+Options for building the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server is fully built and ready to start.
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Start the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server is listening for connections.
+
+#### Overrides
+
+`IComponent.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server has shut down all connections.
+
+#### Overrides
+
+`IComponent.stop`

package/docs/reference/interfaces/IWebServerOptions.md

@@ -0,0 +1,113 @@
+# Interface: IWebServerOptions
+
+Options for the web server.
+
+## Properties
+
+### port? {#port}
+
+> `optional` **port?**: `number`
+
+The port to bind the web server to.
+
+#### Default
+
+```ts
+3000
+```
+
+***
+
+### host? {#host}
+
+> `optional` **host?**: `string`
+
+The address to bind the web server to.
+
+#### Default
+
+```ts
+localhost
+```
+
+***
+
+### methods? {#methods}
+
+> `optional` **methods?**: `HttpMethod`[]
+
+The methods that the server accepts.
+
+#### Default
+
+```ts
+["GET", "PUT", "POST", "PATCH", "DELETE", "OPTIONS"]
+```
+
+***
+
+### allowedHeaders? {#allowedheaders}
+
+> `optional` **allowedHeaders?**: `string`[]
+
+Any additional allowed headers.
+
+***
+
+### exposedHeaders? {#exposedheaders}
+
+> `optional` **exposedHeaders?**: `string`[]
+
+And additional exposed headers.
+
+***
+
+### corsOrigins? {#corsorigins}
+
+> `optional` **corsOrigins?**: `string` \| `string`[]
+
+The allowed CORS domains.
+
+#### Default
+
+```ts
+["*"]
+```
+
+***
+
+### publicOrigin? {#publicorigin}
+
+> `optional` **publicOrigin?**: `string`
+
+The public origin of the server, used for constructing the request URL.
+If not provided, it will be determined from the incoming request.
+
+***
+
+### bodyLimits? {#bodylimits}
+
+> `optional` **bodyLimits?**: `object`
+
+Named body size limits in bytes for REST routes, referenced by a route's bodyLimit name.
+Merged over the server's built-in limits; the "default" entry applies to routes with no bodyLimit name.
+
+#### Index Signature
+
+\[`name`: `string`\]: `number`
+
+***
+
+### customWebConfig? {#customwebconfig}
+
+> `optional` **customWebConfig?**: `unknown`
+
+Custom configuration for the web server.
+
+***
+
+### customSocketConfig? {#customsocketconfig}
+
+> `optional` **customSocketConfig?**: `unknown`
+
+Custom configuration for the socket server.

package/docs/reference/type-aliases/HealthApplicationCallback.md

@@ -0,0 +1,16 @@
+# Type Alias: HealthApplicationCallback
+
+> **HealthApplicationCallback** = (`result`) => `Promise`\<`void`\>
+
+Callback invoked by a component to supply a deferred application health result.
+Only called when healthApplication returns undefined.
+
+## Parameters
+
+### result
+
+[`IHealth`](../interfaces/IHealth.md)[]
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/type-aliases/HealthCategory.md

@@ -0,0 +1,5 @@
+# Type Alias: HealthCategory
+
+> **HealthCategory** = *typeof* [`HealthCategory`](../variables/HealthCategory.md)\[keyof *typeof* [`HealthCategory`](../variables/HealthCategory.md)\]
+
+The category of a health check.

package/docs/reference/type-aliases/HealthStatus.md

@@ -0,0 +1,5 @@
+# Type Alias: HealthStatus
+
+> **HealthStatus** = *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
+
+The health status of the component.

package/docs/reference/type-aliases/HttpBodyLimit.md

@@ -0,0 +1,5 @@
+# Type Alias: HttpBodyLimit
+
+> **HttpBodyLimit** = *typeof* [`HttpBodyLimit`](../variables/HttpBodyLimit.md)\[keyof *typeof* [`HttpBodyLimit`](../variables/HttpBodyLimit.md)\]
+
+The names of the well-known body size limits for routes.