@twin.org/node-core 0.0.3-next.3 → 0.0.3-next.30

package/dist/es/models/nodeFeatures.js

@@ -1,21 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The features that can be enabled on the node.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const NodeFeatures = {
-    /**
-     * NodeId - generates an identity for the node if not provided in config.
-     */
-    NodeId: "node-identity",
-    /**
-     * NodeAdminUser - generates an admin user for the node if not provided in config.
-     */
-    NodeAdminUser: "node-admin-user",
-    /**
-     * NodeWallet - generates wallets for any identities that need them.
-     */
-    NodeWallet: "node-wallet"
-};
-//# sourceMappingURL=nodeFeatures.js.map

package/dist/es/models/nodeFeatures.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeFeatures.js","sourceRoot":"","sources":["../../../src/models/nodeFeatures.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,eAAe;IAEvB;;OAEG;IACH,aAAa,EAAE,iBAAiB;IAEhC;;OAEG;IACH,UAAU,EAAE,aAAa;CAChB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The features that can be enabled on the node.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const NodeFeatures = {\n\t/**\n\t * NodeId - generates an identity for the node if not provided in config.\n\t */\n\tNodeId: \"node-identity\",\n\n\t/**\n\t * NodeAdminUser - generates an admin user for the node if not provided in config.\n\t */\n\tNodeAdminUser: \"node-admin-user\",\n\n\t/**\n\t * NodeWallet - generates wallets for any identities that need them.\n\t */\n\tNodeWallet: \"node-wallet\"\n} as const;\n\n/**\n * The features that can be enabled on the node.\n */\nexport type NodeFeatures = (typeof NodeFeatures)[keyof typeof NodeFeatures];\n"]}

package/dist/es/server.js

@@ -1,81 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { GeneralError, I18n, Is } from "@twin.org/core";
-import { Engine } from "@twin.org/engine";
-import { FileStateStorage } from "@twin.org/engine-core";
-import { EngineCoreFactory } from "@twin.org/engine-models";
-import { EngineServer } from "@twin.org/engine-server";
-import { BlobStorageConnectorType, EntityStorageConnectorType } from "@twin.org/engine-types";
-import { bootstrap } from "./bootstrap.js";
-import { extensionsInitialiseEngine, extensionsInitialiseEngineServer, shutdownExtensions } from "./builders/extensionsBuilder.js";
-let isStarted = false;
-/**
- * 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 availableContextIdKeys The context ID keys available for operation.
- * @returns The engine server.
- */
-export async function start(nodeOptions, nodeEngineConfig, envVars, availableContextIdKeys) {
-    const entityStorageConnectorType = envVars.entityStorageConnectorType?.split(",") ?? [];
-    const blobStorageConnectorType = envVars.blobStorageConnectorType?.split(",") ?? [];
-    // If the blob storage or entity storage is configured with file connectors
-    // then we need to make sure the storageFileRoot is set
-    if ((entityStorageConnectorType.includes(EntityStorageConnectorType.File) ||
-        blobStorageConnectorType.includes(BlobStorageConnectorType.File) ||
-        Is.empty(nodeOptions?.stateStorage)) &&
-        !Is.stringValue(envVars.storageFileRoot)) {
-        throw new GeneralError("node", "storageFileRootNotSet", {
-            storageFileRoot: `${nodeOptions?.envPrefix ?? ""}STORAGE_FILE_ROOT`
-        });
-    }
-    // Create the engine instance using file state storage unless one is configured in options
-    const engine = new Engine({
-        config: nodeEngineConfig,
-        stateStorage: nodeOptions?.stateStorage ?? new FileStateStorage(envVars.stateFilename ?? ""),
-        customBootstrap: async (core, engineContext) => bootstrap(core, engineContext, envVars)
-    });
-    if (Is.arrayValue(availableContextIdKeys)) {
-        const added = [];
-        for (const availableContextIdKey of availableContextIdKeys) {
-            if (!added.includes(availableContextIdKey.key)) {
-                engine.addContextIdKey(availableContextIdKey.key, availableContextIdKey.componentFeatures);
-                added.push(availableContextIdKey.key);
-            }
-        }
-    }
-    // Construct the server with the engine.
-    const server = new EngineServer({ engineCore: engine });
-    // Extend the engine.
-    if (Is.function(nodeOptions?.extendEngine)) {
-        await engine.logInfo(I18n.formatMessage("node.extendingEngine"));
-        await nodeOptions.extendEngine(engine);
-    }
-    await extensionsInitialiseEngine(envVars, engine);
-    // Extend the engine server.
-    if (Is.function(nodeOptions?.extendEngineServer)) {
-        await engine.logInfo(I18n.formatMessage("node.extendingEngineServer"));
-        await nodeOptions?.extendEngineServer(server);
-    }
-    await extensionsInitialiseEngineServer(envVars, engine, server);
-    // Need to register the engine with the factory so that background tasks
-    // can clone it to spawn new instances.
-    EngineCoreFactory.register("engine", () => engine);
-    // Start the server, which also starts the engine.
-    isStarted = await server.start();
-    if (isStarted) {
-        return {
-            engine,
-            server,
-            shutdown: async () => {
-                if (isStarted) {
-                    isStarted = false;
-                    await shutdownExtensions(envVars, engine);
-                    await server.stop();
-                }
-            }
-        };
-    }
-}
-//# sourceMappingURL=server.js.map

