@twin.org/node-core 0.0.2-next.26 → 0.0.2-next.27

package/dist/types/index.d.ts

@@ -1,19 +1,20 @@
-export * from "./bootstrap";
-export * from "./builders/engineEnvBuilder";
-export * from "./builders/engineServerEnvBuilder";
-export * from "./builders/extensionsBuilder";
-export * from "./defaults";
-export * from "./models/ICacheMetadata";
-export * from "./models/IEngineEnvironmentVariables";
-export * from "./models/IEngineServerEnvironmentVariables";
-export * from "./models/IModuleProtocol";
-export * from "./models/INodeEngineConfig";
-export * from "./models/INodeEnvironmentVariables";
-export * from "./models/INodeOptions";
-export * from "./models/IProtocolHandlerResult";
-export * from "./models/moduleProtocol";
-export * from "./models/nodeExtensionMethods";
-export * from "./models/nodeFeatures";
-export * from "./node";
-export * from "./server";
-export * from "./utils";
+export * from "./bootstrap.js";
+export * from "./builders/engineEnvBuilder.js";
+export * from "./builders/engineServerEnvBuilder.js";
+export * from "./builders/extensionsBuilder.js";
+export * from "./defaults.js";
+export * from "./models/ICacheMetadata.js";
+export * from "./models/IEngineEnvironmentVariables.js";
+export * from "./models/IEngineServerEnvironmentVariables.js";
+export * from "./models/IModuleProtocol.js";
+export * from "./models/INodeEngineConfig.js";
+export * from "./models/INodeEngineState.js";
+export * from "./models/INodeEnvironmentVariables.js";
+export * from "./models/INodeOptions.js";
+export * from "./models/IProtocolHandlerResult.js";
+export * from "./models/moduleProtocol.js";
+export * from "./models/nodeExtensionMethods.js";
+export * from "./models/nodeFeatures.js";
+export * from "./node.js";
+export * from "./server.js";
+export * from "./utils.js";

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

