@twin.org/node-core 0.0.3-next.1 → 0.0.3-next.10

package/dist/types/models/ICliCommand.d.ts

@@ -0,0 +1,17 @@
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+import type { ICliCommandDefinition } from "./ICliCommandDefinition.js";
+/**
+ * Command to execute in the CLI.
+ */
+export interface ICliCommand {
+    /**
+     * The command to execute.
+     */
+    definition: ICliCommandDefinition;
+    /**
+     * The params to execute the command with.
+     */
+    params: {
+        [id: string]: CliCommandParamType;
+    };
+}

package/dist/types/models/ICliCommandDefinition.d.ts

@@ -0,0 +1,46 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+import type { ICliCommandDefinitionParam } from "./ICliCommandDefinitionParam.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
+/**
+ * Command to execute in the CLI.
+ */
+export interface ICliCommandDefinition {
+    /**
+     * The command name.
+     */
+    command: string;
+    /**
+     * The command description.
+     */
+    description: string;
+    /**
+     * The example.
+     */
+    example: string;
+    /**
+     * The params available for the command.
+     */
+    params: ICliCommandDefinitionParam[];
+    /**
+     * The method to execute for the command.
+     */
+    action: (engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+        [id: string]: CliCommandParamType;
+    }) => Promise<unknown>;
+    /**
+     * Indicates whether the engine needs to be started before executing the command.
+     * @default true
+     */
+    requiresEngineStarted?: boolean;
+    /**
+     * Indicates whether the engine needs the node identity to be set if configured to use.
+     * @default true
+     */
+    requiresNodeIdentity?: boolean;
+    /**
+     * Indicates whether the engine needs the tenant id to be set if configured to use.
+     * @default true
+     */
+    requiresTenantId?: boolean;
+}

package/dist/types/models/ICliCommandDefinitionParam.d.ts

@@ -0,0 +1,35 @@
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+/**
+ * Command param to execute in the CLI.
+ */
+export interface ICliCommandDefinitionParam {
+    /**
+     * The param key.
+     */
+    key: string;
+    /**
+     * The param type.
+     */
+    type: "string" | "number" | "boolean";
+    /**
+     * Possible options for the param.
+     */
+    options?: string[];
+    /**
+     * The extended type e.g. hex etc.
+     */
+    extendedType?: string;
+    /**
+     * Whether the param is required.
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * The default value of the param.
+     */
+    defaultValue?: CliCommandParamType;
+    /**
+     * The param description.
+     */
+    description: string;
+}

package/dist/types/models/IEngineEnvironmentVariables.d.ts