package/dist/es/server.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACN,0BAA0B,EAC1B,gCAAgC,EAChC,kBAAkB,EAClB,MAAM,iCAAiC,CAAC;AAMzC,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAC1B,WAAqC,EACrC,gBAAmC,EACnC,OAAkC,EAClC,sBAAuE;IASvE,MAAM,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACxF,MAAM,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAEpF,2EAA2E;IAC3E,uDAAuD;IACvD,IACC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC;QACpE,wBAAwB,CAAC,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC;QAChE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACrC,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,EACvC,CAAC;QACF,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE,uBAAuB,EAAE;YACvD,eAAe,EAAE,GAAG,WAAW,EAAE,SAAS,IAAI,EAAE,mBAAmB;SACnE,CAAC,CAAC;IACJ,CAAC;IAED,0FAA0F;IAC1F,MAAM,MAAM,GAAG,IAAI,MAAM,CAAwC;QAChE,MAAM,EAAE,gBAAgB;QACxB,YAAY,EAAE,WAAW,EAAE,YAAY,IAAI,IAAI,gBAAgB,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;QAC5F,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC;KACvF,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,qBAAqB,IAAI,sBAAsB,EAAE,CAAC;YAC5D,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChD,MAAM,CAAC,eAAe,CAAC,qBAAqB,CAAC,GAAG,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;gBAC3F,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;QACF,CAAC;IACF,CAAC;IAED,wCAAwC;IACxC,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;IAExD,qBAAqB;IACrB,IAAI,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,CAAC;QAC5C,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACjE,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAElD,4BAA4B;IAC5B,IAAI,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAClD,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC,CAAC;QACvE,MAAM,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,gCAAgC,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhE,wEAAwE;IACxE,uCAAuC;IACvC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAEnD,kDAAkD;IAClD,SAAS,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IAEjC,IAAI,SAAS,EAAE,CAAC;QACf,OAAO;YACN,MAAM;YACN,MAAM;YACN,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACpB,IAAI,SAAS,EAAE,CAAC;oBACf,SAAS,GAAG,KAAK,CAAC;oBAClB,MAAM,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBAC1C,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACrB,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;AACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, I18n, Is } from \"@twin.org/core\";\nimport { Engine } from \"@twin.org/engine\";\nimport { FileStateStorage } from \"@twin.org/engine-core\";\nimport { EngineCoreFactory } from \"@twin.org/engine-models\";\nimport { EngineServer } from \"@twin.org/engine-server\";\nimport type { IEngineServerConfig } from \"@twin.org/engine-server-types\";\nimport { BlobStorageConnectorType, EntityStorageConnectorType } from \"@twin.org/engine-types\";\nimport { bootstrap } from \"./bootstrap.js\";\nimport {\n\textensionsInitialiseEngine,\n\textensionsInitialiseEngineServer,\n\tshutdownExtensions\n} from \"./builders/extensionsBuilder.js\";\nimport type { INodeEngineConfig } from \"./models/INodeEngineConfig.js\";\nimport type { INodeEngineState } from \"./models/INodeEngineState.js\";\nimport type { INodeEnvironmentVariables } from \"./models/INodeEnvironmentVariables.js\";\nimport type { INodeOptions } from \"./models/INodeOptions.js\";\n\nlet isStarted = false;\n\n/**\n * Start the engine server.\n * @param nodeOptions Optional run options for the engine server.\n * @param nodeEngineConfig The configuration for the engine server.\n * @param envVars The environment variables.\n * @param availableContextIdKeys The context ID keys available for operation.\n * @returns The engine server.\n */\nexport async function start(\n\tnodeOptions: INodeOptions | undefined,\n\tnodeEngineConfig: INodeEngineConfig,\n\tenvVars: INodeEnvironmentVariables,\n\tavailableContextIdKeys?: { key: string; componentFeatures: string[] }[]\n): Promise<\n\t| {\n\t\t\tengine: Engine<IEngineServerConfig, INodeEngineState>;\n\t\t\tserver: EngineServer;\n\t\t\tshutdown: () => Promise<void>;\n\t  }\n\t| undefined\n> {\n\tconst entityStorageConnectorType = envVars.entityStorageConnectorType?.split(\",\") ?? [];\n\tconst blobStorageConnectorType = envVars.blobStorageConnectorType?.split(\",\") ?? [];\n\n\t// If the blob storage or entity storage is configured with file connectors\n\t// then we need to make sure the storageFileRoot is set\n\tif (\n\t\t(entityStorageConnectorType.includes(EntityStorageConnectorType.File) ||\n\t\t\tblobStorageConnectorType.includes(BlobStorageConnectorType.File) ||\n\t\t\tIs.empty(nodeOptions?.stateStorage)) &&\n\t\t!Is.stringValue(envVars.storageFileRoot)\n\t) {\n\t\tthrow new GeneralError(\"node\", \"storageFileRootNotSet\", {\n\t\t\tstorageFileRoot: `${nodeOptions?.envPrefix ?? \"\"}STORAGE_FILE_ROOT`\n\t\t});\n\t}\n\n\t// Create the engine instance using file state storage unless one is configured in options\n\tconst engine = new Engine<IEngineServerConfig, INodeEngineState>({\n\t\tconfig: nodeEngineConfig,\n\t\tstateStorage: nodeOptions?.stateStorage ?? new FileStateStorage(envVars.stateFilename ?? \"\"),\n\t\tcustomBootstrap: async (core, engineContext) => bootstrap(core, engineContext, envVars)\n\t});\n\n\tif (Is.arrayValue(availableContextIdKeys)) {\n\t\tconst added: string[] = [];\n\t\tfor (const availableContextIdKey of availableContextIdKeys) {\n\t\t\tif (!added.includes(availableContextIdKey.key)) {\n\t\t\t\tengine.addContextIdKey(availableContextIdKey.key, availableContextIdKey.componentFeatures);\n\t\t\t\tadded.push(availableContextIdKey.key);\n\t\t\t}\n\t\t}\n\t}\n\n\t// Construct the server with the engine.\n\tconst server = new EngineServer({ engineCore: engine });\n\n\t// Extend the engine.\n\tif (Is.function(nodeOptions?.extendEngine)) {\n\t\tawait engine.logInfo(I18n.formatMessage(\"node.extendingEngine\"));\n\t\tawait nodeOptions.extendEngine(engine);\n\t}\n\n\tawait extensionsInitialiseEngine(envVars, engine);\n\n\t// Extend the engine server.\n\tif (Is.function(nodeOptions?.extendEngineServer)) {\n\t\tawait engine.logInfo(I18n.formatMessage(\"node.extendingEngineServer\"));\n\t\tawait nodeOptions?.extendEngineServer(server);\n\t}\n\n\tawait extensionsInitialiseEngineServer(envVars, engine, server);\n\n\t// Need to register the engine with the factory so that background tasks\n\t// can clone it to spawn new instances.\n\tEngineCoreFactory.register(\"engine\", () => engine);\n\n\t// Start the server, which also starts the engine.\n\tisStarted = await server.start();\n\n\tif (isStarted) {\n\t\treturn {\n\t\t\tengine,\n\t\t\tserver,\n\t\t\tshutdown: async () => {\n\t\t\t\tif (isStarted) {\n\t\t\t\t\tisStarted = false;\n\t\t\t\t\tawait shutdownExtensions(envVars, engine);\n\t\t\t\t\tawait server.stop();\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t}\n}\n"]}

