@twin.org/api-tenant-processor 0.0.3-next.1

package/dist/es/utils/tenantIdHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenantIdHelper.js","sourceRoot":"","sources":["../../../src/utils/tenantIdHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEzD;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;;OAGG;IACI,MAAM,CAAC,gBAAgB;QAC7B,OAAO,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc;QAC3B,OAAO,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC;CACD","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, RandomHelper } from \"@twin.org/core\";\n\n/**\n * Helper class for tenant id related operations.\n */\nexport class TenantIdHelper {\n\t/**\n\t * Generates a new tenant ID.\n\t * @returns A new tenant ID.\n\t */\n\tpublic static generateTenantId(): string {\n\t\treturn Converter.bytesToHex(RandomHelper.generate(16));\n\t}\n\n\t/**\n\t * Generates a new API Key.\n\t * @returns A new API Key.\n\t */\n\tpublic static generateApiKey(): string {\n\t\treturn Converter.bytesToHex(RandomHelper.generate(16));\n\t}\n}\n"]}

package/dist/types/entities/tenant.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Class defining the storage for node tenants.
+ */
+export declare class Tenant {
+    /**
+     * The unique identifier for the tenant.
+     */
+    id: string;
+    /**
+     * The api key for the tenant.
+     */
+    apiKey: string;
+    /**
+     * The label of the tenant.
+     */
+    label: string;
+    /**
+     * The date the tenant was created.
+     */
+    dateCreated: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./entities/tenant.js";
+export * from "./models/ITenant.js";
+export * from "./models/ITenantAdminComponent.js";
+export * from "./models/ITenantAdminServiceConfig.js";
+export * from "./models/ITenantAdminServiceConstructorOptions.js";
+export * from "./models/ITenantProcessorConfig.js";
+export * from "./models/ITenantProcessorConstructorOptions.js";
+export * from "./schema.js";
+export * from "./tenantAdminService.js";
+export * from "./tenantIdContextIdHandler.js";
+export * from "./tenantProcessor.js";
+export * from "./utils/tenantIdHelper.js";

package/dist/types/models/ITenant.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Model defining the tenant.
+ */
+export interface ITenant {
+    /**
+     * The unique identifier for the tenant.
+     */
+    id: string;
+    /**
+     * The api key for the tenant.
+     */
+    apiKey: string;
+    /**
+     * The label of the tenant.
+     */
+    label: string;
+    /**
+     * The date the tenant was created.
+     */
+    dateCreated: string;
+}

package/dist/types/models/ITenantAdminComponent.d.ts

@@ -0,0 +1,41 @@
+import type { IComponent } from "@twin.org/core";
+import type { ITenant } from "./ITenant.js";
+/**
+ * Configuration for the tenant admin component
+ */
+export interface ITenantAdminComponent extends IComponent {
+    /**
+     * Get a tenant by its id.
+     * @param tenantId The id of the tenant.
+     * @returns The tenant or undefined if not found.
+     */
+    get(tenantId: string): Promise<ITenant | undefined>;
+    /**
+     * Get a tenant by its api key.
+     * @param apiKey The api key of the tenant.
+     * @returns The tenant or undefined if not found.
+     */
+    getByApiKey(apiKey: string): Promise<ITenant | undefined>;
+    /**
+     * Set a tenant.
+     * @param tenant The tenant to store.
+     * @returns Nothing.
+     */
+    set(tenant: ITenant): Promise<void>;
+    /**
+     * Remove a tenant by its id.
+     * @param tenantId The id of the tenant.
+     * @returns Nothing.
+     */
+    remove(tenantId: string): Promise<void>;
+    /**
+     * Query tenants with pagination.
+     * @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<{
+        tenants: ITenant[];
+        cursor?: string;
+    }>;
+}

package/dist/types/models/ITenantAdminServiceConfig.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Configuration for the tenant admin service
+ */
+export interface ITenantAdminServiceConfig {
+}

package/dist/types/models/ITenantAdminServiceConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { ITenantAdminServiceConfig } from "./ITenantAdminServiceConfig.js";
+/**
+ * Options for the Tenant Admin Service constructor.
+ */
+export interface ITenantAdminServiceConstructorOptions {
+    /**
+     * The entity storage for the tenants.
+     * @default tenant
+     */
+    tenantEntityStorageType?: string;
+    /**
+     * Configuration for the admin service.
+     */
+    config?: ITenantAdminServiceConfig;
+}

package/dist/types/models/ITenantProcessorConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Configuration for the tenant processor
+ */
+export interface ITenantProcessorConfig {
+    /**
+     * The key to look for in the header or query params for the api key.
+     * @default x-api-key
+     */
+    apiKeyName?: string;
+}

package/dist/types/models/ITenantProcessorConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { ITenantProcessorConfig } from "./ITenantProcessorConfig.js";
+/**
+ * Options for the Tenant Processor constructor.
+ */
+export interface ITenantProcessorConstructorOptions {
+    /**
+     * The entity storage for the tenants.
+     * @default tenant
+     */
+    tenantEntityStorageType?: string;
+    /**
+     * Configuration for the processor.
+     */
+    config?: ITenantProcessorConfig;
+}

package/dist/types/schema.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Initialize the schema for the node tenant processor.
+ */
+export declare function initSchema(): void;

package/dist/types/tenantAdminService.d.ts

@@ -0,0 +1,56 @@
+import type { ITenant } from "./models/ITenant.js";
+import type { ITenantAdminComponent } from "./models/ITenantAdminComponent.js";
+import type { ITenantAdminServiceConstructorOptions } from "./models/ITenantAdminServiceConstructorOptions.js";
+/**
+ * Service for performing email messaging operations to a connector.
+ */
+export declare class TenantAdminService implements ITenantAdminComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TenantAdminService.
+     * @param options The options for the connector.
+     */
+    constructor(options?: ITenantAdminServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Get a tenant by its id.
+     * @param tenantId The id of the tenant.
+     * @returns The tenant or undefined if not found.
+     */
+    get(tenantId: string): Promise<ITenant | undefined>;
+    /**
+     * Get a tenant by its api key.
+     * @param apiKey The api key of the tenant.
+     * @returns The tenant or undefined if not found.
+     */
+    getByApiKey(apiKey: string): Promise<ITenant | undefined>;
+    /**
+     * Set a tenant.
+     * @param tenant The tenant to store.
+     * @returns Nothing.
+     */
+    set(tenant: ITenant): Promise<void>;
+    /**
+     * Remove a tenant by its id.
+     * @param tenantId The id of the tenant.
+     * @returns Nothing.
+     */
+    remove(tenantId: string): Promise<void>;
+    /**
+     * Query tenants with pagination.
+     * @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<{
+        tenants: ITenant[];
+        cursor?: string;
+    }>;
+}

package/dist/types/tenantIdContextIdHandler.d.ts

@@ -0,0 +1,22 @@
+import type { IContextIdHandler } from "@twin.org/context";
+/**
+ * Context Id handler for testing as a tenant id.
+ */
+export declare class TenantIdContextIdHandler implements IContextIdHandler {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * The short form of the tenant id is the same as the full version.
+     * @param value The full context id value.
+     * @returns Short form string.
+     */
+    short(value: string): string;
+    /**
+     * Guard the value ensuring length.
+     * @param value The value to guard.
+     * @throws GeneralError if the value is too short.
+     */
+    guard(value: string): void;
+}

package/dist/types/tenantProcessor.d.ts

@@ -0,0 +1,33 @@
+import { type IBaseRoute, type IBaseRouteProcessor, type IHttpResponse, type IHttpServerRequest } from "@twin.org/api-models";
+import { type IContextIds } from "@twin.org/context";
+import type { ITenantProcessorConstructorOptions } from "./models/ITenantProcessorConstructorOptions.js";
+/**
+ * Handles incoming api keys and maps them to tenant ids.
+ */
+export declare class TenantProcessor implements IBaseRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of NodeTenantProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options?: ITenantProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     */
+    pre(request: IHttpServerRequest, response: IHttpResponse, route: IBaseRoute | undefined, contextIds: IContextIds, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+}

package/dist/types/utils/tenantIdHelper.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Helper class for tenant id related operations.
+ */
+export declare class TenantIdHelper {
+    /**
+     * Generates a new tenant ID.
+     * @returns A new tenant ID.
+     */
+    static generateTenantId(): string;
+    /**
+     * Generates a new API Key.
+     * @returns A new API Key.
+     */
+    static generateApiKey(): string;
+}

package/docs/changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-tenant-processor-v0.0.3-next.0...api-tenant-processor-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## @twin.org/api-tenant-processor - Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/api-tenant-processor - Examples

package/docs/reference/classes/Tenant.md

@@ -0,0 +1,45 @@
+# Class: Tenant
+
+Class defining the storage for node tenants.
+
+## Constructors
+
+### Constructor
+
+> **new Tenant**(): `Tenant`
+
+#### Returns
+
+`Tenant`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The unique identifier for the tenant.
+
+***
+
+### apiKey
+
+> **apiKey**: `string`
+
+The api key for the tenant.
+
+***
+
+### label
+
+> **label**: `string`
+
+The label of the tenant.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date the tenant was created.

package/docs/reference/classes/TenantAdminService.md

@@ -0,0 +1,189 @@
+# Class: TenantAdminService
+
+Service for performing email messaging operations to a connector.
+
+## Implements
+
+- [`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md)
+
+## Constructors
+
+### Constructor
+
+> **new TenantAdminService**(`options?`): `TenantAdminService`
+
+Create a new instance of TenantAdminService.
+
+#### Parameters
+
+##### options?
+
+[`ITenantAdminServiceConstructorOptions`](../interfaces/ITenantAdminServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`TenantAdminService`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ITenantAdminComponent.className`
+
+***
+
+### get()
+
+> **get**(`tenantId`): `Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+
+Get a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+
+The tenant or undefined if not found.
+
+#### Implementation of
+
+[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`get`](../interfaces/ITenantAdminComponent.md#get)
+
+***
+
+### getByApiKey()
+
+> **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+
+Get a tenant by its api key.
+
+#### Parameters
+
+##### apiKey
+
+`string`
+
+The api key of the tenant.
+
+#### Returns
+
+`Promise`\<[`ITenant`](../interfaces/ITenant.md) \| `undefined`\>
+
+The tenant or undefined if not found.
+
+#### Implementation of
+
+[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`getByApiKey`](../interfaces/ITenantAdminComponent.md#getbyapikey)
+
+***
+
+### set()
+
+> **set**(`tenant`): `Promise`\<`void`\>
+
+Set a tenant.
+
+#### Parameters
+
+##### tenant
+
+[`ITenant`](../interfaces/ITenant.md)
+
+The tenant to store.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`set`](../interfaces/ITenantAdminComponent.md#set)
+
+***
+
+### remove()
+
+> **remove**(`tenantId`): `Promise`\<`void`\>
+
+Remove a tenant by its id.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The id of the tenant.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`remove`](../interfaces/ITenantAdminComponent.md#remove)
+
+***
+
+### query()
+
+> **query**(`cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](../interfaces/ITenant.md)[]; `cursor?`: `string`; \}\>
+
+Query tenants with pagination.
+
+#### Parameters
+
+##### cursor?
+
+`string`
+
+The cursor to start from.
+
+##### limit?
+
+`number`
+
+The maximum number of tenants to return.
+
+#### Returns
+
+`Promise`\<\{ `tenants`: [`ITenant`](../interfaces/ITenant.md)[]; `cursor?`: `string`; \}\>
+
+The tenants and the next cursor if more tenants are available.
+
+#### Implementation of
+
+[`ITenantAdminComponent`](../interfaces/ITenantAdminComponent.md).[`query`](../interfaces/ITenantAdminComponent.md#query)

package/docs/reference/classes/TenantIdContextIdHandler.md

@@ -0,0 +1,79 @@
+# Class: TenantIdContextIdHandler
+
+Context Id handler for testing as a tenant id.
+
+## Implements
+
+- `IContextIdHandler`
+
+## Constructors
+
+### Constructor
+
+> **new TenantIdContextIdHandler**(): `TenantIdContextIdHandler`
+
+#### Returns
+
+`TenantIdContextIdHandler`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### short()
+
+> **short**(`value`): `string`
+
+The short form of the tenant id is the same as the full version.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The full context id value.
+
+#### Returns
+
+`string`
+
+Short form string.
+
+#### Implementation of
+
+`IContextIdHandler.short`
+
+***
+
+### guard()
+
+> **guard**(`value`): `void`
+
+Guard the value ensuring length.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to guard.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if the value is too short.
+
+#### Implementation of
+
+`IContextIdHandler.guard`

package/docs/reference/classes/TenantIdHelper.md

@@ -0,0 +1,41 @@
+# Class: TenantIdHelper
+
+Helper class for tenant id related operations.
+
+## Constructors
+
+### Constructor
+
+> **new TenantIdHelper**(): `TenantIdHelper`
+
+#### Returns
+
+`TenantIdHelper`
+
+## Methods
+
+### generateTenantId()
+
+> `static` **generateTenantId**(): `string`
+
+Generates a new tenant ID.
+
+#### Returns
+
+`string`
+
+A new tenant ID.
+
+***
+
+### generateApiKey()
+
+> `static` **generateApiKey**(): `string`
+
+Generates a new API Key.
+
+#### Returns
+
+`string`
+
+A new API Key.