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

package/docs/reference/classes/TenantAdminService.md

@@ -0,0 +1,393 @@
+# Class: TenantAdminService
+
+Service for performing tenant administration operations.
+
+## Implements
+
+- `ITenantAdminComponent`
+- `IHealthProviderComponent`
+
+## Constructors
+
+### Constructor
+
+> **new TenantAdminService**(`options?`): `TenantAdminService`
+
+Create a new instance of TenantAdminService.
+
+#### Parameters
+
+##### options?
+
+[`ITenantAdminServiceConstructorOptions`](../interfaces/ITenantAdminServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`TenantAdminService`
+
+## 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
+
+`ITenantAdminComponent.className`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the service and release the tenant cache.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the service has stopped.
+
+#### Implementation of
+
+`ITenantAdminComponent.stop`
+
+***
+
+### get() {#get}
+
+> **get**(`tenantId`): `Promise`\<`ITenant`\>
+
+Get a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<`ITenant`\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+#### Implementation of
+
+`ITenantAdminComponent.get`
+
+***
+
+### getByApiKey() {#getbyapikey}
+
+> **getByApiKey**(`apiKey`): `Promise`\<`ITenant`\>
+
+Get a tenant by its api key.
+
+#### Parameters
+
+##### apiKey
+
+`string`
+
+The api key of the tenant.
+
+#### Returns
+
+`Promise`\<`ITenant`\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+#### Implementation of
+
+`ITenantAdminComponent.getByApiKey`
+
+***
+
+### getByPublicOrigin() {#getbypublicorigin}
+
+> **getByPublicOrigin**(`publicOrigin`): `Promise`\<`ITenant`\>
+
+Get a tenant by its public origin.
+
+#### Parameters
+
+##### publicOrigin
+
+`string`
+
+The origin of the tenant.
+
+#### Returns
+
+`Promise`\<`ITenant`\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+#### Implementation of
+
+`ITenantAdminComponent.getByPublicOrigin`
+
+***
+
+### getTenantByOrganizationId() {#gettenantbyorganizationid}
+
+> **getTenantByOrganizationId**(`organizationId`, `includeLegacy?`): `Promise`\<`ITenant`\>
+
+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`\>
+
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
+
+#### Implementation of
+
+`ITenantAdminComponent.getTenantByOrganizationId`
+
+***
+
+### create() {#create}
+
+> **create**(`tenant`): `Promise`\<`string`\>
+
+Create a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
+
+The tenant to store.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The tenant id.
+
+#### Implementation of
+
+`ITenantAdminComponent.create`
+
+***
+
+### update() {#update}
+
+> **update**(`tenant`): `Promise`\<`void`\>
+
+Update a tenant.
+
+#### Parameters
+
+##### tenant
+
+`Partial`\<`Omit`\<`ITenant`, `"dateCreated"` \| `"dateModified"`\>\>
+
+The tenant to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the tenant has been updated.
+
+#### Implementation of
+
+`ITenantAdminComponent.update`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`tenantId`): `Promise`\<`void`\>
+
+Remove a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`ITenantAdminComponent.remove`
+
+***
+
+### query() {#query}
+
+> **query**(`conditions?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: `ITenant`[]; `cursor?`: `string`; \}\>
+
+Query tenants with pagination.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`ITenant`\>
+
+The conditions to filter the tenants.
+
+##### properties?
+
+(keyof `ITenant`)[]
+
+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`[]; `cursor?`: `string`; \}\>
+
+The tenants and the next cursor if more tenants are available.
+
+#### Implementation of
+
+`ITenantAdminComponent.query`
+
+***
+
+### healthApplicationInit() {#healthapplicationinit}
+
+> **healthApplicationInit**(`contextIds`): `Promise`\<`void`\>
+
+Provision a temporary tenant for the application health cycle.
+
+#### Parameters
+
+##### contextIds
+
+`IContextIds`
+
+Accumulated context IDs; receives the provisional tenant ID.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when provisioning is complete.
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplicationInit`
+
+***
+
+### healthApplication() {#healthapplication}
+
+> **healthApplication**(`callback`): `Promise`\<`IHealth`[] \| `undefined`\>
+
+Verify the provisioned tenant can be retrieved.
+The tenant ID is read from the active context set by the init pass.
+
+#### Parameters
+
+##### callback
+
+`HealthApplicationCallback`
+
+The callback to invoke when a deferred health result is ready.
+
+#### Returns
+
+`Promise`\<`IHealth`[] \| `undefined`\>
+
+The health entries for this component.
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplication`
+
+***
+
+### healthApplicationTeardown() {#healthapplicationteardown}
+
+> **healthApplicationTeardown**(): `Promise`\<`void`\>
+
+Remove the temporary tenant provisioned during init.
+The tenant ID is read from the active context set by the init pass.
+Does nothing when no tenant ID is present.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when teardown is complete.
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplicationTeardown`

