@twin.org/engine-types 0.0.3-next.1 → 0.0.3-next.11

package/docs/changelog.md

@@ -1,5 +1,160 @@
 # @twin.org/engine-types - Changelog
 
+## [0.0.3-next.11](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.10...engine-types-v0.0.3-next.11) (2026-01-16)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.10 to 0.0.3-next.11
+    * @twin.org/engine-models bumped from 0.0.3-next.10 to 0.0.3-next.11
+
+## [0.0.3-next.10](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.9...engine-types-v0.0.3-next.10) (2026-01-13)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.9 to 0.0.3-next.10
+    * @twin.org/engine-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.8...engine-types-v0.0.3-next.9) (2026-01-07)
+
+
+### Features
+
+* inject logging into immutable proof ([#60](https://github.com/twinfoundation/engine/issues/60)) ([8d0bc86](https://github.com/twinfoundation/engine/commit/8d0bc86c01502e9c9031471834ee3da824c18b27))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.8 to 0.0.3-next.9
+    * @twin.org/engine-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.7...engine-types-v0.0.3-next.8) (2026-01-06)
+
+
+### Features
+
+* update dependencies ([034adac](https://github.com/twinfoundation/engine/commit/034adac97b177d8df9775da92f0cc0dbdfc8ab55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.7 to 0.0.3-next.8
+    * @twin.org/engine-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.6...engine-types-v0.0.3-next.7) (2025-12-04)
+
+
+### Features
+
+* add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.6 to 0.0.3-next.7
+    * @twin.org/engine-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.5...engine-types-v0.0.3-next.6) (2025-11-28)
+
+
+### Features
+
+* add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.5 to 0.0.3-next.6
+    * @twin.org/engine-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.4...engine-types-v0.0.3-next.5) (2025-11-20)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.4 to 0.0.3-next.5
+    * @twin.org/engine-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.3...engine-types-v0.0.3-next.4) (2025-11-20)
+
+
+### Features
+
+* context id handlers repopulated after engine clone ([9712e32](https://github.com/twinfoundation/engine/commit/9712e328f4607f5b2c82355c394c61bde0ee39bf))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.3 to 0.0.3-next.4
+    * @twin.org/engine-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.2...engine-types-v0.0.3-next.3) (2025-11-14)
+
+
+### Bug Fixes
+
+* make sure stop is called even if start is not implemented ([ece2b9d](https://github.com/twinfoundation/engine/commit/ece2b9de5c6dff2b5ccf2a3115c1a7328a330125))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.2 to 0.0.3-next.3
+    * @twin.org/engine-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.1...engine-types-v0.0.3-next.2) (2025-11-13)
+
+
+### Features
+
+* close already started components on startup error ([a55a117](https://github.com/twinfoundation/engine/commit/a55a117a508998288c8ae804e732fc6085cb22fa))
+
+
+### Bug Fixes
+
+* missing dependency ([e8147fb](https://github.com/twinfoundation/engine/commit/e8147fbd66248efd86877ece23022f2dd58c950a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.1 to 0.0.3-next.2
+    * @twin.org/engine-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
 ## [0.0.3-next.1](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.3-next.0...engine-types-v0.0.3-next.1) (2025-11-13)
 
 

package/docs/reference/functions/{initialiseBackgroundTaskConnector.md → initialiseBackgroundTaskComponent.md}

@@ -1,8 +1,8 @@
-# Function: initialiseBackgroundTaskConnector()
+# Function: initialiseBackgroundTaskComponent()
 
-> **initialiseBackgroundTaskConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBackgroundTaskConnector`\>; `component?`: `IComponent`; \}\>
+> **initialiseBackgroundTaskComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-Initialise a background task connector.
+Initialise a background task component.
 
 ## Parameters
 
@@ -20,12 +20,12 @@ The context for the engine.
 
 ### instanceConfig
 
-[`BackgroundTaskConnectorConfig`](../type-aliases/BackgroundTaskConnectorConfig.md)
+[`BackgroundTaskComponentConfig`](../type-aliases/BackgroundTaskComponentConfig.md)
 
 The instance config.
 
 ## Returns
 
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBackgroundTaskConnector`\>; `component?`: `IComponent`; \}\>
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 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/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/initialiseRightsManagementDataAccessHandlerComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyArbiterComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyEnforcementProcessorComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyExecutionActionComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyInformationSourceComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyNegotiatorComponent.md

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

package/docs/reference/functions/initialiseRightsManagementPolicyRequesterComponent.md

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

package/docs/reference/functions/initialiseTrustVerifierComponent.md

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