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

package/docs/reference/classes/HealthService.md

@@ -0,0 +1,127 @@
+# Class: HealthService
+
+The health service for the server.
+
+## Implements
+
+- `IHealthComponent`
+
+## Constructors
+
+### Constructor
+
+> **new HealthService**(`options?`): `HealthService`
+
+Create a new instance of HealthService.
+
+#### Parameters
+
+##### options?
+
+[`IHealthServiceConstructorOptions`](../interfaces/IHealthServiceConstructorOptions.md)
+
+The constructor options.
+
+#### Returns
+
+`HealthService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IHealthComponent.className`
+
+***
+
+### start() {#start}
+
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the initial health check timers have been scheduled.
+
+#### Throws
+
+GeneralError if an exclude clone component is not a valid regular expression.
+
+#### Implementation of
+
+`IHealthComponent.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the health check timers have been cancelled.
+
+#### Implementation of
+
+`IHealthComponent.stop`
+
+***
+
+### healthStatus() {#healthstatus}
+
+> **healthStatus**(): `Promise`\<\{ `status`: `HealthStatus`; `components`: `IHealth`[]; \}\>
+
+Get the server health.
+
+#### Returns
+
+`Promise`\<\{ `status`: `HealthStatus`; `components`: `IHealth`[]; \}\>
+
+The service health.
+
+#### Implementation of
+
+`IHealthComponent.healthStatus`

package/docs/reference/classes/InformationService.md

@@ -0,0 +1,179 @@
+# Class: InformationService
+
+The information service for the server.
+
+## Implements
+
+- `IInformationComponent`
+
+## Constructors
+
+### Constructor
+
+> **new InformationService**(`options`): `InformationService`
+
+Create a new instance of InformationService.
+
+#### Parameters
+
+##### options
+
+[`IInformationServiceConstructorOptions`](../interfaces/IInformationServiceConstructorOptions.md)
+
+The options to create the service.
+
+#### Returns
+
+`InformationService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IInformationComponent.className`
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+The service needs to be started when the application is initialized.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the OpenAPI spec and favicon have been loaded from disk.
+
+#### Implementation of
+
+`IInformationComponent.start`
+
+***
+
+### root() {#root}
+
+> **root**(): `Promise`\<`string`\>
+
+Get the root information.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root information.
+
+#### Implementation of
+
+`IInformationComponent.root`
+
+***
+
+### info() {#info}
+
+> **info**(): `Promise`\<`IServerInfo`\>
+
+Get the server information.
+
+#### Returns
+
+`Promise`\<`IServerInfo`\>
+
+The service information.
+
+#### Implementation of
+
+`IInformationComponent.info`
+
+***
+
+### favicon() {#favicon}
+
+> **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
+
+Get the favicon.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
+
+The favicon.
+
+#### Implementation of
+
+`IInformationComponent.favicon`
+
+***
+
+### spec() {#spec}
+
+> **spec**(): `Promise`\<`unknown`\>
+
+Get the OpenAPI spec.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The OpenAPI spec.
+
+#### Implementation of
+
+`IInformationComponent.spec`
+
+***
+
+### livez() {#livez}
+
+> **livez**(): `Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
+
+Is the server live.
+
+#### Returns
+
+`Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
+
+The liveness status of the server.
+
+#### Implementation of
+
+`IInformationComponent.livez`
+
+***
+
+### readyz() {#readyz}
+
+> **readyz**(): `Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
+
+Is the server ready.
+
+#### Returns
+
+`Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
+
+The readyz status of the server.
+
+#### Implementation of
+
+`IInformationComponent.readyz`

package/docs/reference/classes/PlatformService.md

@@ -0,0 +1,209 @@
+# Class: PlatformService
+
+Service for performing platform operations.
+
+## Implements
+
+- `IPlatformComponent`
+
+## Constructors
+
+### Constructor
+
+> **new PlatformService**(`options?`): `PlatformService`
+
+Create a new instance of PlatformService.
+
+#### Parameters
+
+##### options?
+
+[`IPlatformServiceConstructorOptions`](../interfaces/IPlatformServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`PlatformService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPlatformComponent.className`
+
+***
+
+### isMultiTenant() {#ismultitenant}
+
+> **isMultiTenant**(): `boolean`
+
+Indicates whether the component is running in a multi-tenant environment.
+
+#### Returns
+
+`boolean`
+
+True if the component is running in a multi-tenant environment, false otherwise.
+
+#### Implementation of
+
+`IPlatformComponent.isMultiTenant`
+
+***
+
+### execute() {#execute}
+
+> **execute**(`method`): `Promise`\<`void`\>
+
+Execute a method, if single tenant will run once, if multi-tenant will run for each tenant.
+
+#### Parameters
+
+##### method
+
+() => `Promise`\<`void`\> \| `Promise`\<`boolean` \| `undefined`\>
+
+The method to run for each tenant, returning false will stop any further iterations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the method has been executed for all applicable tenants.
+
+#### Implementation of
+
+`IPlatformComponent.execute`
+
+***
+
+### getLocalOriginContext() {#getlocalorigincontext}
+
+> **getLocalOriginContext**(`url`): `Promise`\<`IContextIds` \| `undefined`\>
+
+Get the local origin context IDs for the given URL.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to check.
+
+#### Returns
+
+`Promise`\<`IContextIds` \| `undefined`\>
+
+A promise that resolves to the context IDs if the URL is a local origin, undefined otherwise.
+
+#### Implementation of
+
+`IPlatformComponent.getLocalOriginContext`
+
+***
+
+### registerTenantEventCallback() {#registertenanteventcallback}
+
+> **registerTenantEventCallback**(`callbackId`, `callback`): `void`
+
+Registers a callback to be invoked when a tenant event occurs.
+
+#### Parameters
+
+##### callbackId
+
+`string`
+
+A unique identifier for the callback.
+
+##### callback
+
+`TenantEventCallback`
+
+The callback to invoke when a tenant event occurs.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPlatformComponent.registerTenantEventCallback`
+
+***
+
+### unregisterTenantEventCallback() {#unregistertenanteventcallback}
+
+> **unregisterTenantEventCallback**(`callbackId`): `void`
+
+Unregisters a previously registered tenant event callback.
+
+#### Parameters
+
+##### callbackId
+
+`string`
+
+The identifier of the callback to unregister.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IPlatformComponent.unregisterTenantEventCallback`
+
+***
+
+### fireTenantEvent() {#firetenantevent}
+
+> **fireTenantEvent**(`tenantId`, `eventType`): `Promise`\<`void`\>
+
+Fires all registered tenant event callbacks.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The ID of the tenant for which the event occurred.
+
+##### eventType
+
+`TenantEventType`
+
+The type of event that occurred.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all callbacks have been invoked.
+
+#### Implementation of
+
+`IPlatformComponent.fireTenantEvent`

package/docs/reference/functions/generateRestRoutesHealth.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesHealth()
+
+> **generateRestRoutesHealth**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for server health.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/generateRestRoutesInformation.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesInformation()
+
+> **generateRestRoutesInformation**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for server information.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/serverFavIcon.md

@@ -0,0 +1,31 @@
+# Function: serverFavIcon()
+
+> **serverFavIcon**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerFavIconResponse`\>
+
+Get the favicon for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerFavIconResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serverHealth.md

@@ -0,0 +1,31 @@
+# Function: serverHealth()
+
+> **serverHealth**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerHealthResponse`\>
+
+Get the health for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerHealthResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serverInfo.md

@@ -0,0 +1,31 @@
+# Function: serverInfo()
+
+> **serverInfo**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerInfoResponse`\>
+
+Get the information for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerInfoResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serverLivez.md

@@ -0,0 +1,31 @@
+# Function: serverLivez()
+
+> **serverLivez**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerLivezResponse`\>
+
+Get the livez for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerLivezResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serverReadyz.md

@@ -0,0 +1,31 @@
+# Function: serverReadyz()
+
+> **serverReadyz**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerReadyzResponse`\>
+
+Get the readyz for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerReadyzResponse`\>
+
+The response object with additional http response properties.