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

package/dist/es/tenantService.js

@@ -0,0 +1,51 @@
+import { ContextIdKeys, ContextIdStore } from "@twin.org/context";
+import { Is } from "@twin.org/core";
+import { EntityStorageConnectorFactory } from "@twin.org/entity-storage-models";
+/**
+ * Service for performing tenant administration operations.
+ */
+export class TenantService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "TenantService";
+    /**
+     * Entity storage connector used by the service.
+     * @internal
+     */
+    _entityStorageConnector;
+    /**
+     * Create a new instance of TenantService.
+     * @param options The options for the connector.
+     */
+    constructor(options) {
+        this._entityStorageConnector = EntityStorageConnectorFactory.get(options?.tenantEntityStorageType ?? "tenant");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return TenantService.CLASS_NAME;
+    }
+    /**
+     * Run a per tenant operation.
+     * @param method The method to run for each tenant.
+     * @returns Nothing.
+     */
+    async runPerTenant(method) {
+        let cursor;
+        const contextIds = (await ContextIdStore.getContextIds()) ?? {};
+        do {
+            const result = await this._entityStorageConnector.query(undefined, undefined, ["id"], cursor);
+            for (const tenant of result.entities) {
+                contextIds[ContextIdKeys.Tenant] = tenant.id;
+                await ContextIdStore.run(contextIds, async () => {
+                    await method();
+                });
+            }
+            cursor = result.cursor;
+        } while (Is.stringValue(cursor));
+    }
+}
+//# sourceMappingURL=tenantService.js.map

package/dist/es/tenantService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenantService.js","sourceRoot":"","sources":["../../src/tenantService.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AACpC,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AAKzC;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;OAEG;IACI,MAAM,CAAU,UAAU,mBAAmC;IAEpE;;;OAGG;IACc,uBAAuB,CAAkC;IAE1E;;;OAGG;IACH,YAAY,OAA+C;QAC1D,IAAI,CAAC,uBAAuB,GAAG,6BAA6B,CAAC,GAAG,CAC/D,OAAO,EAAE,uBAAuB,IAAI,QAAQ,CAC5C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,aAAa,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAA2B;QACpD,IAAI,MAA0B,CAAC;QAE/B,MAAM,UAAU,GAAG,CAAC,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,CAAC;QAEhE,GAAG,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;YAE9F,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACtC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;gBAE7C,MAAM,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;oBAC/C,MAAM,MAAM,EAAE,CAAC;gBAChB,CAAC,CAAC,CAAC;YACJ,CAAC;YAED,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QACxB,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;IAClC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITenantComponent } from \"@twin.org/api-models\";\nimport { ContextIdKeys, ContextIdStore } from \"@twin.org/context\";\nimport { Is } from \"@twin.org/core\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { Tenant } from \"./entities/tenant.js\";\nimport type { ITenantAdminServiceConstructorOptions } from \"./models/ITenantAdminServiceConstructorOptions.js\";\n\n/**\n * Service for performing tenant administration operations.\n */\nexport class TenantService implements ITenantComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TenantService>();\n\n\t/**\n\t * Entity storage connector used by the service.\n\t * @internal\n\t */\n\tprivate readonly _entityStorageConnector: IEntityStorageConnector<Tenant>;\n\n\t/**\n\t * Create a new instance of TenantService.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options?: ITenantAdminServiceConstructorOptions) {\n\t\tthis._entityStorageConnector = EntityStorageConnectorFactory.get(\n\t\t\toptions?.tenantEntityStorageType ?? \"tenant\"\n\t\t);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn TenantService.CLASS_NAME;\n\t}\n\n\t/**\n\t * Run a per tenant operation.\n\t * @param method The method to run for each tenant.\n\t * @returns Nothing.\n\t */\n\tpublic async runPerTenant(method: () => Promise<void>): Promise<void> {\n\t\tlet cursor: string | undefined;\n\n\t\tconst contextIds = (await ContextIdStore.getContextIds()) ?? {};\n\n\t\tdo {\n\t\t\tconst result = await this._entityStorageConnector.query(undefined, undefined, [\"id\"], cursor);\n\n\t\t\tfor (const tenant of result.entities) {\n\t\t\t\tcontextIds[ContextIdKeys.Tenant] = tenant.id;\n\n\t\t\t\tawait ContextIdStore.run(contextIds, async () => {\n\t\t\t\t\tawait method();\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tcursor = result.cursor;\n\t\t} while (Is.stringValue(cursor));\n\t}\n}\n"]}

