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

package/docs/reference/interfaces/IEngineServer.md

@@ -0,0 +1,83 @@
+# Interface: IEngineServer
+
+Interface describing the engine server methods.
+
+## Methods
+
+### addRestRouteGenerator()
+
+> **addRestRouteGenerator**(`type`, `typeConfig`, `generator`): `void`
+
+Add a REST route generator.
+
+#### Parameters
+
+• **type**: `string`
+
+The type to add the generator for.
+
+• **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+The type config.
+
+• **generator**: [`RestRouteGenerator`](../type-aliases/RestRouteGenerator.md)
+
+The generator to add.
+
+#### Returns
+
+`void`
+
+***
+
+### addSocketRouteGenerator()
+
+> **addSocketRouteGenerator**(`type`, `typeConfig`, `generator`): `void`
+
+Add a socket route generator.
+
+#### Parameters
+
+• **type**: `string`
+
+The type to add the generator for.
+
+• **typeConfig**: `undefined` \| [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)[]
+
+The type config.
+
+• **generator**: [`SocketRouteGenerator`](../type-aliases/SocketRouteGenerator.md)
+
+The generator to add.
+
+#### Returns
+
+`void`
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`void`\>
+
+Start the engine server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the engine server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IEngineServerConfig.md

@@ -0,0 +1,51 @@
+# Interface: IEngineServerConfig
+
+Configuration for the engine server.
+
+## Properties
+
+### web?
+
+> `optional` **web**: `IWebServerOptions`
+
+Configuration for the web server.
+
+***
+
+### informationComponent?
+
+> `optional` **informationComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
+
+Information component options which can be overridden by individual components by specifying types other than default..
+
+***
+
+### restRouteProcessor?
+
+> `optional` **restRouteProcessor**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
+
+REST route processors options which can be overridden by individual components by specifying types other than default..
+
+***
+
+### socketRouteProcessor?
+
+> `optional` **socketRouteProcessor**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
+
+Socket route processors options which can be overridden by individual components by specifying types other than default..
+
+***
+
+### mimeTypeProcessor?
+
+> `optional` **mimeTypeProcessor**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
+
+Mime type processors options which can be overridden by individual components by specifying types other than default..
+
+***
+
+### authenticationComponent?
+
+> `optional` **authenticationComponent**: [`IEngineCoreTypeConfig`](../type-aliases/IEngineCoreTypeConfig.md)\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
+
+Authentication component options which can be overridden by individual components by specifying types other than default..

package/docs/reference/interfaces/IEngineState.md

@@ -0,0 +1,19 @@
+# Interface: IEngineState
+
+The state of the engine.
+
+## Properties
+
+### nodeIdentity?
+
+> `optional` **nodeIdentity**: `string`
+
+The identity for the node.
+
+***
+
+### bootstrappedComponents
+
+> **bootstrappedComponents**: `string`[]
+
+The ids of the bootstrapped components.

package/docs/reference/interfaces/IEngineStateStorage.md

@@ -0,0 +1,47 @@
+# Interface: IEngineStateStorage
+
+Definition of state storage for engine.
+
+## Methods
+
+### load()
+
+> **load**(`engineCore`): `Promise`\<`undefined` \| [`IEngineState`](IEngineState.md)\>
+
+Method for loading the state.
+
+#### Parameters
+
+• **engineCore**: [`IEngineCore`](IEngineCore.md)
+
+The engine core to load the state for.
+
+#### Returns
+
+`Promise`\<`undefined` \| [`IEngineState`](IEngineState.md)\>
+
+The state of the engine or undefined if it doesn't exist.
+
+***
+
+### save()
+
+> **save**(`engineCore`, `state`): `Promise`\<`void`\>
+
+Method for saving the state.
+
+#### Parameters
+
+• **engineCore**: [`IEngineCore`](IEngineCore.md)
+
+The engine core to save the state for.
+
+• **state**: [`IEngineState`](IEngineState.md)
+
+The state of the engine to save.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/type-aliases/AttestationComponentConfig.md

