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

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/TenantOverrideProcessor.md

@@ -0,0 +1,119 @@
+# Class: TenantOverrideProcessor
+
+Processes the overrideTenant query parameter for routes that allow tenant override.
+Requires the caller to hold the escalated privilege scope. Runs after AuthHeaderProcessor so
+authentication is always resolved in the caller's own partition first.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new TenantOverrideProcessor**(`options?`): `TenantOverrideProcessor`
+
+Create a new instance of TenantOverrideProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ITenantOverrideProcessorConstructorOptions`](../interfaces/ITenantOverrideProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`TenantOverrideProcessor`
+
+## Properties
+
+### OVERRIDE\_TENANT\_PARAM {#override_tenant_param}
+
+> `readonly` `static` **OVERRIDE\_TENANT\_PARAM**: `string` = `"override-tenant"`
+
+The query parameter name used to supply the override tenant ID.
+
+***
+
+### DEFAULT\_ESCALATED\_PRIVILEGE\_SCOPE {#default_escalated_privilege_scope}
+
+> `readonly` `static` **DEFAULT\_ESCALATED\_PRIVILEGE\_SCOPE**: `string` = `"global-admin"`
+
+The scope string required to perform a tenant override.
+
+***
+
+### 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
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the tenant override has been applied or skipped.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`

package/docs/reference/classes/TenantProcessor.md

@@ -0,0 +1,101 @@
+# 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
+
+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/functions/generateRestRoutesTenants.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesTenants()
+
+> **generateRestRoutesTenants**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for tenant management.
+
+## 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/initSchema.md

@@ -0,0 +1,10 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the node tenant processor, including the Tenant 1 to 2 migration
+step which converts organizationIdLegacy from a pipe-delimited string to an array of ids.
+
+## Returns
+
+`void`

package/docs/reference/functions/tenantByApiKey.md

@@ -0,0 +1,31 @@
+# Function: tenantByApiKey()
+
+> **tenantByApiKey**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+Get the tenant by api key.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantGetByApiKeyRequest`](../interfaces/ITenantGetByApiKeyRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantById.md

@@ -0,0 +1,31 @@
+# Function: tenantById()
+
+> **tenantById**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+Get the tenant by id.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantGetByIdRequest`](../interfaces/ITenantGetByIdRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantByPublicOrigin.md

@@ -0,0 +1,31 @@
+# Function: tenantByPublicOrigin()
+
+> **tenantByPublicOrigin**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+Get the tenant by public origin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantGetByPublicOriginRequest`](../interfaces/ITenantGetByPublicOriginRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantGetResponse`](../interfaces/ITenantGetResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantCreate.md

@@ -0,0 +1,37 @@
+# Function: tenantCreate()
+
+> **tenantCreate**(`httpRequestContext`, `componentName`, `request`, `baseRouteName`): `Promise`\<`ICreatedResponse`\>
+
+Create the tenant.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantCreateRequest`](../interfaces/ITenantCreateRequest.md)
+
+The request.
+
+### baseRouteName
+
+`string`
+
+The base route name for the tenant.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantList.md

@@ -0,0 +1,31 @@
+# Function: tenantList()
+
+> **tenantList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<[`ITenantListResponse`](../interfaces/ITenantListResponse.md)\>
+
+Get the list of tenants.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantListRequest`](../interfaces/ITenantListRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<[`ITenantListResponse`](../interfaces/ITenantListResponse.md)\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantRemove.md

@@ -0,0 +1,31 @@
+# Function: tenantRemove()
+
+> **tenantRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the tenant by id.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantRemoveRequest`](../interfaces/ITenantRemoveRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/tenantUpdate.md

@@ -0,0 +1,31 @@
+# Function: tenantUpdate()
+
+> **tenantUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the tenant.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantUpdateRequest`](../interfaces/ITenantUpdateRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,47 @@
+# @3sixty/api-tenant-processor
+
+## Classes
+
+- [Tenant](classes/Tenant.md)
+- [SingleTenantProcessor](classes/SingleTenantProcessor.md)
+- [TenantAdminService](classes/TenantAdminService.md)
+- [TenantIdContextIdHandler](classes/TenantIdContextIdHandler.md)
+- [TenantOverrideProcessor](classes/TenantOverrideProcessor.md)
+- [TenantProcessor](classes/TenantProcessor.md)
+- [TenantIdHelper](classes/TenantIdHelper.md)
+
+## Interfaces
+
+- [ISingleTenantProcessorConfig](interfaces/ISingleTenantProcessorConfig.md)
+- [ISingleTenantProcessorConstructorOptions](interfaces/ISingleTenantProcessorConstructorOptions.md)
+- [ITenantAdminServiceConfig](interfaces/ITenantAdminServiceConfig.md)
+- [ITenantAdminServiceConstructorOptions](interfaces/ITenantAdminServiceConstructorOptions.md)
+- [ITenantOverrideProcessorConfig](interfaces/ITenantOverrideProcessorConfig.md)
+- [ITenantOverrideProcessorConstructorOptions](interfaces/ITenantOverrideProcessorConstructorOptions.md)
+- [ITenantProcessorConfig](interfaces/ITenantProcessorConfig.md)
+- [ITenantProcessorConstructorOptions](interfaces/ITenantProcessorConstructorOptions.md)
+- [ITenantCreateRequest](interfaces/ITenantCreateRequest.md)
+- [ITenantGetByApiKeyRequest](interfaces/ITenantGetByApiKeyRequest.md)
+- [ITenantGetByIdRequest](interfaces/ITenantGetByIdRequest.md)
+- [ITenantGetByPublicOriginRequest](interfaces/ITenantGetByPublicOriginRequest.md)
+- [ITenantGetResponse](interfaces/ITenantGetResponse.md)
+- [ITenantListRequest](interfaces/ITenantListRequest.md)
+- [ITenantListResponse](interfaces/ITenantListResponse.md)
+- [ITenantRemoveRequest](interfaces/ITenantRemoveRequest.md)
+- [ITenantUpdateRequest](interfaces/ITenantUpdateRequest.md)
+
+## Variables
+
+- [tagsTenants](variables/tagsTenants.md)
+
+## Functions
+
+- [initSchema](functions/initSchema.md)
+- [generateRestRoutesTenants](functions/generateRestRoutesTenants.md)
+- [tenantList](functions/tenantList.md)
+- [tenantById](functions/tenantById.md)
+- [tenantByApiKey](functions/tenantByApiKey.md)
+- [tenantByPublicOrigin](functions/tenantByPublicOrigin.md)
+- [tenantRemove](functions/tenantRemove.md)
+- [tenantCreate](functions/tenantCreate.md)
+- [tenantUpdate](functions/tenantUpdate.md)

package/docs/reference/interfaces/ISingleTenantProcessorConfig.md

@@ -0,0 +1,11 @@
+# Interface: ISingleTenantProcessorConfig
+
+Configuration for the single tenant processor
+
+## Properties
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.