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

package/dist/types/models/api/ITenantUpdateRequest.d.ts

@@ -0,0 +1,19 @@
+import type { ITenant } from "@twin.org/api-models";
+/**
+ * The tenant to update.
+ */
+export interface ITenantUpdateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the tenant to update.
+         */
+        id: string;
+    };
+    /**
+     * The tenant to update.
+     */
+    body: Omit<ITenant, "id" | "dateCreated" | "dateModified">;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/dist/types/tenantAdminService.d.ts

@@ -1,5 +1,4 @@
-import type { ITenant } from "./models/ITenant.js";
-import type { ITenantAdminComponent } from "./models/ITenantAdminComponent.js";
+import type { ITenantAdminComponent, ITenant } from "@twin.org/api-models";
 import type { ITenantAdminServiceConstructorOptions } from "./models/ITenantAdminServiceConstructorOptions.js";
 /**
  * Service for performing email messaging operations to a connector.
@@ -22,21 +21,38 @@ export declare class TenantAdminService implements ITenantAdminComponent {
     /**
      * Get a tenant by its id.
      * @param tenantId The id of the tenant.
-     * @returns The tenant or undefined if not found.
+     * @returns The tenant.
+     * @throws Error if the tenant is not found.
      */
-    get(tenantId: string): Promise<ITenant | undefined>;
+    get(tenantId: string): Promise<ITenant>;
     /**
      * Get a tenant by its api key.
      * @param apiKey The api key of the tenant.
-     * @returns The tenant or undefined if not found.
+     * @returns The tenant.
+     * @throws Error if the tenant is not found.
      */
-    getByApiKey(apiKey: string): Promise<ITenant | undefined>;
+    getByApiKey(apiKey: string): Promise<ITenant>;
     /**
-     * Set a tenant.
+     * Get a tenant by its public origin.
+     * @param publicOrigin The origin of the tenant.
+     * @returns The tenant.
+     * @throws Error if the tenant is not found.
+     */
+    getByPublicOrigin(publicOrigin: string): Promise<ITenant>;
+    /**
+     * Create a tenant.
      * @param tenant The tenant to store.
-     * @returns Nothing.
+     * @returns The tenant id.
+     */
+    create(tenant: Omit<ITenant, "id" | "dateCreated" | "dateModified"> & {
+        id?: string;
+    }): Promise<string>;
+    /**
+     * Update a tenant.
+     * @param tenant The tenant to update.
+     * @returns The nothing.
      */
-    set(tenant: ITenant): Promise<void>;
+    update(tenant: Partial<Omit<ITenant, "dateCreated" | "dateModified">>): Promise<void>;
     /**
      * Remove a tenant by its id.
      * @param tenantId The id of the tenant.
@@ -45,11 +61,15 @@ export declare class TenantAdminService implements ITenantAdminComponent {
     remove(tenantId: string): Promise<void>;
     /**
      * Query tenants with pagination.
+     * @param options Optional query options.
+     * @param options.isNodeTenant Whether to filter for node admin tenants.
      * @param cursor The cursor to start from.
      * @param limit The maximum number of tenants to return.
      * @returns The tenants and the next cursor if more tenants are available.
      */
