@twin.org/engine-core 0.0.3-next.5 → 0.0.3-next.51

package/dist/es/storage/memoryStateStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"memoryStateStorage.js","sourceRoot":"","sources":["../../../src/storage/memoryStateStorage.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAItC;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAG9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;OAGG;IACc,aAAa,CAAU;IAExC;;;OAGG;IACK,YAAY,CAAK;IAEzB;;;;OAIG;IACH,YAAY,eAAwB,KAAK,EAAE,KAAS;QACnD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,UAAuB;QACxC,UAAU,CAAC,OAAO,CACjB,IAAI,CAAC,aAAa,CAAC,GAAG,oBAAqC,UAAU,EAAE;YACtE,QAAQ,EAAE,IAAI,CAAC,YAAY;SAC3B,CAAC,CACF,CAAC;QACF,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,UAAuB,EAAE,KAAQ;QAClD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACzB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,oBAAqC,SAAS,CAAC,CAAC,CAAC;YAC1F,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC3B,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { I18n } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineState, IEngineStateStorage } from \"@twin.org/engine-models\";\nimport { nameof, nameofCamelCase } from \"@twin.org/nameof\";\n\n/**\n * Store state in memory.\n */\nexport class MemoryStateStorage<S extends IEngineState = IEngineState>\n\timplements IEngineStateStorage<S>\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<MemoryStateStorage>();\n\n\t/**\n\t * Readonly mode state file is not updated.\n\t * @internal\n\t */\n\tprivate readonly _readonlyMode: boolean;\n\n\t/**\n\t * The state object.\n\t * @internal\n\t */\n\tprivate _engineState?: S;\n\n\t/**\n\t * Create a new instance of MemoryStateStorage.\n\t * @param readonlyMode Whether the file is in read-only mode.\n\t * @param state The initial state.\n\t */\n\tconstructor(readonlyMode: boolean = false, state?: S) {\n\t\tthis._readonlyMode = readonlyMode;\n\t\tthis._engineState = state;\n\t}\n\n\t/**\n\t * Method for loading the state.\n\t * @param engineCore The engine core to load the state for.\n\t * @returns The state of the engine or undefined if it doesn't exist.\n\t */\n\tpublic async load(engineCore: IEngineCore): Promise<S | undefined> {\n\t\tengineCore.logInfo(\n\t\t\tI18n.formatMessage(`${nameofCamelCase<MemoryStateStorage>()}.loading`, {\n\t\t\t\tfilename: this._engineState\n\t\t\t})\n\t\t);\n\t\treturn this._engineState;\n\t}\n\n\t/**\n\t * Method for saving the state.\n\t * @param engineCore The engine core to save the state for.\n\t * @param state The state of the engine to save.\n\t * @returns Nothing.\n\t */\n\tpublic async save(engineCore: IEngineCore, state: S): Promise<void> {\n\t\tif (!this._readonlyMode) {\n\t\t\tengineCore.logInfo(I18n.formatMessage(`${nameofCamelCase<MemoryStateStorage>()}.saving`));\n\t\t\tthis._engineState = state;\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"memoryStateStorage.js","sourceRoot":"","sources":["../../../src/storage/memoryStateStorage.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAItC;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAG9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;OAGG;IACc,aAAa,CAAU;IAExC;;;OAGG;IACK,YAAY,CAAK;IAEzB;;;;OAIG;IACH,YAAY,eAAwB,KAAK,EAAE,KAAS;QACnD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,UAAuB;QACxC,UAAU,CAAC,OAAO,CACjB,IAAI,CAAC,aAAa,CAAC,GAAG,oBAAqC,UAAU,EAAE;YACtE,QAAQ,EAAE,IAAI,CAAC,YAAY;SAC3B,CAAC,CACF,CAAC;QACF,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,UAAuB,EAAE,KAAQ;QAClD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACzB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,oBAAqC,SAAS,CAAC,CAAC,CAAC;YAC1F,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC3B,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { I18n } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineState, IEngineStateStorage } from \"@twin.org/engine-models\";\nimport { nameof, nameofCamelCase } from \"@twin.org/nameof\";\n\n/**\n * Store state in memory.\n */\nexport class MemoryStateStorage<\n\tS extends IEngineState = IEngineState\n> implements IEngineStateStorage<S> {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<MemoryStateStorage>();\n\n\t/**\n\t * Readonly mode state file is not updated.\n\t * @internal\n\t */\n\tprivate readonly _readonlyMode: boolean;\n\n\t/**\n\t * The state object.\n\t * @internal\n\t */\n\tprivate _engineState?: S;\n\n\t/**\n\t * Create a new instance of MemoryStateStorage.\n\t * @param readonlyMode Whether the file is in read-only mode.\n\t * @param state The initial state.\n\t */\n\tconstructor(readonlyMode: boolean = false, state?: S) {\n\t\tthis._readonlyMode = readonlyMode;\n\t\tthis._engineState = state;\n\t}\n\n\t/**\n\t * Method for loading the state.\n\t * @param engineCore The engine core to load the state for.\n\t * @returns The state of the engine or undefined if it doesn't exist.\n\t */\n\tpublic async load(engineCore: IEngineCore): Promise<S | undefined> {\n\t\tengineCore.logInfo(\n\t\t\tI18n.formatMessage(`${nameofCamelCase<MemoryStateStorage>()}.loading`, {\n\t\t\t\tfilename: this._engineState\n\t\t\t})\n\t\t);\n\t\treturn this._engineState;\n\t}\n\n\t/**\n\t * Method for saving the state.\n\t * @param engineCore The engine core to save the state for.\n\t * @param state The state of the engine to save.\n\t * @returns A promise that resolves when the state has been stored in memory.\n\t */\n\tpublic async save(engineCore: IEngineCore, state: S): Promise<void> {\n\t\tif (!this._readonlyMode) {\n\t\t\tengineCore.logInfo(I18n.formatMessage(`${nameofCamelCase<MemoryStateStorage>()}.saving`));\n\t\t\tthis._engineState = state;\n\t\t}\n\t}\n}\n"]}

