@twin.org/engine-types 0.0.3-next.3 → 0.0.3-next.30

package/docs/reference/functions/initialiseAttestationComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAttestationComponent()
 
-> **initialiseAttestationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseAttestationComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AttestationComponentConfig`](../type-aliases/AttestationComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the attestation component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`AttestationComponentConfig`](../type-aliases/AttestationComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseAttestationConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseAttestationConnector()
 
-> **initialiseAttestationConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IAttestationConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseAttestationConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AttestationConnectorConfig`](../type-aliases/AttestationConnectorConfig.md), `Factory`\<`IAttestationConnector`\>\>
 
 Initialise the attestation connector.
 
@@ -22,10 +22,10 @@ The context for the engine.
 
 [`AttestationConnectorConfig`](../type-aliases/AttestationConnectorConfig.md)
 
-The instance config.
+The instance config type.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IAttestationConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`AttestationConnectorConfig`](../type-aliases/AttestationConnectorConfig.md), `Factory`\<`IAttestationConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseAuditableItemGraphComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAuditableItemGraphComponent()
 
-> **initialiseAuditableItemGraphComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseAuditableItemGraphComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuditableItemGraphComponentConfig`](../type-aliases/AuditableItemGraphComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the auditable item graph component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`AuditableItemGraphComponentConfig`](../type-aliases/AuditableItemGraphComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseAuditableItemStreamComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAuditableItemStreamComponent()
 
-> **initialiseAuditableItemStreamComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseAuditableItemStreamComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuditableItemStreamComponentConfig`](../type-aliases/AuditableItemStreamComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the auditable item stream component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`AuditableItemStreamComponentConfig`](../type-aliases/AuditableItemStreamComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseBackgroundTaskComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseBackgroundTaskComponent()
+
+> **initialiseBackgroundTaskComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`BackgroundTaskComponentConfig`](../type-aliases/BackgroundTaskComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise a background task component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`BackgroundTaskComponentConfig`](../type-aliases/BackgroundTaskComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`BackgroundTaskComponentConfig`](../type-aliases/BackgroundTaskComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseBlobStorageComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseBlobStorageComponent()
 
-> **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`BlobStorageComponentConfig`](../type-aliases/BlobStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the blob storage component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`BlobStorageComponentConfig`](../type-aliases/BlobStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseBlobStorageConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseBlobStorageConnector()
 
-> **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBlobStorageConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`BlobStorageConnectorConfig`](../type-aliases/BlobStorageConnectorConfig.md), `Factory`\<`IBlobStorageConnector`\>\>
 
 Initialise the blob storage connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBlobStorageConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`BlobStorageConnectorConfig`](../type-aliases/BlobStorageConnectorConfig.md), `Factory`\<`IBlobStorageConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseContextIdHandlerComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseContextIdHandlerComponent()
+
+> **initialiseContextIdHandlerComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`ContextIdHandlerComponentConfig`](../type-aliases/ContextIdHandlerComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the context id handler component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`ContextIdHandlerComponentConfig`](../type-aliases/ContextIdHandlerComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`ContextIdHandlerComponentConfig`](../type-aliases/ContextIdHandlerComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseDataConverterConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseDataConverterConnector()
 
-> **initialiseDataConverterConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataConverterConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseDataConverterConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`DataConverterConnectorConfig`](../type-aliases/DataConverterConnectorConfig.md), `Factory`\<`IDataConverterConnector`\>\>
 
 Initialise the data converter connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataConverterConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`DataConverterConnectorConfig`](../type-aliases/DataConverterConnectorConfig.md), `Factory`\<`IDataConverterConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseDataExtractorConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseDataExtractorConnector()
 
-> **initialiseDataExtractorConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataExtractorConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseDataExtractorConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`DataExtractorConnectorConfig`](../type-aliases/DataExtractorConnectorConfig.md), `Factory`\<`IDataExtractorConnector`\>\>
 
 Initialise the data extractor connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataExtractorConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`DataExtractorConnectorConfig`](../type-aliases/DataExtractorConnectorConfig.md), `Factory`\<`IDataExtractorConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseDataProcessingComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseDataProcessingComponent()
 