package/dist/es/utils/tenantIdHelper.js

@@ -1,6 +1,6 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { Converter, RandomHelper } from "@twin.org/core";
+import { RandomHelper } from "@twin.org/core";
 /**
  * Helper class for tenant id related operations.
  */
@@ -10,14 +10,14 @@ export class TenantIdHelper {
      * @returns A new tenant ID.
      */
     static generateTenantId() {
-        return Converter.bytesToHex(RandomHelper.generate(16));
+        return RandomHelper.generateUuidV7("compact");
     }
     /**
      * Generates a new API Key.
      * @returns A new API Key.
      */
     static generateApiKey() {
-        return Converter.bytesToHex(RandomHelper.generate(16));
+        return RandomHelper.generateUuidV7("compact");
     }
 }
 //# sourceMappingURL=tenantIdHelper.js.map

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

@@ -1 +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"]}
+{"version":3,"file":"tenantIdHelper.js","sourceRoot":"","sources":["../../../src/utils/tenantIdHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;;OAGG;IACI,MAAM,CAAC,gBAAgB;QAC7B,OAAO,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc;QAC3B,OAAO,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;CACD","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { 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 RandomHelper.generateUuidV7(\"compact\");\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 RandomHelper.generateUuidV7(\"compact\");\n\t}\n}\n"]}

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

@@ -18,4 +18,12 @@ export declare class Tenant {
      * The date the tenant was created.
      */
     dateCreated: string;
+    /**
+     * The date the tenant was modified.
+     */
+    dateModified: string;
+    /**
+     * The origin available to the public for accessing the API.
+     */
+    publicOrigin?: string;
 }

package/dist/types/index.d.ts

@@ -1,12 +1,23 @@
 export * from "./entities/tenant.js";
-export * from "./models/ITenant.js";
-export * from "./models/ITenantAdminComponent.js";
+export * from "./models/api/ITenantCreateRequest.js";
+export * from "./models/api/ITenantGetByApiKeyRequest.js";
+export * from "./models/api/ITenantGetByIdRequest.js";
+export * from "./models/api/ITenantGetByPublicOriginRequest.js";
+export * from "./models/api/ITenantGetResponse.js";
+export * from "./models/api/ITenantListRequest.js";
+export * from "./models/api/ITenantListResponse.js";
+export * from "./models/api/ITenantRemoveRequest.js";
+export * from "./models/api/ITenantUpdateRequest.js";
 export * from "./models/ITenantAdminServiceConfig.js";
 export * from "./models/ITenantAdminServiceConstructorOptions.js";
 export * from "./models/ITenantProcessorConfig.js";
 export * from "./models/ITenantProcessorConstructorOptions.js";
+export * from "./models/ITenantServiceConfig.js";
+export * from "./models/ITenantServiceConstructorOptions.js";
 export * from "./schema.js";
 export * from "./tenantAdminService.js";
 export * from "./tenantIdContextIdHandler.js";
 export * from "./tenantProcessor.js";
+export * from "./tenantRoutes.js";
+export * from "./tenantService.js";
 export * from "./utils/tenantIdHelper.js";

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

@@ -7,4 +7,8 @@ export interface ITenantProcessorConfig {
      * @default x-api-key
      */
     apiKeyName?: string;
+    /**
+     * The list of endpoint paths that should be checked for an api key header, can be regexp strings. Defaults to ["/login$"].
+     */
+    apiKeyEndpoints?: string[];
 }

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

