@3sixty/api-tenant-processor 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/ISingleTenantProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: ISingleTenantProcessorConstructorOptions
+
+Options for the Single Tenant Processor constructor.
+
+## Properties
+
+### config? {#config}
+
+> `optional` **config?**: [`ISingleTenantProcessorConfig`](ISingleTenantProcessorConfig.md)
+
+Configuration for the processor.

package/docs/reference/interfaces/ITenantAdminServiceConfig.md

@@ -0,0 +1,49 @@
+# Interface: ITenantAdminServiceConfig
+
+Configuration for the tenant admin service.
+
+## Properties
+
+### tenantCacheTtlMs? {#tenantcachettlms}
+
+> `optional` **tenantCacheTtlMs?**: `number`
+
+The time in milliseconds a tenant is kept in the in-memory lookup cache, counted from when it
+was read and not extended by use, set to 0 to disable caching. Entries are invalidated when a
+tenant is created, updated or removed through this service, but only in the process that made
+the change, so this is also the longest another node can serve a tenant that has been edited
+elsewhere.
+
+#### Default
+
+```ts
+30000
+```
+
+***
+
+### tenantCacheCapacity? {#tenantcachecapacity}
+
+> `optional` **tenantCacheCapacity?**: `number`
+
+The maximum number of tenant lookups to hold in the in-memory cache.
+
+#### Default
+
+```ts
+undefined (LfuCache default)
+```
+
+***
+
+### tenantCacheMutexTimeoutMs? {#tenantcachemutextimeoutms}
+
+> `optional` **tenantCacheMutexTimeoutMs?**: `number`
+
+Maximum time in milliseconds to wait for the tenant cache mutex during a cache population.
+
+#### Default
+
+```ts
+undefined (LfuCache default)
+```

package/docs/reference/interfaces/ITenantAdminServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: ITenantAdminServiceConstructorOptions
+
+Options for the Tenant Admin Service constructor.
+
+## Properties
+
+### tenantEntityStorageType? {#tenantentitystoragetype}
+
+> `optional` **tenantEntityStorageType?**: `string`
+
+The entity storage for the tenants.
+
+#### Default
+
+```ts
+tenant
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITenantAdminServiceConfig`](ITenantAdminServiceConfig.md)
+
+Configuration for the 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,36 @@
+# Interface: ITenantListRequest
+
+The list of tenants.
+
+## Properties
+
+### query {#query}
+
+> **query**: `object`
+
+The query parameters.
+
+#### conditions?
+
+> `optional` **conditions?**: `string`
+
+The condition for the query as JSON version of EntityCondition type.
+
+#### 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/ITenantOverrideProcessorConfig.md

@@ -0,0 +1,19 @@
+# Interface: ITenantOverrideProcessorConfig
+
+Configuration for the TenantOverrideProcessor.
+
+## Properties
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.
+
+***
+
+### escalatedPrivilegeScope? {#escalatedprivilegescope}
+
+> `optional` **escalatedPrivilegeScope?**: `string`
+
+The scope value that grants escalated privilege for cross-tenant access. Defaults to "global-admin".

package/docs/reference/interfaces/ITenantOverrideProcessorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: ITenantOverrideProcessorConstructorOptions
+
+Options for the TenantOverrideProcessor constructor.
+
+## Properties
+
+### tenantAdminComponentType? {#tenantadmincomponenttype}
+
+> `optional` **tenantAdminComponentType?**: `string`
+
+The component used to resolve tenants, which also provides the lookup caching.
+
+#### Default
+
+```ts
+tenant-admin
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITenantOverrideProcessorConfig`](ITenantOverrideProcessorConfig.md)
+
+Configuration for the processor.

package/docs/reference/interfaces/ITenantProcessorConfig.md

@@ -0,0 +1,33 @@
+# Interface: ITenantProcessorConfig
+
+Configuration for the tenant processor
+
+## Properties
+
+### apiKeyName? {#apikeyname}
+
+> `optional` **apiKeyName?**: `string`
+
+The key to look for in the header or query params for the api key.
+
+#### Default
+
+```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$"].
+
+***
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.

package/docs/reference/interfaces/ITenantProcessorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: ITenantProcessorConstructorOptions
+
+Options for the Tenant Processor constructor.
+
+## Properties
+
+### tenantAdminComponentType? {#tenantadmincomponenttype}
+
+> `optional` **tenantAdminComponentType?**: `string`
+
+The component used to resolve tenants, which also provides the lookup caching.
+
+#### Default
+
+```ts
+tenant-admin
+```
+
+***
+
+### 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/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

@@ -0,0 +1,24 @@
+{
+	"error": {
+		"tenantProcessor": {
+			"missingApiKey": "API key \"{keyName}\" is missing",
+			"missingOrganizationId": "Organization ID query parameter \"{paramName}\" is missing",
+			"apiKeyNotFound": "No tenant found for API key \"{key}\".",
+			"organizationIdNotFound": "No tenant found for organization ID \"{organizationId}\"."
+		},
+		"tenantOverrideProcessor": {
+			"insufficientScopeForTenantOverride": "Caller does not hold the required scope for tenant override.",
+			"tenantNotFound": "Tenant \"{notFoundId}\" not found."
+		},
+		"singleTenantProcessor": {
+			"invalidOrganizationId": "Organization ID query parameter \"{paramName}\" value \"{value}\" is not valid for this node"
+		},
+		"tenantAdminService": {
+			"apiKeyAlreadyInUse": "The provided API key is already in use by another tenant.",
+			"tenantAlreadyExists": "Tenant with ID \"{existingId}\" already exists.",
+			"tenantNotFound": "Tenant with ID \"{notFoundId}\" not found.",
+			"organizationIdAlreadyExists": "A tenant with organization ID \"{existingId}\" already exists.",
+			"publicOriginAlreadyExists": "A tenant with public origin \"{existingId}\" already exists."
+		}
+	}
+}

package/package.json

@@ -1,6 +1,58 @@
 {
-  "name": "@3sixty/api-tenant-processor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-tenant-processor",
+	"version": "0.20.0-next.0",
+	"description": "Tenant resolution services and route handlers that derive tenant context from API keys.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-tenant-processor"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "0.20.0-next.0",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/crypto": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/entity-storage-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/vault-models": "next",
+		"@3sixty/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/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}