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

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,19 @@
 # Changelog
 
+## [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 +325,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/interfaces/ITenantAdminServiceConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the Tenant Admin Service constructor.
 
 The entity storage for the tenants.
 
-#### Default
-
-```ts
-tenant
-```
-
 ***
 
 ### config?

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -9,9 +9,3 @@ Configuration for the tenant processor
 > `optional` **apiKeyName**: `string`
 
 The key to look for in the header or query params for the api key.
-
-#### Default
-
-```ts
-x-api-key
-```

package/docs/reference/interfaces/ITenantProcessorConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the Tenant Processor constructor.
 
 The entity storage for the tenants.
 
-#### Default
-
-```ts
-tenant
-```
-
 ***
 
 ### config?

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.21",
+	"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.21",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",