@@ -14,6 +14,18 @@ export interface IEngineEnvironmentVariables {
      * The name of the state file.
      */
     stateFilename?: string;
+    /**
+     * Is multi-tenant support enabled, defaults to false.
+     */
+    tenantEnabled?: 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.
+     */
+    tenantApiKey?: 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
@@ -285,11 +297,6 @@ export interface IEngineEnvironmentVariables {
      * Are the messaging components enabled, defaults to false.
      */
     messagingEnabled?: string;
-    /**
-     * An initial set of templates for the messages.
-     * Use the @json: prefix to specify the path to the JSON file.
-     */
-    messagingTemplates?: string;
     /**
      * AWS SES region.
      */

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

@@ -1,4 +1,4 @@
-import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables";
+import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables.js";
 /**
  * The engine server environment variables.
  */

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

@@ -1,4 +1,4 @@
-import type { ModuleProtocol } from "./moduleProtocol";
+import type { ModuleProtocol } from "./moduleProtocol.js";
 /**
  * The parsed module protocol information.
  */

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

@@ -0,0 +1,22 @@
+import type { IEngineState } from "@twin.org/engine-models";
+/**
+ * The engine state for the node.
+ */
+export interface INodeEngineState extends IEngineState {
+    /**
+     * The identity for the node.
+     */
+    nodeId?: string;
+    /**
+     * 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

@@ -1,30 +1,46 @@
-import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironmentVariables";
+import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironmentVariables.js";
 /**
  * The environment variables for the node.
  */
 export interface INodeEnvironmentVariables extends IEngineServerEnvironmentVariables {
     /**
      * The features that are enabled on the node.
-     * @default [NodeFeatures.NodeIdentity]
+     * @default []
      */
     features?: string;
     /**
      * The identity of the node which, if empty and node-identity feature is enabled it will be generated.
      */
-    identity?: string;
+    nodeIdentity?: string;
     /**
      * The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
      */
-    mnemonic?: string;
+    nodeMnemonic?: string;
     /**
-     * If the node-user feature is enabled, this will be the name of the user.
+     * 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
      */
-    username?: string;
+    adminUserName?: string;
     /**
-     * If the node-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
+     * If the node-admin-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
      */
-    password?: string;
+    adminUserPassword?: string;
     /**
      * Maximum size in MB for HTTPS extensions downloads.
      * @default 10

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

@@ -1,7 +1,7 @@
 import type { IEngineCore, IEngineServer, IEngineStateStorage } from "@twin.org/engine-models";
 import type { IEngineConfig } from "@twin.org/engine-types";
-import type { INodeEngineConfig } from "./INodeEngineConfig";
-import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables";
+import type { INodeEngineConfig } from "./INodeEngineConfig.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
 /**
  * The options when running the node.
  */
@@ -15,12 +15,18 @@ export interface INodeOptions {
      * The version of the server, defaults to the current version.
      */
     serverVersion?: string;
+    /**
+     * Additional environment variables to set.
+     */
+    envVars?: {
+        [key: string]: string;
+    };
     /**
      * Additional environment variable filenames to load, defaults to .env.
      */
     envFilenames?: string[];
     /**
-     * The prefix for environment variables, defaults to "TWIN_NODE_".
+     * The prefix for environment variables, defaults to "TWIN_".
      */
     envPrefix?: string;
     /**
@@ -71,4 +77,8 @@ export interface INodeOptions {
      * If not provided, a default file-based state storage will be used.
      */
     stateStorage?: IEngineStateStorage;
+    /**
+     * Disables process.exit calls on fatal errors and throws instead.
+     */
+    disableProcessExitOnFailure?: boolean;
 }

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

@@ -1,6 +1,6 @@
 import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
-import type { INodeEngineConfig } from "./INodeEngineConfig";
-import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables";
+import type { INodeEngineConfig } from "./INodeEngineConfig.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
 /**
  * The type for the initialise method of an extension module.
  * @param envVars The environment variables for the node.

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

@@ -3,15 +3,15 @@
  */
 export declare const NodeFeatures: {
     /**
-     * NodeIdentity - generates an identity for the node if not provided in config.
+     * NodeId - generates an identity for the node if not provided in config.
      */
-    readonly NodeIdentity: "node-identity";
+    readonly NodeId: "node-identity";
     /**
-     * NodeUser - generates a user for the node if not provided in config.
+     * NodeAdminUser - generates an admin user for the node if not provided in config.
      */
-    readonly NodeUser: "node-user";
+    readonly NodeAdminUser: "node-admin-user";
     /**
-     * NodeWallet - generates a wallet for the node and funds it when there is a faucet available.
+     * NodeWallet - generates wallets for any identities that need them.
      */
     readonly NodeWallet: "node-wallet";
 };

package/dist/types/node.d.ts

@@ -1,13 +1,21 @@
 import type { IServerInfo } from "@twin.org/api-models";
-import type { INodeEngineConfig } from "./models/INodeEngineConfig";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
-import type { INodeOptions } from "./models/INodeOptions";
+import type { Engine } from "@twin.org/engine";
+import type { EngineServer } from "@twin.org/engine-server";
+import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
+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.
  * @param nodeOptions Optional configuration options for running the server.
- * @returns A promise that resolves when the server is started.
+ * @returns A promise that resolves when the server is started containing a shutdown method.
  */
-export declare function run(nodeOptions?: INodeOptions): Promise<void>;
+export declare function run(nodeOptions?: INodeOptions): Promise<{
+    engine: Engine<IEngineServerConfig, INodeEngineState>;
+    server: EngineServer;
+    shutdown: () => Promise<void>;
+} | undefined>;
 /**
  * Build the configuration for the TWIN Node server.
  * @param processEnv The environment variables from the process.
@@ -23,6 +31,7 @@ export declare function buildConfiguration(processEnv: {
         [id: string]: string | unknown;
     };
     nodeEngineConfig: INodeEngineConfig;
+    contextIdKeys: string[];
 }>;
 /**
  * Override module imports to support protocol-based loading (npm:, https:) and local files.

package/dist/types/server.d.ts

@@ -1,19 +1,20 @@
 import { Engine } from "@twin.org/engine";
-import { type IEngineState } from "@twin.org/engine-models";
 import { EngineServer } from "@twin.org/engine-server";
 import type { IEngineServerConfig } from "@twin.org/engine-server-types";
-import type { INodeEngineConfig } from "./models/INodeEngineConfig";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
-import type { INodeOptions } from "./models/INodeOptions";
+import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
+import type { INodeEngineState } from "./models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
+import type { INodeOptions } from "./models/INodeOptions.js";
 /**
  * Start the engine server.
  * @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.
  * @returns The engine server.
  */
-export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables): Promise<{
-    engine: Engine<IEngineServerConfig, IEngineState>;
+export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables, contextIdKeys?: string[]): Promise<{
+    engine: Engine<IEngineServerConfig, INodeEngineState>;
     server: EngineServer;
     shutdown: () => Promise<void>;
 } | undefined>;

package/dist/types/utils.d.ts

@@ -1,8 +1,8 @@
-import type { IModuleProtocol } from "./models/IModuleProtocol";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
-import type { IProtocolHandlerResult } from "./models/IProtocolHandlerResult";
-import { ModuleProtocol } from "./models/moduleProtocol";
-import { NodeFeatures } from "./models/nodeFeatures";
+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.

package/docs/detailed-guide.md

@@ -1,19 +1,19 @@
-# TWIN Node Core - Detailed Documentation
+# TWIN Node - Detailed Documentation
 
 ## Overview
 
-TWIN Node Core provides the foundational components for running TWIN nodes, including dynamic extension loading, protocol-based module resolution, and lifecycle management.
+TWIN Node provides the foundational components for running TWIN nodes, including dynamic extension loading, protocol-based module resolution, and lifecycle management.
 
 ## Protocol-Based Extension Loading
 
-The TWIN Node Core supports dynamic extension loading from multiple sources:
+The TWIN Node supports dynamic extension loading from multiple sources:
 
 ### Local Files
 
 Load extensions from your filesystem:
 
 ```bash
-TWIN_NODE_EXTENSIONS="./my-extension.mjs"
+TWIN_EXTENSIONS="./my-extension.mjs"
 ```
 
 ### NPM Packages
@@ -21,7 +21,7 @@ TWIN_NODE_EXTENSIONS="./my-extension.mjs"
 Automatically install and load npm packages:
 
 ```bash
-TWIN_NODE_EXTENSIONS="npm:@twin.org/package"
+TWIN_EXTENSIONS="npm:@twin.org/package"
 ```
 
 ### HTTPS URLs
@@ -29,7 +29,7 @@ TWIN_NODE_EXTENSIONS="npm:@twin.org/package"
 Download and cache remote extensions:
 
 ```bash
-TWIN_NODE_EXTENSIONS="https://example.com/extension.mjs"
+TWIN_EXTENSIONS="https://example.com/extension.mjs"
 ```
 
 ## Extension Lifecycle Hooks
@@ -69,14 +69,14 @@ export function extensionShutdown() {
 
 ### Cache Management
 
-- `TWIN_NODE_EXTENSIONS_CACHE_TTL_HOURS` - TTL for HTTPS extensions cache (default: 24)
-- `TWIN_NODE_EXTENSIONS_FORCE_REFRESH` - Force refresh all cached extensions (default: false)
-- `TWIN_NODE_EXTENSIONS_CACHE_DIRECTORY` - Custom cache directory (default: ".tmp")
+- `TWIN_EXTENSIONS_CACHE_TTL_HOURS` - TTL for HTTPS extensions cache (default: 24)
+- `TWIN_EXTENSIONS_FORCE_REFRESH` - Force refresh all cached extensions (default: false)
+- `TWIN_EXTENSIONS_CACHE_DIRECTORY` - Custom cache directory (default: ".tmp")
 
 ### Security
 
-- `TWIN_NODE_EXTENSIONS_MAX_SIZE_MB` - Maximum size for HTTPS downloads (default: 10)
-- `TWIN_NODE_EXTENSIONS_CLEAR_CACHE` - Clear cache on startup (default: false)
+- `TWIN_EXTENSIONS_MAX_SIZE_MB` - Maximum size for HTTPS downloads (default: 10)
+- `TWIN_EXTENSIONS_CLEAR_CACHE` - Clear cache on startup (default: false)
 
 ## API Reference
 
@@ -111,7 +111,7 @@ Handles download and caching of HTTPS extensions.
 ## Security Considerations
 
 - **HTTPS Only**: Remote extensions must use HTTPS protocol
-- **Size Limits**: Downloads are limited by `TWIN_NODE_EXTENSIONS_MAX_SIZE_MB`
+- **Size Limits**: Downloads are limited by `TWIN_EXTENSIONS_MAX_SIZE_MB`
 - **Cache TTL**: Extensions are automatically refreshed based on TTL
 - **Security Warnings**: Warnings are displayed when loading remote extensions
 
@@ -120,8 +120,8 @@ Handles download and caching of HTTPS extensions.
 ### Common Issues
 
 1. **Extension not found**: Check that the path/URL is correct and accessible
-2. **Cache issues**: Use `TWIN_NODE_EXTENSIONS_FORCE_REFRESH=true` to force refresh
-3. **Size limit exceeded**: Increase `TWIN_NODE_EXTENSIONS_MAX_SIZE_MB` if needed
+2. **Cache issues**: Use `TWIN_EXTENSIONS_FORCE_REFRESH=true` to force refresh
+3. **Size limit exceeded**: Increase `TWIN_EXTENSIONS_MAX_SIZE_MB` if needed
 4. **Network issues**: Ensure HTTPS URLs are accessible and not blocked by firewall
 
 ### Debug Mode

package/docs/reference/functions/bootstrap.md

@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/bootstrapAuth.md

@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/bootstrapBlobEncryption.md

@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/bootstrapContextIdHandlers.md

@@ -0,0 +1,35 @@
+# Function: bootstrapContextIdHandlers()
+
+> **bootstrapContextIdHandlers**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the context id handlers creating any necessary resources.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node. The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/bootstrapImmutableProofMethod.md

@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/{bootstrapNodeUser.md → bootstrapNodeAdminUser.md}

@@ -1,6 +1,6 @@
-# Function: bootstrapNodeUser()
+# Function: bootstrapNodeAdminUser()
 
-> **bootstrapNodeUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+> **bootstrapNodeAdminUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
 
 Bootstrap the user.
 
@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/{bootstrapNodeIdentity.md → bootstrapNodeId.md}

@@ -1,6 +1,6 @@
-# Function: bootstrapNodeIdentity()
+# Function: bootstrapNodeId()
 
-> **bootstrapNodeIdentity**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+> **bootstrapNodeId**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
 
 Bootstrap the node creating any necessary resources.
 
@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/bootstrapSynchronisedStorage.md

@@ -14,7 +14,7 @@ The engine core for the node.
 
 ### context
 
-`IEngineCoreContext`\<`IEngineServerConfig`, `IEngineState`\>
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
 
 The context for the node.
 

package/docs/reference/functions/bootstrapTenantId.md

@@ -0,0 +1,35 @@
+# Function: bootstrapTenantId()
+
+> **bootstrapTenantId**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+
+Bootstrap the node creating any necessary resources.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`
+
+The engine core for the node.
+
+### context
+
+`IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
+
+The context for the node.
+
+### envVars
+
+[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
+
+The environment variables for the node.
+
+### features
+
+[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
+
+The features that are enabled on the node. The features that are enabled on the node.
+
+## Returns
+
+`Promise`\<`void`\>

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); \}\>
+> **buildConfiguration**(`processEnv`, `options`, `serverInfo`): `Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `contextIdKeys`: `string`[]; \}\>
 
 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); \}\>
+`Promise`\<\{ `nodeEnvVars`: [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md) & `object`; `nodeEngineConfig`: [`INodeEngineConfig`](../interfaces/INodeEngineConfig.md); `contextIdKeys`: `string`[]; \}\>
 
 A promise that resolves to the engine server configuration, environment prefix, environment variables,
 and options.

package/docs/reference/functions/buildEngineConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildEngineConfiguration()
 
-> **buildEngineConfiguration**(`envVars`): `Promise`\<`IEngineConfig`\>
+> **buildEngineConfiguration**(`envVars`, `contextIdKeys`): `Promise`\<`IEngineConfig`\>
 
 Build the engine core configuration from environment variables.
 
@@ -12,6 +12,12 @@ Build the engine core configuration from environment variables.
 
 The environment variables.
 
+### contextIdKeys
+
+`string`[]
+
+The context ID keys.
+
 ## Returns
 
 `Promise`\<`IEngineConfig`\>

package/docs/reference/functions/buildEngineServerConfiguration.md

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

package/docs/reference/functions/run.md

@@ -1,6 +1,6 @@
 # Function: run()
 
-> **run**(`nodeOptions?`): `Promise`\<`void`\>
+> **run**(`nodeOptions?`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
 
 Run the TWIN Node server.
 
@@ -14,6 +14,6 @@ Optional configuration options for running the server.
 
 ## Returns
 
-`Promise`\<`void`\>
+`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
 
-A promise that resolves when the server is started.
+A promise that resolves when the server is started containing a shutdown method.