@twin.org/engine-models 0.0.1-next.9 → 0.0.1

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

@@ -1,6 +1,4 @@
 import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
-import type { RestRouteGenerator } from "./restRouteGenerator";
-import type { SocketRouteGenerator } from "./socketRouteGenerator";
 /**
  * Interface describing the engine server methods.
  */
@@ -9,21 +7,23 @@ export interface IEngineServer {
      * Add a REST route generator.
      * @param type The type to add the generator for.
      * @param typeConfig The type config.
-     * @param generator The generator to add.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      */
-    addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, generator: RestRouteGenerator): void;
+    addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
     /**
      * Add a socket route generator.
      * @param type The type to add the generator for.
      * @param typeConfig The type config.
-     * @param generator The generator to add.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      */
-    addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, generator: SocketRouteGenerator): void;
+    addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
     /**
      * Start the engine server.
-     * @returns Nothing.
+     * @returns True if the start was successful.
      */
-    start(): Promise<void>;
+    start(): Promise<boolean>;
     /**
      * Stop the engine server.
      * @returns Nothing.

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

@@ -7,7 +7,11 @@ export interface IEngineState {
      */
     nodeIdentity?: string;
     /**
-     * The ids of the bootstrapped components.
+     * The component states.
      */
-    bootstrappedComponents: string[];
+    componentStates: {
+        [component: string]: {
+            [id: string]: unknown;
+        };
+    };
 }

package/dist/types/models/config/IEngineCoreConfig.d.ts

@@ -1,29 +1,4 @@
 import type { IEngineCoreTypeConfig } from "./IEngineCoreTypeConfig";
-import type { AttestationComponentConfig } from "./typeConfig/attestationComponentConfig";
-import type { AttestationConnectorConfig } from "./typeConfig/attestationConnectorConfig";
-import type { AuditableItemGraphComponentConfig } from "./typeConfig/auditableItemGraphComponentConfig";
-import type { AuditableItemStreamComponentConfig } from "./typeConfig/auditableItemStreamComponentConfig";
-import type { BackgroundTaskConnectorConfig } from "./typeConfig/backgroundTaskConnectorConfig";
-import type { BlobStorageComponentConfig } from "./typeConfig/blobStorageComponentConfig";
-import type { BlobStorageConnectorConfig } from "./typeConfig/blobStorageConnectorConfig";
-import type { DltConfig } from "./typeConfig/dltConfig";
-import type { EntityStorageComponentConfig } from "./typeConfig/entityStorageComponentConfig";
-import type { EntityStorageConnectorConfig } from "./typeConfig/entityStorageConnectorConfig";
-import type { FaucetConnectorConfig } from "./typeConfig/faucetConnectorConfig";
-import type { IdentityComponentConfig } from "./typeConfig/identityComponentConfig";
-import type { IdentityConnectorConfig } from "./typeConfig/identityConnectorConfig";
-import type { IdentityProfileComponentConfig } from "./typeConfig/identityProfileComponentConfig";
-import type { IdentityProfileConnectorConfig } from "./typeConfig/identityProfileConnectorConfig";
-import type { ImmutableProofComponentConfig } from "./typeConfig/immutableProofComponentConfig";
-import type { ImmutableStorageConnectorConfig } from "./typeConfig/immutableStorageConnectorConfig";
-import type { LoggingComponentConfig } from "./typeConfig/loggingComponentConfig";
-import type { LoggingConnectorConfig } from "./typeConfig/loggingConnectorConfig";
-import type { NftComponentConfig } from "./typeConfig/nftComponentConfig";
-import type { NftConnectorConfig } from "./typeConfig/nftConnectorConfig";
-import type { TelemetryComponentConfig } from "./typeConfig/telemetryComponentConfig";
-import type { TelemetryConnectorConfig } from "./typeConfig/telemetryConnectorConfig";
-import type { VaultConnectorConfig } from "./typeConfig/vaultConnectorConfig";
-import type { WalletConnectorConfig } from "./typeConfig/walletConnectorConfig";
 /**
  * Configuration for the engine core.
  */
