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

package/dist/types/utils.d.ts

@@ -1,5 +1,8 @@
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
-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.
@@ -16,6 +19,24 @@ export declare function getExecutionDirectory(): string;
  * @returns True if the file exists.
  */
 export declare function fileExists(filename: string): Promise<boolean>;
+/**
+ * Does the specified directory exist.
+ * @param directory The directory to check for existence.
+ * @returns True if the directory exists.
+ */
+export declare function directoryExists(directory: string): Promise<boolean>;
+/**
+ * Get the sub folders for the folder.
+ * @param directory The directory to get the sub folders.
+ * @returns The list of sub folders.
+ */
+export declare function getSubFolders(directory: string): Promise<string[]>;
+/**
+ * Get the files in the directory.
+ * @param directory The directory to get the files from.
+ * @returns The list of files in the directory.
+ */
+export declare function getFiles(directory: string): Promise<string[]>;
 /**
  * Load the text file.
  * @param filename The filename of the text file to load.
@@ -34,3 +55,67 @@ export declare function loadJsonFile<T>(filename: string): Promise<T>;
  * @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.
+ * @returns The parsed protocol information.
+ */
+export declare function parseModuleProtocol(moduleName: string): IModuleProtocol;
+/**
+ * Hash a URL to create a safe filename.
+ * @param url The URL to hash.
+ * @returns A hashed filename safe for the filesystem.
+ */
+export declare function hashUrl(url: string): string;
+/**
+ * Get the extensions cache directory.
+ * @param executionDirectory The execution directory.
+ * @param protocol The protocol type for subdirectory organization.
+ * @param cacheDirectory The cache directory base path.
+ * @returns The cache directory path.
+ */
+export declare function getExtensionsCacheDir(executionDirectory: string, protocol: ModuleProtocol, cacheDirectory?: string): string;
+/**
+ * Handle the npm: protocol by installing the package if needed.
+ * @param packageName The npm package name (without npm: prefix).
+ * @param executionDirectory The execution directory.
+ * @param cacheDirectory The cache directory base path.
+ * @returns The resolved path to the installed module.
+ */
+export declare function handleNpmProtocol(packageName: string, executionDirectory: string, cacheDirectory?: string): Promise<IProtocolHandlerResult>;
+/**
+ * Check if a cached file has expired based on TTL and force refresh settings.
+ * @param metadataPath Path to the cache metadata file.
+ * @param ttlHours Time to live in hours.
+ * @param forceRefresh Whether to force refresh regardless of TTL.
+ * @returns True if the cache is expired or should be refreshed.
+ */
+export declare function isCacheExpired(metadataPath: string, ttlHours: number, forceRefresh: boolean): Promise<boolean>;
+/**
+ * Handle the https: protocol by downloading the module if needed.
+ * @param url The HTTPS URL to download from.
+ * @param executionDirectory The execution directory.
+ * @param maxSizeMb The maximum size in MB for the download.
+ * @param cacheDirectory The cache directory base path.
+ * @param ttlHours TTL in hours for cache expiration.
+ * @param forceRefresh Whether to force refresh the cache.
+ * @returns The resolved path to the downloaded module.
+ */
+export declare function handleHttpsProtocol(url: string, executionDirectory: string, maxSizeMb: number, cacheDirectory?: string, ttlHours?: number, forceRefresh?: boolean): Promise<IProtocolHandlerResult>;
+/**
+ * Resolve the main entry point from a package directory using Node.js resolution with fallback.
+ * Uses require.resolve() when possible for standard Node.js behavior, with manual fallback.
+ * @param packagePath The absolute path to the package directory.
+ * @param packageName The package name for require.resolve().
+ * @param fallback The fallback file name if no entry point is found.
+ * @returns The resolved entry point file name (relative to package directory).
+ */
+export declare function resolvePackageEntryPoint(packagePath: string, packageName: string, fallback?: string): Promise<string>;
+/**
+ * Convert a file path to an import-compatible URL for cross-platform module loading.
+ * On Windows, adds the 'file://' protocol prefix required for dynamic imports.
+ * On other platforms, returns the path unchanged.
+ * @param filePath The absolute file path to convert.
+ * @returns A URL string compatible with dynamic import().
+ */
+export declare function createModuleImportUrl(filePath: string): string;

package/docs/changelog.md

