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

package/docs/reference/interfaces/ITenantUpdateRequest.md

@@ -0,0 +1,25 @@
+# Interface: ITenantUpdateRequest
+
+The tenant to update.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to update.
+
+***
+
+### body
+
+> **body**: `Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\>
+
+The tenant to update.

package/docs/reference/variables/tagsTenants.md

@@ -0,0 +1,5 @@
+# Variable: tagsTenants
+
+> `const` **tagsTenants**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -3,6 +3,10 @@
 		"tenantProcessor": {
 			"missingApiKey": "API key header or query param \"{keyName}\" is missing or invalid.",
 			"apiKeyNotFound": "No node tenant found for API key \"{key}\"."
+		},
+		"tenantAdminService": {
+			"apiKeyAlreadyInUse": "The provided API key is already in use by another tenant.",
+			"tenantNotFound": "Tenant with ID \"{notFoundId}\" not found."
 		}
 	}
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-tenant-processor",
-	"version": "0.0.3-next.2",
-	"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.2",
+		"@twin.org/api-models": "0.0.3-next.21",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",

package/dist/es/models/ITenant.js

@@ -1,4 +0,0 @@
-// Copyright 2025 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-export {};
-//# sourceMappingURL=ITenant.js.map

package/dist/es/models/ITenant.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITenant.js","sourceRoot":"","sources":["../../../src/models/ITenant.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model defining the tenant.\n */\nexport interface ITenant {\n\t/**\n\t * The unique identifier for the tenant.\n\t */\n\tid: string;\n\n\t/**\n\t * The api key for the tenant.\n\t */\n\tapiKey: string;\n\n\t/**\n\t * The label of the tenant.\n\t */\n\tlabel: string;\n\n\t/**\n\t * The date the tenant was created.\n\t */\n\tdateCreated: string;\n}\n"]}

package/dist/es/models/ITenantAdminComponent.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=ITenantAdminComponent.js.map

package/dist/es/models/ITenantAdminComponent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITenantAdminComponent.js","sourceRoot":"","sources":["../../../src/models/ITenantAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { ITenant } from \"./ITenant.js\";\n\n/**\n * Configuration for the tenant admin component\n */\nexport interface ITenantAdminComponent extends IComponent {\n\t/**\n\t * Get a tenant by its id.\n\t * @param tenantId The id of the tenant.\n\t * @returns The tenant or undefined if not found.\n\t */\n\tget(tenantId: string): Promise<ITenant | undefined>;\n\n\t/**\n\t * Get a tenant by its api key.\n\t * @param apiKey The api key of the tenant.\n\t * @returns The tenant or undefined if not found.\n\t */\n\tgetByApiKey(apiKey: string): Promise<ITenant | undefined>;\n\n\t/**\n\t * Set a tenant.\n\t * @param tenant The tenant to store.\n\t * @returns Nothing.\n\t */\n\tset(tenant: ITenant): Promise<void>;\n\n\t/**\n\t * Remove a tenant by its id.\n\t * @param tenantId The id of the tenant.\n\t * @returns Nothing.\n\t */\n\tremove(tenantId: string): Promise<void>;\n\n\t/**\n\t * Query tenants with pagination.\n\t * @param cursor The cursor to start from.\n\t * @param limit The maximum number of tenants to return.\n\t * @returns The tenants and the next cursor if more tenants are available.\n\t */\n\tquery(cursor?: string, limit?: number): Promise<{ tenants: ITenant[]; cursor?: string }>;\n}\n"]}

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

@@ -1,21 +0,0 @@
-/**
- * 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

@@ -1,41 +0,0 @@
-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/docs/reference/interfaces/ITenant.md

@@ -1,35 +0,0 @@
-# Interface: ITenant
-
-Model defining the 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/interfaces/ITenantAdminComponent.md

@@ -1,123 +0,0 @@
-# Interface: ITenantAdminComponent
-
-Configuration for the tenant admin component
-
-## Extends
-
-- `IComponent`
-
-## Methods
-
-### get()
-
-> **get**(`tenantId`): `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
-
-Get a tenant by its id.
-
-#### Parameters
-
-##### tenantId
-
-`string`
-
-The id of the tenant.
-
-#### Returns
-
-`Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
-
-The tenant or undefined if not found.
-
-***
-
-### getByApiKey()
-
-> **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
-
-Get a tenant by its api key.
-
-#### Parameters
-
-##### apiKey
-
-`string`
-
-The api key of the tenant.
-
-#### Returns
-
-`Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
-
-The tenant or undefined if not found.
-
-***
-
-### set()
-
-> **set**(`tenant`): `Promise`\<`void`\>
-
-Set a tenant.
-
-#### Parameters
-
-##### tenant
-
-[`ITenant`](ITenant.md)
-
-The tenant to store.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-***
-
-### remove()
-
-> **remove**(`tenantId`): `Promise`\<`void`\>
-
-Remove a tenant by its id.
-
-#### Parameters
-
-##### tenantId
-
-`string`
-
-The id of the tenant.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-***
-
-### query()
-
-> **query**(`cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](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`](ITenant.md)[]; `cursor?`: `string`; \}\>
-
-The tenants and the next cursor if more tenants are available.