-    query(cursor?: string, limit?: number): Promise<{
+    query(options?: {
+        isNodeTenant?: boolean;
+    }, cursor?: string, limit?: number): Promise<{
         tenants: ITenant[];
         cursor?: string;
     }>;

package/dist/types/tenantIdContextIdHandler.d.ts

@@ -7,6 +7,11 @@ export declare class TenantIdContextIdHandler implements IContextIdHandler {
      * Runtime name for the class.
      */
     static readonly CLASS_NAME: string;
+    /**
+     * The class name of the component.
+     * @returns The class name.
+     */
+    className(): string;
     /**
      * The short form of the tenant id is the base64 version to compact.
      * @param value The full context id value.

package/dist/types/tenantRoutes.d.ts

@@ -0,0 +1,77 @@
+import type { ICreatedResponse, IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import type { ITenantCreateRequest } from "./models/api/ITenantCreateRequest.js";
+import type { ITenantGetByApiKeyRequest } from "./models/api/ITenantGetByApiKeyRequest.js";
+import type { ITenantGetByIdRequest } from "./models/api/ITenantGetByIdRequest.js";
+import type { ITenantGetByPublicOriginRequest } from "./models/api/ITenantGetByPublicOriginRequest.js";
+import type { ITenantGetResponse } from "./models/api/ITenantGetResponse.js";
+import type { ITenantListRequest } from "./models/api/ITenantListRequest.js";
+import type { ITenantListResponse } from "./models/api/ITenantListResponse.js";
+import type { ITenantRemoveRequest } from "./models/api/ITenantRemoveRequest.js";
+import type { ITenantUpdateRequest } from "./models/api/ITenantUpdateRequest.js";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsTenants: ITag[];
+/**
+ * The REST routes for tenant management.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesTenants(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Get the list of tenants.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantList(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantListRequest): Promise<ITenantListResponse>;
+/**
+ * Get the tenant by id.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantById(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantGetByIdRequest): Promise<ITenantGetResponse>;
+/**
+ * Get the tenant by api key.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantByApiKey(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantGetByApiKeyRequest): Promise<ITenantGetResponse>;
+/**
+ * Get the tenant by public origin.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantByPublicOrigin(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantGetByPublicOriginRequest): Promise<ITenantGetResponse>;
+/**
+ * Remove the tenant by id.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Create the tenant.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantCreateRequest): Promise<ICreatedResponse>;
+/**
+ * Update the tenant.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantUpdateRequest): Promise<INoContentResponse>;

package/docs/changelog.md

@@ -1,5 +1,297 @@
 # 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)
+
+
+### Features
+
+* location encoding ([#79](https://github.com/twinfoundation/api/issues/79)) ([c684465](https://github.com/twinfoundation/api/commit/c684465f2a871376152472bdecb6aa230b1101a1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.19 to 0.0.3-next.20
+
+## [0.0.3-next.19](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.18...api-tenant-processor-v0.0.3-next.19) (2026-02-06)
+
+
+### 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.18 to 0.0.3-next.19
+
+## [0.0.3-next.18](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.17...api-tenant-processor-v0.0.3-next.18) (2026-02-04)
+
+
+### Features
+
+* tenant api and scopes ([#75](https://github.com/twinfoundation/api/issues/75)) ([c663141](https://github.com/twinfoundation/api/commit/c663141091e8974d769f8f9904ecdab009ebd083))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.17 to 0.0.3-next.18
+
+## [0.0.3-next.17](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.16...api-tenant-processor-v0.0.3-next.17) (2026-01-26)
+
+
+### 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.16 to 0.0.3-next.17
+
+## [0.0.3-next.16](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.15...api-tenant-processor-v0.0.3-next.16) (2026-01-26)
+
+
+### Features
+
+* public base url ([#70](https://github.com/twinfoundation/api/issues/70)) ([5b958cd](https://github.com/twinfoundation/api/commit/5b958cd91e8a38cdae2835ff5f2356c7e48d37c3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.15 to 0.0.3-next.16
+
+## [0.0.3-next.15](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.14...api-tenant-processor-v0.0.3-next.15) (2026-01-22)
+
+
+### 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.14 to 0.0.3-next.15
+
+## [0.0.3-next.14](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.13...api-tenant-processor-v0.0.3-next.14) (2026-01-20)
+
+
+### 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.13 to 0.0.3-next.14
+
+## [0.0.3-next.13](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.12...api-tenant-processor-v0.0.3-next.13) (2026-01-19)
+
+
+### 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.12 to 0.0.3-next.13
+
+## [0.0.3-next.12](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.11...api-tenant-processor-v0.0.3-next.12) (2026-01-12)
+
+
+### 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.11 to 0.0.3-next.12
+
+## [0.0.3-next.11](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.10...api-tenant-processor-v0.0.3-next.11) (2026-01-08)
+
+
+### Bug Fixes
+
+* duplicate api keys ([#61](https://github.com/twinfoundation/api/issues/61)) ([5519c2d](https://github.com/twinfoundation/api/commit/5519c2d077d9b3d4b5fc7d5f073ef67cd000a367))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.10 to 0.0.3-next.11
+
+## [0.0.3-next.10](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.9...api-tenant-processor-v0.0.3-next.10) (2026-01-05)
+
+
+### 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.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.8...api-tenant-processor-v0.0.3-next.9) (2026-01-05)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add livez endpoint ([#57](https://github.com/twinfoundation/api/issues/57)) ([ef007db](https://github.com/twinfoundation/api/commit/ef007db8201736dd3053211f849ffd03baaa485e))
+* add tests for tenant id handler ([c868e7e](https://github.com/twinfoundation/api/commit/c868e7e5831e13df39b8994c40834e51f69fa0b9))
+* check tenant id in auth if set ([937ba0c](https://github.com/twinfoundation/api/commit/937ba0cd790038556a7b2af251e52b43cb059df4))
+* check tenant id in auth if set ([66f7337](https://github.com/twinfoundation/api/commit/66f73374d3cf4c1c85ea96ec74bb30712fb84dd7))
+* reduce short form tenant id length ([bcda377](https://github.com/twinfoundation/api/commit/bcda377daed03b21fd1c6ffe47bad4a45d96602b))
+
+
+### Bug Fixes
+
+* do not check x-api-key for health resourcr ([#54](https://github.com/twinfoundation/api/issues/54)) ([897a747](https://github.com/twinfoundation/api/commit/897a747a57ed76ee37035f7ea3d40953df3f5fb0))
+* remove extraneous type ([f85c52c](https://github.com/twinfoundation/api/commit/f85c52c55caa3a7a64f6f675842f0ea59289a5d9))
+* use base64Url for tenant id short form so it doesn't include slash ([7210771](https://github.com/twinfoundation/api/commit/72107718650acd05440ce9d9bf10905e6052281c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.7...api-tenant-processor-v0.0.3-next.8) (2025-12-17)
+
+
+### Bug Fixes
+
+* do not check x-api-key for health resourcr ([#54](https://github.com/twinfoundation/api/issues/54)) ([897a747](https://github.com/twinfoundation/api/commit/897a747a57ed76ee37035f7ea3d40953df3f5fb0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.6...api-tenant-processor-v0.0.3-next.7) (2025-11-26)
+
+
+### 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.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.5...api-tenant-processor-v0.0.3-next.6) (2025-11-20)
+
+
+### Features
+
+* check tenant id in auth if set ([937ba0c](https://github.com/twinfoundation/api/commit/937ba0cd790038556a7b2af251e52b43cb059df4))
+* check tenant id in auth if set ([66f7337](https://github.com/twinfoundation/api/commit/66f73374d3cf4c1c85ea96ec74bb30712fb84dd7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.4...api-tenant-processor-v0.0.3-next.5) (2025-11-14)
+
+
+### 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.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.3...api-tenant-processor-v0.0.3-next.4) (2025-11-14)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add tests for tenant id handler ([c868e7e](https://github.com/twinfoundation/api/commit/c868e7e5831e13df39b8994c40834e51f69fa0b9))
+* reduce short form tenant id length ([bcda377](https://github.com/twinfoundation/api/commit/bcda377daed03b21fd1c6ffe47bad4a45d96602b))
+
+
+### Bug Fixes
+
+* remove extraneous type ([f85c52c](https://github.com/twinfoundation/api/commit/f85c52c55caa3a7a64f6f675842f0ea59289a5d9))
+* use base64Url for tenant id short form so it doesn't include slash ([7210771](https://github.com/twinfoundation/api/commit/72107718650acd05440ce9d9bf10905e6052281c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.2...api-tenant-processor-v0.0.3-next.3) (2025-11-14)
+
+
+### Features
+
+* add tests for tenant id handler ([c868e7e](https://github.com/twinfoundation/api/commit/c868e7e5831e13df39b8994c40834e51f69fa0b9))
+
+
+### Bug Fixes
+
+* use base64Url for tenant id short form so it doesn't include slash ([7210771](https://github.com/twinfoundation/api/commit/72107718650acd05440ce9d9bf10905e6052281c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
 ## [0.0.3-next.2](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.1...api-tenant-processor-v0.0.3-next.2) (2025-11-12)
 
 
@@ -33,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/classes/Tenant.md

@@ -43,3 +43,27 @@ The label of the tenant.
 > **dateCreated**: `string`
 
 The date the tenant was created.
+
+***
+
+### dateModified
+
+> **dateModified**: `string`
+
+The date the tenant was modified.
+
+***
+
+### publicOrigin?
+
+> `optional` **publicOrigin**: `string`
+
+The origin available to the public for accessing the API.
+
+***
+
+### isNodeTenant
+
+> **isNodeTenant**: `boolean`
+
+Indicates whether the tenant is the node tenant.