@twin.org/engine-types 0.0.3-next.4 → 0.0.3-next.40

package/docs/reference/functions/initialiseRightsManagementPolicyExecutionActionComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseRightsManagementPolicyExecutionActionComponent()
+
+> **initialiseRightsManagementPolicyExecutionActionComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`RightsManagementPolicyExecutionActionComponentConfig`](../type-aliases/RightsManagementPolicyExecutionActionComponentConfig.md), `Factory`\<`IPolicyExecutionAction`\>\>
+
+Initialise the rights management policy execution action component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`RightsManagementPolicyExecutionActionComponentConfig`](../type-aliases/RightsManagementPolicyExecutionActionComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`RightsManagementPolicyExecutionActionComponentConfig`](../type-aliases/RightsManagementPolicyExecutionActionComponentConfig.md), `Factory`\<`IPolicyExecutionAction`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseRightsManagementPolicyInformationSourceComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseRightsManagementPolicyInformationSourceComponent()
+
+> **initialiseRightsManagementPolicyInformationSourceComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`RightsManagementPolicyInformationSourceComponentConfig`](../type-aliases/RightsManagementPolicyInformationSourceComponentConfig.md), `Factory`\<`IPolicyInformationSource`\>\>
+
+Initialise the rights management policy information source component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`RightsManagementPolicyInformationSourceComponentConfig`](../type-aliases/RightsManagementPolicyInformationSourceComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`RightsManagementPolicyInformationSourceComponentConfig`](../type-aliases/RightsManagementPolicyInformationSourceComponentConfig.md), `Factory`\<`IPolicyInformationSource`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseRightsManagementPolicyNegotiatorComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyObligationEnforcerComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseRightsManagementPolicyObligationEnforcerComponent()
+
+> **initialiseRightsManagementPolicyObligationEnforcerComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`RightsManagementPolicyObligationEnforcerComponentConfig`](../type-aliases/RightsManagementPolicyObligationEnforcerComponentConfig.md), `Factory`\<`IPolicyObligationEnforcer`\>\>
+
+Initialise the rights management policy obligation enforcer component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`RightsManagementPolicyObligationEnforcerComponentConfig`](../type-aliases/RightsManagementPolicyObligationEnforcerComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`RightsManagementPolicyObligationEnforcerComponentConfig`](../type-aliases/RightsManagementPolicyObligationEnforcerComponentConfig.md), `Factory`\<`IPolicyObligationEnforcer`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseRightsManagementPolicyRequesterComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPxpComponent.md

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

package/docs/reference/functions/initialiseSynchronisedStorageComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseSynchronisedStorageComponent()
 
-> **initialiseSynchronisedStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseSynchronisedStorageComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise the synchronised storage component.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md), `Factory`\<`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`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+> **initialiseTaskSchedulerComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`TaskSchedulerComponentConfig`](../type-aliases/TaskSchedulerComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 Initialise a task scheduler.
 
@@ -26,6 +26,6 @@ The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+`EngineTypeInitialiserReturn`\<[`TaskSchedulerComponentConfig`](../type-aliases/TaskSchedulerComponentConfig.md), `Factory`\<`IComponent`\>\>
 
 The instance created and the factory for it.

package/docs/reference/functions/initialiseTelemetryComponent.md

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

package/docs/reference/functions/initialiseTelemetryConnector.md

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

package/docs/reference/functions/initialiseTenantAdminComponent.md

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

package/docs/reference/functions/initialiseTrustComponent.md

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

package/docs/reference/functions/initialiseTrustGeneratorComponent.md

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

package/docs/reference/functions/initialiseTrustVerifierComponent.md

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

package/docs/reference/functions/initialiseUrlTransformerComponent.md

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

package/docs/reference/functions/initialiseVaultConnector.md

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

package/docs/reference/functions/initialiseVerifiableStorageComponent.md

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

package/docs/reference/functions/initialiseVerifiableStorageConnector.md

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

package/docs/reference/functions/initialiseWalletConnector.md

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