@twin.org/api-tenant-processor 0.0.3-next.20 → 0.0.3-next.22

package/README.md

@@ -1,6 +1,6 @@
 # TWIN API Tenant Processor
 
-Will read `x-api-key` from HTTP header or query params and convert it to a tenant id, to be used for partitioning data.
+This package provides tenant resolution services and route handlers that derive tenant context from API keys.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.0.3-next.22](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.21...api-tenant-processor-v0.0.3-next.22) (2026-03-27)
+
+
+### Miscellaneous Chores
+
+* **api-tenant-processor:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.21 to 0.0.3-next.22
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.20...api-tenant-processor-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-tenant-processor:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.20 to 0.0.3-next.21
+
 ## [0.0.3-next.20](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.19...api-tenant-processor-v0.0.3-next.20) (2026-02-09)
 
 
@@ -311,4 +339,4 @@
   * dependencies
     * @twin.org/api-models bumped from 0.0.3-next.0 to 0.0.3-next.1
 
-## @twin.org/api-tenant-processor - Changelog
+## Changelog

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,7 +38,7 @@ The label of the tenant.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -46,7 +46,7 @@ The date the tenant was created.
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
@@ -54,15 +54,15 @@ The date the tenant was modified.
 
 ***
 
-### publicOrigin?
+### publicOrigin? {#publicorigin}
 
-> `optional` **publicOrigin**: `string`
+> `optional` **publicOrigin?**: `string`
 
 The origin available to the public for accessing the API.
 
 ***
 
-### isNodeTenant
+### isNodeTenant {#isnodetenant}
 
 > **isNodeTenant**: `boolean`
 

package/docs/reference/classes/TenantAdminService.md

@@ -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,7 +54,7 @@ The class name of the component.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`tenantId`): `Promise`\<`ITenant`\>
 
@@ -84,7 +84,7 @@ Error if the tenant is not found.
 
 ***
 
-### getByApiKey()
+### getByApiKey() {#getbyapikey}
 
 > **getByApiKey**(`apiKey`): `Promise`\<`ITenant`\>
 
@@ -114,7 +114,7 @@ Error if the tenant is not found.
 
 ***
 
-### getByPublicOrigin()
+### getByPublicOrigin() {#getbypublicorigin}
 
 > **getByPublicOrigin**(`publicOrigin`): `Promise`\<`ITenant`\>
 
@@ -144,7 +144,7 @@ Error if the tenant is not found.
 
 ***
 
-### create()
+### create() {#create}
 
 > **create**(`tenant`): `Promise`\<`string`\>
 
@@ -170,7 +170,7 @@ The tenant id.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`tenant`): `Promise`\<`void`\>
 
@@ -196,7 +196,7 @@ The nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`tenantId`): `Promise`\<`void`\>
 
@@ -222,7 +222,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `tenants`: `ITenant`[]; `cursor?`: `string`; \}\>
 

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,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -44,7 +44,7 @@ The class name.
 
 ***
 
-### short()
+### short() {#short}
 
 > **short**(`value`): `string`
 
@@ -70,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

@@ -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/interfaces/ITenantAdminServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the Tenant Admin Service constructor.
 
 ## Properties
 
-### tenantEntityStorageType?
+### tenantEntityStorageType? {#tenantentitystoragetype}
 
-> `optional` **tenantEntityStorageType**: `string`
+> `optional` **tenantEntityStorageType?**: `string`
 
 The entity storage for the tenants.
 
@@ -18,8 +18,8 @@ tenant
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`ITenantAdminServiceConfig`](ITenantAdminServiceConfig.md)
+> `optional` **config?**: [`ITenantAdminServiceConfig`](ITenantAdminServiceConfig.md)
 
 Configuration for the admin service.

package/docs/reference/interfaces/ITenantCreateRequest.md

@@ -4,7 +4,7 @@ The tenant to create.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
 
@@ -14,4 +14,4 @@ The tenant to create.
 
 ##### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`

package/docs/reference/interfaces/ITenantGetByApiKeyRequest.md

@@ -4,7 +4,7 @@ The tenant to get by API key.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/ITenantGetByIdRequest.md

@@ -4,7 +4,7 @@ The tenant to get by id.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/ITenantGetByPublicOriginRequest.md

@@ -4,7 +4,7 @@ The tenant to get by public origin.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/ITenantGetResponse.md

@@ -4,7 +4,7 @@ The tenant get response.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `ITenant`
 

package/docs/reference/interfaces/ITenantListRequest.md

@@ -4,7 +4,7 @@ The list of tenants.
 
 ## Properties
 
-### query
+### query {#query}
 
 > **query**: `object`
 
@@ -12,12 +12,12 @@ The query parameters.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get the next chunk of tenants.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 The number of tenants to return.

package/docs/reference/interfaces/ITenantListResponse.md

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

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -4,9 +4,9 @@ Configuration for the tenant processor
 
 ## Properties
 
-### apiKeyName?
+### apiKeyName? {#apikeyname}
 
-> `optional` **apiKeyName**: `string`
+> `optional` **apiKeyName?**: `string`
 
 The key to look for in the header or query params for the api key.
 

package/docs/reference/interfaces/ITenantProcessorConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the Tenant Processor constructor.
 
 ## Properties
 
-### tenantEntityStorageType?
+### tenantEntityStorageType? {#tenantentitystoragetype}
 
-> `optional` **tenantEntityStorageType**: `string`
+> `optional` **tenantEntityStorageType?**: `string`
 
 The entity storage for the tenants.
 
@@ -18,8 +18,8 @@ tenant
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`ITenantProcessorConfig`](ITenantProcessorConfig.md)
+> `optional` **config?**: [`ITenantProcessorConfig`](ITenantProcessorConfig.md)
 
 Configuration for the processor.

package/docs/reference/interfaces/ITenantRemoveRequest.md

@@ -4,7 +4,7 @@ The tenant to remove by id.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/ITenantUpdateRequest.md

@@ -4,7 +4,7 @@ The tenant to update.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The id of the tenant to update.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\>
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-tenant-processor",
-	"version": "0.0.3-next.20",
-	"description": "API Tenant Processor for converting and api key to a tenant id.",
+	"version": "0.0.3-next.22",
+	"description": "Tenant resolution services and route handlers that derive tenant context from API keys.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.3-next.20",
+		"@twin.org/api-models": "0.0.3-next.22",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",