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

package/docs/reference/classes/TenantV1.md

@@ -0,0 +1,77 @@
+# Class: TenantV1
+
+Class defining the storage for node tenants.
+
+## Constructors
+
+### Constructor
+
+> **new TenantV1**(): `TenantV1`
+
+#### Returns
+
+`TenantV1`
+
+## 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.
+
+***
+
+### organizationId {#organizationid}
+
+> **organizationId**: `string`
+
+The organization id for the tenant.
+
+***
+
+### organizationIdLegacy? {#organizationidlegacy}
+
+> `optional` **organizationIdLegacy?**: `string`
+
+Optional list of organization aliases that can be used for legacy lookups, indexed format.

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)
+- [TenantV0](classes/TenantV0.md)
+- [TenantV1](classes/TenantV1.md)
+- [SingleTenantProcessor](classes/SingleTenantProcessor.md)
+- [TenantAdminService](classes/TenantAdminService.md)
+- [TenantIdContextIdHandler](classes/TenantIdContextIdHandler.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)
+- [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
+
+- [restEntryPoints](variables/restEntryPoints.md)
+- [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.

package/docs/reference/interfaces/ISingleTenantProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: ISingleTenantProcessorConstructorOptions
+
+Options for the Single Tenant Processor constructor.
+
+## Properties
+
+### config? {#config}
+
+> `optional` **config?**: [`ISingleTenantProcessorConfig`](ISingleTenantProcessorConfig.md)
+
+Configuration for the processor.

package/docs/reference/interfaces/ITenantAdminServiceConfig.md

@@ -0,0 +1,49 @@
+# Interface: ITenantAdminServiceConfig
+
+Configuration for the tenant admin service.
+
+## Properties
+
+### tenantCacheTtlMs? {#tenantcachettlms}
+
+> `optional` **tenantCacheTtlMs?**: `number`
+
+The time in milliseconds a tenant is kept in the in-memory lookup cache, counted from when it
+was read and not extended by use, set to 0 to disable caching. Entries are invalidated when a
+tenant is created, updated or removed through this service, but only in the process that made
+the change, so this is also the longest another node can serve a tenant that has been edited
+elsewhere.
+
+#### Default
+
+```ts
+30000
+```
+
+***
+
+### tenantCacheCapacity? {#tenantcachecapacity}
+
+> `optional` **tenantCacheCapacity?**: `number`
+
+The maximum number of tenant lookups to hold in the in-memory cache.
+
+#### Default
+
+```ts
+undefined (LfuCache default)
+```
+
+***
+
+### tenantCacheMutexTimeoutMs? {#tenantcachemutextimeoutms}
+
+> `optional` **tenantCacheMutexTimeoutMs?**: `number`
+
+Maximum time in milliseconds to wait for the tenant cache mutex during a cache population.
+
+#### Default
+
+```ts
+undefined (LfuCache default)
+```

package/docs/reference/interfaces/ITenantAdminServiceConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: ITenantAdminServiceConstructorOptions
+
+Options for the Tenant Admin Service constructor.
+
+## Properties
+
+### tenantEntityStorageType? {#tenantentitystoragetype}
+
+> `optional` **tenantEntityStorageType?**: `string`
+
+The entity storage for the tenants.
+
+#### Default
+
+```ts
+tenant
+```
+
+***
+
+### platformComponentType? {#platformcomponenttype}
+
+> `optional` **platformComponentType?**: `string`
+
+The component type to use for firing tenant events.
+
+#### Default
+
+```ts
+platform
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITenantAdminServiceConfig`](ITenantAdminServiceConfig.md)
+
+Configuration for the service.

package/docs/reference/interfaces/ITenantCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantCreateRequest
+
+The tenant to create.
+
+## Properties
+
+### body {#body}
+
+> **body**: `Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
+
+The tenant to create.
+
+#### Type Declaration
+
+##### id?
+
+> `optional` **id?**: `string`

package/docs/reference/interfaces/ITenantGetByApiKeyRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByApiKeyRequest
+
+The tenant to get by API key.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### apiKey
+
+> **apiKey**: `string`
+
+The API key of the tenant to get.

package/docs/reference/interfaces/ITenantGetByIdRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByIdRequest
+
+The tenant to get by id.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to get.

package/docs/reference/interfaces/ITenantGetByPublicOriginRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByPublicOriginRequest
+
+The tenant to get by public origin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### publicOrigin
+
+> **publicOrigin**: `string`
+
+The public origin of the tenant to get.

package/docs/reference/interfaces/ITenantGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: ITenantGetResponse
+
+The tenant get response.
+
+## Properties
+
+### body {#body}
+
+> **body**: `ITenant`
+
+The tenant.

package/docs/reference/interfaces/ITenantListRequest.md

@@ -0,0 +1,36 @@
+# Interface: ITenantListRequest
+
+The list of tenants.
+
+## Properties
+
+### query {#query}
+
+> **query**: `object`
+
+The query parameters.
+
+#### conditions?
+
+> `optional` **conditions?**: `string`
+
+The condition for the query as JSON version of EntityCondition type.
+
+#### properties?
+
+> `optional` **properties?**: `string`
+
+The properties to include in the returned tenants, separated by commas.
+If not provided, all properties will be returned.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The cursor to get the next chunk of tenants.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+The number of tenants to return.

package/docs/reference/interfaces/ITenantListResponse.md

@@ -0,0 +1,23 @@
+# Interface: ITenantListResponse
+
+The list of tenants.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to include the cursor.
+
+#### link?
+
+> `optional` **link?**: `string` \| `string`[]
+
+***
+
+### body {#body}
+
+> **body**: `ITenant`[]
+
+The list of tenants.

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -0,0 +1,33 @@
+# Interface: ITenantProcessorConfig
+
+Configuration for the tenant processor
+
+## Properties
+
+### apiKeyName? {#apikeyname}
+
+> `optional` **apiKeyName?**: `string`
+
+The key to look for in the header or query params for the api key.
+
+#### Default
+
+```ts
+x-api-key
+```
+
+***
+
+### apiKeyEndpoints? {#apikeyendpoints}
+
+> `optional` **apiKeyEndpoints?**: `string`[]
+
+The list of endpoint paths that should be checked for an api key header, can be regexp strings. Defaults to ["/login$"].
+
+***
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.