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

package/docs/reference/classes/TenantProcessor.md

@@ -0,0 +1,99 @@
+# Class: TenantProcessor
+
+Handles incoming api keys and maps them to tenant ids.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new TenantProcessor**(`options?`): `TenantProcessor`
+
+Create a new instance of NodeTenantProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ITenantProcessorConstructorOptions`](../interfaces/ITenantProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`TenantProcessor`
+
+## 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
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre()
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+The route to process.
+
+`IBaseRoute` | `undefined`
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`

package/docs/reference/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the node tenant processor.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,22 @@
+# @twin.org/api-tenant-processor
+
+## Classes
+
+- [Tenant](classes/Tenant.md)
+- [TenantAdminService](classes/TenantAdminService.md)
+- [TenantIdContextIdHandler](classes/TenantIdContextIdHandler.md)
+- [TenantProcessor](classes/TenantProcessor.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)
+
+## Functions
+
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/ITenant.md

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,123 @@
+# 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.

package/docs/reference/interfaces/ITenantAdminServiceConfig.md

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

package/docs/reference/interfaces/ITenantAdminServiceConstructorOptions.md

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

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -0,0 +1,17 @@
+# Interface: ITenantProcessorConfig
+
+Configuration for the tenant processor
+
+## Properties
+
+### apiKeyName?
+
+> `optional` **apiKeyName**: `string`
+
+The key to look for in the header or query params for the api key.
+
+#### Default
+
+```ts
+x-api-key
+```

package/docs/reference/interfaces/ITenantProcessorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: ITenantProcessorConstructorOptions
+
+Options for the Tenant Processor constructor.
+
+## Properties
+
+### tenantEntityStorageType?
+
+> `optional` **tenantEntityStorageType**: `string`
+
+The entity storage for the tenants.
+
+#### Default
+
+```ts
+tenant
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`ITenantProcessorConfig`](ITenantProcessorConfig.md)
+
+Configuration for the processor.

package/locales/en.json

@@ -0,0 +1,8 @@
+{
+	"error": {
+		"tenantProcessor": {
+			"missingApiKey": "API key header or query param \"{keyName}\" is missing or invalid.",
+			"apiKeyNotFound": "No node tenant found for API key \"{key}\"."
+		}
+	}
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+	"name": "@twin.org/api-tenant-processor",
+	"version": "0.0.3-next.1",
+	"description": "API Tenant Processor for converting and api key to a tenant id.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/api.git",
+		"directory": "packages/api-tenant-processor"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "0.0.3-next.1",
+		"@twin.org/context": "next",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"node",
+		"tenant",
+		"foundation",
+		"utilities"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
+}