@twin.org/engine-core 0.0.1-next.1

package/dist/types/components/attestation.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type AttestationComponentConfig, type AttestationConnectorConfig, type IEngineCore } from "@twin.org/engine-models";
+/**
+ * Initialise the attestation connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseAttestationConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: AttestationConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the attestation component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseAttestationComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: AttestationComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/auditableItemGraph.d.ts

@@ -0,0 +1,11 @@
+import { type AuditableItemGraphComponentConfig, type IEngineCore, type IEngineCoreContext } from "@twin.org/engine-models";
+/**
+ * Initialise the auditable item graph component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseAuditableItemGraphComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: AuditableItemGraphComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/auditableItemStream.d.ts

@@ -0,0 +1,11 @@
+import { type AuditableItemStreamComponentConfig, type IEngineCore, type IEngineCoreContext } from "@twin.org/engine-models";
+/**
+ * Initialise the auditable item stream component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseAuditableItemStreamComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: AuditableItemStreamComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/backgroundTask.d.ts

@@ -0,0 +1,11 @@
+import { type IEngineCoreContext, type BackgroundTaskConnectorConfig, type IEngineCore } from "@twin.org/engine-models";
+/**
+ * Initialise a background task connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseBackgroundTaskConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: BackgroundTaskConnectorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/blobStorage.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type BlobStorageComponentConfig, type BlobStorageConnectorConfig, type IEngineCore } from "@twin.org/engine-models";
+/**
+ * Initialise the blob storage connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseBlobStorageConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: BlobStorageConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the blob storage component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseBlobStorageComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: BlobStorageComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/entityStorage.d.ts

@@ -0,0 +1,20 @@
+import { type EntityStorageComponentConfig, type IEngineCore, type IEngineCoreContext } from "@twin.org/engine-models";
+/**
+ * Initialise the entity storage connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param typeCustom Override the type of connector to use instead of default configuration.
+ * @param schema The schema for the entity storage.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseEntityStorageConnector(engineCore: IEngineCore, context: IEngineCoreContext, typeCustom: string | undefined, schema: string): void;
+/**
+ * Initialise the entity storage connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseEntityStorageComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: EntityStorageComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/faucet.d.ts

@@ -0,0 +1,11 @@
+import { type FaucetConnectorConfig, type IEngineCore, type IEngineCoreContext } from "@twin.org/engine-models";
+/**
+ * Initialise a faucet connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseFaucetConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: FaucetConnectorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/identity.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type IdentityComponentConfig, type IdentityConnectorConfig, type IEngineCore } from "@twin.org/engine-models";
+/**
+ * Initialise the identity connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseIdentityConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: IdentityConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the identity component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseIdentityComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: IdentityComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/identityProfile.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type IdentityProfileComponentConfig, type IdentityProfileConnectorConfig, type IEngineCore } from "@twin.org/engine-models";
+/**
+ * Initialise the identity profile connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseIdentityProfileConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: IdentityProfileConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the identity profile component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseIdentityProfileComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: IdentityProfileComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/immutableProof.d.ts

@@ -0,0 +1,11 @@
+import { type IEngineCore, type IEngineCoreContext, type ImmutableProofComponentConfig } from "@twin.org/engine-models";
+/**
+ * Initialise the immutable proof component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseImmutableProofComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: ImmutableProofComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/immutableStorage.d.ts

@@ -0,0 +1,11 @@
+import { type IEngineCoreContext, type IEngineCore, type ImmutableStorageConnectorConfig } from "@twin.org/engine-models";
+/**
+ * Initialise the immutable storage connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseImmutableStorageConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: ImmutableStorageConnectorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/logging.d.ts

@@ -0,0 +1,21 @@
+import { type LoggingConnectorConfig, type IEngineCore, type LoggingComponentConfig, type IEngineCoreContext } from "@twin.org/engine-models";
+/**
+ * Initialise the logging connector.
+ * @param engineCore The engine core.
+ * @param context The engine core context.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseLoggingConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: LoggingConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the logging component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseLoggingComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: LoggingComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/nft.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type IEngineCore, type NftComponentConfig, type NftConnectorConfig } from "@twin.org/engine-models";
+/**
+ * Initialise the NFT connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseNftConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: NftConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the NFT component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseNftComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: NftComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/telemetry.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type IEngineCore, type TelemetryComponentConfig, type TelemetryConnectorConfig } from "@twin.org/engine-models";
+/**
+ * Initialise a telemetry connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseTelemetryConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: TelemetryConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the telemetry component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseTelemetryComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: TelemetryComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/vault.d.ts

@@ -0,0 +1,11 @@
+import { type IEngineCoreContext, type IEngineCore, type VaultConnectorConfig } from "@twin.org/engine-models";
+/**
+ * Initialise the vault connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseVaultConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: VaultConnectorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/wallet.d.ts

@@ -0,0 +1,21 @@
+import { type IEngineCoreContext, type IEngineCore, type WalletConnectorConfig } from "@twin.org/engine-models";
+/**
+ * Initialise a wallet connector.
+ * @param engineCore The engine core.
+ * @param context The context for the node.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseWalletConnector(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: WalletConnectorConfig, overrideInstanceType?: string): string | undefined;
+/**
+ * Initialise the wallet storage.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns Nothing.
+ * @throws GeneralError if the connector type is unknown.
+ */
+export declare function initialiseWalletStorage(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: WalletConnectorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/engineCore.d.ts

@@ -0,0 +1,65 @@
+import { type IError } from "@twin.org/core";
+import type { EngineTypeInitialiser, IEngineCore, IEngineCoreConfig, IEngineCoreTypeBaseConfig, IEngineCoreTypeConfig, IEngineState } from "@twin.org/engine-models";
+import type { IEngineCoreOptions } from "./models/IEngineCoreOptions";
+/**
+ * Core for the engine.
+ */
+export declare class EngineCore implements IEngineCore {
+    /**
+     * Name for the engine logger.
+     */
+    static readonly LOGGER_TYPE_NAME: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EngineCore.
+     * @param options The options for the engine.
+     */
+    constructor(options?: IEngineCoreOptions);
+    /**
+     * Add a type initialiser.
+     * @param type The type to add the initialiser for.
+     * @param typeConfig The type config.
+     * @param initialiser The initialiser to add.
+     */
+    addTypeInitialiser<V extends IEngineCoreTypeBaseConfig>(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, initialiser: EngineTypeInitialiser<V>): void;
+    /**
+     * Start the engine core.
+     * @returns Nothing.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the engine core.
+     * @returns Nothing.
+     */
+    stop(): Promise<void>;
+    /**
+     * Log info.
+     * @param message The message to log.
+     */
+    logInfo(message: string): void;
+    /**
+     * Log error.
+     * @param error The error to log.
+     */
+    logError(error: IError): void;
+    /**
+     * Get the config for the engine.
+     * @returns The config for the engine.
+     */
+    getConfig(): IEngineCoreConfig;
+    /**
+     * Get the state of the engine.
+     * @returns The state of the engine.
+     */
+    getState(): IEngineState;
+    /**
+     * Get the types for the component.
+     * @returns The default types.
+     */
+    getDefaultTypes(): {
+        [type: string]: string;
+    };
+}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export { initialiseEntityStorageConnector } from "./components/entityStorage";
+export * from "./engineCore";
+export * from "./models/IEngineCoreOptions";
+export * from "./storage/fileStateStorage";
+export * from "./storage/memoryStateStorage";

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

@@ -0,0 +1,22 @@
+import type { IEngineCore, IEngineCoreConfig, IEngineCoreContext, IEngineStateStorage } from "@twin.org/engine-models";
+/**
+ * The options for creating engine core.
+ */
+export interface IEngineCoreOptions {
+    /**
+     * The engine core config.
+     */
+    config?: IEngineCoreConfig;
+    /**
+     * The state storage component.
+     */
+    stateStorage?: IEngineStateStorage;
+    /**
+     * Skip the bootstrap process, useful for additional engine instances.
+     */
+    skipBootstrap?: boolean;
+    /**
+     * Custom bootstrap method for the engine.
+     */
+    customBootstrap?: (engineCore: IEngineCore, context: IEngineCoreContext) => Promise<void>;
+}

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

@@ -0,0 +1,29 @@
+import type { IEngineCore, IEngineState, IEngineStateStorage } from "@twin.org/engine-models";
+/**
+ * Store state in a file.
+ */
+export declare class FileStateStorage implements IEngineStateStorage {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of FileStateStorage.
+     * @param filename The filename to store the state.
+     * @param readonlyMode Whether the file is in read-only mode.
+     */
+    constructor(filename: string, readonlyMode?: boolean);
+    /**
+     * 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.
+     */
+    load(engineCore: IEngineCore): Promise<IEngineState | undefined>;
+    /**
+     * 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.
+     */
+    save(engineCore: IEngineCore, state: IEngineState): Promise<void>;
+}

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

@@ -0,0 +1,28 @@
+import type { IEngineCore, IEngineState, IEngineStateStorage } from "@twin.org/engine-models";
+/**
+ * Store state in memory.
+ */
+export declare class MemoryStateStorage implements IEngineStateStorage {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of MemoryStateStorage.
+     * @param readonlyMode Whether the file is in read-only mode.
+     */
+    constructor(readonlyMode?: boolean);
+    /**
+     * 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.
+     */
+    load(engineCore: IEngineCore): Promise<IEngineState | undefined>;
+    /**
+     * 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.
+     */
+    save(engineCore: IEngineCore, state: IEngineState): Promise<void>;
+}

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/engine-core - Examples

package/docs/reference/classes/EngineCore.md

@@ -0,0 +1,209 @@
+# Class: EngineCore
+
+Core for the engine.
+
+## Implements
+
+- `IEngineCore`
+
+## Constructors
+
+### new EngineCore()
+
+> **new EngineCore**(`options`?): [`EngineCore`](EngineCore.md)
+
+Create a new instance of EngineCore.
+
+#### Parameters
+
+• **options?**: [`IEngineCoreOptions`](../interfaces/IEngineCoreOptions.md)
+
+The options for the engine.
+
+#### Returns
+
+[`EngineCore`](EngineCore.md)
+
+## Properties
+
+### LOGGER\_TYPE\_NAME
+
+> `readonly` `static` **LOGGER\_TYPE\_NAME**: `string` = `"engine"`
+
+Name for the engine logger.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### addTypeInitialiser()
+
+> **addTypeInitialiser**\<`V`\>(`type`, `typeConfig`, `initialiser`): `void`
+
+Add a type initialiser.
+
+#### Type Parameters
+
+• **V** *extends* `IEngineCoreTypeBaseConfig`\<`unknown`\>
+
+#### Parameters
+
+• **type**: `string`
+
+The type to add the initialiser for.
+
+• **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
+
+The type config.
+
+• **initialiser**: `EngineTypeInitialiser`\<`V`\>
+
+The initialiser to add.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.addTypeInitialiser`
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`void`\>
+
+Start the engine core.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEngineCore.start`
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the engine core.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEngineCore.stop`
+
+***
+
+### logInfo()
+
+> **logInfo**(`message`): `void`
+
+Log info.
+
+#### Parameters
+
+• **message**: `string`
+
+The message to log.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.logInfo`
+
+***
+
+### logError()
+
+> **logError**(`error`): `void`
+
+Log error.
+
+#### Parameters
+
+• **error**: `IError`
+
+The error to log.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineCore.logError`
+
+***
+
+### getConfig()
+
+> **getConfig**(): `IEngineCoreConfig`
+
+Get the config for the engine.
+
+#### Returns
+
+`IEngineCoreConfig`
+
+The config for the engine.
+
+#### Implementation of
+
+`IEngineCore.getConfig`
+
+***
+
+### getState()
+
+> **getState**(): `IEngineState`
+
+Get the state of the engine.
+
+#### Returns
+
+`IEngineState`
+
+The state of the engine.
+
+#### Implementation of
+
+`IEngineCore.getState`
+
+***
+
+### getDefaultTypes()
+
+> **getDefaultTypes**(): `object`
+
+Get the types for the component.
+
+#### Returns
+
+`object`
+
+The default types.
+
+#### Implementation of
+
+`IEngineCore.getDefaultTypes`