@twin.org/engine-core 0.0.1-next.11 → 0.0.1-next.13

package/dist/cjs/index.cjs

@@ -107,7 +107,7 @@ function initialiseEntityStorageConnector(engineCore, context, typeCustom, schem
             ...entityStorageConfig.options,
             config: {
                 ...entityStorageConfig.options.config,
-                directory: path.join(entityStorageConfig.options.config.directory, instanceName)
+                directory: path.join(entityStorageConfig.options.config.directory, `${entityStorageConfig.options.folderPrefix ?? ""}${instanceName}`)
             }
         });
     }
@@ -1189,6 +1189,60 @@ function initialiseWalletStorage(engineCore, context, instanceConfig, overrideIn
     return undefined;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Store state in memory.
+ */
+class MemoryStateStorage {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "MemoryStateStorage";
+    /**
+     * Readonly mode state file is not updated.
+     * @internal
+     */
+    _readonlyMode;
+    /**
+     * The state object.
+     * @internal
+     */
+    _engineState;
+    /**
+     * Create a new instance of MemoryStateStorage.
+     * @param readonlyMode Whether the file is in read-only mode.
+     * @param state The initial state.
+     */
+    constructor(readonlyMode = false, state) {
+        this._readonlyMode = readonlyMode;
+        this._engineState = state;
+    }
+    /**
+     * Method for loading the state.
+     * @param engineCore The engine core to load the state for.
+     * @returns The state of the engine or undefined if it doesn't exist.
+     */
+    async load(engineCore) {
+        engineCore.logInfo(core.I18n.formatMessage(`${core.StringHelper.camelCase(this.CLASS_NAME)}.loading`, {
+            filename: this._engineState
+        }));
+        return this._engineState;
+    }
+    /**
+     * 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.
+     */
+    async save(engineCore, state) {
+        if (!this._readonlyMode) {
+            engineCore.logInfo(core.I18n.formatMessage(`${core.StringHelper.camelCase(this.CLASS_NAME)}.saving`));
+            this._engineState = state;
+        }
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1387,6 +1441,36 @@ class EngineCore {
     getDefaultTypes() {
         return this._context.defaultTypes;
     }
+    /**
+     * Get the data required to create a clone of the engine.
+     * @returns The clone data.
+     */
+    getCloneData() {
+        const cloneData = {
+            config: this._context.config,
+            state: this._context.state
+        };
+        return cloneData;
+    }
+    /**
+     * Populate the engine from the clone data.
+     * @param cloneData The clone data to populate from.
+     */
+    populateClone(cloneData) {
+        core.Guards.object(this.CLASS_NAME, "cloneData", cloneData);
+        core.Guards.object(this.CLASS_NAME, "cloneData.config", cloneData.config);
+        core.Guards.object(this.CLASS_NAME, "cloneData.state", cloneData.state);
+        this._context = {
+            config: cloneData.config,
+            defaultTypes: {},
+            componentInstances: [],
+            state: { bootstrappedComponents: [] },
+            stateDirty: false
+        };
+        this.addCoreTypeInitialisers();
+        this._stateStorage = new MemoryStateStorage(true, cloneData.state);
+        this._isStarted = false;
+    }
     /**
      * Initialise the types from connector.
      * @param typeKey The key for the default types.
@@ -1636,58 +1720,6 @@ class FileStateStorage {
     }
 }
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Store state in memory.
- */
-class MemoryStateStorage {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "MemoryStateStorage";
-    /**
-     * Readonly mode state file is not updated.
-     * @internal
-     */
-    _readonlyMode;
-    /**
-     * The state object.
-     * @internal
-     */
-    _engineState;
-    /**
-     * Create a new instance of MemoryStateStorage.
-     * @param readonlyMode Whether the file is in read-only mode.
-     */
-    constructor(readonlyMode = false) {
-        this._readonlyMode = readonlyMode;
-    }
-    /**
-     * Method for loading the state.
-     * @param engineCore The engine core to load the state for.
-     * @returns The state of the engine or undefined if it doesn't exist.
-     */
-    async load(engineCore) {
-        engineCore.logInfo(core.I18n.formatMessage(`${core.StringHelper.camelCase(this.CLASS_NAME)}.loading`, {
-            filename: this._engineState
-        }));
-        return this._engineState;
-    }
-    /**
-     * 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.
-     */
-    async save(engineCore, state) {
-        if (!this._readonlyMode) {
-            engineCore.logInfo(core.I18n.formatMessage(`${core.StringHelper.camelCase(this.CLASS_NAME)}.saving`));
-            this._engineState = state;
-        }
-    }
-}
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1785,7 +1817,10 @@ function configureEntityStorageConnectors(coreConfig, envVars) {
         envVars.entityStorageConnectorType === engineModels.EntityStorageConnectorType.File) {
         coreConfig.entityStorageConnector.push({
             type: engineModels.EntityStorageConnectorType.File,
-            options: { config: { directory: envVars.storageFileRoot } }
+            options: {
+                config: { directory: envVars.storageFileRoot },
+                folderPrefix: envVars.entityStorageTablePrefix
+            }
         });
     }
     if (core.Is.stringValue(envVars.awsDynamodbAccessKeyId)) {

package/dist/esm/index.mjs

@@ -105,7 +105,7 @@ function initialiseEntityStorageConnector(engineCore, context, typeCustom, schem
             ...entityStorageConfig.options,
             config: {
                 ...entityStorageConfig.options.config,
-                directory: path.join(entityStorageConfig.options.config.directory, instanceName)
+                directory: path.join(entityStorageConfig.options.config.directory, `${entityStorageConfig.options.folderPrefix ?? ""}${instanceName}`)
             }
         });
     }
@@ -1187,6 +1187,60 @@ function initialiseWalletStorage(engineCore, context, instanceConfig, overrideIn
     return undefined;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Store state in memory.
+ */
+class MemoryStateStorage {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "MemoryStateStorage";
+    /**
+     * Readonly mode state file is not updated.
+     * @internal
+     */
+    _readonlyMode;
+    /**
+     * The state object.
+     * @internal
+     */
+    _engineState;
+    /**
+     * Create a new instance of MemoryStateStorage.
+     * @param readonlyMode Whether the file is in read-only mode.
+     * @param state The initial state.
+     */
+    constructor(readonlyMode = false, state) {
+        this._readonlyMode = readonlyMode;
+        this._engineState = state;
+    }
+    /**
+     * Method for loading the state.
+     * @param engineCore The engine core to load the state for.
+     * @returns The state of the engine or undefined if it doesn't exist.
+     */
+    async load(engineCore) {
+        engineCore.logInfo(I18n.formatMessage(`${StringHelper.camelCase(this.CLASS_NAME)}.loading`, {
+            filename: this._engineState
+        }));
+        return this._engineState;
+    }
+    /**
+     * 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.
+     */
+    async save(engineCore, state) {
+        if (!this._readonlyMode) {
+            engineCore.logInfo(I18n.formatMessage(`${StringHelper.camelCase(this.CLASS_NAME)}.saving`));
+            this._engineState = state;
+        }
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1385,6 +1439,36 @@ class EngineCore {
     getDefaultTypes() {
         return this._context.defaultTypes;
     }
+    /**
+     * Get the data required to create a clone of the engine.
+     * @returns The clone data.
+     */
+    getCloneData() {
+        const cloneData = {
+            config: this._context.config,
+            state: this._context.state
+        };
+        return cloneData;
+    }
+    /**
+     * Populate the engine from the clone data.
+     * @param cloneData The clone data to populate from.
+     */
+    populateClone(cloneData) {
+        Guards.object(this.CLASS_NAME, "cloneData", cloneData);
+        Guards.object(this.CLASS_NAME, "cloneData.config", cloneData.config);
+        Guards.object(this.CLASS_NAME, "cloneData.state", cloneData.state);
+        this._context = {
+            config: cloneData.config,
+            defaultTypes: {},
+            componentInstances: [],
+            state: { bootstrappedComponents: [] },
+            stateDirty: false
+        };
+        this.addCoreTypeInitialisers();
+        this._stateStorage = new MemoryStateStorage(true, cloneData.state);
+        this._isStarted = false;
+    }
     /**
      * Initialise the types from connector.
      * @param typeKey The key for the default types.
@@ -1634,58 +1718,6 @@ class FileStateStorage {
     }
 }
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Store state in memory.
- */
-class MemoryStateStorage {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "MemoryStateStorage";
-    /**
-     * Readonly mode state file is not updated.
-     * @internal
-     */
-    _readonlyMode;
-    /**
-     * The state object.
-     * @internal
-     */
-    _engineState;
-    /**
-     * Create a new instance of MemoryStateStorage.
-     * @param readonlyMode Whether the file is in read-only mode.
-     */
-    constructor(readonlyMode = false) {
-        this._readonlyMode = readonlyMode;
-    }
-    /**
-     * Method for loading the state.
-     * @param engineCore The engine core to load the state for.
-     * @returns The state of the engine or undefined if it doesn't exist.
-     */
-    async load(engineCore) {
-        engineCore.logInfo(I18n.formatMessage(`${StringHelper.camelCase(this.CLASS_NAME)}.loading`, {
-            filename: this._engineState
-        }));
-        return this._engineState;
-    }
-    /**
-     * 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.
-     */
-    async save(engineCore, state) {
-        if (!this._readonlyMode) {
-            engineCore.logInfo(I18n.formatMessage(`${StringHelper.camelCase(this.CLASS_NAME)}.saving`));
-            this._engineState = state;
-        }
-    }
-}
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1783,7 +1815,10 @@ function configureEntityStorageConnectors(coreConfig, envVars) {
         envVars.entityStorageConnectorType === EntityStorageConnectorType.File) {
         coreConfig.entityStorageConnector.push({
             type: EntityStorageConnectorType.File,
-            options: { config: { directory: envVars.storageFileRoot } }
+            options: {
+                config: { directory: envVars.storageFileRoot },
+                folderPrefix: envVars.entityStorageTablePrefix
+            }
         });
     }
     if (Is.stringValue(envVars.awsDynamodbAccessKeyId)) {

package/dist/types/engineCore.d.ts

@@ -1,5 +1,5 @@
 import { type IError } from "@twin.org/core";
-import type { EngineTypeInitialiser, IEngineCore, IEngineCoreConfig, IEngineCoreTypeBaseConfig, IEngineCoreTypeConfig, IEngineState } from "@twin.org/engine-models";
+import type { EngineTypeInitialiser, IEngineCore, IEngineCoreClone, IEngineCoreConfig, IEngineCoreTypeBaseConfig, IEngineCoreTypeConfig, IEngineState } from "@twin.org/engine-models";
 import type { IEngineCoreOptions } from "./models/IEngineCoreOptions";
 /**
  * Core for the engine.
@@ -62,4 +62,14 @@ export declare class EngineCore<S extends IEngineState = IEngineState> implement
     getDefaultTypes(): {
         [type: string]: string;
     };
+    /**
+     * Get the data required to create a clone of the engine.
+     * @returns The clone data.
+     */
+    getCloneData(): IEngineCoreClone;
+    /**
+     * Populate the engine from the clone data.
+     * @param cloneData The clone data to populate from.
+     */
+    populateClone(cloneData: IEngineCoreClone): void;
 }

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

@@ -10,8 +10,9 @@ export declare class MemoryStateStorage<S extends IEngineState = IEngineState> i
     /**
      * Create a new instance of MemoryStateStorage.
      * @param readonlyMode Whether the file is in read-only mode.
+     * @param state The initial state.
      */
-    constructor(readonlyMode?: boolean);
+    constructor(readonlyMode?: boolean, state?: S);
     /**
      * Method for loading the state.
      * @param engineCore The engine core to load the state for.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/engine-core - Changelog
 
-## v0.0.1-next.11
+## v0.0.1-next.13
 
 - Initial Release

package/docs/reference/classes/EngineCore.md

@@ -211,3 +211,43 @@ The default types.
 #### Implementation of
 
 `IEngineCore.getDefaultTypes`
+
+***
+
+### getCloneData()
+
+> **getCloneData**(): `IEngineCoreClone`\<`IEngineState`\>
+
+Get the data required to create a clone of the engine.
+
+#### Returns
+
+`IEngineCoreClone`\<`IEngineState`\>
+
+The clone data.
+
+#### Implementation of
+
+`IEngineCore.getCloneData`
+
+***
+
+### populateClone()
+
+> **populateClone**(`cloneData`): `void`
+
+Populate the engine from the clone data.
+
+#### Parameters
+
+• **cloneData**: `IEngineCoreClone`\<`IEngineState`\>
+
+The clone data to populate from.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.populateClone`

package/docs/reference/classes/MemoryStateStorage.md

@@ -14,7 +14,7 @@ Store state in memory.
 
 ### new MemoryStateStorage()
 
-> **new MemoryStateStorage**\<`S`\>(`readonlyMode`): [`MemoryStateStorage`](MemoryStateStorage.md)\<`S`\>
+> **new MemoryStateStorage**\<`S`\>(`readonlyMode`, `state`?): [`MemoryStateStorage`](MemoryStateStorage.md)\<`S`\>
 
 Create a new instance of MemoryStateStorage.
 
@@ -24,6 +24,10 @@ Create a new instance of MemoryStateStorage.
 
 Whether the file is in read-only mode.
 
+• **state?**: `S`
+
+The initial state.
+
 #### Returns
 
 [`MemoryStateStorage`](MemoryStateStorage.md)\<`S`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-core",
-	"version": "0.0.1-next.11",
+	"version": "0.0.1-next.13",
 	"description": "Engine implementation for a core.",
 	"repository": {
 		"type": "git",
@@ -43,7 +43,7 @@
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-schema-org": "next",
-		"@twin.org/engine-models": "0.0.1-next.11",
+		"@twin.org/engine-models": "0.0.1-next.13",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",