@twin.org/node-core 0.0.3-next.53 → 0.0.3-next.55

package/docs/changelog.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.0.3-next.55](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.54...node-core-v0.0.3-next.55) (2026-06-16)
+
+
+### Bug Fixes
+
+* test endpoints ([2b83ed0](https://github.com/iotaledger/twin-node/commit/2b83ed0d4f1da473a525a95202e01d9680c7d26c))
+* use async getStore in tests ([2189df4](https://github.com/iotaledger/twin-node/commit/2189df49a57637ba8effdee50965473f0a814c6c))
+
+## [0.0.3-next.54](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.53...node-core-v0.0.3-next.54) (2026-06-12)
+
+
+### Features
+
+* improved cli commands ([#206](https://github.com/iotaledger/twin-node/issues/206)) ([cf00850](https://github.com/iotaledger/twin-node/commit/cf0085023a66e187aaaaf3889128c845c73a1faf))
+
 ## [0.0.3-next.53](https://github.com/iotaledger/twin-node/compare/node-core-v0.0.3-next.52...node-core-v0.0.3-next.53) (2026-06-11)
 
 

package/docs/reference/functions/extensionsInitialiseEngine.md

@@ -22,4 +22,4 @@ The engine core instance.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when all extension engine initialisation methods have completed.

package/docs/reference/functions/extensionsInitialiseEngineServer.md

@@ -28,4 +28,4 @@ The engine server instance.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when all extension engine-server initialisation methods have completed.

package/docs/reference/functions/getScriptDirectory.md

@@ -16,4 +16,4 @@ The command line arguments.
 
 `string`
 
-The execution directory.
+The directory containing the entry-point script, or the current working directory if not determinable.

package/docs/reference/functions/initialiseLocales.md

@@ -15,3 +15,5 @@ The directory containing the locales.
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the locale dictionary has been loaded.

package/docs/reference/functions/isFederatedCatalogueRequired.md

@@ -2,8 +2,8 @@
 
 > **isFederatedCatalogueRequired**(`envVars`): `boolean`
 
-Checks if the immutable proof subsystem is required.
-Returns true when any component that depends on the immutable proof subsystem is enabled.
+Checks if the federated catalogue subsystem is required.
+Returns true when the catalogue is explicitly enabled, a remote endpoint is configured, filters are set, or dataspace is enabled.
 
 ## Parameters
 
@@ -17,4 +17,4 @@ The environment variables.
 
 `boolean`
 
-True if verifiable storage is enabled.
+True if the federated catalogue is required.

package/docs/reference/functions/isRightsManagementRequired.md

@@ -4,7 +4,7 @@
 
 Checks if the rights management subsystem is required.
 Returns true when any component that depends on the rights management subsystem is enabled.
-Note: rights management has no standalone enable flag — it is gated entirely on
+Note: rights management has no standalone enable flag - it is gated entirely on
 `dataspaceEnabled`. Setting `TWIN_RIGHTS_MANAGEMENT_*` env var in isolation does not
 enable the subsystem; `TWIN_DATASPACE_ENABLED` must also be true.
 

package/docs/reference/functions/loadJsonFile.md

@@ -22,4 +22,4 @@ The filename of the JSON file to load.
 
 `Promise`\<`T`\>
 
-The contents of the JSON file or null if it could not be loaded.
+The parsed JSON content of the file.

package/docs/reference/functions/loadTextFile.md

@@ -16,4 +16,4 @@ The filename of the text file to load.
 
 `Promise`\<`string`\>
 
-The contents of the text file if it could not be loaded.
+The contents of the text file as a UTF-8 string.

package/docs/reference/functions/processEnvOptions.md

@@ -20,7 +20,7 @@ The options.
 
 `void`
 
-The processed parameters.
+The substituted options, mutated in place with env variable values resolved.
 
 ## Throws
 

package/docs/reference/functions/registerCommands.md

@@ -2,7 +2,7 @@
 
 > **registerCommands**(): `void`
 
-Register available CLI commands.
+Register all built-in CLI command definitions into the shared command map.
 
 ## Returns
 

package/docs/reference/functions/shutdownExtensions.md

@@ -22,4 +22,4 @@ The engine core instance.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when all extension shutdown methods have completed.

package/docs/reference/interfaces/ICliArgs.md

@@ -1,6 +1,6 @@
 # Interface: ICliArgs
 
-Command to execute in the CLI.
+Parsed command line arguments passed to the CLI.
 
 ## Properties
 

package/docs/reference/interfaces/ICliCommand.md

@@ -1,6 +1,6 @@
 # Interface: ICliCommand
 
-Command to execute in the CLI.
+A resolved CLI command ready for execution, pairing a definition with its populated parameters.
 
 ## Properties
 

package/docs/reference/interfaces/ICliCommandDefinition.md

@@ -1,6 +1,6 @@
 # Interface: ICliCommandDefinition
 
-Command to execute in the CLI.
+Static definition of a CLI command including its name, parameters, and execution action.
 
 ## Properties
 
@@ -24,7 +24,7 @@ The command description.
 
 > **example**: `string`
 
-The example.
+An example invocation string shown in help output.
 
 ***
 

package/docs/reference/interfaces/ICliCommandDefinitionParam.md

@@ -1,6 +1,6 @@
 # Interface: ICliCommandDefinitionParam
 
-Command param to execute in the CLI.
+Definition of a single parameter accepted by a CLI command.
 
 ## Properties
 

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -40,14 +40,6 @@ The name of the state file.
 
 ***
 
-### nodeIdentityEnabled? {#nodeidentityenabled}
-
-> `optional` **nodeIdentityEnabled?**: `string`
-
-Does the node have a unique ID, defaults to true.
-
-***
-
 ### tenantEnabled? {#tenantenabled}
 
 > `optional` **tenantEnabled?**: `string`

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`
@@ -1872,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/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`
@@ -1908,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/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md

@@ -16,3 +16,5 @@ The engine core instance.
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the extension engine initialisation is complete.

package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md

@@ -22,3 +22,5 @@ The engine server instance.
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the extension engine-server initialisation is complete.

package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md

@@ -21,3 +21,5 @@ The node engine config.
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the extension configuration initialisation is complete.

package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md

@@ -8,3 +8,5 @@ This is called when the engine is shutting down.
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the extension shutdown is complete.

package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md

@@ -1,3 +1,5 @@
 # Variable: ATTESTATION\_VERIFICATION\_METHOD\_ID
 
 > `const` **ATTESTATION\_VERIFICATION\_METHOD\_ID**: `"attestation-assertion"` = `"attestation-assertion"`
+
+Default verification method fragment ID for attestation.

package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md

@@ -1,3 +1,5 @@
 # Variable: AUTH\_SIGNING\_KEY\_ID
 
 > `const` **AUTH\_SIGNING\_KEY\_ID**: `"auth-signing"` = `"auth-signing"`
+
+Default vault key ID used for signing authentication tokens.

package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md

@@ -1,3 +1,5 @@
 # Variable: BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID
 
 > `const` **BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID**: `"blob-encryption"` = `"blob-encryption"`
+
+Default vault key ID for blob storage encryption.

package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md

@@ -1,3 +1,5 @@
 # Variable: CONTEXT\_ID\_HANDLER\_FEATURE\_DID
 
 > `const` **CONTEXT\_ID\_HANDLER\_FEATURE\_DID**: `"did"` = `"did"`
+
+Feature tag identifying the DID context ID handler.

package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md

@@ -1,3 +1,5 @@
 # Variable: CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT
 
 > `const` **CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT**: `"tenant"` = `"tenant"`
+
+Feature tag identifying the tenant context ID handler.

package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md

@@ -1,3 +1,5 @@
 # Variable: IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID
 
 > `const` **IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID**: `"immutable-proof-assertion"` = `"immutable-proof-assertion"`
+
+Default verification method fragment ID for immutable proofs.

package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md

@@ -1,3 +1,5 @@
 # Variable: TRUST\_VERIFICATION\_METHOD\_ID
 
 > `const` **TRUST\_VERIFICATION\_METHOD\_ID**: `"trust-assertion"` = `"trust-assertion"`
+
+Default verification method fragment ID for trust assertions.

package/locales/en.json

@@ -18,10 +18,11 @@
 		},
 		"bootstrapLegacy": {
 			"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 bootstrap with the \"node-identity\" feature first."
+			"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.",
+			"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": {
@@ -61,8 +62,7 @@
 			"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}\"."
+			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
 		},
 		"removeTenantOrgAlias": {
 			"tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command.",
@@ -111,14 +111,12 @@
 						"nodeIdentityCreate": "Creating node identity",
 						"nodeAuthKeyCreate": "Creating node auth key",
 						"trustVerificationMethodCreate": "Creating trust verification method for organisation identity",
-						"nodeIdentitySet": "Setting node 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",
-						"tenantOrganizationIdSet": "Setting tenant organisation ID",
 						"adminIdentityCreate": "Creating admin user identity",
 						"adminUserCreate": "Creating admin user",
 						"tenantFallback": "No Node-labelled tenant found; using first available tenant"
@@ -155,6 +153,9 @@
 						"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)."
 						},
@@ -167,12 +168,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",
@@ -349,7 +350,8 @@
 					},
 					"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": {
@@ -398,7 +400,7 @@
 				},
 				"tenant-import": {
 					"description": "Import a tenant with associated api key",
-					"example": "tenant-import --tenant-id=\"0011..aabb\" --api-key=\"aabb..0099\" --label=\"My Tenant\" --public-origin=\"https://example.com:1234\"",
+					"example": "tenant-import --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_."
@@ -409,6 +411,9 @@
 						"api-key": {
 							"description": "The API key to associate with the tenant id."
 						},
+						"organization-id": {
+							"description": "The organization DID to associate with the tenant."
+						},
 						"label": {
 							"description": "A descriptive label for the tenant."
 						},
@@ -437,6 +442,9 @@
 						"api-key": {
 							"description": "The API key to associate with the tenant id."
 						},
+						"organization-id": {
+							"description": "The organization DID to associate with the tenant."
+						},
 						"label": {
 							"description": "A descriptive label for the tenant."
 						},

package/package.json

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