-> **initialiseDataProcessingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseDataProcessingComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`DataProcessingComponentConfig`](../type-aliases/DataProcessingComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the data processing component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`DataProcessingComponentConfig`](../type-aliases/DataProcessingComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseDataspaceControlPlaneComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseDataspaceControlPlaneComponent()
+
+> **initialiseDataspaceControlPlaneComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`DataspaceControlPlaneComponentConfig`](../type-aliases/DataspaceControlPlaneComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the dataspace control plane component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`DataspaceControlPlaneComponentConfig`](../type-aliases/DataspaceControlPlaneComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`DataspaceControlPlaneComponentConfig`](../type-aliases/DataspaceControlPlaneComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseDataspaceDataPlaneComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseDataspaceDataPlaneComponent()
+
+> **initialiseDataspaceDataPlaneComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`DataspaceDataPlaneComponentConfig`](../type-aliases/DataspaceDataPlaneComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the dataspace data plane component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`DataspaceDataPlaneComponentConfig`](../type-aliases/DataspaceDataPlaneComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`DataspaceDataPlaneComponentConfig`](../type-aliases/DataspaceDataPlaneComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseDocumentManagementComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseDocumentManagementComponent()
 
-> **initialiseDocumentManagementComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseDocumentManagementComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`DocumentManagementComponentConfig`](../type-aliases/DocumentManagementComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the document management component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`DocumentManagementComponentConfig`](../type-aliases/DocumentManagementComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseEntityStorageComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseEntityStorageComponent()
 
-> **initialiseEntityStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseEntityStorageComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`EntityStorageComponentConfig`](../type-aliases/EntityStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the entity storage connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`EntityStorageComponentConfig`](../type-aliases/EntityStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseEntityStorageConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseEntityStorageConnector()
 
-> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`, `partitionContextIds`): `string`
+> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`, `partitionContextIds`): `void`
 
 Initialise the entity storage connector.
 
@@ -20,9 +20,9 @@ The context for the engine.
 
 ### typeCustom
 
-Override the type of connector to use instead of default configuration.
+`string` \| `undefined`
 
-`undefined` | `string`
+Override the type of connector to use instead of default configuration.
 
 ### schema
 
@@ -38,9 +38,7 @@ The context IDs to use for partitioning the data.
 
 ## Returns
 
-`string`
-
-The name of the instance type that was created.
+`void`
 
 ## Throws
 

package/docs/reference/functions/initialiseEventBusComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseEventBusComponent()
 
-> **initialiseEventBusComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseEventBusComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`EventBusComponentConfig`](../type-aliases/EventBusComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the event bus component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`EventBusComponentConfig`](../type-aliases/EventBusComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseEventBusConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseEventBusConnector()
 
-> **initialiseEventBusConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IEventBusConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseEventBusConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`EventBusConnectorConfig`](../type-aliases/EventBusConnectorConfig.md), `Factory`\<`IEventBusConnector`\>\>
 
 Initialise a event bus connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IEventBusConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`EventBusConnectorConfig`](../type-aliases/EventBusConnectorConfig.md), `Factory`\<`IEventBusConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseFaucetConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseFaucetConnector()
 
-> **initialiseFaucetConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFaucetConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseFaucetConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`FaucetConnectorConfig`](../type-aliases/FaucetConnectorConfig.md), `Factory`\<`IFaucetConnector`\>\>
 
 Initialise a faucet connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFaucetConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`FaucetConnectorConfig`](../type-aliases/FaucetConnectorConfig.md), `Factory`\<`IFaucetConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseFederatedCatalogueComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseFederatedCatalogueComponent()
 
-> **initialiseFederatedCatalogueComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseFederatedCatalogueComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`FederatedCatalogueComponentConfig`](../type-aliases/FederatedCatalogueComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the federated catalogue component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`FederatedCatalogueComponentConfig`](../type-aliases/FederatedCatalogueComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseFederatedCatalogueFilterComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseFederatedCatalogueFilterComponent()
+
+> **initialiseFederatedCatalogueFilterComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`FederatedCatalogueFilterComponentConfig`](../type-aliases/FederatedCatalogueFilterComponentConfig.md), `Factory`\<`IFederatedCatalogueFilter`\>\>
+
+Initialise the federated catalogue filter component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`FederatedCatalogueFilterComponentConfig`](../type-aliases/FederatedCatalogueFilterComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`FederatedCatalogueFilterComponentConfig`](../type-aliases/FederatedCatalogueFilterComponentConfig.md), `Factory`\<`IFederatedCatalogueFilter`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityComponent()
 