package/dist/types/bootstrap.d.ts

@@ -1,68 +0,0 @@
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import { type IEngineServerConfig } from "@twin.org/engine-server-types";
-import type { INodeEngineState } from "./models/INodeEngineState.js";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
-import { NodeFeatures } from "./models/nodeFeatures.js";
-/**
- * Bootstrap the application.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- */
-export declare function bootstrap(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables): Promise<void>;
-/**
- * Bootstrap the node creating any necessary resources.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node. The features that are enabled on the node.
- */
-export declare function bootstrapNodeId(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the node creating any necessary resources.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node. The features that are enabled on the node.
- */
-export declare function bootstrapTenantId(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the user.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapNodeAdminUser(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the immutable proof verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapImmutableProofMethod(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the keys for blob encryption.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapBlobEncryption(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the JWT signing key.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapAuth(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the synchronised storage blob encryption and verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapSynchronisedStorage(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;

package/dist/types/identity.d.ts

@@ -1,14 +0,0 @@
-import type { IEngineCore } from "@twin.org/engine-models";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
-/**
- * Generate an identity and fund it.
- * @param engineCore The engine core for the node.
- * @param envVars The environment variables for the node.
- * @param configIdentity A identity from config to use.
- * @param configMnemonic A mnemonic from config to use.
- * @param controller The controller for the identity.
- * @param identityType The type of identity.
- * @param addWallet Whether to add a wallet for the identity.
- * @returns The identity that was generated.
- */
-export declare function createIdentity(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, configIdentity: string | undefined, configMnemonic: string | undefined, controller: string | undefined, identityType: "node" | "organization" | "user", addWallet: boolean): Promise<string>;

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

@@ -1,21 +0,0 @@
-/**
- * The features that can be enabled on the node.
- */
-export declare const NodeFeatures: {
-    /**
-     * NodeId - generates an identity for the node if not provided in config.
-     */
-    readonly NodeId: "node-identity";
-    /**
-     * NodeAdminUser - generates an admin user for the node if not provided in config.
-     */
-    readonly NodeAdminUser: "node-admin-user";
-    /**
-     * NodeWallet - generates wallets for any identities that need them.
-     */
-    readonly NodeWallet: "node-wallet";
-};
-/**
- * The features that can be enabled on the node.
- */
-export type NodeFeatures = (typeof NodeFeatures)[keyof typeof NodeFeatures];

package/docs/detailed-guide.md

@@ -1,129 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# Function: bootstrap()
-
-> **bootstrap**(`engineCore`, `context`, `envVars`): `Promise`\<`void`\>
-
-Bootstrap the application.
-
-## 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.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapAuth.md

@@ -1,35 +0,0 @@
-# Function: bootstrapAuth()
-
-> **bootstrapAuth**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the JWT signing key.
-
-## 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.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapBlobEncryption.md

@@ -1,35 +0,0 @@
-# Function: bootstrapBlobEncryption()
-
-> **bootstrapBlobEncryption**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the keys for blob encryption.
-
-## 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.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapImmutableProofMethod.md

@@ -1,35 +0,0 @@
-# Function: bootstrapImmutableProofMethod()
-
-> **bootstrapImmutableProofMethod**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the immutable proof verification methods.
-
-## 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.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapNodeAdminUser.md

@@ -1,35 +0,0 @@
-# Function: bootstrapNodeAdminUser()
-
-> **bootstrapNodeAdminUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the user.
-
-## 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.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapNodeId.md

@@ -1,35 +0,0 @@
-# Function: bootstrapNodeId()
-
-> **bootstrapNodeId**(`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/bootstrapSynchronisedStorage.md

@@ -1,35 +0,0 @@
-# Function: bootstrapSynchronisedStorage()
-
-> **bootstrapSynchronisedStorage**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
-
-Bootstrap the synchronised storage blob encryption and verification methods.
-
-## 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.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/functions/bootstrapTenantId.md

@@ -1,35 +0,0 @@
-# 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/getFeatures.md

@@ -1,19 +0,0 @@
-# Function: getFeatures()
-
-> **getFeatures**(`env`): [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-Get the features that are enabled on the node.
-
-## Parameters
-
-### env
-
-[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
-
-The environment variables for the node.
-
-## Returns
-
-[`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
-
-The features that are enabled on the node.

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

@@ -1,5 +0,0 @@
-# Type Alias: NodeFeatures
-
-> **NodeFeatures** = *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\[keyof *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\]
-
-The features that can be enabled on the node.