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

package/docs/reference/classes/TenantIdContextIdHandler.md

@@ -26,6 +26,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+The class name of the component.
+
+#### Returns
+
+`string`
+
+The class name.
+
+#### Implementation of
+
+`IContextIdHandler.className`
+
+***
+
 ### short()
 
 > **short**(`value`): `string`

package/docs/reference/functions/generateRestRoutesTenants.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesTenants()
+
+> **generateRestRoutesTenants**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for tenant management.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/tenantByApiKey.md

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

package/docs/reference/functions/tenantById.md

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

package/docs/reference/functions/tenantByPublicOrigin.md

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

package/docs/reference/functions/tenantCreate.md

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

package/docs/reference/functions/tenantList.md

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

package/docs/reference/functions/tenantRemove.md

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

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

@@ -10,13 +10,32 @@
 
 ## 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)
+- [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/ITenantCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITenantCreateRequest
+
+The tenant to create.
+
+## Properties
+
+### 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**: `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**: `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**: `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**: `ITenant`
+
+The tenant.

package/docs/reference/interfaces/ITenantListRequest.md

@@ -0,0 +1,23 @@
+# Interface: ITenantListRequest
+
+The list of tenants.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### 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?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to include the cursor.
+
+#### link?
+
+> `optional` **link**: `string` \| `string`[]
+
+***
+
+### body
+
+> **body**: `ITenant`[]
+
+The list of tenants.

package/docs/reference/interfaces/ITenantRemoveRequest.md

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

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,6 +1,6 @@
 {
 	"name": "@twin.org/api-tenant-processor",
-	"version": "0.0.3-next.2",
+	"version": "0.0.3-next.20",
 	"description": "API Tenant Processor for converting and api key to a tenant id.",
 	"repository": {
 		"type": "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.20",
 		"@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.