@@ -8,6 +8,11 @@ export interface ITenantProcessorConstructorOptions {
      * @default tenant
      */
     tenantEntityStorageType?: string;
+    /**
+     * The URL transformer component for the tenants.
+     * @default url-transformer
+     */
+    urlTransformerComponentType?: string;
     /**
      * Configuration for the processor.
      */

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

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

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

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

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

@@ -0,0 +1,12 @@
+import type { ITenant } from "@twin.org/api-models";
+/**
+ * The tenant to create.
+ */
+export interface ITenantCreateRequest {
+    /**
+     * The tenant to create.
+     */
+    body: Omit<ITenant, "id" | "dateCreated" | "dateModified"> & {
+        id?: string;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * The tenant to get by API key.
+ */
+export interface ITenantGetByApiKeyRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The API key of the tenant to get.
+         */
+        apiKey: string;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * The tenant to get by id.
+ */
+export interface ITenantGetByIdRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the tenant to get.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * The tenant to get by public origin.
+ */
+export interface ITenantGetByPublicOriginRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The public origin of the tenant to get.
+         */
+        publicOrigin: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { ITenant } from "@twin.org/api-models";
+/**
+ * The tenant get response.
+ */
+export interface ITenantGetResponse {
+    /**
+     * The tenant.
+     */
+    body: ITenant;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * The list of tenants.
+ */
+export interface ITenantListRequest {
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The properties to include in the returned tenants, separated by commas.
+         * If not provided, all properties will be returned.
+         */
+        properties?: string;
+        /**
+         * The cursor to get the next chunk of tenants.
+         */
+        cursor?: string;
+        /**
+         * The number of tenants to return.
+         */
+        limit?: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { ITenant } from "@twin.org/api-models";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * The list of tenants.
+ */
+export interface ITenantListResponse {
+    /**
+     * The headers which can be used to include the cursor.
+     */
+    headers?: {
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The list of tenants.
+     */
+    body: ITenant[];
+}

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

@@ -0,0 +1,14 @@
+/**
+ * The tenant to remove by id.
+ */
+export interface ITenantRemoveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the tenant to remove.
+         */
+        id: string;
+    };
+}

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,8 +1,7 @@
-import type { ITenant } from "./models/ITenant.js";
-import type { ITenantAdminComponent } from "./models/ITenantAdminComponent.js";
+import type { ITenant, ITenantAdminComponent } from "@twin.org/api-models";
 import type { ITenantAdminServiceConstructorOptions } from "./models/ITenantAdminServiceConstructorOptions.js";
 /**
- * Service for performing email messaging operations to a connector.
+ * Service for performing tenant administration operations.
  */
 export declare class TenantAdminService implements ITenantAdminComponent {
     /**
@@ -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,12 @@ export declare class TenantAdminService implements ITenantAdminComponent {
     remove(tenantId: string): Promise<void>;
     /**
      * Query tenants with pagination.
+     * @param properties The properties to include in the returned 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(properties: (keyof ITenant)[] | undefined, 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/tenantProcessor.d.ts

@@ -10,7 +10,7 @@ export declare class TenantProcessor implements IBaseRouteProcessor {
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of NodeTenantProcessor.
+     * Create a new instance of TenantProcessor.
      * @param options Options for the processor.
      */
     constructor(options?: ITenantProcessorConstructorOptions);

package/dist/types/tenantRoutes.d.ts

@@ -0,0 +1,77 @@
+import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type 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/dist/types/tenantService.d.ts

@@ -0,0 +1,27 @@
+import type { ITenantComponent } from "@twin.org/api-models";
+import type { ITenantAdminServiceConstructorOptions } from "./models/ITenantAdminServiceConstructorOptions.js";
+/**
+ * Service for performing tenant administration operations.
+ */
+export declare class TenantService implements ITenantComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TenantService.
+     * @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;
+    /**
+     * Run a per tenant operation.
+     * @param method The method to run for each tenant.
+     * @returns Nothing.
+     */
+    runPerTenant(method: () => Promise<void>): Promise<void>;
+}