-> **initialiseIdentityComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseIdentityComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`IdentityComponentConfig`](../type-aliases/IdentityComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the identity component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`IdentityComponentConfig`](../type-aliases/IdentityComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityConnector()
 
-> **initialiseIdentityConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseIdentityConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`IdentityConnectorConfig`](../type-aliases/IdentityConnectorConfig.md), `Factory`\<`IIdentityConnector`\>\>
 
 Initialise the identity connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`IdentityConnectorConfig`](../type-aliases/IdentityConnectorConfig.md), `Factory`\<`IIdentityConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityProfileComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityProfileComponent()
 
-> **initialiseIdentityProfileComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseIdentityProfileComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`IdentityProfileComponentConfig`](../type-aliases/IdentityProfileComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the identity profile component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`IdentityProfileComponentConfig`](../type-aliases/IdentityProfileComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityProfileConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityProfileConnector()
 
-> **initialiseIdentityProfileConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityProfileConnector`\<`IJsonLdDocument`, `IJsonLdDocument`\>\>; `component?`: `IComponent`; \}\>
+> **initialiseIdentityProfileConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`IdentityProfileConnectorConfig`](../type-aliases/IdentityProfileConnectorConfig.md), `Factory`\<`IIdentityProfileConnector`\<`IJsonLdDocument`, `IJsonLdDocument`\>\>\>
 
 Initialise the identity profile connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityProfileConnector`\<`IJsonLdDocument`, `IJsonLdDocument`\>\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`IdentityProfileConnectorConfig`](../type-aliases/IdentityProfileConnectorConfig.md), `Factory`\<`IIdentityProfileConnector`\<`IJsonLdDocument`, `IJsonLdDocument`\>\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityResolverComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityResolverComponent()
 
-> **initialiseIdentityResolverComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseIdentityResolverComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`IdentityResolverComponentConfig`](../type-aliases/IdentityResolverComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the identity resolver component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`IdentityResolverComponentConfig`](../type-aliases/IdentityResolverComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityResolverConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityResolverConnector()
 
-> **initialiseIdentityResolverConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityResolverConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseIdentityResolverConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`IdentityResolverConnectorConfig`](../type-aliases/IdentityResolverConnectorConfig.md), `Factory`\<`IIdentityResolverConnector`\>\>
 
 Initialise the identity resolver connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityResolverConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`IdentityResolverConnectorConfig`](../type-aliases/IdentityResolverConnectorConfig.md), `Factory`\<`IIdentityResolverConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseImmutableProofComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseImmutableProofComponent()
 
-> **initialiseImmutableProofComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseImmutableProofComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`ImmutableProofComponentConfig`](../type-aliases/ImmutableProofComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the immutable proof component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`ImmutableProofComponentConfig`](../type-aliases/ImmutableProofComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseLoggingComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseLoggingComponent()
 
-> **initialiseLoggingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseLoggingComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`LoggingComponentConfig`](../type-aliases/LoggingComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the logging component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`LoggingComponentConfig`](../type-aliases/LoggingComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseLoggingConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseLoggingConnector()
 
-> **initialiseLoggingConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ILoggingConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseLoggingConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`LoggingConnectorConfig`](../type-aliases/LoggingConnectorConfig.md), `Factory`\<`ILoggingConnector`\>\>
 
 Initialise the logging connector.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ILoggingConnector`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`LoggingConnectorConfig`](../type-aliases/LoggingConnectorConfig.md), `Factory`\<`ILoggingConnector`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseMessagingAdminComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseMessagingAdminComponent()
 
-> **initialiseMessagingAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseMessagingAdminComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`MessagingAdminComponentConfig`](../type-aliases/MessagingAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the messaging admin component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`MessagingAdminComponentConfig`](../type-aliases/MessagingAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.