@twin.org/engine-models 0.0.1-next.12 → 0.0.1-next.13

package/dist/types/index.d.ts

@@ -36,6 +36,7 @@ export * from "./models/config/typeConfig/vaultConnectorConfig";
 export * from "./models/config/typeConfig/walletConnectorConfig";
 export * from "./models/engineTypeInitialiser";
 export * from "./models/IEngineCore";
+export * from "./models/IEngineCoreClone";
 export * from "./models/IEngineCoreContext";
 export * from "./models/IEngineServer";
 export * from "./models/IEngineState";

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

@@ -3,6 +3,7 @@ import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
 import type { IEngineCoreTypeBaseConfig } from "./config/IEngineCoreTypeBaseConfig";
 import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
 import type { EngineTypeInitialiser } from "./engineTypeInitialiser";
+import type { IEngineCoreClone } from "./IEngineCoreClone";
 import type { IEngineState } from "./IEngineState";
 /**
  * Interface describing the engine core methods.
@@ -52,4 +53,14 @@ export interface IEngineCore<S extends IEngineState = IEngineState> {
     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/models/IEngineCoreClone.d.ts

@@ -0,0 +1,15 @@
+import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
+import type { IEngineState } from "./IEngineState";
+/**
+ * Interface describing the data required to clone an engine.
+ */
+export interface IEngineCoreClone<S extends IEngineState = IEngineState> {
+    /**
+     * The config for the engine.
+     */
+    config: IEngineCoreConfig;
+    /**
+     * The state of the engine.
+     */
+    state: S;
+}

package/docs/changelog.md

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

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Interfaces
 
 - [IEngineCore](interfaces/IEngineCore.md)
+- [IEngineCoreClone](interfaces/IEngineCoreClone.md)
 - [IEngineCoreContext](interfaces/IEngineCoreContext.md)
 - [IEngineServer](interfaces/IEngineServer.md)
 - [IEngineState](interfaces/IEngineState.md)

package/docs/reference/interfaces/IEngineCore.md

@@ -141,3 +141,35 @@ Get the types for the component.
 `object`
 
 The default types.
+
+***
+
+### getCloneData()
+
+> **getCloneData**(): [`IEngineCoreClone`](IEngineCoreClone.md)\<[`IEngineState`](IEngineState.md)\>
+
+Get the data required to create a clone of the engine.
+
+#### Returns
+
+[`IEngineCoreClone`](IEngineCoreClone.md)\<[`IEngineState`](IEngineState.md)\>
+
+The clone data.
+
+***
+
+### populateClone()
+
+> **populateClone**(`cloneData`): `void`
+
+Populate the engine from the clone data.
+
+#### Parameters
+
+• **cloneData**: [`IEngineCoreClone`](IEngineCoreClone.md)\<[`IEngineState`](IEngineState.md)\>
+
+The clone data to populate from.
+
+#### Returns
+
+`void`

package/docs/reference/interfaces/IEngineCoreClone.md

@@ -0,0 +1,23 @@
+# Interface: IEngineCoreClone\<S\>
+
+Interface describing the data required to clone an engine.
+
+## Type Parameters
+
+• **S** *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
+
+## Properties
+
+### config
+
+> **config**: [`IEngineCoreConfig`](IEngineCoreConfig.md)
+
+The config for the engine.
+
+***
+
+### state
+
+> **state**: `S`
+
+The state of the engine.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-models",
-	"version": "0.0.1-next.12",
+	"version": "0.0.1-next.13",
 	"description": "Models which define the structure of the engine.",
 	"repository": {
 		"type": "git",