@twin.org/node-core 0.0.3-next.52 → 0.0.3-next.54

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -60,18 +60,6 @@ The name of the state file.
 
 ***
 
-### nodeIdentityEnabled? {#nodeidentityenabled}
-
-> `optional` **nodeIdentityEnabled?**: `string`
-
-Does the node have a unique ID, defaults to true.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineEnvironmentVariables.md#nodeidentityenabled)
-
-***
-
 ### tenantEnabled? {#tenantenabled}
 
 > `optional` **tenantEnabled?**: `string`
@@ -866,6 +854,18 @@ The batch flush interval in seconds for the logging task, how often to flush the
 
 ***
 
+### loggingSilentComponents? {#loggingsilentcomponents}
+
+> `optional` **loggingSilentComponents?**: `string`
+
+A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingSilentComponents`](IEngineEnvironmentVariables.md#loggingsilentcomponents)
+
+***
+
 ### eventBusConnector? {#eventbusconnector}
 
 > `optional` **eventBusConnector?**: `string`
@@ -1394,6 +1394,18 @@ The type of the default data extractor, can be a comma separated list: json-path
 
 ***
 
+### taskSchedulerEnabled? {#taskschedulerenabled}
+
+> `optional` **taskSchedulerEnabled?**: `string`
+
+Enable the task scheduler regardless of which other components are active, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
+
+***
+
 ### auditableItemGraphEnabled? {#auditableitemgraphenabled}
 
 > `optional` **auditableItemGraphEnabled?**: `string`
@@ -1743,18 +1755,6 @@ This allows components that take a long time to initialize to be healthy before
 
 ***
 
-### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
-
-> `optional` **urlTransformerEncryptionKeyId?**: `string`
-
-The id of the key in the vault to use for encrypting parameters in url transformer.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`urlTransformerEncryptionKeyId`](IEngineEnvironmentVariables.md#urltransformerencryptionkeyid)
-
-***
-
 ### automationActionTypes? {#automationactiontypes}
 
 > `optional` **automationActionTypes?**: `string`
@@ -1860,6 +1860,14 @@ The id of the key in the vault to use for signing in auth operations.
 
 ***
 
+### authApiKeyHeader? {#authapikeyheader}
+
+> `optional` **authApiKeyHeader?**: `string`
+
+The HTTP header name used to pass the API key on requests, defaults to x-api-key.
+
+***
+
 ### hostingParamEncryptionKeyId? {#hostingparamencryptionkeyid}
 
 > `optional` **hostingParamEncryptionKeyId?**: `string`

package/docs/reference/interfaces/INodeEngineState.md

@@ -13,3 +13,12 @@ The engine state for the node.
 > `optional` **nodeId?**: `string`
 
 The identity for the node.
+
+***
+
+### nodeOrganizationId? {#nodeorganizationid}
+
+> `optional` **nodeOrganizationId?**: `string`
+
+This is the default organization used in the context ids when a user is not authenticated.
+It is not used in multi-tenant mode, which gets the organization from the tenant table.

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -56,18 +56,6 @@ The name of the state file.
 
 ***
 
-### nodeIdentityEnabled? {#nodeidentityenabled}
-
-> `optional` **nodeIdentityEnabled?**: `string`
-
-Does the node have a unique ID, defaults to true.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineServerEnvironmentVariables.md#nodeidentityenabled)
-
-***
-
 ### tenantEnabled? {#tenantenabled}
 
 > `optional` **tenantEnabled?**: `string`
@@ -862,6 +850,18 @@ The batch flush interval in seconds for the logging task, how often to flush the
 
 ***
 
+### loggingSilentComponents? {#loggingsilentcomponents}
+
+> `optional` **loggingSilentComponents?**: `string`
+
+A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`loggingSilentComponents`](IEngineServerEnvironmentVariables.md#loggingsilentcomponents)
+
+***
+
 ### eventBusConnector? {#eventbusconnector}
 
 > `optional` **eventBusConnector?**: `string`
@@ -1390,6 +1390,18 @@ The type of the default data extractor, can be a comma separated list: json-path
 
 ***
 
+### taskSchedulerEnabled? {#taskschedulerenabled}
+
+> `optional` **taskSchedulerEnabled?**: `string`
+
+Enable the task scheduler regardless of which other components are active, defaults to false.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineServerEnvironmentVariables.md#taskschedulerenabled)
+
+***
+
 ### auditableItemGraphEnabled? {#auditableitemgraphenabled}
 
 > `optional` **auditableItemGraphEnabled?**: `string`
@@ -1739,18 +1751,6 @@ This allows components that take a long time to initialize to be healthy before
 
 ***
 
-### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
-
-> `optional` **urlTransformerEncryptionKeyId?**: `string`
-
-The id of the key in the vault to use for encrypting parameters in url transformer.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`urlTransformerEncryptionKeyId`](IEngineServerEnvironmentVariables.md#urltransformerencryptionkeyid)
-
-***
-
 ### automationActionTypes? {#automationactiontypes}
 
 > `optional` **automationActionTypes?**: `string`
@@ -1896,6 +1896,18 @@ The id of the key in the vault to use for signing in auth operations.
 
 ***
 
+### authApiKeyHeader? {#authapikeyheader}
+
+> `optional` **authApiKeyHeader?**: `string`
+
+The HTTP header name used to pass the API key on requests, defaults to x-api-key.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`authApiKeyHeader`](IEngineServerEnvironmentVariables.md#authapikeyheader)
+
+***
+
 ### hostingParamEncryptionKeyId? {#hostingparamencryptionkeyid}
 
 > `optional` **hostingParamEncryptionKeyId?**: `string`

package/locales/en.json

@@ -2,6 +2,8 @@
 	"error": {
 		"node": {
 			"nodeIdentityNotSet": "The node identity is enabled in config but is not set, please set it using the \"node-set-identity\" CLI command.",
+			"nodeOrganizationIdNotSet": "The node organization is not set, please set it using the \"set-node-org-id\".",
+			"tenantsWithoutOrganizationId": "The following tenants have no organization ID assigned. Use the \"set-tenant-org-id\" command to assign one before starting the node: {tenantIds}",
 			"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file",
 			"extensionLoadingError": "Failed to load extension \"{extension}\"",
 			"insecureProtocol": "Cannot load extension from insecure protocol: {protocol}. Only HTTPS is allowed for remote extensions.",
@@ -15,10 +17,13 @@
 			"invalidPublicOrigin": "The public origin \"{publicOrigin}\" is not a valid origin URL, it should be in the format \"protocol://host[:port]\"."
 		},
 		"bootstrapLegacy": {
-			"noFeaturesEnabled": "No features are enabled in legacy bootstrap mode, at least one feature must be enabled."
+			"noFeaturesEnabled": "No features are enabled in legacy bootstrap mode, at least one feature must be enabled.",
+			"organizationNotSet": "The organisation identity has not been set. Run \"set-node-org-id\"."
 		},
 		"identityCreate": {
-			"invalidMnemonic": "The mnemonic is invalid, it should be 24 words from the standard wordlist."
+			"invalidMnemonic": "The mnemonic is invalid, it should be 24 words from the standard wordlist.",
+			"onlyOneAssignmentOptionAllowed": "Only one of node-id, node-organization-id, or tenant-organization-id can be set at the same time.",
+			"nodeOrganizationIdNotAvailableInMultiTenantMode": "The node-organization-id option is not available in multi-tenant mode, use tenant-organization-id instead."
 		},
 		"identityImport": {
 			"identityNotFound": "The identity was not found, it must be created on-chain already.",
@@ -33,11 +38,6 @@
 		"tenantCreate": {
 			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
 		},
-		"tenantToken": {
-			"tenantIdOrApiKeyRequired": "Either a tenant ID or an API key must be provided.",
-			"urlTransformerComponentNotRegistered": "The URL transformer component is not registered, ensure the node is configured correctly.",
-			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
-		},
 		"tenantImport": {
 			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
 		},
@@ -57,6 +57,17 @@
 		},
 		"nodeSetIdentity": {
 			"identityNotFound": "The identity with DID \"{notFoundId}\" was not found in the system."
+		},
+		"setNodeOrgId": {
+			"notAvailableInMultiTenantMode": "The set-node-org-id command is not available in multi-tenant mode, use set-tenant-org-id instead."
+		},
+		"applyOrganizationIdToTenant": {
+			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command.",
+			"organizationIdAlreadyInUse": "The organization ID \"{organizationId}\" is already assigned to tenant \"{conflictingTenantId}\"."
+		},
+		"removeTenantOrgAlias": {
+			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command.",
+			"aliasNotFound": "The alias \"{alias}\" was not found in the tenant organization legacy list."
 		}
 	},
 	"node": {
@@ -71,6 +82,7 @@
 		"extensionHttpsDownloading": "Downloading HTTPS extension",
 		"extensionCacheExpired": "Cache expired for extension: {url}",
 		"extensionForceRefresh": "Force refresh enabled for extension: {url}",
+		"tenantOrganizationIdAutoAssigned": "Legacy migration: automatically assigned organization ID \"{organizationId}\" to tenant \"{tenantId}\".",
 		"cli": {
 			"commands": {
 				"command": "Command",
@@ -99,16 +111,16 @@
 					"labels": {
 						"nodeIdentityCreate": "Creating node identity",
 						"nodeAuthKeyCreate": "Creating node auth key",
-						"trustVerificationMethodCreate": "Creating trust verification method for node identity",
-						"nodeIdentitySet": "Setting node identity",
+						"trustVerificationMethodCreate": "Creating trust verification method for organisation identity",
 						"nodeTenantCreate": "Creating node tenant",
 						"organisationCreate": "Creating organisation identity",
 						"blobStorageKeyCreate": "Creating blob storage encryption key for organisation identity",
 						"attestationMethodCreate": "Creating attestation method for organisation identity",
 						"immutableProofMethodCreate": "Creating immutable proof method for organisation identity",
+						"nodeOrganizationIdSet": "Setting node organisation ID",
 						"adminIdentityCreate": "Creating admin user identity",
 						"adminUserCreate": "Creating admin user",
-						"urlTransformParamKeyAdd": "Adding URL transform parameter encryption key"
+						"tenantFallback": "No Node-labelled tenant found; using first available tenant"
 					}
 				},
 				"identity-create": {
@@ -141,6 +153,15 @@
 						},
 						"output-env-prefix": {
 							"description": "Prefix to use for variables in the output .env file."
+						},
+						"node-id": {
+							"description": "If true, set the created identity DID as the node identity."
+						},
+						"node-organization-id": {
+							"description": "If true, set the created identity DID as the node organization ID (not available in multi-tenant mode)."
+						},
+						"tenant-organization-id": {
+							"description": "The tenant ID to set the created identity DID as the organization ID for (requires multi-tenant mode)."
 						}
 					},
 					"labels": {
@@ -148,12 +169,12 @@
 						"processingMnemonic": "Processing mnemonic",
 						"readingMnemonic": "Reading mnemonic",
 						"storingMnemonic": "Storing mnemonic",
-						"existingMnemonic": "Mnemonic already exists",
+						"existingMnemonic": "Mnemonic already exists, skipping creation",
 						"noExistingMnemonic": "No existing mnemonic found",
 						"generatingMnemonic": "Generating mnemonic",
 						"processingIdentity": "Processing identity",
 						"resolvingIdentity": "Resolving identity",
-						"existingIdentity": "Identity already exists",
+						"existingIdentity": "Identity already exists, skipping creation",
 						"noIdentityFound": "No identity found",
 						"creatingIdentity": "Creating identity",
 						"createdIdentity": "Created identity",
@@ -330,12 +351,13 @@
 					},
 					"labels": {
 						"resolvingIdentity": "Resolving identity",
-						"stored": "The node identity has been stored"
+						"stored": "The node identity has been stored",
+						"skipping": "The node identity has not changed, skipping"
 					}
 				},
 				"tenant-create": {
 					"description": "Create a tenant with associated api key",
-					"example": "tenant-create --tenant-id=\"0011..aabb\" --api-key=\"aabb..0099\" --label=\"My Tenant\" --public-origin=\"https://example.com:1234\"",
+					"example": "tenant-create --tenant-id=\"0011..aabb\" --api-key=\"aabb..0099\" --organization-id=\"did:iota:...\" --label=\"My Tenant\" --public-origin=\"https://example.com:1234\"",
 					"params": {
 						"env-prefix": {
 							"description": "Prefix to use for standard .env files e.g. TWIN_."
@@ -346,6 +368,9 @@
 						"api-key": {
 							"description": "The API key to associate with the tenant id. If not provided, a random key will be generated."
 						},
+						"organization-id": {
+							"description": "The organization DID to associate with the tenant."
+						},
 						"label": {
 							"description": "A descriptive label for the tenant."
 						},
@@ -369,6 +394,7 @@
 						"creating": "Creating tenant",
 						"tenantId": "Tenant ID",
 						"apiKey": "API Key",
+						"organizationId": "Organization ID",
 						"label": "Label",
 						"publicOrigin": "Public Origin"
 					}
@@ -429,30 +455,6 @@
 						"updated": "Updated tenant"
 					}
 				},
-				"tenant-token": {
-					"description": "Generate the x-enc-tenant-token token value for a tenant",
-					"example": "tenant-token --tenant-id=\"0011..aabb\"",
-					"params": {
-						"tenant-id": {
-							"description": "The tenant ID to generate the token for."
-						},
-						"api-key": {
-							"description": "The API key to look up the tenant ID from."
-						},
-						"load-env": {
-							"description": "Comma separated list of paths to .env files to read input parameters from."
-						},
-						"output-json": {
-							"description": "Path to a .json file to store the command output."
-						}
-					},
-					"labels": {
-						"lookingUp": "Looking up tenant",
-						"generating": "Generating tenant token",
-						"tenantId": "Tenant ID",
-						"token": "Token"
-					}
-				},
 				"user-create": {
 					"description": "Create a user",
 					"example": "user-create --user-identity=\"did:iota:....\" --organization-identity=\"did:iota:....\" --email=\"bob@examples.com\" --password=\"pass1234\" --scope=\"tenant-admin\" --givenName=\"Bob\" --familyName=\"Smith\"",
@@ -595,6 +597,69 @@
 						"publicKeyHex": "Public Key Hex"
 					}
 				},
+				"set-node-org-id": {
+					"description": "Set the node organization ID",
+					"example": "set-node-org-id --organization-id=\"did:iota:...\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"organization-id": {
+							"description": "The organization DID to set as the node organization ID."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"stored": "The node organization ID has been stored"
+					}
+				},
+				"set-tenant-org-id": {
+					"description": "Set the organization ID for a tenant",
+					"example": "set-tenant-org-id --tenant-id=\"0011..aabb\" --organization-id=\"did:iota:...\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"tenant-id": {
+							"description": "The tenant ID to update."
+						},
+						"organization-id": {
+							"description": "The organization DID to set as the tenant organization ID."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"updating": "Updating tenant organization ID",
+						"stored": "The tenant organization ID has been stored"
+					}
+				},
+				"remove-tenant-org-alias": {
+					"description": "Remove an alias from the tenant organization ID legacy list",
+					"example": "remove-tenant-org-alias --tenant-id=\"0011..aabb\" --alias=\"did:iota:...\"",
+					"params": {
+						"env-prefix": {
+							"description": "Prefix to use for standard .env files e.g. TWIN_."
+						},
+						"tenant-id": {
+							"description": "The tenant ID to update."
+						},
+						"alias": {
+							"description": "The organization DID alias to remove from the legacy list."
+						},
+						"load-env": {
+							"description": "Comma separated list of paths to .env files to read input parameters from."
+						}
+					},
+					"labels": {
+						"reading": "Reading tenant",
+						"updating": "Removing alias from tenant organization legacy list",
+						"removed": "The alias has been removed from the tenant organization legacy list"
+					}
+				},
 				"vault-key-import": {
 					"description": "Import a vault key for an identity",
 					"example": "vault-key-import --identity=\"did:iota:....\" --key-id=\"my-key\" --key-type=Ed25519 --private-key-hex=\"15...a2\"",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.3-next.52",
+	"version": "0.0.3-next.54",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",

package/dist/es/commands/tenantToken.js

@@ -1,97 +0,0 @@
-import { CLIDisplay, CLIUtils } from "@twin.org/cli-core";
-import { ComponentFactory, GeneralError, Guards, I18n, Is } from "@twin.org/core";
-const COMMAND_NAME = "tenant-token";
-/**
- * Get the command definition parameters.
- * @param commandDefinitions The registered command definitions.
- */
-export function getCommandDefinitionTenantToken(commandDefinitions) {
-    commandDefinitions[COMMAND_NAME] = {
-        command: COMMAND_NAME,
-        description: I18n.formatMessage("node.cli.commands.tenant-token.description"),
-        example: I18n.formatMessage("node.cli.commands.tenant-token.example"),
-        params: [
-            {
-                key: "tenant-id",
-                type: "string",
-                extendedType: "hex(32)",
-                description: I18n.formatMessage("node.cli.commands.tenant-token.params.tenant-id.description"),
-                required: false
-            },
-            {
-                key: "api-key",
-                type: "string",
-                extendedType: "hex(32)",
-                description: I18n.formatMessage("node.cli.commands.tenant-token.params.api-key.description"),
-                required: false
-            },
-            {
-                key: "load-env",
-                type: "string",
-                description: I18n.formatMessage("node.cli.commands.tenant-token.params.load-env.description"),
-                required: false
-            },
-            {
-                key: "output-json",
-                type: "string",
-                description: I18n.formatMessage("node.cli.commands.tenant-token.params.output-json.description"),
-                required: false
-            }
-        ],
-        action: async (engineCore, envVars, params) => tenantToken(engineCore, envVars, params)
-    };
-}
-/**
- * Command for generating the x-enc-tenant-token token value for a tenant.
- * @param engineCore The engine core.
- * @param envVars The environment variables for the node.
- * @param params The parameters for the command.
- * @param params.tenantId The tenant ID to generate the token for.
- * @param params.apiKey The API key to look up the tenant ID from.
- * @param params.outputJson The output .json file to store the command output.
- * @returns The tenant ID and generated encrypted token.
- */
-export async function tenantToken(engineCore, envVars, params) {
-    if (!Is.stringValue(params.tenantId) && !Is.stringValue(params.apiKey)) {
-        throw new GeneralError("tenantToken", "tenantIdOrApiKeyRequired");
-    }
-    if (Is.stringValue(params.tenantId)) {
-        Guards.stringHexLength("tenantToken", "tenant-id", params.tenantId, 32);
-    }
-    if (Is.stringValue(params.apiKey)) {
-        Guards.stringHexLength("tenantToken", "api-key", params.apiKey, 32);
-    }
-    const urlTransformerComponentType = engineCore.getRegisteredInstanceTypeOptional("urlTransformerComponent");
-    if (!Is.stringValue(urlTransformerComponentType)) {
-        throw new GeneralError("tenantToken", "urlTransformerComponentNotRegistered");
-    }
-    const urlTransformer = ComponentFactory.get(urlTransformerComponentType);
-    // CLI commands skip component starts (engineCore.start(true)), so the URL transformer
-    // service's _nodeId is never initialized. Starting it here within the ContextIdStore
-    // context (set by executeCommand) lets it pick up the nodeId correctly.
-    await urlTransformer.start?.();
-    let tenantId = params.tenantId;
-    if (!Is.stringValue(tenantId)) {
-        const tenantAdminServiceComponentType = engineCore.getRegisteredInstanceTypeOptional("tenantAdminComponent");
-        if (!Is.stringValue(tenantAdminServiceComponentType)) {
-            throw new GeneralError("tenantToken", "tenantAdminComponentNotRegistered");
-        }
-        const tenantAdminService = ComponentFactory.get(tenantAdminServiceComponentType);
-        CLIDisplay.task(I18n.formatMessage("node.cli.commands.tenant-token.labels.lookingUp"));
-        const tenant = await tenantAdminService.getByApiKey(params.apiKey);
-        tenantId = tenant.id;
-    }
-    CLIDisplay.task(I18n.formatMessage("node.cli.commands.tenant-token.labels.generating"));
-    const token = await urlTransformer.encryptParam(tenantId);
-    CLIDisplay.break();
-    CLIDisplay.value(I18n.formatMessage("node.cli.commands.tenant-token.labels.tenantId"), tenantId);
-    CLIDisplay.value(I18n.formatMessage("node.cli.commands.tenant-token.labels.token"), token);
-    CLIDisplay.break();
-    const json = { tenantId, token };
-    if (Is.stringValue(params.outputJson)) {
-        await CLIUtils.writeJsonFile(params.outputJson, json, false);
-    }
-    CLIDisplay.done();
-    return json;
-}
-//# sourceMappingURL=tenantToken.js.map

package/dist/es/commands/tenantToken.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tenantToken.js","sourceRoot":"","sources":["../../../src/commands/tenantToken.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAKlF,MAAM,YAAY,GAAG,cAAc,CAAC;AAEpC;;;GAGG;AACH,MAAM,UAAU,+BAA+B,CAAC,kBAE/C;IACA,kBAAkB,CAAC,YAAY,CAAC,GAAG;QAClC,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,4CAA4C,CAAC;QAC7E,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,wCAAwC,CAAC;QACrE,MAAM,EAAE;YACP;gBACC,GAAG,EAAE,WAAW;gBAChB,IAAI,EAAE,QAAQ;gBACd,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,IAAI,CAAC,aAAa,CAC9B,6DAA6D,CAC7D;gBACD,QAAQ,EAAE,KAAK;aACf;YACD;gBACC,GAAG,EAAE,SAAS;gBACd,IAAI,EAAE,QAAQ;gBACd,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,IAAI,CAAC,aAAa,CAC9B,2DAA2D,CAC3D;gBACD,QAAQ,EAAE,KAAK;aACf;YACD;gBACC,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,IAAI,CAAC,aAAa,CAC9B,4DAA4D,CAC5D;gBACD,QAAQ,EAAE,KAAK;aACf;YACD;gBACC,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,IAAI,CAAC,aAAa,CAC9B,+DAA+D,CAC/D;gBACD,QAAQ,EAAE,KAAK;aACf;SACD;QACD,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC;KACvF,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAChC,UAAuB,EACvB,OAAkC,EAClC,MAIC;IAED,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC;IACnE,CAAC;IAED,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,eAAe,CAAC,aAAa,EAAE,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,CAAC,eAAe,CAAC,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,2BAA2B,GAChC,UAAU,CAAC,iCAAiC,CAAC,yBAAyB,CAAC,CAAC;IAEzE,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,2BAA2B,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,sCAAsC,CAAC,CAAC;IAC/E,CAAC;IAED,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAC1C,2BAA2B,CAC3B,CAAC;IAEF,sFAAsF;IACtF,qFAAqF;IACrF,wEAAwE;IACxE,MAAM,cAAc,CAAC,KAAK,EAAE,EAAE,CAAC;IAE/B,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IAE/B,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,MAAM,+BAA+B,GACpC,UAAU,CAAC,iCAAiC,CAAC,sBAAsB,CAAC,CAAC;QAEtE,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,+BAA+B,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,YAAY,CAAC,aAAa,EAAE,mCAAmC,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,GAAG,CAC9C,+BAA+B,CAC/B,CAAC;QAEF,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,iDAAiD,CAAC,CAAC,CAAC;QAEvF,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;QAC7E,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAC;IACtB,CAAC;IAED,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,kDAAkD,CAAC,CAAC,CAAC;IAExF,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAE1D,UAAU,CAAC,KAAK,EAAE,CAAC;IACnB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,gDAAgD,CAAC,EAAE,QAAQ,CAAC,CAAC;IACjG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,6CAA6C,CAAC,EAAE,KAAK,CAAC,CAAC;IAC3F,UAAU,CAAC,KAAK,EAAE,CAAC;IAEnB,MAAM,IAAI,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QACvC,MAAM,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED,UAAU,CAAC,IAAI,EAAE,CAAC;IAElB,OAAO,IAAI,CAAC;AACb,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITenantAdminComponent, IUrlTransformerComponent } from \"@twin.org/api-models\";\nimport { CLIDisplay, CLIUtils } from \"@twin.org/cli-core\";\nimport { ComponentFactory, GeneralError, Guards, I18n, Is } from \"@twin.org/core\";\nimport type { IEngineCore } from \"@twin.org/engine-models\";\nimport type { ICliCommandDefinition } from \"../models/ICliCommandDefinition.js\";\nimport type { INodeEnvironmentVariables } from \"../models/INodeEnvironmentVariables.js\";\n\nconst COMMAND_NAME = \"tenant-token\";\n\n/**\n * Get the command definition parameters.\n * @param commandDefinitions The registered command definitions.\n */\nexport function getCommandDefinitionTenantToken(commandDefinitions: {\n\t[id: string]: ICliCommandDefinition;\n}): void {\n\tcommandDefinitions[COMMAND_NAME] = {\n\t\tcommand: COMMAND_NAME,\n\t\tdescription: I18n.formatMessage(\"node.cli.commands.tenant-token.description\"),\n\t\texample: I18n.formatMessage(\"node.cli.commands.tenant-token.example\"),\n\t\tparams: [\n\t\t\t{\n\t\t\t\tkey: \"tenant-id\",\n\t\t\t\ttype: \"string\",\n\t\t\t\textendedType: \"hex(32)\",\n\t\t\t\tdescription: I18n.formatMessage(\n\t\t\t\t\t\"node.cli.commands.tenant-token.params.tenant-id.description\"\n\t\t\t\t),\n\t\t\t\trequired: false\n\t\t\t},\n\t\t\t{\n\t\t\t\tkey: \"api-key\",\n\t\t\t\ttype: \"string\",\n\t\t\t\textendedType: \"hex(32)\",\n\t\t\t\tdescription: I18n.formatMessage(\n\t\t\t\t\t\"node.cli.commands.tenant-token.params.api-key.description\"\n\t\t\t\t),\n\t\t\t\trequired: false\n\t\t\t},\n\t\t\t{\n\t\t\t\tkey: \"load-env\",\n\t\t\t\ttype: \"string\",\n\t\t\t\tdescription: I18n.formatMessage(\n\t\t\t\t\t\"node.cli.commands.tenant-token.params.load-env.description\"\n\t\t\t\t),\n\t\t\t\trequired: false\n\t\t\t},\n\t\t\t{\n\t\t\t\tkey: \"output-json\",\n\t\t\t\ttype: \"string\",\n\t\t\t\tdescription: I18n.formatMessage(\n\t\t\t\t\t\"node.cli.commands.tenant-token.params.output-json.description\"\n\t\t\t\t),\n\t\t\t\trequired: false\n\t\t\t}\n\t\t],\n\t\taction: async (engineCore, envVars, params) => tenantToken(engineCore, envVars, params)\n\t};\n}\n\n/**\n * Command for generating the x-enc-tenant-token token value for a tenant.\n * @param engineCore The engine core.\n * @param envVars The environment variables for the node.\n * @param params The parameters for the command.\n * @param params.tenantId The tenant ID to generate the token for.\n * @param params.apiKey The API key to look up the tenant ID from.\n * @param params.outputJson The output .json file to store the command output.\n * @returns The tenant ID and generated encrypted token.\n */\nexport async function tenantToken(\n\tengineCore: IEngineCore,\n\tenvVars: INodeEnvironmentVariables,\n\tparams: {\n\t\ttenantId?: string;\n\t\tapiKey?: string;\n\t\toutputJson?: string;\n\t}\n): Promise<{ tenantId: string; token: string }> {\n\tif (!Is.stringValue(params.tenantId) && !Is.stringValue(params.apiKey)) {\n\t\tthrow new GeneralError(\"tenantToken\", \"tenantIdOrApiKeyRequired\");\n\t}\n\n\tif (Is.stringValue(params.tenantId)) {\n\t\tGuards.stringHexLength(\"tenantToken\", \"tenant-id\", params.tenantId, 32);\n\t}\n\n\tif (Is.stringValue(params.apiKey)) {\n\t\tGuards.stringHexLength(\"tenantToken\", \"api-key\", params.apiKey, 32);\n\t}\n\n\tconst urlTransformerComponentType =\n\t\tengineCore.getRegisteredInstanceTypeOptional(\"urlTransformerComponent\");\n\n\tif (!Is.stringValue(urlTransformerComponentType)) {\n\t\tthrow new GeneralError(\"tenantToken\", \"urlTransformerComponentNotRegistered\");\n\t}\n\n\tconst urlTransformer = ComponentFactory.get<IUrlTransformerComponent>(\n\t\turlTransformerComponentType\n\t);\n\n\t// CLI commands skip component starts (engineCore.start(true)), so the URL transformer\n\t// service's _nodeId is never initialized. Starting it here within the ContextIdStore\n\t// context (set by executeCommand) lets it pick up the nodeId correctly.\n\tawait urlTransformer.start?.();\n\n\tlet tenantId = params.tenantId;\n\n\tif (!Is.stringValue(tenantId)) {\n\t\tconst tenantAdminServiceComponentType =\n\t\t\tengineCore.getRegisteredInstanceTypeOptional(\"tenantAdminComponent\");\n\n\t\tif (!Is.stringValue(tenantAdminServiceComponentType)) {\n\t\t\tthrow new GeneralError(\"tenantToken\", \"tenantAdminComponentNotRegistered\");\n\t\t}\n\n\t\tconst tenantAdminService = ComponentFactory.get<ITenantAdminComponent>(\n\t\t\ttenantAdminServiceComponentType\n\t\t);\n\n\t\tCLIDisplay.task(I18n.formatMessage(\"node.cli.commands.tenant-token.labels.lookingUp\"));\n\n\t\tconst tenant = await tenantAdminService.getByApiKey(params.apiKey as string);\n\t\ttenantId = tenant.id;\n\t}\n\n\tCLIDisplay.task(I18n.formatMessage(\"node.cli.commands.tenant-token.labels.generating\"));\n\n\tconst token = await urlTransformer.encryptParam(tenantId);\n\n\tCLIDisplay.break();\n\tCLIDisplay.value(I18n.formatMessage(\"node.cli.commands.tenant-token.labels.tenantId\"), tenantId);\n\tCLIDisplay.value(I18n.formatMessage(\"node.cli.commands.tenant-token.labels.token\"), token);\n\tCLIDisplay.break();\n\n\tconst json = { tenantId, token };\n\tif (Is.stringValue(params.outputJson)) {\n\t\tawait CLIUtils.writeJsonFile(params.outputJson, json, false);\n\t}\n\n\tCLIDisplay.done();\n\n\treturn json;\n}\n"]}

package/dist/types/commands/tenantToken.d.ts

@@ -1,28 +0,0 @@
-import type { IEngineCore } from "@twin.org/engine-models";
-import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
-import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
-/**
- * Get the command definition parameters.
- * @param commandDefinitions The registered command definitions.
- */
-export declare function getCommandDefinitionTenantToken(commandDefinitions: {
-    [id: string]: ICliCommandDefinition;
-}): void;
-/**
- * Command for generating the x-enc-tenant-token token value for a tenant.
- * @param engineCore The engine core.
- * @param envVars The environment variables for the node.
- * @param params The parameters for the command.
- * @param params.tenantId The tenant ID to generate the token for.
- * @param params.apiKey The API key to look up the tenant ID from.
- * @param params.outputJson The output .json file to store the command output.
- * @returns The tenant ID and generated encrypted token.
- */
-export declare function tenantToken(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
-    tenantId?: string;
-    apiKey?: string;
-    outputJson?: string;
-}): Promise<{
-    tenantId: string;
-    token: string;
-}>;

package/docs/reference/functions/isUrlTransformerRequired.md

@@ -1,20 +0,0 @@
-# Function: isUrlTransformerRequired()
-
-> **isUrlTransformerRequired**(`envVars`): `boolean`
-
-Checks if the URL transformer subsystem is required.
-Returns true when any component that depends on the URL transformer subsystem is enabled.
-
-## Parameters
-
-### envVars
-
-[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
-
-The environment variables.
-
-## Returns
-
-`boolean`
-
-True if rights-management, dataspace, federated-catalogue, tenant, or auth entity storage is enabled.

package/docs/reference/variables/URL_TRANSFORMER_ENCRYPTION_KEY_ID.md

@@ -1,3 +0,0 @@
-# Variable: URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID
-
-> `const` **URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID**: `"param-encryption"` = `"param-encryption"`