@@ -1,5 +1,190 @@
 # @twin.org/node-core - Changelog
 
+## [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)
+
+
+### Features
+
+* add auth admin component ([1661e57](https://github.com/twinfoundation/node/commit/1661e57a699d5cf9ebde333e3cbc3aaea89d7c9c))
+* add context id features ([#53](https://github.com/twinfoundation/node/issues/53)) ([827adf5](https://github.com/twinfoundation/node/commit/827adf52cb87fca53cec52b27e67f7a9dba2c088))
+* add data space connector ([5a57087](https://github.com/twinfoundation/node/commit/5a57087d938265d3a4a812ff7c83d130ea4e103c))
+* add data space connector ([f7a3644](https://github.com/twinfoundation/node/commit/f7a364477ec664e333e5ad018795acec6ee61edc))
+* add data space connector ([157e8b0](https://github.com/twinfoundation/node/commit/157e8b0a76e3a8a63c1991924f7f963eb83e27ae))
+* add extend engine and server methods ([ec09c7e](https://github.com/twinfoundation/node/commit/ec09c7eb882d9f5797f2fd372e96cad1a3716f59))
+* add extend engine and server methods ([0136a6f](https://github.com/twinfoundation/node/commit/0136a6f3f4e1a82b1427ee9618b8a17c79bc7fda))
+* add extensions support ([476d5a8](https://github.com/twinfoundation/node/commit/476d5a864026a2f78e5b02bc9eb81359777a4a45))
+* add isDefault flag to logging connectors ([358e839](https://github.com/twinfoundation/node/commit/358e8394819dab9832d3a9ebfac74b897b7d5f40))
+* add missing export ([e8eb621](https://github.com/twinfoundation/node/commit/e8eb6213937a202520b164a9970a891004122b61))
+* add module cache and improve resolution ([482be05](https://github.com/twinfoundation/node/commit/482be056c37a598033250ea8a7288a33cf3470b4))
+* add module override for better local import resolution ([ba00d17](https://github.com/twinfoundation/node/commit/ba00d17beea0a9a1851c89ad7c6a33256051c818))
+* add rights management ([78fba62](https://github.com/twinfoundation/node/commit/78fba62f82afdbe615d55dd90eca8ee70ea62fc0))
+* add rights management components ([0fc6293](https://github.com/twinfoundation/node/commit/0fc629332db24494bd73003625c7bf3f939a2597))
+* add synchronised storage config ([e315869](https://github.com/twinfoundation/node/commit/e315869adbffcd7fe5d3ce151dd35f662f6134a9))
+* add validate-locales ([1a19dcb](https://github.com/twinfoundation/node/commit/1a19dcb005c2f0e3103e290db28c48a3464094cb))
+* adding npm and https protocols to load extensions ([#45](https://github.com/twinfoundation/node/issues/45)) ([33940b7](https://github.com/twinfoundation/node/commit/33940b7e771a0c5af32c18d442deb26a8631fd02))
+* additional options for enabling components ([e13d772](https://github.com/twinfoundation/node/commit/e13d7721a0dd7143d456fff246622cbe63dbd0f1))
+* additional route logging env vars ([7152c88](https://github.com/twinfoundation/node/commit/7152c887c3ba76778e2d9e68ba57198b8d81d802))
+* additional run options ([c35e5bb](https://github.com/twinfoundation/node/commit/c35e5bbb8a80fe6a36628d41f64585b3723d9ad7))
+* additional startup logging ([0740293](https://github.com/twinfoundation/node/commit/0740293b366032f2907046603abf587c9c324aff))
+* eslint migration to flat config ([080db74](https://github.com/twinfoundation/node/commit/080db746390230f78725d214bc957da2efee9eb1))
+* improve default options and spec ([b538721](https://github.com/twinfoundation/node/commit/b538721902e7f65021d2715148ba59409ccce035))
+* improve error handling for extensions and logging ([bd84fde](https://github.com/twinfoundation/node/commit/bd84fde67e5a9db6ac66730397992401ca52e88c))
+* improve error reporting ([fcd39a1](https://github.com/twinfoundation/node/commit/fcd39a18da2a6ce33965a99ca5f2f36f4aba712f))
+* improve node logging ([63d6ea6](https://github.com/twinfoundation/node/commit/63d6ea661c2c76985d98addb8d905ad6f0c7f164))
+* improve node logging ([c25b9c6](https://github.com/twinfoundation/node/commit/c25b9c6779bdb76f341df072c39b4c2fae4565a3))
+* initial commit ([522f1e5](https://github.com/twinfoundation/node/commit/522f1e515348f9b1dd1eeb3170b1249e2b0b5371))
+* migrate env config from engine to node ([5da29b8](https://github.com/twinfoundation/node/commit/5da29b8d714495308320d237a68e84355bba2b47))
+* node app use JavaScript ([14fe08c](https://github.com/twinfoundation/node/commit/14fe08cb760dd885a5dac9056a4d5dbc3d61df64))
+* remove unused properties ([d8344b5](https://github.com/twinfoundation/node/commit/d8344b5aee5dc1c8104d75fad5093097f6530168))
+* support multiple entity and blob storage connectors ([a489f79](https://github.com/twinfoundation/node/commit/a489f7907544aef5708d5111e9f72985e1377bae))
+* update dependencies ([9d25f16](https://github.com/twinfoundation/node/commit/9d25f16f1d554cd38f3bec28fdf7f8fff892ceaf))
+* update engine dependency ([db290df](https://github.com/twinfoundation/node/commit/db290df3b18374f7d86da575c6048657b98c355b))
+* update engine dependency ([3494c31](https://github.com/twinfoundation/node/commit/3494c3144fd5ce6d3a9f2936c7890ab36795aeaa))
+* update framework components ([4bee2b9](https://github.com/twinfoundation/node/commit/4bee2b9d3651df09b8550a9ed226be1b46031854))
+* update framework core ([8bd769a](https://github.com/twinfoundation/node/commit/8bd769a4451f5f1f6be3f115a5e94eeb05bce7f1))
+* update rights management components ([176a0d6](https://github.com/twinfoundation/node/commit/176a0d611f88360fc845ae233b26ee0b43d7cb23))
+* update rights management dependencies ([97ad02e](https://github.com/twinfoundation/node/commit/97ad02e4b74cfe5e722f74da2fc2229bbf004c0a))
+* update to latest engine ([00d4974](https://github.com/twinfoundation/node/commit/00d4974f9cfb02bf48505cfb4af4a7aba1df4b3d))
+* update to latest engine config ([347386c](https://github.com/twinfoundation/node/commit/347386c0609e717dc20c456ad2264c83df793c59))
+* updating linting ([feacd17](https://github.com/twinfoundation/node/commit/feacd178bb025bcd29a0ae6e4b8e79f23a989169))
+* use features instead of disableNodeIdentity ([2e6109b](https://github.com/twinfoundation/node/commit/2e6109bd1de825e0f5396fc120d99ad7b3929852))
+
+
+### Bug Fixes
+
+* adding a condition to verify if the password exists when bootstrapping ([6030a42](https://github.com/twinfoundation/node/commit/6030a42bdaf581678d96932fd0b809396bf7b8b0))
+* adding a condition to verify if the password exists when bootstrapping ([c66f396](https://github.com/twinfoundation/node/commit/c66f396717394161a7647d1f08b3d87729d96e96))
+* broken docs ([61479fd](https://github.com/twinfoundation/node/commit/61479fd618f766d22c5aafec5277e1a89e22b453))
+* pr comments [#1](https://github.com/twinfoundation/node/issues/1) ([66e795b](https://github.com/twinfoundation/node/commit/66e795b16c372ab131ec1de30085aee90e4dbbd0))
+
+## [0.0.2-next.26](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.25...node-core-v0.0.2-next.26) (2025-10-10)
+
+
+### Features
+
+* adding npm and https protocols to load extensions ([#45](https://github.com/twinfoundation/node/issues/45)) ([33940b7](https://github.com/twinfoundation/node/commit/33940b7e771a0c5af32c18d442deb26a8631fd02))
+
+## [0.0.2-next.25](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.24...node-core-v0.0.2-next.25) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([1a19dcb](https://github.com/twinfoundation/node/commit/1a19dcb005c2f0e3103e290db28c48a3464094cb))
+
+## [0.0.2-next.24](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.23...node-core-v0.0.2-next.24) (2025-10-08)
+
+
+### Features
+
+* add isDefault flag to logging connectors ([358e839](https://github.com/twinfoundation/node/commit/358e8394819dab9832d3a9ebfac74b897b7d5f40))
+
+## [0.0.2-next.23](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.22...node-core-v0.0.2-next.23) (2025-10-07)
+
+
+### Features
+
+* add module cache and improve resolution ([482be05](https://github.com/twinfoundation/node/commit/482be056c37a598033250ea8a7288a33cf3470b4))
+
+## [0.0.2-next.22](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.21...node-core-v0.0.2-next.22) (2025-10-07)
+
+
+### Features
+
+* update engine dependency ([db290df](https://github.com/twinfoundation/node/commit/db290df3b18374f7d86da575c6048657b98c355b))
+
+## [0.0.2-next.21](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.20...node-core-v0.0.2-next.21) (2025-10-07)
+
+
+### Features
+
+* update engine dependency ([3494c31](https://github.com/twinfoundation/node/commit/3494c3144fd5ce6d3a9f2936c7890ab36795aeaa))
+
+## [0.0.2-next.20](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.19...node-core-v0.0.2-next.20) (2025-10-06)
+
+
+### Features
+
+* improve node logging ([63d6ea6](https://github.com/twinfoundation/node/commit/63d6ea661c2c76985d98addb8d905ad6f0c7f164))
+* improve node logging ([c25b9c6](https://github.com/twinfoundation/node/commit/c25b9c6779bdb76f341df072c39b4c2fae4565a3))
+
+## [0.0.2-next.19](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.18...node-core-v0.0.2-next.19) (2025-10-03)
+
+
+### Features
+
+* use features instead of disableNodeIdentity ([2e6109b](https://github.com/twinfoundation/node/commit/2e6109bd1de825e0f5396fc120d99ad7b3929852))
+
+## [0.0.2-next.18](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.17...node-core-v0.0.2-next.18) (2025-10-03)
+
+
+### Features
+
+* improve error handling for extensions and logging ([bd84fde](https://github.com/twinfoundation/node/commit/bd84fde67e5a9db6ac66730397992401ca52e88c))
+
+## [0.0.2-next.17](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.16...node-core-v0.0.2-next.17) (2025-10-02)
+
+
+### Features
+
+* add extensions support ([476d5a8](https://github.com/twinfoundation/node/commit/476d5a864026a2f78e5b02bc9eb81359777a4a45))
+* updating linting ([feacd17](https://github.com/twinfoundation/node/commit/feacd178bb025bcd29a0ae6e4b8e79f23a989169))
+
+## [0.0.2-next.16](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.15...node-core-v0.0.2-next.16) (2025-09-29)
+
+
+### Features
+
+* update framework components ([4bee2b9](https://github.com/twinfoundation/node/commit/4bee2b9d3651df09b8550a9ed226be1b46031854))
+
+## [0.0.2-next.15](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.14...node-core-v0.0.2-next.15) (2025-09-26)
+
+
+### Features
+
+* additional options for enabling components ([e13d772](https://github.com/twinfoundation/node/commit/e13d7721a0dd7143d456fff246622cbe63dbd0f1))
+
+## [0.0.2-next.14](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.13...node-core-v0.0.2-next.14) (2025-09-25)
+
+
+### Features
+
+* additional route logging env vars ([7152c88](https://github.com/twinfoundation/node/commit/7152c887c3ba76778e2d9e68ba57198b8d81d802))
+
+## [0.0.2-next.13](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.12...node-core-v0.0.2-next.13) (2025-09-24)
+
+
+### Features
+
+* update to latest engine ([00d4974](https://github.com/twinfoundation/node/commit/00d4974f9cfb02bf48505cfb4af4a7aba1df4b3d))
+
+## [0.0.2-next.12](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.11...node-core-v0.0.2-next.12) (2025-09-19)
+
+
+### Features
+
+* update rights management components ([176a0d6](https://github.com/twinfoundation/node/commit/176a0d611f88360fc845ae233b26ee0b43d7cb23))
+
+## [0.0.2-next.11](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.10...node-core-v0.0.2-next.11) (2025-09-08)
+
+
+### Features
+
+* update rights management dependencies ([97ad02e](https://github.com/twinfoundation/node/commit/97ad02e4b74cfe5e722f74da2fc2229bbf004c0a))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.9...node-core-v0.0.2-next.10) (2025-09-05)
+
+
+### Features
+
+* add rights management components ([0fc6293](https://github.com/twinfoundation/node/commit/0fc629332db24494bd73003625c7bf3f939a2597))
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.8...node-core-v0.0.2-next.9) (2025-08-31)
 
 

package/docs/detailed-guide.md

@@ -0,0 +1,129 @@
+# TWIN Node - Detailed Documentation
+
+## Overview
+
+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 supports dynamic extension loading from multiple sources:
+
+### Local Files
+
+Load extensions from your filesystem:
+
+```bash
+TWIN_EXTENSIONS="./my-extension.mjs"
+```
+
+### NPM Packages
+
+Automatically install and load npm packages:
+
+```bash
+TWIN_EXTENSIONS="npm:@twin.org/package"
+```
+
+### HTTPS URLs
+
+Download and cache remote extensions:
+
+```bash
+TWIN_EXTENSIONS="https://example.com/extension.mjs"
+```
+
+## Extension Lifecycle Hooks
+
+Extensions can implement lifecycle hooks to customize node behavior at different stages:
+
+- **`extensionInitialise`** - Called before engine initialization
+- **`extensionInitialiseEngine`** - Called during engine initialization
+- **`extensionInitialiseEngineServer`** - Called during server initialization
+- **`extensionShutdown`** - Called during graceful shutdown
+
+### Example Extension
+
+```javascript
+// my-extension.mjs
+export function extensionInitialise() {
+  console.log('Extension initializing...');
+}
+
+export function extensionInitialiseEngine(engine) {
+  console.log('Configuring engine...');
+  // Add custom components, routes, etc.
+}
+
+export function extensionInitialiseEngineServer(server) {
+  console.log('Configuring server...');
+  // Add middleware, routes, etc.
+}
+
+export function extensionShutdown() {
+  console.log('Extension shutting down...');
+  // Cleanup resources
+}
+```
+
+## Configuration Options
+
+### Cache Management
+
+- `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_EXTENSIONS_MAX_SIZE_MB` - Maximum size for HTTPS downloads (default: 10)
+- `TWIN_EXTENSIONS_CLEAR_CACHE` - Clear cache on startup (default: false)
+
+## API Reference
+
+### Core Functions
+
+#### `overrideModuleImport(executionDirectory, envVars)`
+
+Sets up protocol-based module resolution for extensions.
+
+#### `buildConfiguration(options)`
+
+Builds node configuration from environment variables and options.
+
+#### `start(options)`
+
+Starts the TWIN node with the specified configuration.
+
+### Utility Functions
+
+#### `parseModuleProtocol(moduleName)`
+
+Parses module name to determine protocol type (npm, https, local, etc.).
+
+#### `handleNpmProtocol(packageName, executionDirectory, cacheDirectory)`
+
+Handles installation and resolution of npm packages.
+
+#### `handleHttpsProtocol(url, executionDirectory, maxSizeMb, cacheDirectory, ttlHours, forceRefresh)`
+
+Handles download and caching of HTTPS extensions.
+
+## Security Considerations
+
+- **HTTPS Only**: Remote extensions must use HTTPS protocol
+- **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
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Extension not found**: Check that the path/URL is correct and accessible
+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
+
+Set `NODE_ENV=development` for additional debug output during extension loading.

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`; `engineServerConfig`: `IEngineServerConfig`; \}\>
+> **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`; `engineServerConfig`: `IEngineServerConfig`; \}\>
+`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`): `IEngineConfig`
+> **buildEngineConfiguration**(`envVars`, `contextIdKeys`): `Promise`\<`IEngineConfig`\>
 
 Build the engine core configuration from environment variables.
 
@@ -12,8 +12,14 @@ Build the engine core configuration from environment variables.
 
 The environment variables.
 
+### contextIdKeys
+
+`string`[]
+
+The context ID keys.
+
 ## Returns
 
-`IEngineConfig`
+`Promise`\<`IEngineConfig`\>
 
 The config for the core.

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildEngineServerConfiguration()
 
-> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`, `favIconPath?`): `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`
@@ -38,6 +44,6 @@ The path to the favicon.
 
 ## Returns
 
-`IEngineServerConfig`
+`Promise`\<`IEngineServerConfig`\>
 
-The the config for the core and the server.
+The config for the core and the server.