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

package/docs/reference/functions/tenantUpdate.md

@@ -0,0 +1,31 @@
+# Function: tenantUpdate()
+
+> **tenantUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the tenant.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+[`ITenantUpdateRequest`](../interfaces/ITenantUpdateRequest.md)
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -6,17 +6,39 @@
 - [TenantAdminService](classes/TenantAdminService.md)
 - [TenantIdContextIdHandler](classes/TenantIdContextIdHandler.md)
 - [TenantProcessor](classes/TenantProcessor.md)
+- [TenantService](classes/TenantService.md)
 - [TenantIdHelper](classes/TenantIdHelper.md)
 
 ## Interfaces
 
-- [ITenant](interfaces/ITenant.md)
-- [ITenantAdminComponent](interfaces/ITenantAdminComponent.md)
 - [ITenantAdminServiceConfig](interfaces/ITenantAdminServiceConfig.md)
 - [ITenantAdminServiceConstructorOptions](interfaces/ITenantAdminServiceConstructorOptions.md)
 - [ITenantProcessorConfig](interfaces/ITenantProcessorConfig.md)
 - [ITenantProcessorConstructorOptions](interfaces/ITenantProcessorConstructorOptions.md)
+- [ITenantServiceConfig](interfaces/ITenantServiceConfig.md)
+- [ITenantServiceConstructorOptions](interfaces/ITenantServiceConstructorOptions.md)
+- [ITenantCreateRequest](interfaces/ITenantCreateRequest.md)
+- [ITenantGetByApiKeyRequest](interfaces/ITenantGetByApiKeyRequest.md)
+- [ITenantGetByIdRequest](interfaces/ITenantGetByIdRequest.md)
+- [ITenantGetByPublicOriginRequest](interfaces/ITenantGetByPublicOriginRequest.md)
+- [ITenantGetResponse](interfaces/ITenantGetResponse.md)
+- [ITenantListRequest](interfaces/ITenantListRequest.md)
+- [ITenantListResponse](interfaces/ITenantListResponse.md)
+- [ITenantRemoveRequest](interfaces/ITenantRemoveRequest.md)
+- [ITenantUpdateRequest](interfaces/ITenantUpdateRequest.md)
+
+## Variables
+
+- [tagsTenants](variables/tagsTenants.md)
 
 ## Functions
 
 - [initSchema](functions/initSchema.md)
+- [generateRestRoutesTenants](functions/generateRestRoutesTenants.md)
+- [tenantList](functions/tenantList.md)
+- [tenantById](functions/tenantById.md)
+- [tenantByApiKey](functions/tenantByApiKey.md)
+- [tenantByPublicOrigin](functions/tenantByPublicOrigin.md)
+- [tenantRemove](functions/tenantRemove.md)
+- [tenantCreate](functions/tenantCreate.md)
+- [tenantUpdate](functions/tenantUpdate.md)

package/docs/reference/interfaces/ITenantAdminServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the Tenant Admin Service constructor.
 
 ## Properties
 
-### tenantEntityStorageType?
+### tenantEntityStorageType? {#tenantentitystoragetype}
 
-> `optional` **tenantEntityStorageType**: `string`
+> `optional` **tenantEntityStorageType?**: `string`
 
 The entity storage for the tenants.
 
@@ -18,8 +18,8 @@ tenant
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`ITenantAdminServiceConfig`](ITenantAdminServiceConfig.md)
+> `optional` **config?**: [`ITenantAdminServiceConfig`](ITenantAdminServiceConfig.md)
 
 Configuration for the admin service.

package/docs/reference/interfaces/ITenantCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantCreateRequest
+
+The tenant to create.
+
+## Properties
+
+### body {#body}
+
+> **body**: `Omit`\<`ITenant`, `"id"` \| `"dateCreated"` \| `"dateModified"`\> & `object`
+
+The tenant to create.
+
+#### Type Declaration
+
+##### id?
+
+> `optional` **id?**: `string`

package/docs/reference/interfaces/ITenantGetByApiKeyRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByApiKeyRequest
+
+The tenant to get by API key.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### apiKey
+
+> **apiKey**: `string`
+
+The API key of the tenant to get.

package/docs/reference/interfaces/ITenantGetByIdRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByIdRequest
+
+The tenant to get by id.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to get.

package/docs/reference/interfaces/ITenantGetByPublicOriginRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantGetByPublicOriginRequest
+
+The tenant to get by public origin.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### publicOrigin
+
+> **publicOrigin**: `string`
+
+The public origin of the tenant to get.

package/docs/reference/interfaces/ITenantGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: ITenantGetResponse
+
+The tenant get response.
+
+## Properties
+
+### body {#body}
+
+> **body**: `ITenant`
+
+The tenant.