@@ -0,0 +1,23 @@
+# Type Alias: AttestationComponentConfig
+
+> **AttestationComponentConfig**: `object`
+
+Attestation component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AttestationComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.walletConnectorType?
+
+> `optional` **walletConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IAttestationServiceConfig`

package/docs/reference/type-aliases/AttestationComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: AttestationComponentType
+
+> **AttestationComponentType**: *typeof* [`AttestationComponentType`](../variables/AttestationComponentType.md)\[keyof *typeof* [`AttestationComponentType`](../variables/AttestationComponentType.md)\]
+
+Attestation component types.

package/docs/reference/type-aliases/AttestationConnectorConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: AttestationConnectorConfig
+
+> **AttestationConnectorConfig**: `object` \| `object`
+
+Attestation config connector types.

package/docs/reference/type-aliases/AttestationConnectorType.md

@@ -0,0 +1,5 @@
+# Type Alias: AttestationConnectorType
+
+> **AttestationConnectorType**: *typeof* [`AttestationConnectorType`](../variables/AttestationConnectorType.md)\[keyof *typeof* [`AttestationConnectorType`](../variables/AttestationConnectorType.md)\]
+
+Attestation connector types.

package/docs/reference/type-aliases/AuditableItemGraphComponentConfig.md

@@ -0,0 +1,31 @@
+# Type Alias: AuditableItemGraphComponentConfig
+
+> **AuditableItemGraphComponentConfig**: `object`
+
+Auditable item graph component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AuditableItemGraphComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.immutableProofComponentType?
+
+> `optional` **immutableProofComponentType**: `string`
+
+### options.vertexEntityStorageType?
+
+> `optional` **vertexEntityStorageType**: `string`
+
+### options.changesetEntityStorageType?
+
+> `optional` **changesetEntityStorageType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IAuditableItemGraphServiceConfig`

package/docs/reference/type-aliases/AuditableItemGraphComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphComponentType
+
+> **AuditableItemGraphComponentType**: *typeof* [`AuditableItemGraphComponentType`](../variables/AuditableItemGraphComponentType.md)\[keyof *typeof* [`AuditableItemGraphComponentType`](../variables/AuditableItemGraphComponentType.md)\]
+
+Auditable item graph component types.

package/docs/reference/type-aliases/AuditableItemStreamComponentConfig.md

@@ -0,0 +1,31 @@
+# Type Alias: AuditableItemStreamComponentConfig
+
+> **AuditableItemStreamComponentConfig**: `object`
+
+Auditable item stream component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AuditableItemStreamComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.immutableProofComponentType?
+
+> `optional` **immutableProofComponentType**: `string`
+
+### options.streamEntityStorageType?
+
+> `optional` **streamEntityStorageType**: `string`
+
+### options.streamEntryEntityStorageType?
+
+> `optional` **streamEntryEntityStorageType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IAuditableItemStreamServiceConfig`

package/docs/reference/type-aliases/AuditableItemStreamComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemStreamComponentType
+
+> **AuditableItemStreamComponentType**: *typeof* [`AuditableItemStreamComponentType`](../variables/AuditableItemStreamComponentType.md)\[keyof *typeof* [`AuditableItemStreamComponentType`](../variables/AuditableItemStreamComponentType.md)\]
+
+Auditable item stream component types.

package/docs/reference/type-aliases/AuthenticationComponentConfig.md

@@ -0,0 +1,27 @@
+# Type Alias: AuthenticationComponentConfig
+
+> **AuthenticationComponentConfig**: `object`
+
+Authentication component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AuthenticationComponentType.AuthEntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.userEntityStorageType?
+
+> `optional` **userEntityStorageType**: `string`
+
+### options.vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IEntityStorageAuthenticationServiceConfig`

package/docs/reference/type-aliases/AuthenticationComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: AuthenticationComponentType
+
+> **AuthenticationComponentType**: *typeof* [`AuthenticationComponentType`](../variables/AuthenticationComponentType.md)\[keyof *typeof* [`AuthenticationComponentType`](../variables/AuthenticationComponentType.md)\]
+
+Authentication component types.

package/docs/reference/type-aliases/BackgroundTaskConnectorConfig.md

@@ -0,0 +1,27 @@
+# Type Alias: BackgroundTaskConnectorConfig
+
+> **BackgroundTaskConnectorConfig**: `object`
+
+Background task connector config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `BackgroundTaskConnectorType.EntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.backgroundTaskEntityStorageType?
+
+> `optional` **backgroundTaskEntityStorageType**: `string`
+
+### options.loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IEntityStorageBackgroundTaskConnectorConfig`

package/docs/reference/type-aliases/BackgroundTaskConnectorType.md