@@ -6,6 +6,10 @@ export interface IEngineEnvironmentVariables {
      * Start the engine in debug mode.
      */
     debug?: string;
+    /**
+     * Start the engine in silent mode.
+     */
+    silent?: string;
     /**
      * The root directory for storing items like state file.
      */
@@ -15,17 +19,13 @@ export interface IEngineEnvironmentVariables {
      */
     stateFilename?: string;
     /**
-     * Is multi-tenant support enabled, defaults to false.
+     * Does the node have a unique ID, defaults to true.
      */
-    tenantEnabled?: string;
+    nodeIdentityEnabled?: string;
     /**
-     * A tenant id to use as a default for the node.
-     */
-    tenantId?: string;
-    /**
-     * A tenant api key to use as a default for the node.
+     * Is multi-tenant support enabled, defaults to false.
      */
-    tenantApiKey?: string;
+    tenantEnabled?: string;
     /**
      * The type of the entity storage to create, comma separate for more than one connector.
      * values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
@@ -59,6 +59,10 @@ export interface IEngineEnvironmentVariables {
      * AWS Dynamo DB secret access key.
      */
     awsDynamodbSecretAccessKey?: string;
+    /**
+     * AWS Dynamo DB connection timeout.
+     */
+    awsDynamodbConnectionTimeoutMs?: string;
     /**
      * Azure Cosmos DB key.
      */
@@ -200,11 +204,6 @@ export interface IEngineEnvironmentVariables {
      * The id of the encryption key for the blob storage.
      */
     blobStorageEncryptionKeyId?: string;
-    /**
-     * A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
-     * If encryption is enabled but a key is not provided one will be generated.
-     */
-    blobStorageSymmetricEncryptionKey?: string;
     /**
      * A prefix for all the blobs in blob-storage, can be empty.
      */
@@ -281,10 +280,6 @@ export interface IEngineEnvironmentVariables {
      * The type of logging task connector, can be a comma separated list: console, entity-storage.
      */
     loggingConnector?: string;
-    /**
-     * The type of background task connector: entity-storage.
-     */
-    backgroundTaskConnector?: string;
     /**
      * The type of event bus connector: local.
      */
@@ -353,6 +348,10 @@ export interface IEngineEnvironmentVariables {
      * The type of identity connector: entity-storage, iota.
      */
     identityConnector?: string;
+    /**
+     * The index of the wallet address to use, defaults to 0.
+     */
+    identityWalletAddressIndex?: string;
     /**
      * The type of identity resolver connector: entity-storage, iota.
      */
@@ -482,13 +481,26 @@ export interface IEngineEnvironmentVariables {
      */
     federatedCatalogueEnabled?: string;
     /**
-     * Federated catalog TTL for the cache.
+     * Federated catalog filters, command separated list of filters to add.
+     */
+    federatedCatalogueFilters?: string;
+    /**
+     * Is the trust management enabled, defaults to false.
+     */
+    trustEnabled?: string;
+    /**
+     * The trust generators to add to the factory, comma separated list.
+     */
+    trustGenerators?: string;
+    /**
+     * The trust verifiers to add to the factory, comma separated list.
      */
-    federatedCatalogueCacheTtlMs?: number;
+    trustVerifiers?: string;
     /**
-     * Federated catalog clearing house approver list, stringified array of DIDs.
+     * The verification method to use for trust identities.
+     * Defaults to node-authentication-assertion.
      */
-    federatedCatalogueClearingHouseApproverList?: string;
+    trustVerificationMethodId?: string;
     /**
      * Is the rights management enabled, defaults to false.
      */
@@ -498,40 +510,37 @@ export interface IEngineEnvironmentVariables {
      */
     rightsManagementBaseCallbackUrl?: string;
     /**
-     * The rights management configuration which includes the information sources modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy information sources to add to the factory.
+     */
+    rightsManagementPolicyInformationSources?: string;
+    /**
+     * The rights management policy negotiators sources to add to the factory.
      */
-    rightsManagementInformationSources?: string;
+    rightsManagementPolicyNegotiators?: string;
     /**
-     * The rights management configuration which includes the negotiator modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy requesters to add to the factory.
      */
-    rightsManagementNegotiators?: string;
+    rightsManagementPolicyRequesters?: string;
     /**
-     * The rights management configuration which includes the requester modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy execution actions to add to the factory.
      */
-    rightsManagementRequesters?: string;
+    rightsManagementPolicyExecutionActions?: string;
     /**
-     * The rights management configuration which includes the execution actions modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy enforcement processors to add to the factory.
      */
-    rightsManagementExecutionActions?: string;
+    rightsManagementPolicyEnforcementProcessors?: string;
     /**
-     * The rights management configuration which includes the enforcement processor modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy arbiters to add to the factory.
      */
-    rightsManagementEnforcementProcessors?: string;
+    rightsManagementPolicyArbiters?: string;
     /**
-     * The rights management configuration which includes the arbiter modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management data access handlers to add to the factory.
      */
-    rightsManagementArbiters?: string;
+    rightsManagementDataAccessHandlers?: string;
     /**
-     * The rights management configuration which includes the offer modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * Are background tasks enabled, defaults to false.
      */
-    rightsManagementOffers?: string;
+    backgroundTasksEnabled?: string;
     /**
      * Is the task scheduler enabled, defaults to false.
      */

package/dist/types/models/INodeEngineState.d.ts

@@ -11,12 +11,4 @@ export interface INodeEngineState extends IEngineState {
      * The tenant id for the node.
      */
     nodeTenantId?: string;
-    /**
-     * The identity for the organization.
-     */
-    nodeOrganizationId?: string;
-    /**
-     * The identity for the admin user.
-     */
-    nodeAdminUserId?: string;
 }

package/dist/types/models/INodeEnvironmentVariables.d.ts

@@ -3,44 +3,6 @@ import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironme
  * The environment variables for the node.
  */
 export interface INodeEnvironmentVariables extends IEngineServerEnvironmentVariables {
-    /**
-     * The features that are enabled on the node.
-     * @default []
-     */
-    features?: string;
-    /**
-     * The identity of the node which, if empty and node-identity feature is enabled it will be generated.
-     */
-    nodeIdentity?: string;
-    /**
-     * The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
-     */
-    nodeMnemonic?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the organization of the user, if one is not provided it will be generated
-     */
-    organizationIdentity?: string;
-    /**
-     * The mnemonic for the organization, if empty and node-admin-user feature is enabled it will be randomly generated.
-     */
-    organizationMnemonic?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the identity of the user, if one is not provided it will be generated
-     */
-    adminUserIdentity?: string;
-    /**
-     * The mnemonic for the admin user, if empty and node-admin-user feature is enabled it will be randomly generated.
-     */
-    adminUserMnemonic?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the name of the user.
-     * @default admin@node
-     */
-    adminUserName?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
-     */
-    adminUserPassword?: string;
     /**
      * Maximum size in MB for HTTPS extensions downloads.
      * @default 10

package/dist/types/models/cliCommandParamType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Type for the properties in commands.
+ */
+export type CliCommandParamType = string | number | boolean;

package/dist/types/node.d.ts

@@ -9,9 +9,10 @@ import type { INodeOptions } from "./models/INodeOptions.js";
 /**
  * Run the TWIN Node server.
  * @param nodeOptions Optional configuration options for running the server.
+ * @param args Optional command line arguments.
  * @returns A promise that resolves when the server is started containing a shutdown method.
  */
-export declare function run(nodeOptions?: INodeOptions): Promise<{
+export declare function run(nodeOptions?: INodeOptions, args?: string[]): Promise<{
     engine: Engine<IEngineServerConfig, INodeEngineState>;
     server: EngineServer;
     shutdown: () => Promise<void>;
@@ -31,7 +32,10 @@ export declare function buildConfiguration(processEnv: {
         [id: string]: string | unknown;
     };
     nodeEngineConfig: INodeEngineConfig;
-    contextIdKeys: string[];
+    availableContextIdKeys: {
+        key: string;
+        requiredHandlerFeatures: string[];
+    }[];
 }>;
 /**
  * Override module imports to support protocol-based loading (npm:, https:) and local files.

package/dist/types/{server.d.ts → start.d.ts}

@@ -1,6 +1,7 @@
 import { Engine } from "@twin.org/engine";
 import { EngineServer } from "@twin.org/engine-server";
 import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import type { ICliCommand } from "./models/ICliCommand.js";
 import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
 import type { INodeEngineState } from "./models/INodeEngineState.js";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
@@ -10,10 +11,14 @@ import type { INodeOptions } from "./models/INodeOptions.js";
  * @param nodeOptions Optional run options for the engine server.
  * @param nodeEngineConfig The configuration for the engine server.
  * @param envVars The environment variables.
- * @param contextIdKeys The context ID keys.
+ * @param cliCommand The constructed CLI command (optional).
+ * @param availableContextIdKeys The context ID keys available for operation.
  * @returns The engine server.
  */
-export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables, contextIdKeys?: string[]): Promise<{
+export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables, cliCommand?: ICliCommand, availableContextIdKeys?: {
+    key: string;
+    requiredHandlerFeatures: string[];
+}[]): Promise<{
     engine: Engine<IEngineServerConfig, INodeEngineState>;
     server: EngineServer;
     shutdown: () => Promise<void>;

package/dist/types/utils.d.ts

@@ -1,8 +1,6 @@
 import type { IModuleProtocol } from "./models/IModuleProtocol.js";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
 import type { IProtocolHandlerResult } from "./models/IProtocolHandlerResult.js";
 import { ModuleProtocol } from "./models/moduleProtocol.js";
-import { NodeFeatures } from "./models/nodeFeatures.js";
 /**
  * Initialise the locales for the application.
  * @param localesDirectory The directory containing the locales.
@@ -49,12 +47,6 @@ export declare function loadTextFile(filename: string): Promise<string>;
  * @returns The contents of the JSON file or null if it could not be loaded.
  */
 export declare function loadJsonFile<T>(filename: string): Promise<T>;
-/**
- * Get the features that are enabled on the node.
- * @param env The environment variables for the node.
- * @returns The features that are enabled on the node.
- */
-export declare function getFeatures(env: INodeEnvironmentVariables): NodeFeatures[];
 /**
  * Parse the protocol from a module name.
  * @param moduleName The module name to parse.

package/docs/changelog.md

@@ -1,5 +1,68 @@
 # @twin.org/node-core - Changelog
 
+## [0.0.3-next.10](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.9...node-core-v0.0.3-next.10) (2026-01-19)
+
+
+### Features
+
+* add CLI commands and remove automated bootstrap code ([#69](https://github.com/twinfoundation/node/issues/69)) ([6e40933](https://github.com/twinfoundation/node/commit/6e40933d8bb820b380e1074fc88feeedca0ef7d9))
+
+## [0.0.3-next.9](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.8...node-core-v0.0.3-next.9) (2026-01-07)
+
+
+### Features
+
+* improve bootstrapping and shutdown behaviour ([#66](https://github.com/twinfoundation/node/issues/66)) ([65b3452](https://github.com/twinfoundation/node/commit/65b345240334bfff48b52e136cc486cd7ac7f290))
+
+## [0.0.3-next.8](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.7...node-core-v0.0.3-next.8) (2026-01-05)
+
+
+### Features
+
+* update for livez endpoint ([9fc2e6a](https://github.com/twinfoundation/node/commit/9fc2e6ade38b3ec9591399a633d02b1e5fe07910))
+
+## [0.0.3-next.7](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.6...node-core-v0.0.3-next.7) (2025-12-04)
+
+
+### Features
+
+* add trust and rights management plugin support ([cdeb504](https://github.com/twinfoundation/node/commit/cdeb504ee5986a347466162b9afa781645b4a54c))
+
+## [0.0.3-next.6](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.5...node-core-v0.0.3-next.6) (2025-11-28)
+
+
+### Features
+
+* update background tasks and add fedcat filters ([1fd297e](https://github.com/twinfoundation/node/commit/1fd297e29f60b5bb3909638b68e326c5b0e2d77d))
+
+## [0.0.3-next.5](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.4...node-core-v0.0.3-next.5) (2025-11-26)
+
+
+### Features
+
+* add support for dynamodb connection timeout ([63051b0](https://github.com/twinfoundation/node/commit/63051b0d22138079115dfac921e7f0c45eaad34e))
+
+## [0.0.3-next.4](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.3...node-core-v0.0.3-next.4) (2025-11-24)
+
+
+### Bug Fixes
+
+* org identity verification methods ([18f158b](https://github.com/twinfoundation/node/commit/18f158b2f63930e20e94437c17ed43421771a458))
+
+## [0.0.3-next.3](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.2...node-core-v0.0.3-next.3) (2025-11-20)
+
+
+### Features
+
+* updated context id features ([ef7be07](https://github.com/twinfoundation/node/commit/ef7be07d44dccdeacf10f90cb4ffde0303faa6fa))
+
+## [0.0.3-next.2](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.1...node-core-v0.0.3-next.2) (2025-11-14)
+
+
+### Features
+
+* additional stop interlock ([b3a2757](https://github.com/twinfoundation/node/commit/b3a2757325af0e7b258a9f97f1b52e86087e6301))
+
 ## [0.0.3-next.1](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.0...node-core-v0.0.3-next.1) (2025-11-13)
 
 

package/docs/reference/functions/buildConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildConfiguration()
 
-> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `contextIdKeys`: `string`[]; \}\>
+> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
 
 Build the configuration for the TWIN Node server.
 
@@ -24,7 +24,7 @@ The server information.
 
 ## Returns
 
-`Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `contextIdKeys`: `string`[]; \}\>
+`Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `availableContextIdKeys`: `object`[]; \}\>
 
 A promise that resolves to the engine server configuration, environment prefix, environment variables,
 and options.

package/docs/reference/functions/buildEngineConfiguration.md

@@ -14,7 +14,7 @@ The environment variables.
 
 ### contextIdKeys
 
-`string`[]
+`object`[]
 
 The context ID keys.
 

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildEngineServerConfiguration()
 
-> **buildEngineServerConfiguration**(`envVars`, `contextIdKeys`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`, `favIconPath?`): `Promise`\<`IEngineServerConfig`\>
+> **buildEngineServerConfiguration**(`envVars`, `availableContextIdKeys`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`, `favIconPath?`): `Promise`\<`IEngineServerConfig`\>
 
 Handles the configuration of the server.
 
@@ -12,9 +12,9 @@ Handles the configuration of the server.
 
 The environment variables for the engine server.
 
-### contextIdKeys
+### availableContextIdKeys
 
-`string`[]
+`object`[]
 
 The context ID keys.
 

package/docs/reference/functions/constructCliCommand.md

@@ -0,0 +1,27 @@
+# Function: constructCliCommand()
+
+> **constructCliCommand**(`processEnv`, `cliArgs`): [`ICliCommand`](../interfaces/ICliCommand.md) \| `undefined`
+
+Construct the CLI command from the parsed arguments.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### cliArgs
+
+[`ICliArgs`](../interfaces/ICliArgs.md)
+
+The parsed CLI arguments.
+
+## Returns
+
+[`ICliCommand`](../interfaces/ICliCommand.md) \| `undefined`
+
+The constructed CLI command.
+
+## Throws
+
+GeneralError if the command is missing.

package/docs/reference/functions/executeCommand.md

@@ -0,0 +1,29 @@
+# Function: executeCommand()
+
+> **executeCommand**(`engineCore`, `envVars`, `cliCommand`): `Promise`\<`void`\>
+
+Execute the CLI command.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### cliCommand
+
+[`ICliCommand`](../interfaces/ICliCommand.md)
+
+The CLI command to execute.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/getEnvDefaults.md

@@ -0,0 +1,19 @@
+# Function: getEnvDefaults()
+
+> **getEnvDefaults**(`envPrefix`): `object`
+
+Get the default environment variables for the node.
+
+## Parameters
+
+### envPrefix
+
+`string`
+
+The environment variable prefix.
+
+## Returns
+
+`object`
+
+The default environment variables.

package/docs/reference/functions/initCli.md

@@ -0,0 +1,27 @@
+# Function: initCli()
+
+> **initCli**(`processEnv`, `args?`): [`ICliCommand`](../interfaces/ICliCommand.md) \| `undefined`
+
+Initialise the CLI.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### args?
+
+`string`[]
+
+The command line arguments.
+
+## Returns
+
+[`ICliCommand`](../interfaces/ICliCommand.md) \| `undefined`
+
+The constructed CLI command if there is one.
+
+## Throws
+
+GeneralError if the command is missing or invalid.

package/docs/reference/functions/parseCommandLineArgs.md

@@ -0,0 +1,19 @@
+# Function: parseCommandLineArgs()
+
+> **parseCommandLineArgs**(`args?`): [`ICliArgs`](../interfaces/ICliArgs.md)
+
+Parse command line arguments.
+
+## Parameters
+
+### args?
+
+`string`[]
+
+The command line arguments.
+
+## Returns
+
+[`ICliArgs`](../interfaces/ICliArgs.md)
+
+The parsed command line arguments.