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

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,9 +75,10 @@ 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 Nothing.
      */
-    start(): Promise<boolean>;
+    start(skipComponentStart?: boolean): Promise<void>;
     /**
      * Stop the engine core.
      * @returns Nothing.
@@ -118,6 +119,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 +149,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 Nothing.
+     */
+    addRegisteredComponent(instanceType: string, component: IComponent): Promise<void>;
     /**
      * Get the data required to create a clone of the engine.
      * @returns The clone data.
@@ -152,7 +179,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;
 }