@twin.org/api-tenant-processor 0.0.3-next.4 → 0.0.3-next.41

package/docs/examples.md

@@ -1 +1,81 @@
-# @twin.org/api-tenant-processor - Examples
+# Tenant Processor Examples
+
+These snippets show tenant lifecycle management and request context routing for multi-tenant deployments.
+
+## TenantAdminService
+
+```typescript
+import { TenantAdminService } from '@twin.org/api-tenant-processor';
+
+const tenantAdmin = new TenantAdminService();
+
+console.log(tenantAdmin.className()); // TenantAdminService
+
+const createdTenantId = await tenantAdmin.create({
+  label: 'North Region',
+  apiKey: '0123456789abcdef0123456789abcdef',
+  publicOrigin: 'https://north.example.org'
+});
+
+await tenantAdmin.update({
+  id: createdTenantId,
+  label: 'North Region EU'
+});
+
+const byKey = await tenantAdmin.getByApiKey('0123456789abcdef0123456789abcdef');
+console.log(byKey.id.length); // 32
+```
+
+```typescript
+import { TenantAdminService } from '@twin.org/api-tenant-processor';
+
+const tenantAdmin = new TenantAdminService();
+
+const byId = await tenantAdmin.get('0123456789abcdef0123456789abcdef');
+const byOrigin = await tenantAdmin.getByPublicOrigin('https://north.example.org');
+const page = await tenantAdmin.query({ isNodeTenant: false }, '', 10);
+
+await tenantAdmin.remove(byId.id);
+
+console.log(byOrigin.label); // North Region EU
+console.log(page.tenants.length); // 1
+```
+
+## TenantIdContextIdHandler
+
+```typescript
+import { TenantIdContextIdHandler } from '@twin.org/api-tenant-processor';
+
+const handler = new TenantIdContextIdHandler();
+
+console.log(handler.className()); // TenantIdContextIdHandler
+console.log(handler.short('0123456789abcdef0123456789abcdef')); // ASNFZ4mrze8BI0VniavN7w
+
+handler.guard('0123456789abcdef0123456789abcdef');
+```
+
+## TenantProcessor
+
+```typescript
+import { TenantProcessor } from '@twin.org/api-tenant-processor';
+
+const tenantProcessor = new TenantProcessor();
+
+console.log(tenantProcessor.className()); // TenantProcessor
+
+const request = {
+  method: 'get',
+  url: '/info',
+  headers: {
+    'x-api-key': '0123456789abcdef0123456789abcdef'
+  },
+  query: {}
+};
+
+const response = {};
+const contextIds = {};
+const processorState: { [id: string]: unknown } = {};
+
+await tenantProcessor.pre(request, response, { skipTenant: false }, contextIds, processorState);
+console.log(typeof contextIds.tenant); // string
+```

package/docs/reference/classes/Tenant.md

@@ -14,7 +14,7 @@ Class defining the storage for node tenants.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The unique identifier for the tenant.
 
 ***
 
-### apiKey
+### apiKey {#apikey}
 
 > **apiKey**: `string`
 
@@ -30,7 +30,7 @@ The api key for the tenant.
 
 ***
 
-### label
+### label {#label}
 
 > **label**: `string`
 
@@ -38,8 +38,24 @@ The label of the tenant.
 
 ***
 
-### dateCreated
+### 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.

package/docs/reference/classes/TenantAdminService.md

@@ -1,10 +1,10 @@
 # Class: TenantAdminService
 
-Service for performing email messaging operations to a connector.
+Service for performing tenant administration operations.
 
 ## Implements
 
-- [`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md)
+- `ITenantAdminComponent`
 
 ## Constructors
 
@@ -28,7 +28,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,9 +54,9 @@ The class name of the component.
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**(`tenantId`): `Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+> **get**(`tenantId`): `Promise`\<`ITenant`\>
 
 Get a tenant by its id.
 
@@ -70,19 +70,23 @@ The id of the tenant.
 
 #### Returns
 
-`Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+`Promise`\<`ITenant`\>
 
-The tenant or undefined if not found.
+The tenant.
+
+#### Throws
+
+Error if the tenant is not found.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`get`](../interfaces/ITenantAdminComponent.md#get)
+`ITenantAdminComponent.get`
 
 ***
 
-### getByApiKey()
+### getByApiKey() {#getbyapikey}
 
-> **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+> **getByApiKey**(`apiKey`): `Promise`\<`ITenant`\>
 
 Get a tenant by its api key.
 
@@ -96,43 +100,103 @@ The api key of the tenant.
 
 #### Returns
 
-`Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+`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.
 
-The tenant or undefined if not found.
+#### Throws
+
+Error if the tenant is not found.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`getByApiKey`](../interfaces/ITenantAdminComponent.md#getbyapikey)
+`ITenantAdminComponent.getByPublicOrigin`
 
 ***
 
-### set()
+### create() {#create}
 
-> **set**(`tenant`): `Promise`\<`void`\>
+> **create**(`tenant`): `Promise`\<`string`\>
 
-Set a tenant.
+Create a tenant.
 
 #### Parameters
 
 ##### tenant
 
-[`ITenant`](../interfaces/ITenant.md)
+`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`\>
 
-Nothing.
+The nothing.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`set`](../interfaces/ITenantAdminComponent.md#set)
+`ITenantAdminComponent.update`
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`tenantId`): `Promise`\<`void`\>
 
@@ -154,18 +218,24 @@ Nothing.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`remove`](../interfaces/ITenantAdminComponent.md#remove)
+`ITenantAdminComponent.remove`
 
 ***
 
-### query()
+### query() {#query}
 
-> **query**(`cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](../interfaces/ITenant.md)[]; `cursor?`: `string`; \}\>
+> **query**(`properties`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: `ITenant`[]; `cursor?`: `string`; \}\>
 
 Query tenants with pagination.
 
 #### Parameters
 
