@twin.org/engine-types 0.0.2-next.2 → 0.0.2-next.20

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`): `void`
+> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`): `string`
 
 Initialise the entity storage connector.
 
@@ -32,8 +32,10 @@ The schema for the entity storage.
 
 ## Returns
 
-`void`
+`string`
+
+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/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.

package/docs/reference/functions/initialiseLoggingComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseLoggingComponent()
 
-> **initialiseLoggingComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseLoggingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the logging 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/initialiseLoggingConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseLoggingConnector()
 
-> **initialiseLoggingConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseLoggingConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ILoggingConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise the logging connector.
 
@@ -24,18 +24,8 @@ The engine core context.
 
 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`\<`ILoggingConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseMessagingAdminComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseMessagingAdminComponent()
+
+> **initialiseMessagingAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+
+Initialise the messaging admin component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`MessagingAdminComponentConfig`](../type-aliases/MessagingAdminComponentConfig.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/initialiseMessagingComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseMessagingComponent()
 
-> **initialiseMessagingComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseMessagingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the messaging 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/initialiseMessagingEmailConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseMessagingEmailConnector()
 
-> **initialiseMessagingEmailConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseMessagingEmailConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMessagingEmailConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise a messaging email 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`\<`IMessagingEmailConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseMessagingPushNotificationConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseMessagingPushNotificationConnector()
 
-> **initialiseMessagingPushNotificationConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseMessagingPushNotificationConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMessagingPushNotificationsConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise a messaging push notification 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`\<`IMessagingPushNotificationsConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseMessagingSmsConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseMessagingSmsConnector()
 
-> **initialiseMessagingSmsConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseMessagingSmsConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMessagingSmsConnector`\>; `component?`: `IComponent`; \}\>
 
 Initialise a messaging sms 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`\<`IMessagingSmsConnector`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the connector type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseNftComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseNftComponent()
 
-> **initialiseNftComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+> **initialiseNftComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the NFT 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.