package/docs/reference/interfaces/ITenantListRequest.md

@@ -0,0 +1,30 @@
+# Interface: ITenantListRequest
+
+The list of tenants.
+
+## Properties
+
+### query {#query}
+
+> **query**: `object`
+
+The query parameters.
+
+#### properties?
+
+> `optional` **properties?**: `string`
+
+The properties to include in the returned tenants, separated by commas.
+If not provided, all properties will be returned.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The cursor to get the next chunk of tenants.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+The number of tenants to return.

package/docs/reference/interfaces/ITenantListResponse.md

@@ -0,0 +1,23 @@
+# Interface: ITenantListResponse
+
+The list of tenants.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to include the cursor.
+
+#### link?
+
+> `optional` **link?**: `string` \| `string`[]
+
+***
+
+### body {#body}
+
+> **body**: `ITenant`[]
+
+The list of tenants.

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -4,9 +4,9 @@ Configuration for the tenant processor
 
 ## Properties
 
-### apiKeyName?
+### apiKeyName? {#apikeyname}
 
-> `optional` **apiKeyName**: `string`
+> `optional` **apiKeyName?**: `string`
 
 The key to look for in the header or query params for the api key.
 
@@ -15,3 +15,11 @@ The key to look for in the header or query params for the api key.
 ```ts
 x-api-key
 ```
+
+***
+
+### apiKeyEndpoints? {#apikeyendpoints}
+
+> `optional` **apiKeyEndpoints?**: `string`[]
+
+The list of endpoint paths that should be checked for an api key header, can be regexp strings. Defaults to ["/login$"].

package/docs/reference/interfaces/ITenantProcessorConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the Tenant Processor constructor.
 
 ## Properties
 
-### tenantEntityStorageType?
+### tenantEntityStorageType? {#tenantentitystoragetype}
 
-> `optional` **tenantEntityStorageType**: `string`
+> `optional` **tenantEntityStorageType?**: `string`
 
 The entity storage for the tenants.
 
@@ -18,8 +18,22 @@ tenant
 
 ***
 
-### config?
+### urlTransformerComponentType? {#urltransformercomponenttype}
 
-> `optional` **config**: [`ITenantProcessorConfig`](ITenantProcessorConfig.md)
+> `optional` **urlTransformerComponentType?**: `string`
+
+The URL transformer component for the tenants.
+
+#### Default
+
+```ts
+url-transformer
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITenantProcessorConfig`](ITenantProcessorConfig.md)
 
 Configuration for the processor.

package/docs/reference/interfaces/ITenantRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantRemoveRequest
+
+The tenant to remove by id.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to remove.

package/docs/reference/interfaces/ITenantServiceConfig.md

@@ -0,0 +1,3 @@
+# Interface: ITenantServiceConfig
+
+Configuration for the tenant service

package/docs/reference/interfaces/ITenantServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: ITenantServiceConstructorOptions
+
+Options for the Tenant Service constructor.
+
+## Properties
+
+### tenantEntityStorageType? {#tenantentitystoragetype}
+
+> `optional` **tenantEntityStorageType?**: `string`
+
+The entity storage for the tenants.
+
+#### Default
+
+```ts
+tenant
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITenantServiceConfig`](ITenantServiceConfig.md)
+
+Configuration for the service.

package/docs/reference/interfaces/ITenantUpdateRequest.md

@@ -0,0 +1,25 @@
+# Interface: ITenantUpdateRequest
+
+The tenant to update.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the tenant to update.
+
+***
+
+### body {#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

@@ -1,8 +1,14 @@
 {
 	"error": {
 		"tenantProcessor": {
-			"missingApiKey": "API key header or query param \"{keyName}\" is missing or invalid.",
-			"apiKeyNotFound": "No node tenant found for API key \"{key}\"."
+			"missingApiKey": "API key \"{keyName}\" is missing",
+			"missingTenantToken": "Tenant token query parameter \"{paramName}\" is missing",
+			"apiKeyNotFound": "No node tenant found for API key \"{key}\".",
+			"tenantNotFound": "No node tenant found for the decrypted tenant token \"{tenantId}\"."
+		},
+		"tenantAdminService": {
+			"apiKeyAlreadyInUse": "The provided API key is already in use by another tenant.",
+			"tenantNotFound": "Tenant with ID \"{notFoundId}\" not found."
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-tenant-processor",
-	"version": "0.0.3-next.4",
-	"description": "API Tenant Processor for converting and api key to a tenant id.",
+	"version": "0.0.3-next.40",
+	"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",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-tenant-processor"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,12 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.3-next.4",
+		"@twin.org/api-models": "0.0.3-next.40",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",
+		"@twin.org/vault-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -50,7 +51,7 @@
 		"utilities"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }

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.