+##### properties
+
+keyof `ITenant`[] \| `undefined`
+
+The properties to include in the returned tenants.
+
 ##### cursor?
 
 `string`
@@ -180,10 +250,10 @@ The maximum number of tenants to return.
 
 #### Returns
 
-`Promise`\<\{ `tenants`: [`ITenant`](../interfaces/ITenant.md)[]; `cursor?`: `string`; \}\>
+`Promise`\<\{ `tenants`: `ITenant`[]; `cursor?`: `string`; \}\>
 
 The tenants and the next cursor if more tenants are available.
 
 #### Implementation of
 
-[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`query`](../interfaces/ITenantAdminComponent.md#query)
+`ITenantAdminComponent.query`

package/docs/reference/classes/TenantIdContextIdHandler.md

@@ -18,7 +18,7 @@ Context Id handler for testing as a tenant id.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -26,7 +26,25 @@ Runtime name for the class.
 
 ## Methods
 
-### short()
+### className() {#classname}
+
+> **className**(): `string`
+
+The class name of the component.
+
+#### Returns
+
+`string`
+
+The class name.
+
+#### Implementation of
+
+`IContextIdHandler.className`
+
+***
+
+### short() {#short}
 
 > **short**(`value`): `string`
 
@@ -52,7 +70,7 @@ Short form string.
 
 ***
 
-### guard()
+### guard() {#guard}
 
 > **guard**(`value`): `void`
 

package/docs/reference/classes/TenantIdHelper.md

@@ -14,7 +14,7 @@ Helper class for tenant id related operations.
 
 ## Methods
 
-### generateTenantId()
+### generateTenantId() {#generatetenantid}
 
 > `static` **generateTenantId**(): `string`
 
@@ -28,7 +28,7 @@ A new tenant ID.
 
 ***
 
-### generateApiKey()
+### generateApiKey() {#generateapikey}
 
 > `static` **generateApiKey**(): `string`
 

package/docs/reference/classes/TenantProcessor.md

@@ -12,7 +12,7 @@ Handles incoming api keys and maps them to tenant ids.
 
 > **new TenantProcessor**(`options?`): `TenantProcessor`
 
-Create a new instance of NodeTenantProcessor.
+Create a new instance of TenantProcessor.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ Options for the processor.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### pre()
+### pre() {#pre}
 
 > **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
 
@@ -76,9 +76,9 @@ The outgoing response.
 
 ##### route
 
-The route to process.
+`IBaseRoute` \| `undefined`
 
-`IBaseRoute` | `undefined`
+The route to process.
 
 ##### contextIds
 

package/docs/reference/classes/TenantService.md

@@ -0,0 +1,79 @@
+# Class: TenantService
+
+Service for performing tenant administration operations.
+
+## Implements
+
+- `ITenantComponent`
+
+## Constructors
+
+### Constructor
+
+> **new TenantService**(`options?`): `TenantService`
+
+Create a new instance of TenantService.
+
+#### Parameters
+
+##### options?
+
+[`ITenantAdminServiceConstructorOptions`](../interfaces/ITenantAdminServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`TenantService`
+
+## 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
+
+`ITenantComponent.className`
+
+***
+
+### runPerTenant() {#runpertenant}
+
+> **runPerTenant**(`method`): `Promise`\<`void`\>
+
+Run a per tenant operation.
+
+#### Parameters
+
+##### method
+
+() => `Promise`\<`void`\>
+
+The method to run for each tenant.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`ITenantComponent.runPerTenant`

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/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,31 @@
+# Function: tenantCreate()
+
+> **tenantCreate**(`httpRequestContext`, `componentName`, `request`): `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.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.