package/docs/reference/classes/TenantIdContextIdHandler.md

@@ -0,0 +1,123 @@
+# Class: TenantIdContextIdHandler
+
+Context ID handler that treats a tenant ID as a compact base64url-encoded hex string.
+
+## Implements
+
+- `IContextIdHandler`
+
+## Constructors
+
+### Constructor
+
+> **new TenantIdContextIdHandler**(): `TenantIdContextIdHandler`
+
+#### Returns
+
+`TenantIdContextIdHandler`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+The class name of the component.
+
+#### Returns
+
+`string`
+
+The class name.
+
+#### Implementation of
+
+`IContextIdHandler.className`
+
+***
+
+### short() {#short}
+
+> **short**(`value`): `string`
+
+The short form of the tenant id is the base64 version to compact.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The full context id value.
+
+#### Returns
+
+`string`
+
+Short form string.
+
+#### Implementation of
+
+`IContextIdHandler.short`
+
+***
+
+### long() {#long}
+
+> **long**(`value`): `string`
+
+The long form version of the context ID, expanded from a short version.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The short form context ID value.
+
+#### Returns
+
+`string`
+
+The long form version of the context ID.
+
+#### Implementation of
+
+`IContextIdHandler.long`
+
+***
+
+### guard() {#guard}
+
+> **guard**(`value`): `void`
+
+Guard the value ensuring length.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to guard.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if the value is too short.
+
+#### Implementation of
+
+`IContextIdHandler.guard`

package/docs/reference/classes/TenantIdHelper.md

@@ -0,0 +1,41 @@
+# Class: TenantIdHelper
+
+Helper class for tenant id related operations.
+
+## Constructors
+
+### Constructor
+
+> **new TenantIdHelper**(): `TenantIdHelper`
+
+#### Returns
+
+`TenantIdHelper`
+
+## Methods
+
+### generateTenantId() {#generatetenantid}
+
+> `static` **generateTenantId**(): `string`
+
+Generates a new tenant ID.
+
+#### Returns
+
+`string`
+
+A new tenant ID.
+
+***
+
+### generateApiKey() {#generateapikey}
+
+> `static` **generateApiKey**(): `string`
+
+Generates a new API Key.
+
+#### Returns
+
+`string`
+
+A new API Key.

package/docs/reference/classes/TenantProcessor.md

@@ -0,0 +1,103 @@
+# Class: TenantProcessor
+
+Handles incoming api keys and maps them to tenant ids.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new TenantProcessor**(`options?`): `TenantProcessor`
+
+Create a new instance of TenantProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ITenantProcessorConstructorOptions`](../interfaces/ITenantProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`TenantProcessor`
+
+## 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
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the tenant context has been resolved and injected, or an error response set.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`

package/docs/reference/classes/TenantV0.md

@@ -0,0 +1,61 @@
+# Class: TenantV0
+
+Class defining the storage for node tenants.
+
+## Constructors
+
+### Constructor
+
+> **new TenantV0**(): `TenantV0`
+
+#### Returns
+
+`TenantV0`
+
+## 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 origin available to the public for accessing the API.