@twin.org/engine-types 0.0.2-next.9 → 0.0.3-next.10

package/docs/reference/functions/initialiseBlobStorageComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseBlobStorageComponent()
 
-> **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the blob storage component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseBlobStorageConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseBlobStorageConnector()
 
-> **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBlobStorageConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise the blob storage connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBlobStorageConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseContextIdHandlerComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseContextIdHandlerComponent()
+
+> **initialiseContextIdHandlerComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `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
+
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `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`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseDataConverterConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataConverterConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise the data converter connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataConverterConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseDataExtractorConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseDataExtractorConnector()
 
-> **initialiseDataExtractorConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseDataExtractorConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataExtractorConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise the data extractor connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataExtractorConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseDataProcessingComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseDataProcessingComponent()
 
-> **initialiseDataProcessingComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseDataProcessingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the data processing component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseDataSpaceConnectorComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseDataSpaceConnectorComponent()
+
+> **initialiseDataSpaceConnectorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+
+Initialise the data space connector component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`DataSpaceConnectorComponentConfig`](../type-aliases/DataSpaceConnectorComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `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`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseDocumentManagementComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the document management component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseEntityStorageComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseEntityStorageComponent()
 
-> **initialiseEntityStorageComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseEntityStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the entity storage connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+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`): `string`
+> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`, `partitionContextIds`): `string`
 
 Initialise the entity storage connector.
 
@@ -30,6 +30,12 @@ Override the type of connector to use instead of default configuration.
 
 The schema for the entity storage.
 
+### partitionContextIds
+
+`string`[]
+
+The context IDs to use for partitioning the data.
+
 ## Returns
 
 `string`
@@ -38,4 +44,4 @@ The name of the instance type that was created.
 
 ## Throws
 
-GeneralError if the connector type is unknown.
+GeneralError when the configuration is invalid.

package/docs/reference/functions/initialiseEventBusComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseEventBusComponent()
 
-> **initialiseEventBusComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseEventBusComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the event bus component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseEventBusConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseEventBusConnector()
 
-> **initialiseEventBusConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseEventBusConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IEventBusConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise a event bus connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IEventBusConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseFaucetConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseFaucetConnector()
 
-> **initialiseFaucetConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseFaucetConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFaucetConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise a faucet connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFaucetConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseFederatedCatalogueComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseFederatedCatalogueComponent()
 
-> **initialiseFederatedCatalogueComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseFederatedCatalogueComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the federated catalogue component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseFederatedCatalogueFilterComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseFederatedCatalogueFilterComponent()
+
+> **initialiseFederatedCatalogueFilterComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFederatedCatalogueFilter`\>; `component?`: `IComponent`; \}\>
+
+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
+
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFederatedCatalogueFilter`\>; `component?`: `IComponent`; \}\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityComponent()
 
-> **initialiseIdentityComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseIdentityComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the identity component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityConnector()
 
-> **initialiseIdentityConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseIdentityConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise the identity connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityProfileComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityProfileComponent()
 
-> **initialiseIdentityProfileComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseIdentityProfileComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the identity profile component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityProfileConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityProfileConnector()
 
-> **initialiseIdentityProfileConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseIdentityProfileConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityProfileConnector`\<`IJsonLdDocument`, `IJsonLdDocument`\>\>; `component?`: `IComponent`; \}\>
 
 Initialise the identity profile connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityProfileConnector`\<`IJsonLdDocument`, `IJsonLdDocument`\>\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityResolverComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityResolverComponent()
 
-> **initialiseIdentityResolverComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseIdentityResolverComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the identity resolver component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseIdentityResolverConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseIdentityResolverConnector()
 
-> **initialiseIdentityResolverConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseIdentityResolverConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityResolverConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise the identity resolver connector.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IIdentityResolverConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseImmutableProofComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseImmutableProofComponent()
 
-> **initialiseImmutableProofComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseImmutableProofComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the immutable proof component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`undefined` \| `string`
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.