@@ -0,0 +1,5 @@
+# Type Alias: BackgroundTaskConnectorType
+
+> **BackgroundTaskConnectorType**: *typeof* [`BackgroundTaskConnectorType`](../variables/BackgroundTaskConnectorType.md)\[keyof *typeof* [`BackgroundTaskConnectorType`](../variables/BackgroundTaskConnectorType.md)\]
+
+Background task connector types.

package/docs/reference/type-aliases/BlobStorageComponentConfig.md

@@ -0,0 +1,27 @@
+# Type Alias: BlobStorageComponentConfig
+
+> **BlobStorageComponentConfig**: `object`
+
+Blob storage component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `BlobStorageComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.entryEntityStorageType?
+
+> `optional` **entryEntityStorageType**: `string`
+
+### options.vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IBlobStorageServiceConfig`

package/docs/reference/type-aliases/BlobStorageComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: BlobStorageComponentType
+
+> **BlobStorageComponentType**: *typeof* [`BlobStorageComponentType`](../variables/BlobStorageComponentType.md)\[keyof *typeof* [`BlobStorageComponentType`](../variables/BlobStorageComponentType.md)\]
+
+Blob storage component types.

package/docs/reference/type-aliases/BlobStorageConnectorConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: BlobStorageConnectorConfig
+
+> **BlobStorageConnectorConfig**: `object` \| `object` \| `object` \| `object` \| `object` \| `object`
+
+Blob storage connector config types.

package/docs/reference/type-aliases/BlobStorageConnectorType.md

@@ -0,0 +1,5 @@
+# Type Alias: BlobStorageConnectorType
+
+> **BlobStorageConnectorType**: *typeof* [`BlobStorageConnectorType`](../variables/BlobStorageConnectorType.md)\[keyof *typeof* [`BlobStorageConnectorType`](../variables/BlobStorageConnectorType.md)\]
+
+Blob storage connector types.

package/docs/reference/type-aliases/DltConfig.md

@@ -0,0 +1,19 @@
+# Type Alias: DltConfig
+
+> **DltConfig**: `object`
+
+DLT config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `DltConfigType.Iota`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.config?
+
+> `optional` **config**: `IIotaConfig`

package/docs/reference/type-aliases/DltConfigType.md

@@ -0,0 +1,5 @@
+# Type Alias: DltConfigType
+
+> **DltConfigType**: *typeof* [`DltConfigType`](../variables/DltConfigType.md)\[keyof *typeof* [`DltConfigType`](../variables/DltConfigType.md)\]
+
+DLT config types.

package/docs/reference/type-aliases/EngineTypeInitialiser.md