package/dist/types/engineCore.d.ts

@@ -1,5 +1,5 @@
 import { type IContextIds } from "@twin.org/context";
-import { type IError } from "@twin.org/core";
+import { type IComponent, type IError } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreClone, IEngineCoreConfig, IEngineCoreContext, IEngineCoreTypeConfig, IEngineState } from "@twin.org/engine-models";
 import type { IEngineCoreOptions } from "./models/IEngineCoreOptions.js";
 /**
@@ -75,12 +75,13 @@ export declare class EngineCore<C extends IEngineCoreConfig = IEngineCoreConfig,
     getContextIds(): IContextIds | undefined;
     /**
      * Start the engine core.
-     * @returns True if the start was successful.
+     * @param skipComponentStart Should the component start be skipped.
+     * @returns A promise that resolves when the engine and all components have started.
      */
-    start(): Promise<boolean>;
+    start(skipComponentStart?: boolean): Promise<void>;
     /**
      * Stop the engine core.
-     * @returns Nothing.
+     * @returns A promise that resolves when all components have stopped and state has been saved.
      */
     stop(): Promise<void>;
     /**
@@ -101,11 +102,13 @@ export declare class EngineCore<C extends IEngineCoreConfig = IEngineCoreConfig,
     /**
      * Log info.
      * @param message The message to log.
+     * @returns A promise that resolves when the message has been logged.
      */
     logInfo(message: string): Promise<void>;
     /**
      * Log error.
      * @param error The error to log.
+     * @returns A promise that resolves when the error has been logged.
      */
     logError(error: IError): Promise<void>;
     /**
@@ -118,6 +121,10 @@ export declare class EngineCore<C extends IEngineCoreConfig = IEngineCoreConfig,
      * @returns The state of the engine.
      */
     getState(): S;
+    /**
+     * Set the state to dirty so it gets saved.
+     */
+    setStateDirty(): void;
     /**
      * Get all the registered instances.
      * @returns The registered instances.
@@ -144,6 +151,28 @@ export declare class EngineCore<C extends IEngineCoreConfig = IEngineCoreConfig,
      * @returns The instance type matching the criteria if one is registered.
      */
     getRegisteredInstanceTypeOptional(componentConnectorType: string, features?: string[]): string | undefined;
+    /**
+     * Get the registered logger for the component/connector.
+     * @param componentName The name of the component to get the logger for.
+     * @returns The logger type name if one is registered and not silenced.
+     */
+    getRegisteredLoggerType(componentName: string): string | undefined;
+    /**
+     * Get the registered components.
+     * @returns The registered components.
+     */
+    getRegisteredComponents(): Promise<{
+        instanceType: string;
+        component: IComponent;
+        initialised: boolean;
+    }[]>;
+    /**
+     * Add a registered component to the engine.
+     * @param instanceType The instance type to register the component under.
+     * @param component The component to register.
+     * @returns A promise that resolves when the component has been registered.
+     */
+    addRegisteredComponent(instanceType: string, component: IComponent): Promise<void>;
     /**
      * Get the data required to create a clone of the engine.
      * @returns The clone data.
@@ -152,7 +181,8 @@ export declare class EngineCore<C extends IEngineCoreConfig = IEngineCoreConfig,
     /**
      * Populate the engine from the clone data.
      * @param cloneData The clone data to populate from.
+     * @param contextIds The context IDs to use for the clone.
      * @param silent Should the clone be silent.
      */
-    populateClone(cloneData: IEngineCoreClone<C, S>, silent?: boolean): void;
+    populateClone(cloneData: IEngineCoreClone<C, S>, contextIds?: IContextIds, silent?: boolean): void;
 }

package/dist/types/index.d.ts

@@ -2,4 +2,3 @@ export * from "./engineCore.js";
 export * from "./models/IEngineCoreOptions.js";
 export * from "./storage/fileStateStorage.js";
 export * from "./storage/memoryStateStorage.js";
-export * from "./utils/engineModuleHelper.js";

package/dist/types/storage/fileStateStorage.d.ts

@@ -23,7 +23,7 @@ export declare class FileStateStorage<S extends IEngineState = IEngineState> imp
      * Method for saving the state.
      * @param engineCore The engine core to save the state for.
      * @param state The state of the engine to save.
-     * @returns Nothing.
+     * @returns A promise that resolves when the state has been written to disk.
      */
     save(engineCore: IEngineCore, state: S): Promise<void>;
 }

package/dist/types/storage/memoryStateStorage.d.ts

@@ -23,7 +23,7 @@ export declare class MemoryStateStorage<S extends IEngineState = IEngineState> i
      * Method for saving the state.
      * @param engineCore The engine core to save the state for.
      * @param state The state of the engine to save.
-     * @returns Nothing.
+     * @returns A promise that resolves when the state has been stored in memory.
      */
     save(engineCore: IEngineCore, state: S): Promise<void>;
 }