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

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

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

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

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

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

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

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

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

package/docs/reference/functions/initialiseVerifiableStorageComponent.md

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

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

package/docs/reference/functions/initialiseWalletConnector.md

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