@@ -0,0 +1,23 @@
+# Type Alias: EngineTypeInitialiser()\<T\>
+
+> **EngineTypeInitialiser**\<`T`\>: (`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?) => `string` \| `undefined`
+
+Method definition for the engine type initialiser.
+
+## Type Parameters
+
+• **T** *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md)
+
+## Parameters
+
+• **engineCore**: [`IEngineCore`](../interfaces/IEngineCore.md)
+
+• **context**: [`IEngineCoreContext`](../interfaces/IEngineCoreContext.md)
+
+• **instanceConfig**: `T`
+
+• **overrideInstanceType?**: `string`
+
+## Returns
+
+`string` \| `undefined`

package/docs/reference/type-aliases/EntityStorageComponentConfig.md

@@ -0,0 +1,23 @@
+# Type Alias: EntityStorageComponentConfig
+
+> **EntityStorageComponentConfig**: `object`
+
+Entity storage component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `EntityStorageComponentType.Service`
+
+### options
+
+> **options**: `object`
+
+### options.entityStorageType
+
+> **entityStorageType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IEntityStorageConfig`

package/docs/reference/type-aliases/EntityStorageComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: EntityStorageComponentType
+
+> **EntityStorageComponentType**: *typeof* [`EntityStorageComponentType`](../variables/EntityStorageComponentType.md)\[keyof *typeof* [`EntityStorageComponentType`](../variables/EntityStorageComponentType.md)\]
+
+Entity storage component types.

package/docs/reference/type-aliases/EntityStorageConnectorConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: EntityStorageConnectorConfig
+
+> **EntityStorageConnectorConfig**: `object` \| `object` \| `object` \| `object` \| `object` \| `object`
+
+Entity storage connector config types.

package/docs/reference/type-aliases/EntityStorageConnectorType.md

@@ -0,0 +1,5 @@
+# Type Alias: EntityStorageConnectorType
+
+> **EntityStorageConnectorType**: *typeof* [`EntityStorageConnectorType`](../variables/EntityStorageConnectorType.md)\[keyof *typeof* [`EntityStorageConnectorType`](../variables/EntityStorageConnectorType.md)\]
+
+Entity storage connector types.

package/docs/reference/type-aliases/FaucetConnectorConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: FaucetConnectorConfig
+
+> **FaucetConnectorConfig**: `object` \| `object`
+
+Faucet config types.

package/docs/reference/type-aliases/FaucetConnectorType.md

@@ -0,0 +1,5 @@
+# Type Alias: FaucetConnectorType
+
+> **FaucetConnectorType**: *typeof* [`FaucetConnectorType`](../variables/FaucetConnectorType.md)\[keyof *typeof* [`FaucetConnectorType`](../variables/FaucetConnectorType.md)\]
+
+Faucet connector types.

package/docs/reference/type-aliases/IEngineCoreTypeConfig.md

@@ -0,0 +1,19 @@
+# Type Alias: IEngineCoreTypeConfig\<T\>
+
+> **IEngineCoreTypeConfig**\<`T`\>: `T` & `object`
+
+Configuration for the engine core type.
+
+## Type declaration
+
+### overrideInstanceType?
+
+> `optional` **overrideInstanceType**: `string`
+
+### isDefault?
+
+> `optional` **isDefault**: `boolean`
+
+## Type Parameters
+
+• **T** *extends* [`IEngineCoreTypeBaseConfig`](../interfaces/IEngineCoreTypeBaseConfig.md) = `object`

package/docs/reference/type-aliases/IImmutableProofComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: IImmutableProofComponentType
+
+> **IImmutableProofComponentType**: *typeof* [`ImmutableProofComponentType`](../variables/ImmutableProofComponentType.md)\[keyof *typeof* [`ImmutableProofComponentType`](../variables/ImmutableProofComponentType.md)\]
+
+Immutable proof component types.

package/docs/reference/type-aliases/IdentityComponentConfig.md

@@ -0,0 +1,19 @@
+# Type Alias: IdentityComponentConfig
+
+> **IdentityComponentConfig**: `object`
+
+Identity component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `IdentityComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.config?
+
+> `optional` **config**: `IIdentityServiceConfig`

package/docs/reference/type-aliases/IdentityComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: IdentityComponentType
+
+> **IdentityComponentType**: *typeof* [`IdentityComponentType`](../variables/IdentityComponentType.md)\[keyof *typeof* [`IdentityComponentType`](../variables/IdentityComponentType.md)\]
+
+Identity component types.

package/docs/reference/type-aliases/IdentityConnectorConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: IdentityConnectorConfig
+
+> **IdentityConnectorConfig**: `object` \| `object`
+
+Identity config connector types.

package/docs/reference/type-aliases/IdentityConnectorType.md

@@ -0,0 +1,5 @@
+# Type Alias: IdentityConnectorType
+
+> **IdentityConnectorType**: *typeof* [`IdentityConnectorType`](../variables/IdentityConnectorType.md)\[keyof *typeof* [`IdentityConnectorType`](../variables/IdentityConnectorType.md)\]
+
+Identity connector types.

package/docs/reference/type-aliases/IdentityProfileComponentConfig.md

@@ -0,0 +1,19 @@
+# Type Alias: IdentityProfileComponentConfig
+
+> **IdentityProfileComponentConfig**: `object`
+
+Identity profile component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `IdentityComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.profileEntityConnectorType?
+
+> `optional` **profileEntityConnectorType**: `string`

package/docs/reference/type-aliases/IdentityProfileComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: IdentityProfileComponentType
+
+> **IdentityProfileComponentType**: *typeof* [`IdentityProfileComponentType`](../variables/IdentityProfileComponentType.md)\[keyof *typeof* [`IdentityProfileComponentType`](../variables/IdentityProfileComponentType.md)\]
+
+Identity profile component types.

package/docs/reference/type-aliases/IdentityProfileConnectorConfig.md

@@ -0,0 +1,19 @@
+# Type Alias: IdentityProfileConnectorConfig
+
+> **IdentityProfileConnectorConfig**: `object`
+
+Identity profile connector config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `IdentityProfileConnectorType.EntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.profileEntityStorageType?
+
+> `optional` **profileEntityStorageType**: `string`