@twin.org/node-core 0.0.3-next.2 → 0.0.3-next.21

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/INodeOptions.d.ts

@@ -7,8 +7,8 @@ import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
  */
 export interface INodeOptions {
     /**
-     * The name of the server, defaults to "TWIN Node Server".
-     * @default "TWIN Node Server"
+     * The name of the server, defaults to "TWIN Node".
+     * @default "TWIN Node"
      */
     serverName?: string;
     /**
@@ -40,6 +40,10 @@ export interface INodeOptions {
      * This will be merged with any configuration loaded from the environment variables.
      */
     config?: IEngineConfig;
+    /**
+     * The directory to override the script location, defaults to location of index.js.
+     */
+    scriptDirectory?: string;
     /**
      * The directory to override the execution location, defaults to process directory.
      */

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

@@ -7,17 +7,18 @@ import type { INodeEngineState } from "./models/INodeEngineState.js";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
 import type { INodeOptions } from "./models/INodeOptions.js";
 /**
- * Run the TWIN Node server.
+ * Run the TWIN Node.
  * @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>;
 } | undefined>;
 /**
- * Build the configuration for the TWIN Node server.
+ * Build the configuration for the TWIN Node.
  * @param processEnv The environment variables from the process.
  * @param options The options for running the server.
  * @param serverInfo The server information.
@@ -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.
@@ -13,6 +11,12 @@ export declare function initialiseLocales(localesDirectory: string): Promise<voi
  * @returns The execution directory.
  */
 export declare function getExecutionDirectory(): string;
+/**
+ * Get the directory where the script is located.
+ * @param args The command line arguments.
+ * @returns The execution directory.
+ */
+export declare function getScriptDirectory(args?: string[]): string;
 /**
  * Does the specified file exist.
  * @param filename The filename to check for existence.
@@ -49,12 +53,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,141 @@
 # @twin.org/node-core - Changelog
 
+## [0.0.3-next.21](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.20...node-core-v0.0.3-next.21) (2026-02-13)
+
+
+### Features
+
+* add obligation enforcers and multi instance support ([#89](https://github.com/twinfoundation/node/issues/89)) ([d81af99](https://github.com/twinfoundation/node/commit/d81af99b8c4db6e9a1370b7065bf6d9d222c71ed))
+
+## [0.0.3-next.20](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.19...node-core-v0.0.3-next.20) (2026-02-06)
+
+
+### Features
+
+* update dependencies ([6cb3d3a](https://github.com/twinfoundation/node/commit/6cb3d3a63f7b976f80074ddecfba034b7e92f919))
+
+## [0.0.3-next.19](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.18...node-core-v0.0.3-next.19) (2026-02-05)
+
+
+### Miscellaneous Chores
+
+* **node-core:** Synchronize repo versions
+
+## [0.0.3-next.18](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.17...node-core-v0.0.3-next.18) (2026-02-04)
+
+
+### Features
+
+* env-prefix option and user-update cli command ([#83](https://github.com/twinfoundation/node/issues/83)) ([fc48efa](https://github.com/twinfoundation/node/commit/fc48efa7ad72173def048170c3afb5eeb9f1b292))
+
+## [0.0.3-next.17](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.16...node-core-v0.0.3-next.17) (2026-02-02)
+
+
+### Features
+
+* update rights management ([5c992c6](https://github.com/twinfoundation/node/commit/5c992c6b0d72f3eeaa39ee267e096d9a3f477f4e))
+
+## [0.0.3-next.16](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.15...node-core-v0.0.3-next.16) (2026-01-28)
+
+
+### Features
+
+* remove dap and darp ([36c3ffb](https://github.com/twinfoundation/node/commit/36c3ffb31af65a0e3025859dab675efeee043155))
+
+## [0.0.3-next.15](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.14...node-core-v0.0.3-next.15) (2026-01-26)
+
+
+### Features
+
+* support public origin and hosting service ([#77](https://github.com/twinfoundation/node/issues/77)) ([3b9039f](https://github.com/twinfoundation/node/commit/3b9039fcba7f7038c06f8fd6a5ccc9fdbbf535b3))
+* update context usage ([2215440](https://github.com/twinfoundation/node/commit/2215440801dea3955885b6579ad9b98b7a5d87ea))
+
+## [0.0.3-next.14](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.13...node-core-v0.0.3-next.14) (2026-01-21)
+
+
+### Features
+
+* add vault prefix configuration ([#75](https://github.com/twinfoundation/node/issues/75)) ([1d4afb1](https://github.com/twinfoundation/node/commit/1d4afb1b1a8aa60795898eeb9e7f5153c279527d))
+
+## [0.0.3-next.13](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.12...node-core-v0.0.3-next.13) (2026-01-19)
+
+
+### Features
+
+* add trust ttl ([#73](https://github.com/twinfoundation/node/issues/73)) ([911cee7](https://github.com/twinfoundation/node/commit/911cee771bba490143bb1574ca8360f7cf8baa1a))
+* update order of logging ([2161938](https://github.com/twinfoundation/node/commit/2161938c969b18e4678459a69090287e5ccdb404))
+* update order of logging ([b295f31](https://github.com/twinfoundation/node/commit/b295f315f7c5b611d229d9e5314d414da05828b9))
+
+## [0.0.3-next.12](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.11...node-core-v0.0.3-next.12) (2026-01-19)
+
+
+### Features
+
+* separate script directory from exec directory ([f6bb4db](https://github.com/twinfoundation/node/commit/f6bb4dbea1f1e200e0640fa154c6997ef99c99b4))
+
+## [0.0.3-next.11](https://github.com/twinfoundation/node/compare/node-core-v0.0.3-next.10...node-core-v0.0.3-next.11) (2026-01-19)
+
+
+### Bug Fixes
+
+* improve calculation of execution directory ([106d65d](https://github.com/twinfoundation/node/commit/106d65d7ad5524e2e147b681d68f9476c024cfaa))
+
+## [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)
 
 

package/docs/reference/functions/buildConfiguration.md

@@ -1,8 +1,8 @@
 # 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.
+Build the configuration for the TWIN Node.
 
 ## Parameters
 
@@ -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/getScriptDirectory.md

@@ -0,0 +1,19 @@
+# Function: getScriptDirectory()
+
+> **getScriptDirectory**(`args?`): `string`
+
+Get the directory where the script is located.
+
+## Parameters
+
+### args?
+
+`string`[]
+
+The command line arguments.
+
+## Returns
+
+`string`
+
+The execution directory.

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.

package/docs/reference/functions/processEnvOptions.md

@@ -0,0 +1,27 @@
+# Function: processEnvOptions()
+
+> **processEnvOptions**(`processEnv`, `options`): `void`
+
+Load the env files and process the options.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### options
+
+`object`[]
+
+The options.
+
+## Returns
+
+`void`
+
+The processed parameters.
+
+## Throws
+
+GeneralError if an env file has errors.

package/docs/reference/functions/registerCommands.md

@@ -0,0 +1,9 @@
+# Function: registerCommands()
+
+> **registerCommands**(): `void`
+
+Register available CLI commands.
+
+## Returns
+
+`void`

package/docs/reference/functions/run.md

@@ -1,8 +1,8 @@
 # Function: run()
 
-> **run**(`nodeOptions?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
+> **run**(`nodeOptions?`, `args?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
 
-Run the TWIN Node server.
+Run the TWIN Node.
 
 ## Parameters
 
@@ -12,6 +12,12 @@ Run the TWIN Node server.
 
 Optional configuration options for running the server.
 
+### args?
+
+`string`[]
+
+Optional command line arguments.
+
 ## Returns
 
 `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>

package/docs/reference/functions/start.md

@@ -1,6 +1,6 @@
 # Function: start()
 
-> **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`, `contextIdKeys?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
+> **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`, `cliCommand?`, `availableContextIdKeys?`): `Promise`\<\{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \} \| `undefined`\>
 
 Start the engine server.
 
@@ -24,11 +24,17 @@ The configuration for the engine server.
 
 The environment variables.
 
-### contextIdKeys?
+### cliCommand?
 
-`string`[]
+[`ICliCommand`](../interfaces/ICliCommand.md)
 
-The context ID keys.
+The constructed CLI command (optional).
+
+### availableContextIdKeys?
+
+`object`[]
+
+The context ID keys available for operation.
 
 ## Returns
 

package/docs/reference/functions/substituteEnvOptions.md

@@ -0,0 +1,25 @@
+# Function: substituteEnvOptions()
+
+> **substituteEnvOptions**(`processEnv`, `options`): `void`
+
+Process options and replace any env variables with their values.
+
+## Parameters
+
+### processEnv
+
+The environment variables from the process.
+
+### options
+
+`object`[]
+
+The options.
+
+## Returns
+
+`void`
+
+## Throws
+
+GeneralError if an env variable is missing.