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

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

@@ -0,0 +1,29 @@
+/**
+ * REST route processor types.
+ */
+export declare const RestRouteProcessorType: {
+    /**
+     * Auth header.
+     */
+    readonly AuthHeader: "auth-header";
+    /**
+     * Logging.
+     */
+    readonly Logging: "logging";
+    /**
+     * Node Identity.
+     */
+    readonly NodeIdentity: "node-identity";
+    /**
+     * Static User Identity.
+     */
+    readonly StaticUserIdentity: "static-user-identity";
+    /**
+     * REST Route.
+     */
+    readonly RestRoute: "rest-route";
+};
+/**
+ * REST route processor types.
+ */
+export type RestRouteProcessorType = (typeof RestRouteProcessorType)[keyof typeof RestRouteProcessorType];

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

@@ -0,0 +1,29 @@
+/**
+ * Socket route processor types.
+ */
+export declare const SocketRouteProcessorType: {
+    /**
+     * Auth header.
+     */
+    readonly AuthHeader: "auth-header";
+    /**
+     * Logging.
+     */
+    readonly Logging: "logging";
+    /**
+     * Node Identity.
+     */
+    readonly NodeIdentity: "node-identity";
+    /**
+     * Static User Identity.
+     */
+    readonly StaticUserIdentity: "static-user-identity";
+    /**
+     * Socket Route.
+     */
+    readonly SocketRoute: "socket-route";
+};
+/**
+ * Socket route processor types.
+ */
+export type SocketRouteProcessorType = (typeof SocketRouteProcessorType)[keyof typeof SocketRouteProcessorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Telemetry component types.
+ */
+export declare const TelemetryComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Telemetry component types.
+ */
+export type TelemetryComponentType = (typeof TelemetryComponentType)[keyof typeof TelemetryComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Telemetry connector types.
+ */
+export declare const TelemetryConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+};
+/**
+ * Telemetry connector types.
+ */
+export type TelemetryConnectorType = (typeof TelemetryConnectorType)[keyof typeof TelemetryConnectorType];

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

@@ -0,0 +1,17 @@
+/**
+ * Vault connector types.
+ */
+export declare const VaultConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * Hashicorp.
+     */
+    readonly Hashicorp: "hashicorp";
+};
+/**
+ * Vault connector types.
+ */
+export type VaultConnectorType = (typeof VaultConnectorType)[keyof typeof VaultConnectorType];

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

@@ -0,0 +1,17 @@
+/**
+ * Wallet connector types.
+ */
+export declare const WalletConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * Wallet connector types.
+ */
+export type WalletConnectorType = (typeof WalletConnectorType)[keyof typeof WalletConnectorType];

package/docs/changelog.md

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

package/docs/examples.md

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

package/docs/reference/index.md