@@ -39,103 +14,9 @@ export interface IEngineCoreConfig {
      */
     silent?: boolean;
     /**
-     * Logging connector options which can be overridden by individual components by specifying types other than default.
+     * The types to initialise in the engine.
      */
-    loggingConnector?: IEngineCoreTypeConfig<LoggingConnectorConfig>[];
-    /**
-     * Logging component options which can be overridden by individual components by specifying types other than default.
-     */
-    loggingComponent?: IEngineCoreTypeConfig<LoggingComponentConfig>[];
-    /**
-     * Entity storage connector options which can be overridden by individual components by specifying types other than default.
-     */
-    entityStorageConnector?: IEngineCoreTypeConfig<EntityStorageConnectorConfig>[];
-    /**
-     * Entity storage component options which can be overridden by individual components by specifying types other than default.
-     */
-    entityStorageComponent?: IEngineCoreTypeConfig<EntityStorageComponentConfig>[];
-    /**
-     * Blob storage connector options which can be overridden by individual components by specifying types other than default.
-     */
-    blobStorageConnector?: IEngineCoreTypeConfig<BlobStorageConnectorConfig>[];
-    /**
-     * Blob storage component options which can be overridden by individual components by specifying types other than default.
-     */
-    blobStorageComponent?: IEngineCoreTypeConfig<BlobStorageComponentConfig>[];
-    /**
-     * Telemetry connector options which can be overridden by individual components by specifying types other than default.
-     */
-    telemetryConnector?: IEngineCoreTypeConfig<TelemetryConnectorConfig>[];
-    /**
-     * Telemetry component options which can be overridden by individual components by specifying types other than default.
-     */
-    telemetryComponent?: IEngineCoreTypeConfig<TelemetryComponentConfig>[];
-    /**
-     * Background task connector options which can be overridden by individual components by specifying types other than default.
-     */
-    backgroundTaskConnector?: IEngineCoreTypeConfig<BackgroundTaskConnectorConfig>[];
-    /**
-     * Vault connector options which can be overridden by individual components by specifying types other than default.
-     */
-    vaultConnector?: IEngineCoreTypeConfig<VaultConnectorConfig>[];
-    /**
-     * DLT options which can be overridden by individual components by specifying types other than default.
-     */
-    dltConfig?: IEngineCoreTypeConfig<DltConfig>[];
-    /**
-     * Wallet connector options which can be overridden by individual components by specifying types other than default.
-     */
-    walletConnector?: IEngineCoreTypeConfig<WalletConnectorConfig>[];
-    /**
-     * Immutable storage connector options which can be overridden by individual components by specifying types other than default.
-     */
-    immutableStorageConnector?: IEngineCoreTypeConfig<ImmutableStorageConnectorConfig>[];
-    /**
-     * Immutable proof component options which can be overridden by individual components by specifying types other than default.
-     */
-    immutableProofComponent?: IEngineCoreTypeConfig<ImmutableProofComponentConfig>[];
-    /**
-     * Faucet connector options which can be overridden by individual components by specifying types other than default.
-     */
-    faucetConnector?: IEngineCoreTypeConfig<FaucetConnectorConfig>[];
-    /**
-     * Identity connector options which can be overridden by individual components by specifying types other than default.
-     */
-    identityConnector?: IEngineCoreTypeConfig<IdentityConnectorConfig>[];
-    /**
-     * Identity component profile options which can be overridden by individual components by specifying types other than default.
-     */
-    identityComponent?: IEngineCoreTypeConfig<IdentityComponentConfig>[];
-    /**
-     * Identity profile connector options which can be overridden by individual components by specifying types other than default.
-     */
-    identityProfileConnector?: IEngineCoreTypeConfig<IdentityProfileConnectorConfig>[];
-    /**
-     * Identity profile component profile options which can be overridden by individual components by specifying types other than default.
-     */
-    identityProfileComponent?: IEngineCoreTypeConfig<IdentityProfileComponentConfig>[];
-    /**
-     * NFT connector options which can be overridden by individual components by specifying types other than default.
-     */
-    nftConnector?: IEngineCoreTypeConfig<NftConnectorConfig>[];
-    /**
-     * NFT component options which can be overridden by individual components by specifying types other than default.
-     */
-    nftComponent?: IEngineCoreTypeConfig<NftComponentConfig>[];
-    /**
-     * Attestation connector options which can be overridden by individual components by specifying types other than default.
-     */
-    attestationConnector?: IEngineCoreTypeConfig<AttestationConnectorConfig>[];
-    /**
-     * Attestation component profile options which can be overridden by individual components by specifying types other than default.
-     */
-    attestationComponent?: IEngineCoreTypeConfig<AttestationComponentConfig>[];
-    /**
-     * Auditable item graph component options which can be overridden by individual components by specifying types other than default.
-     */
-    auditableItemGraphComponent?: IEngineCoreTypeConfig<AuditableItemGraphComponentConfig>[];
-    /**
-     * Auditable item stream component profile options which can be overridden by individual components by specifying types other than default.
-     */
-    auditableItemStreamComponent?: IEngineCoreTypeConfig<AuditableItemStreamComponentConfig>[];
+    types: {
+        [type: string]: IEngineCoreTypeConfig[] | undefined;
+    };
 }

