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

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.

package/docs/reference/functions/initialiseNftConnector.md

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

package/docs/reference/functions/initialiseRightsManagementDapComponent.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/docs/reference/functions/initialiseTenantAdminComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseTenantAdminComponent()
+
+> **initialiseTenantAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+
+Initialise the tenant admin component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`TenantAdminComponentConfig`](../type-aliases/TenantAdminComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+
+The instance created and the factory for it.