@@ -0,0 +1,114 @@
+# @twin.org/engine-models
+
+## Interfaces
+
+- [IEngineCore](interfaces/IEngineCore.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

@@ -0,0 +1,139 @@
+# Interface: IEngineCore
+
+Interface describing the engine core methods.
+
+## Methods
+
+### addTypeInitialiser()
+
+> **addTypeInitialiser**\<`T`\>(`type`, `typeConfig`, `initialiser`): `void`
+
+Add a type initialiser.
+
+#### Type Parameters
+
+• **T** *extends* [`IEngineCoreTypeBaseConfig`](IEngineCoreTypeBaseConfig.md)\<`unknown`\>
+
+#### Parameters
+
+• **type**: `string`
+
+The type to add the initialiser for.
+
+• **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+The type config.
+
+• **initialiser**: [`EngineTypeInitialiser`](../type-aliases/EngineTypeInitialiser.md)\<`T`\>
+
+The initialiser to add.
+
+#### Returns
+
+`void`
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`void`\>
+
+Start the engine core.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the engine core.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### logInfo()
+
+> **logInfo**(`message`): `void`
+
+Log info.
+
+#### Parameters
+
+• **message**: `string`
+
+The message to log.
+
+#### Returns
+
+`void`
+
+***
+
+### logError()
+
+> **logError**(`error`): `void`
+
+Log error.
+
+#### Parameters
+
+• **error**: `IError`
+
+The error to log.
+
+#### Returns
+
+`void`
+
+***
+
+### getConfig()
+
+> **getConfig**(): [`IEngineCoreConfig`](IEngineCoreConfig.md)
+
+Get the config for the engine.
+
+#### Returns
+
+[`IEngineCoreConfig`](IEngineCoreConfig.md)
+
+The config for the engine.
+
+***
+
+### getState()
+
+> **getState**(): [`IEngineState`](IEngineState.md)
+
+Get the state of the engine.
+
+#### Returns
+
+[`IEngineState`](IEngineState.md)
+
+The state of the engine.
+
+***
+
+### getDefaultTypes()
+
+> **getDefaultTypes**(): `object`
+
+Get the types for the component.
+
+#### Returns
+
+`object`
+
+The default types.

package/docs/reference/interfaces/IEngineCoreConfig.md

@@ -0,0 +1,231 @@
+# Interface: IEngineCoreConfig
+
+Configuration for the engine core.
+
+## Properties
+
+### debug?
+
+> `optional` **debug**: `boolean`
+
+Start the engine in debug mode.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### silent?
+
+> `optional` **silent**: `boolean`
+
+Disable output to the console.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### loggingConnector?
+
+> `optional` **loggingConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`LoggingConnectorConfig`](../type-aliases/LoggingConnectorConfig.md)\>[]
+
+Logging connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### loggingComponent?
+
+> `optional` **loggingComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`LoggingComponentConfig`](../type-aliases/LoggingComponentConfig.md)\>[]
+
+Logging component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### entityStorageConnector?
+
+> `optional` **entityStorageConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`EntityStorageConnectorConfig`](../type-aliases/EntityStorageConnectorConfig.md)\>[]
+
+Entity storage connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### entityStorageComponent?
+
+> `optional` **entityStorageComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`EntityStorageComponentConfig`](../type-aliases/EntityStorageComponentConfig.md)\>[]
+
+Entity storage component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### blobStorageConnector?
+
+> `optional` **blobStorageConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`BlobStorageConnectorConfig`](../type-aliases/BlobStorageConnectorConfig.md)\>[]
+
+Blob storage connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### blobStorageComponent?
+
+> `optional` **blobStorageComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`BlobStorageComponentConfig`](../type-aliases/BlobStorageComponentConfig.md)\>[]
+
+Blob storage component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### telemetryConnector?
+
+> `optional` **telemetryConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`TelemetryConnectorConfig`](../type-aliases/TelemetryConnectorConfig.md)\>[]
+
+Telemetry connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### telemetryComponent?
+
+> `optional` **telemetryComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`TelemetryComponentConfig`](../type-aliases/TelemetryComponentConfig.md)\>[]
+
+Telemetry component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### backgroundTaskConnector?
+
+> `optional` **backgroundTaskConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`BackgroundTaskConnectorConfig`](../type-aliases/BackgroundTaskConnectorConfig.md)\>[]
+
+Background task connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### vaultConnector?
+
+> `optional` **vaultConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`VaultConnectorConfig`](../type-aliases/VaultConnectorConfig.md)\>[]
+
+Vault connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### dltConfig?
+
+> `optional` **dltConfig**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`DltConfig`](../type-aliases/DltConfig.md)\>[]
+
+DLT options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### walletConnector?
+
+> `optional` **walletConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`WalletConnectorConfig`](../type-aliases/WalletConnectorConfig.md)\>[]
+
+Wallet connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### immutableStorageConnector?
+
+> `optional` **immutableStorageConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`ImmutableStorageConnectorConfig`](../type-aliases/ImmutableStorageConnectorConfig.md)\>[]
+
+Immutable storage connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### immutableProofComponent?
+
+> `optional` **immutableProofComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`ImmutableProofComponentConfig`](../type-aliases/ImmutableProofComponentConfig.md)\>[]
+
+Immutable proof component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### faucetConnector?
+
+> `optional` **faucetConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`FaucetConnectorConfig`](../type-aliases/FaucetConnectorConfig.md)\>[]
+
+Faucet connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### identityConnector?
+
+> `optional` **identityConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`IdentityConnectorConfig`](../type-aliases/IdentityConnectorConfig.md)\>[]
+
+Identity connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### identityComponent?
+
+> `optional` **identityComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`IdentityComponentConfig`](../type-aliases/IdentityComponentConfig.md)\>[]
+
+Identity component profile options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### identityProfileConnector?
+
+> `optional` **identityProfileConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`IdentityProfileConnectorConfig`](../type-aliases/IdentityProfileConnectorConfig.md)\>[]
+
+Identity profile connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### identityProfileComponent?
+
+> `optional` **identityProfileComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`IdentityProfileComponentConfig`](../type-aliases/IdentityProfileComponentConfig.md)\>[]
+
+Identity profile component profile options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### nftConnector?
+
+> `optional` **nftConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`NftConnectorConfig`](../type-aliases/NftConnectorConfig.md)\>[]
+
+NFT connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### nftComponent?
+
+> `optional` **nftComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`NftComponentConfig`](../type-aliases/NftComponentConfig.md)\>[]
+
+NFT component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### attestationConnector?
+
+> `optional` **attestationConnector**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`AttestationConnectorConfig`](../type-aliases/AttestationConnectorConfig.md)\>[]
+
+Attestation connector options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### attestationComponent?
+
+> `optional` **attestationComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`AttestationComponentConfig`](../type-aliases/AttestationComponentConfig.md)\>[]
+
+Attestation component profile options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### auditableItemGraphComponent?
+
+> `optional` **auditableItemGraphComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`AuditableItemGraphComponentConfig`](../type-aliases/AuditableItemGraphComponentConfig.md)\>[]
+
+Auditable item graph component options which can be overridden by individual components by specifying types other than default.
+
+***
+
+### auditableItemStreamComponent?
+
+> `optional` **auditableItemStreamComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`AuditableItemStreamComponentConfig`](../type-aliases/AuditableItemStreamComponentConfig.md)\>[]
+
+Auditable item stream component profile options which can be overridden by individual components by specifying types other than default.

package/docs/reference/interfaces/IEngineCoreContext.md

@@ -0,0 +1,47 @@
+# Interface: IEngineCoreContext
+
+The context for the engine core.
+
+## Properties
+
+### config
+
+> **config**: [`IEngineCoreConfig`](IEngineCoreConfig.md)
+
+The engine core config.
+
+***
+
+### state
+
+> **state**: [`IEngineState`](IEngineState.md)
+
+The engine core state.
+
+***
+
+### stateDirty
+
+> **stateDirty**: `boolean`
+
+The state dirty flag, which flags that the state needs saving.
+
+***
+
+### defaultTypes
+
+> **defaultTypes**: `object`
+
+The default types to use when components don't have custom types.
+
+#### Index Signature
+
+ \[`type`: `string`\]: `string`
+
+***
+
+### componentInstances
+
+> **componentInstances**: `object`[]
+
+The components.

package/docs/reference/interfaces/IEngineCoreTypeBaseConfig.md

@@ -0,0 +1,23 @@
+# Interface: IEngineCoreTypeBaseConfig\<T\>
+
+Configuration for the engine core type base.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+The type of the instance.
+
+***
+
+### options?
+
+> `optional` **options**: `T`
+
+The options for the instance.