package/docs/changelog.md

@@ -1,5 +1,140 @@
 # @twin.org/engine-models - Changelog
 
-## v0.0.1-next.9
+## 0.0.1 (2025-07-11)
+
+
+### Features
+
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* release to production ([3a4acd1](https://github.com/twinfoundation/engine/commit/3a4acd1f6c66b841d80b6fd3bc1a439a77148fa5))
+* release to production ([5559958](https://github.com/twinfoundation/engine/commit/5559958e2128e6ec3a81e779d1ebd3f370bbb081))
+* remove bootstrapped components, component should manage their own state ([5c7e9e4](https://github.com/twinfoundation/engine/commit/5c7e9e419ef26933e49c9c5a21a20a8961244e7f))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+## [0.0.1-next.84](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.83...engine-models-v0.0.1-next.84) (2025-07-11)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.83](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.82...engine-models-v0.0.1-next.83) (2025-07-10)
+
+
+### Features
+
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* remove bootstrapped components, component should manage their own state ([5c7e9e4](https://github.com/twinfoundation/engine/commit/5c7e9e419ef26933e49c9c5a21a20a8961244e7f))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+## [0.0.1-next.81](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.80...engine-models-v0.0.1-next.81) (2025-07-07)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.80](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.79...engine-models-v0.0.1-next.80) (2025-06-23)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.79](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.78...engine-models-v0.0.1-next.79) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.78](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.77...engine-models-v0.0.1-next.78) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.77](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.76...engine-models-v0.0.1-next.77) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.76](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.75...engine-models-v0.0.1-next.76) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+
+## [0.0.1-next.75](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.74...engine-models-v0.0.1-next.75) (2025-05-29)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.74](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.73...engine-models-v0.0.1-next.74) (2025-05-23)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.73](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.72...engine-models-v0.0.1-next.73) (2025-05-22)
+
+
+### Features
+
+* remove bootstrapped components, component should manage their own state ([5c7e9e4](https://github.com/twinfoundation/engine/commit/5c7e9e419ef26933e49c9c5a21a20a8961244e7f))
+
+## [0.0.1-next.72](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.71...engine-models-v0.0.1-next.72) (2025-05-06)
+
+
+### Features
+
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+## [0.0.1-next.71](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.70...engine-models-v0.0.1-next.71) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.70](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.69...engine-models-v0.0.1-next.70) (2025-04-28)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.69](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.68...engine-models-v0.0.1-next.69) (2025-04-25)
+
+
+### Miscellaneous Chores
+
+* **engine-models:** Synchronize repo versions
+
+## [0.0.1-next.68](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.67...engine-models-v0.0.1-next.68) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+## [0.0.1-next.67](https://github.com/twinfoundation/engine/compare/engine-models-v0.0.1-next.66...engine-models-v0.0.1-next.67) (2025-03-28)
+
+
+### Features
+
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+
+## v0.0.1-next.66
 
 - Initial Release

package/docs/reference/index.md

@@ -3,112 +3,20 @@
 ## Interfaces
 
 - [IEngineCore](interfaces/IEngineCore.md)
+- [IEngineCoreClone](interfaces/IEngineCoreClone.md)
 - [IEngineCoreContext](interfaces/IEngineCoreContext.md)
 - [IEngineServer](interfaces/IEngineServer.md)
 - [IEngineState](interfaces/IEngineState.md)
 - [IEngineStateStorage](interfaces/IEngineStateStorage.md)
 - [IEngineCoreConfig](interfaces/IEngineCoreConfig.md)
 - [IEngineCoreTypeBaseConfig](interfaces/IEngineCoreTypeBaseConfig.md)
-- [IEngineServerConfig](interfaces/IEngineServerConfig.md)
 
 ## Type Aliases
 
 - [IEngineCoreTypeConfig](type-aliases/IEngineCoreTypeConfig.md)
-- [AttestationComponentConfig](type-aliases/AttestationComponentConfig.md)
-- [AttestationConnectorConfig](type-aliases/AttestationConnectorConfig.md)
-- [AuditableItemGraphComponentConfig](type-aliases/AuditableItemGraphComponentConfig.md)
-- [AuditableItemStreamComponentConfig](type-aliases/AuditableItemStreamComponentConfig.md)
-- [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.md)
-- [BackgroundTaskConnectorConfig](type-aliases/BackgroundTaskConnectorConfig.md)
-- [BlobStorageComponentConfig](type-aliases/BlobStorageComponentConfig.md)
-- [BlobStorageConnectorConfig](type-aliases/BlobStorageConnectorConfig.md)
-- [DltConfig](type-aliases/DltConfig.md)
-- [EntityStorageComponentConfig](type-aliases/EntityStorageComponentConfig.md)
-- [EntityStorageConnectorConfig](type-aliases/EntityStorageConnectorConfig.md)
-- [FaucetConnectorConfig](type-aliases/FaucetConnectorConfig.md)
-- [IdentityComponentConfig](type-aliases/IdentityComponentConfig.md)
-- [IdentityConnectorConfig](type-aliases/IdentityConnectorConfig.md)
-- [IdentityProfileComponentConfig](type-aliases/IdentityProfileComponentConfig.md)
-- [IdentityProfileConnectorConfig](type-aliases/IdentityProfileConnectorConfig.md)
-- [ImmutableProofComponentConfig](type-aliases/ImmutableProofComponentConfig.md)
-- [ImmutableStorageConnectorConfig](type-aliases/ImmutableStorageConnectorConfig.md)
-- [InformationComponentConfig](type-aliases/InformationComponentConfig.md)
-- [LoggingComponentConfig](type-aliases/LoggingComponentConfig.md)
-- [LoggingConnectorConfig](type-aliases/LoggingConnectorConfig.md)
-- [MimeTypeProcessorConfig](type-aliases/MimeTypeProcessorConfig.md)
-- [NftComponentConfig](type-aliases/NftComponentConfig.md)
-- [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
-- [RestRouteProcessorConfig](type-aliases/RestRouteProcessorConfig.md)
-- [SocketRouteProcessorConfig](type-aliases/SocketRouteProcessorConfig.md)
-- [TelemetryComponentConfig](type-aliases/TelemetryComponentConfig.md)
-- [TelemetryConnectorConfig](type-aliases/TelemetryConnectorConfig.md)
-- [VaultConnectorConfig](type-aliases/VaultConnectorConfig.md)
-- [WalletConnectorConfig](type-aliases/WalletConnectorConfig.md)
 - [EngineTypeInitialiser](type-aliases/EngineTypeInitialiser.md)
-- [RestRouteGenerator](type-aliases/RestRouteGenerator.md)
-- [SocketRouteGenerator](type-aliases/SocketRouteGenerator.md)
-- [AttestationComponentType](type-aliases/AttestationComponentType.md)
-- [AttestationConnectorType](type-aliases/AttestationConnectorType.md)
-- [AuditableItemGraphComponentType](type-aliases/AuditableItemGraphComponentType.md)
-- [AuditableItemStreamComponentType](type-aliases/AuditableItemStreamComponentType.md)
-- [AuthenticationComponentType](type-aliases/AuthenticationComponentType.md)
-- [BackgroundTaskConnectorType](type-aliases/BackgroundTaskConnectorType.md)
-- [BlobStorageComponentType](type-aliases/BlobStorageComponentType.md)
-- [BlobStorageConnectorType](type-aliases/BlobStorageConnectorType.md)
-- [DltConfigType](type-aliases/DltConfigType.md)
-- [EntityStorageComponentType](type-aliases/EntityStorageComponentType.md)
-- [EntityStorageConnectorType](type-aliases/EntityStorageConnectorType.md)
-- [FaucetConnectorType](type-aliases/FaucetConnectorType.md)
-- [IdentityComponentType](type-aliases/IdentityComponentType.md)
-- [IdentityConnectorType](type-aliases/IdentityConnectorType.md)
-- [IdentityProfileComponentType](type-aliases/IdentityProfileComponentType.md)
-- [IdentityProfileConnectorType](type-aliases/IdentityProfileConnectorType.md)
-- [IImmutableProofComponentType](type-aliases/IImmutableProofComponentType.md)
-- [ImmutableStorageConnectorType](type-aliases/ImmutableStorageConnectorType.md)
-- [InformationComponentType](type-aliases/InformationComponentType.md)
-- [LoggingComponentType](type-aliases/LoggingComponentType.md)
-- [LoggingConnectorType](type-aliases/LoggingConnectorType.md)
-- [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
-- [NftComponentType](type-aliases/NftComponentType.md)
-- [NftConnectorType](type-aliases/NftConnectorType.md)
-- [RestRouteProcessorType](type-aliases/RestRouteProcessorType.md)
-- [SocketRouteProcessorType](type-aliases/SocketRouteProcessorType.md)
-- [TelemetryComponentType](type-aliases/TelemetryComponentType.md)
-- [TelemetryConnectorType](type-aliases/TelemetryConnectorType.md)
-- [VaultConnectorType](type-aliases/VaultConnectorType.md)
-- [WalletConnectorType](type-aliases/WalletConnectorType.md)
 
 ## Variables
 
 - [EngineCoreFactory](variables/EngineCoreFactory.md)
 - [EngineServerFactory](variables/EngineServerFactory.md)
-- [AttestationComponentType](variables/AttestationComponentType.md)
-- [AttestationConnectorType](variables/AttestationConnectorType.md)
-- [AuditableItemGraphComponentType](variables/AuditableItemGraphComponentType.md)
-- [AuditableItemStreamComponentType](variables/AuditableItemStreamComponentType.md)
-- [AuthenticationComponentType](variables/AuthenticationComponentType.md)
-- [BackgroundTaskConnectorType](variables/BackgroundTaskConnectorType.md)
-- [BlobStorageComponentType](variables/BlobStorageComponentType.md)
-- [BlobStorageConnectorType](variables/BlobStorageConnectorType.md)
-- [DltConfigType](variables/DltConfigType.md)
-- [EntityStorageComponentType](variables/EntityStorageComponentType.md)
-- [EntityStorageConnectorType](variables/EntityStorageConnectorType.md)
-- [FaucetConnectorType](variables/FaucetConnectorType.md)
-- [IdentityComponentType](variables/IdentityComponentType.md)
-- [IdentityConnectorType](variables/IdentityConnectorType.md)
-- [IdentityProfileComponentType](variables/IdentityProfileComponentType.md)
-- [IdentityProfileConnectorType](variables/IdentityProfileConnectorType.md)
-- [ImmutableProofComponentType](variables/ImmutableProofComponentType.md)
-- [ImmutableStorageConnectorType](variables/ImmutableStorageConnectorType.md)
-- [InformationComponentType](variables/InformationComponentType.md)
-- [LoggingComponentType](variables/LoggingComponentType.md)
-- [LoggingConnectorType](variables/LoggingConnectorType.md)
-- [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
-- [NftComponentType](variables/NftComponentType.md)
-- [NftConnectorType](variables/NftConnectorType.md)
-- [RestRouteProcessorType](variables/RestRouteProcessorType.md)
-- [SocketRouteProcessorType](variables/SocketRouteProcessorType.md)
-- [TelemetryComponentType](variables/TelemetryComponentType.md)
-- [TelemetryConnectorType](variables/TelemetryConnectorType.md)
-- [VaultConnectorType](variables/VaultConnectorType.md)
-- [WalletConnectorType](variables/WalletConnectorType.md)

package/docs/reference/interfaces/IEngineCore.md

@@ -1,36 +1,50 @@
-# Interface: IEngineCore\<S\>
+# Interface: IEngineCore\<C, S\>
 
 Interface describing the engine core methods.
 
 ## Type Parameters
 
-• **S** *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
+### C
+
+`C` *extends* [`IEngineCoreConfig`](IEngineCoreConfig.md) = [`IEngineCoreConfig`](IEngineCoreConfig.md)
+
+### S
+
+`S` *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
 
 ## Methods
 
 ### addTypeInitialiser()
 
-> **addTypeInitialiser**\<`T`\>(`type`, `typeConfig`, `initialiser`): `void`
+> **addTypeInitialiser**(`type`, `typeConfig`, `module`, `method`): `void`
 
 Add a type initialiser.
 
-#### Type Parameters
-
-• **T** *extends* [`IEngineCoreTypeBaseConfig`](IEngineCoreTypeBaseConfig.md)\<`unknown`\>
-
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type to add the initialiser for.
 
-• **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+##### typeConfig
 
 The type config.
 
-• **initialiser**: [`EngineTypeInitialiser`](../type-aliases/EngineTypeInitialiser.md)\<`T`\>
+`undefined` | [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+##### module
+
+`string`
+
+The name of the module which contains the initialiser method.
+
+##### method
+
+`string`
 
-The initialiser to add.
+The name of the method to call.
 
 #### Returns
 
@@ -40,15 +54,15 @@ The initialiser to add.
 
 ### start()
 
-> **start**(): `Promise`\<`void`\>
+> **start**(): `Promise`\<`boolean`\>
 
 Start the engine core.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`boolean`\>
 
-Nothing.
+True if the start was successful.
 
 ***
 
@@ -74,7 +88,9 @@ Log info.
 
 #### Parameters
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message to log.
 
@@ -92,7 +108,9 @@ Log error.
 
 #### Parameters
 
-• **error**: `IError`
+##### error
+
+`IError`
 
 The error to log.
 
@@ -104,13 +122,13 @@ The error to log.
 
 ### getConfig()
 
-> **getConfig**(): [`IEngineCoreConfig`](IEngineCoreConfig.md)
+> **getConfig**(): `C`
 
 Get the config for the engine.
 
 #### Returns
 
-[`IEngineCoreConfig`](IEngineCoreConfig.md)
+`C`
 
 The config for the engine.
 
@@ -141,3 +159,43 @@ Get the types for the component.
 `object`
 
 The default types.
+
+***
+
+### getCloneData()
+
+> **getCloneData**(): [`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
+
+Get the data required to create a clone of the engine.
+
+#### Returns
+
+[`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
+
+The clone data.
+
+***
+
+### populateClone()
+
+> **populateClone**(`cloneData`, `silent?`): `void`
+
+Populate the engine from the clone data.
+
+#### Parameters
+
+##### cloneData
+
+[`IEngineCoreClone`](IEngineCoreClone.md)\<`C`, `S`\>
+
+The clone data to populate from.
+
+##### silent?
+
+`boolean`
+
+Should the clone be silent.
+
+#### Returns
+
+`void`

package/docs/reference/interfaces/IEngineCoreClone.md

@@ -0,0 +1,73 @@
+# Interface: IEngineCoreClone\<C, S\>
+
+Interface describing the data required to clone an engine.
+
+## Type Parameters
+
+### C
+
+`C` *extends* [`IEngineCoreConfig`](IEngineCoreConfig.md) = [`IEngineCoreConfig`](IEngineCoreConfig.md)
+
+### S
+
+`S` *extends* [`IEngineState`](IEngineState.md) = [`IEngineState`](IEngineState.md)
+
+## Properties
+
+### config
+
+> **config**: `C`
+
+The config for the engine.
+
+***
+
+### state
+
+> **state**: `S`
+
+The state of the engine.
+
+***
+
+### typeInitialisers
+
+> **typeInitialisers**: `object`[]
+
+The type initialisers for the engine.
+
+#### type
+
+> **type**: `string`
+
+#### typeConfig
+
+> **typeConfig**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+#### module
+
+> **module**: `string`
+
+#### method
+
+> **method**: `string`
+
+***
+
+### entitySchemas
+
+> **entitySchemas**: `object`
+
+The entity schemas for the engine.
+
+#### Index Signature
+
+\[`schema`: `string`\]: `IEntitySchema`\<`unknown`\>
+
+***
+
+### loggerTypeName
+
+> **loggerTypeName**: `string`
+
+The logger type name.