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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (218) hide show
  1. package/dist/cjs/index.cjs +1310 -1098
  2. package/dist/esm/index.mjs +1312 -1124
  3. package/dist/types/components/attestation.d.ts +14 -8
  4. package/dist/types/components/auditableItemGraph.d.ts +7 -4
  5. package/dist/types/components/auditableItemStream.d.ts +7 -4
  6. package/dist/types/components/authenticationGenerator.d.ts +17 -0
  7. package/dist/types/components/backgroundTask.d.ts +8 -4
  8. package/dist/types/components/blobStorage.d.ts +14 -8
  9. package/dist/types/components/dataProcessing.d.ts +20 -12
  10. package/dist/types/components/dataSpaceConnector.d.ts +16 -0
  11. package/dist/types/components/documentManagement.d.ts +7 -4
  12. package/dist/types/components/entityStorage.d.ts +10 -6
  13. package/dist/types/components/eventBus.d.ts +14 -8
  14. package/dist/types/components/faucet.d.ts +8 -4
  15. package/dist/types/components/federatedCatalogue.d.ts +7 -4
  16. package/dist/types/components/identity.d.ts +14 -8
  17. package/dist/types/components/identityProfile.d.ts +14 -8
  18. package/dist/types/components/identityResolver.d.ts +14 -8
  19. package/dist/types/components/immutableProof.d.ts +7 -4
  20. package/dist/types/components/logging.d.ts +14 -8
  21. package/dist/types/components/messaging.d.ts +39 -16
  22. package/dist/types/components/nft.d.ts +14 -8
  23. package/dist/types/components/rightsManagementDap.d.ts +16 -0
  24. package/dist/types/components/rightsManagementDarp.d.ts +16 -0
  25. package/dist/types/components/rightsManagementPap.d.ts +7 -4
  26. package/dist/types/components/rightsManagementPdp.d.ts +16 -0
  27. package/dist/types/components/rightsManagementPep.d.ts +16 -0
  28. package/dist/types/components/rightsManagementPip.d.ts +16 -0
  29. package/dist/types/components/rightsManagementPmp.d.ts +16 -0
  30. package/dist/types/components/rightsManagementPnap.d.ts +16 -0
  31. package/dist/types/components/rightsManagementPnp.d.ts +16 -0
  32. package/dist/types/components/rightsManagementPxp.d.ts +16 -0
  33. package/dist/types/components/synchronisedStorage.d.ts +16 -0
  34. package/dist/types/components/taskScheduler.d.ts +7 -4
  35. package/dist/types/components/telemetry.d.ts +14 -8
  36. package/dist/types/components/vault.d.ts +8 -4
  37. package/dist/types/components/verifiableStorage.d.ts +14 -8
  38. package/dist/types/components/wallet.d.ts +8 -14
  39. package/dist/types/index.d.ts +39 -3
  40. package/dist/types/models/IEngineConfig.d.ts +67 -7
  41. package/dist/types/models/config/authenticationGeneratorComponentConfig.d.ts +9 -0
  42. package/dist/types/models/config/dataSpaceConnectorComponentConfig.d.ts +17 -0
  43. package/dist/types/models/config/entityStorageConnectorConfig.d.ts +4 -0
  44. package/dist/types/models/config/messagingAdminComponentConfig.d.ts +9 -0
  45. package/dist/types/models/config/rightsManagementDapComponentConfig.d.ts +16 -0
  46. package/dist/types/models/config/rightsManagementDarpComponentConfig.d.ts +12 -0
  47. package/dist/types/models/config/rightsManagementPapComponentConfig.d.ts +6 -2
  48. package/dist/types/models/config/rightsManagementPdpComponentConfig.d.ts +12 -0
  49. package/dist/types/models/config/rightsManagementPepComponentConfig.d.ts +12 -0
  50. package/dist/types/models/config/rightsManagementPipComponentConfig.d.ts +12 -0
  51. package/dist/types/models/config/rightsManagementPmpComponentConfig.d.ts +9 -0
  52. package/dist/types/models/config/rightsManagementPnapComponentConfig.d.ts +13 -0
  53. package/dist/types/models/config/rightsManagementPnpComponentConfig.d.ts +17 -0
  54. package/dist/types/models/config/rightsManagementPxpComponentConfig.d.ts +12 -0
  55. package/dist/types/models/config/synchronisedStorageComponentConfig.d.ts +13 -0
  56. package/dist/types/models/types/authenticationGeneratorComponentType.d.ts +13 -0
  57. package/dist/types/models/types/dataSpaceConnectorComponentType.d.ts +21 -0
  58. package/dist/types/models/types/entityStorageConnectorType.d.ts +4 -0
  59. package/dist/types/models/types/messagingAdminComponentType.d.ts +13 -0
  60. package/dist/types/models/types/rightsManagementDapComponentType.d.ts +17 -0
  61. package/dist/types/models/types/rightsManagementDarpComponentType.d.ts +13 -0
  62. package/dist/types/models/types/rightsManagementPapComponentType.d.ts +4 -0
  63. package/dist/types/models/types/rightsManagementPdpComponentType.d.ts +13 -0
  64. package/dist/types/models/types/rightsManagementPepComponentType.d.ts +17 -0
  65. package/dist/types/models/types/rightsManagementPipComponentType.d.ts +13 -0
  66. package/dist/types/models/types/rightsManagementPmpComponentType.d.ts +13 -0
  67. package/dist/types/models/types/rightsManagementPnapComponentType.d.ts +17 -0
  68. package/dist/types/models/types/rightsManagementPnpComponentType.d.ts +17 -0
  69. package/dist/types/models/types/rightsManagementPxpComponentType.d.ts +13 -0
  70. package/dist/types/models/types/synchronisedStorageComponentType.d.ts +17 -0
  71. package/dist/types/utils/engineTypeHelper.d.ts +19 -0
  72. package/docs/changelog.md +261 -0
  73. package/docs/reference/classes/EngineTypeHelper.md +61 -0
  74. package/docs/reference/functions/initialiseAttestationComponent.md +3 -13
  75. package/docs/reference/functions/initialiseAttestationConnector.md +3 -13
  76. package/docs/reference/functions/initialiseAuditableItemGraphComponent.md +3 -13
  77. package/docs/reference/functions/initialiseAuditableItemStreamComponent.md +3 -13
  78. package/docs/reference/functions/initialiseAuthenticationGeneratorComponent.md +31 -0
  79. package/docs/reference/functions/initialiseBackgroundTaskConnector.md +3 -13
  80. package/docs/reference/functions/initialiseBlobStorageComponent.md +3 -13
  81. package/docs/reference/functions/initialiseBlobStorageConnector.md +3 -13
  82. package/docs/reference/functions/initialiseDataConverterConnector.md +3 -13
  83. package/docs/reference/functions/initialiseDataExtractorConnector.md +3 -13
  84. package/docs/reference/functions/initialiseDataProcessingComponent.md +3 -13
  85. package/docs/reference/functions/initialiseDataSpaceConnectorComponent.md +31 -0
  86. package/docs/reference/functions/initialiseDocumentManagementComponent.md +3 -13
  87. package/docs/reference/functions/initialiseEntityStorageComponent.md +3 -13
  88. package/docs/reference/functions/initialiseEntityStorageConnector.md +5 -3
  89. package/docs/reference/functions/initialiseEventBusComponent.md +3 -13
  90. package/docs/reference/functions/initialiseEventBusConnector.md +3 -13
  91. package/docs/reference/functions/initialiseFaucetConnector.md +3 -13
  92. package/docs/reference/functions/initialiseFederatedCatalogueComponent.md +3 -13
  93. package/docs/reference/functions/initialiseIdentityComponent.md +3 -13
  94. package/docs/reference/functions/initialiseIdentityConnector.md +3 -13
  95. package/docs/reference/functions/initialiseIdentityProfileComponent.md +3 -13
  96. package/docs/reference/functions/initialiseIdentityProfileConnector.md +3 -13
  97. package/docs/reference/functions/initialiseIdentityResolverComponent.md +3 -13
  98. package/docs/reference/functions/initialiseIdentityResolverConnector.md +3 -13
  99. package/docs/reference/functions/initialiseImmutableProofComponent.md +3 -13
  100. package/docs/reference/functions/initialiseLoggingComponent.md +3 -13
  101. package/docs/reference/functions/initialiseLoggingConnector.md +3 -13
  102. package/docs/reference/functions/initialiseMessagingAdminComponent.md +31 -0
  103. package/docs/reference/functions/initialiseMessagingComponent.md +3 -13
  104. package/docs/reference/functions/initialiseMessagingEmailConnector.md +3 -13
  105. package/docs/reference/functions/initialiseMessagingPushNotificationConnector.md +3 -13
  106. package/docs/reference/functions/initialiseMessagingSmsConnector.md +3 -13
  107. package/docs/reference/functions/initialiseNftComponent.md +3 -13
  108. package/docs/reference/functions/initialiseNftConnector.md +3 -13
  109. package/docs/reference/functions/initialiseRightsManagementDapComponent.md +31 -0
  110. package/docs/reference/functions/initialiseRightsManagementDarpComponent.md +31 -0
  111. package/docs/reference/functions/initialiseRightsManagementPapComponent.md +3 -13
  112. package/docs/reference/functions/initialiseRightsManagementPdpComponent.md +31 -0
  113. package/docs/reference/functions/initialiseRightsManagementPepComponent.md +31 -0
  114. package/docs/reference/functions/initialiseRightsManagementPipComponent.md +31 -0
  115. package/docs/reference/functions/initialiseRightsManagementPmpComponent.md +31 -0
  116. package/docs/reference/functions/initialiseRightsManagementPnapComponent.md +31 -0
  117. package/docs/reference/functions/initialiseRightsManagementPnpComponent.md +31 -0
  118. package/docs/reference/functions/initialiseRightsManagementPxpComponent.md +31 -0
  119. package/docs/reference/functions/initialiseSynchronisedStorageComponent.md +31 -0
  120. package/docs/reference/functions/initialiseTaskSchedulerComponent.md +3 -13
  121. package/docs/reference/functions/initialiseTelemetryComponent.md +3 -13
  122. package/docs/reference/functions/initialiseTelemetryConnector.md +3 -13
  123. package/docs/reference/functions/initialiseVaultConnector.md +3 -13
  124. package/docs/reference/functions/initialiseVerifiableStorageComponent.md +3 -13
  125. package/docs/reference/functions/initialiseVerifiableStorageConnector.md +3 -13
  126. package/docs/reference/functions/initialiseWalletConnector.md +3 -13
  127. package/docs/reference/index.md +56 -5
  128. package/docs/reference/interfaces/IEngineConfig.md +81 -9
  129. package/docs/reference/type-aliases/AuthenticationGeneratorComponentConfig.md +17 -0
  130. package/docs/reference/type-aliases/AuthenticationGeneratorComponentType.md +5 -0
  131. package/docs/reference/type-aliases/DataSpaceConnectorComponentConfig.md +5 -0
  132. package/docs/reference/type-aliases/DataSpaceConnectorComponentType.md +5 -0
  133. package/docs/reference/type-aliases/EntityStorageConnectorConfig.md +1 -1
  134. package/docs/reference/type-aliases/MessagingAdminComponentConfig.md +17 -0
  135. package/docs/reference/type-aliases/MessagingAdminComponentType.md +5 -0
  136. package/docs/reference/type-aliases/RightsManagementDapComponentConfig.md +5 -0
  137. package/docs/reference/type-aliases/RightsManagementDapComponentType.md +5 -0
  138. package/docs/reference/type-aliases/RightsManagementDarpComponentConfig.md +23 -0
  139. package/docs/reference/type-aliases/RightsManagementDarpComponentType.md +5 -0
  140. package/docs/reference/type-aliases/RightsManagementPapComponentConfig.md +1 -13
  141. package/docs/reference/type-aliases/RightsManagementPdpComponentConfig.md +23 -0
  142. package/docs/reference/type-aliases/RightsManagementPdpComponentType.md +5 -0
  143. package/docs/reference/type-aliases/RightsManagementPepComponentConfig.md +23 -0
  144. package/docs/reference/type-aliases/RightsManagementPepComponentType.md +5 -0
  145. package/docs/reference/type-aliases/RightsManagementPipComponentConfig.md +23 -0
  146. package/docs/reference/type-aliases/RightsManagementPipComponentType.md +5 -0
  147. package/docs/reference/type-aliases/RightsManagementPmpComponentConfig.md +17 -0
  148. package/docs/reference/type-aliases/RightsManagementPmpComponentType.md +5 -0
  149. package/docs/reference/type-aliases/RightsManagementPnapComponentConfig.md +5 -0
  150. package/docs/reference/type-aliases/RightsManagementPnapComponentType.md +5 -0
  151. package/docs/reference/type-aliases/RightsManagementPnpComponentConfig.md +5 -0
  152. package/docs/reference/type-aliases/RightsManagementPnpComponentType.md +5 -0
  153. package/docs/reference/type-aliases/RightsManagementPxpComponentConfig.md +23 -0
  154. package/docs/reference/type-aliases/RightsManagementPxpComponentType.md +5 -0
  155. package/docs/reference/type-aliases/SynchronisedStorageComponentConfig.md +5 -0
  156. package/docs/reference/type-aliases/SynchronisedStorageComponentType.md +5 -0
  157. package/docs/reference/variables/AttestationComponentType.md +1 -1
  158. package/docs/reference/variables/AttestationConnectorType.md +1 -1
  159. package/docs/reference/variables/AuditableItemGraphComponentType.md +1 -1
  160. package/docs/reference/variables/AuditableItemStreamComponentType.md +1 -1
  161. package/docs/reference/variables/AuthenticationGeneratorComponentType.md +13 -0
  162. package/docs/reference/variables/BackgroundTaskConnectorType.md +1 -1
  163. package/docs/reference/variables/BlobStorageComponentType.md +1 -1
  164. package/docs/reference/variables/BlobStorageConnectorType.md +1 -1
  165. package/docs/reference/variables/DataConverterConnectorType.md +1 -1
  166. package/docs/reference/variables/DataExtractorConnectorType.md +1 -1
  167. package/docs/reference/variables/DataProcessingComponentType.md +1 -1
  168. package/docs/reference/variables/DataSpaceConnectorComponentType.md +25 -0
  169. package/docs/reference/variables/DltConfigType.md +1 -1
  170. package/docs/reference/variables/DocumentManagementComponentType.md +1 -1
  171. package/docs/reference/variables/EntityStorageComponentType.md +1 -1
  172. package/docs/reference/variables/EntityStorageConnectorType.md +7 -1
  173. package/docs/reference/variables/EventBusComponentType.md +1 -1
  174. package/docs/reference/variables/EventBusConnectorType.md +1 -1
  175. package/docs/reference/variables/FaucetConnectorType.md +1 -1
  176. package/docs/reference/variables/FederatedCatalogueComponentType.md +1 -1
  177. package/docs/reference/variables/IdentityComponentType.md +1 -1
  178. package/docs/reference/variables/IdentityConnectorType.md +1 -1
  179. package/docs/reference/variables/IdentityProfileComponentType.md +1 -1
  180. package/docs/reference/variables/IdentityProfileConnectorType.md +1 -1
  181. package/docs/reference/variables/IdentityResolverComponentType.md +1 -1
  182. package/docs/reference/variables/IdentityResolverConnectorType.md +1 -1
  183. package/docs/reference/variables/ImmutableProofComponentType.md +1 -1
  184. package/docs/reference/variables/LoggingComponentType.md +1 -1
  185. package/docs/reference/variables/LoggingConnectorType.md +1 -1
  186. package/docs/reference/variables/MessagingAdminComponentType.md +13 -0
  187. package/docs/reference/variables/MessagingComponentType.md +1 -1
  188. package/docs/reference/variables/MessagingEmailConnectorType.md +1 -1
  189. package/docs/reference/variables/MessagingPushNotificationConnectorType.md +1 -1
  190. package/docs/reference/variables/MessagingSmsConnectorType.md +1 -1
  191. package/docs/reference/variables/NftComponentType.md +1 -1
  192. package/docs/reference/variables/NftConnectorType.md +1 -1
  193. package/docs/reference/variables/RightsManagementDapComponentType.md +19 -0
  194. package/docs/reference/variables/RightsManagementDarpComponentType.md +13 -0
  195. package/docs/reference/variables/RightsManagementPapComponentType.md +7 -1
  196. package/docs/reference/variables/RightsManagementPdpComponentType.md +13 -0
  197. package/docs/reference/variables/RightsManagementPepComponentType.md +19 -0
  198. package/docs/reference/variables/RightsManagementPipComponentType.md +13 -0
  199. package/docs/reference/variables/RightsManagementPmpComponentType.md +13 -0
  200. package/docs/reference/variables/RightsManagementPnapComponentType.md +19 -0
  201. package/docs/reference/variables/RightsManagementPnpComponentType.md +19 -0
  202. package/docs/reference/variables/RightsManagementPxpComponentType.md +13 -0
  203. package/docs/reference/variables/{RightsManagementComponentType.md → SynchronisedStorageComponentType.md} +4 -4
  204. package/docs/reference/variables/TaskSchedulerComponentType.md +1 -1
  205. package/docs/reference/variables/TelemetryComponentType.md +1 -1
  206. package/docs/reference/variables/TelemetryConnectorType.md +1 -1
  207. package/docs/reference/variables/VaultConnectorType.md +1 -1
  208. package/docs/reference/variables/VerifiableStorageComponentType.md +1 -1
  209. package/docs/reference/variables/VerifiableStorageConnectorType.md +1 -1
  210. package/docs/reference/variables/WalletConnectorType.md +1 -1
  211. package/package.json +28 -2
  212. package/dist/types/components/rightsManagement.d.ts +0 -13
  213. package/dist/types/models/config/rightsManagementComponentConfig.d.ts +0 -13
  214. package/dist/types/models/types/rightsManagementComponentType.d.ts +0 -17
  215. package/docs/reference/functions/initialiseRightsManagementComponent.md +0 -41
  216. package/docs/reference/functions/initialiseWalletStorage.md +0 -41
  217. package/docs/reference/type-aliases/RightsManagementComponentConfig.md +0 -5
  218. package/docs/reference/type-aliases/RightsManagementComponentType.md +0 -5
package/docs/changelog.md CHANGED
@@ -1,5 +1,266 @@
1
1
  # @twin.org/engine-types - Changelog
2
2
 
3
+ ## [0.0.2-next.20](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.19...engine-types-v0.0.2-next.20) (2025-10-06)
4
+
5
+
6
+ ### Features
7
+
8
+ * standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/engine-core bumped from 0.0.2-next.19 to 0.0.2-next.20
16
+ * @twin.org/engine-models bumped from 0.0.2-next.19 to 0.0.2-next.20
17
+
18
+ ## [0.0.2-next.19](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.18...engine-types-v0.0.2-next.19) (2025-10-02)
19
+
20
+
21
+ ### Features
22
+
23
+ * simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/engine-core bumped from 0.0.2-next.18 to 0.0.2-next.19
31
+ * @twin.org/engine-models bumped from 0.0.2-next.18 to 0.0.2-next.19
32
+
33
+ ## [0.0.2-next.18](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.17...engine-types-v0.0.2-next.18) (2025-09-29)
34
+
35
+
36
+ ### Features
37
+
38
+ * upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/engine-core bumped from 0.0.2-next.17 to 0.0.2-next.18
46
+ * @twin.org/engine-models bumped from 0.0.2-next.17 to 0.0.2-next.18
47
+
48
+ ## [0.0.2-next.17](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.16...engine-types-v0.0.2-next.17) (2025-09-26)
49
+
50
+
51
+ ### Features
52
+
53
+ * add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/engine-core bumped from 0.0.2-next.16 to 0.0.2-next.17
61
+ * @twin.org/engine-models bumped from 0.0.2-next.16 to 0.0.2-next.17
62
+
63
+ ## [0.0.2-next.16](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.15...engine-types-v0.0.2-next.16) (2025-09-25)
64
+
65
+
66
+ ### Features
67
+
68
+ * add engine type helper for config lookups ([7d5eeef](https://github.com/twinfoundation/engine/commit/7d5eeefd3e7b9daab1ba20e2fb6b1ebfec178aec))
69
+
70
+
71
+ ### Dependencies
72
+
73
+ * The following workspace dependencies were updated
74
+ * dependencies
75
+ * @twin.org/engine-core bumped from 0.0.2-next.15 to 0.0.2-next.16
76
+ * @twin.org/engine-models bumped from 0.0.2-next.15 to 0.0.2-next.16
77
+
78
+ ## [0.0.2-next.15](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.14...engine-types-v0.0.2-next.15) (2025-09-24)
79
+
80
+
81
+ ### Features
82
+
83
+ * update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/engine-core bumped from 0.0.2-next.14 to 0.0.2-next.15
91
+ * @twin.org/engine-models bumped from 0.0.2-next.14 to 0.0.2-next.15
92
+
93
+ ## [0.0.2-next.14](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.13...engine-types-v0.0.2-next.14) (2025-09-19)
94
+
95
+
96
+ ### Features
97
+
98
+ * add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
99
+
100
+
101
+ ### Dependencies
102
+
103
+ * The following workspace dependencies were updated
104
+ * dependencies
105
+ * @twin.org/engine-core bumped from 0.0.2-next.13 to 0.0.2-next.14
106
+ * @twin.org/engine-models bumped from 0.0.2-next.13 to 0.0.2-next.14
107
+
108
+ ## [0.0.2-next.13](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.12...engine-types-v0.0.2-next.13) (2025-09-08)
109
+
110
+
111
+ ### Features
112
+
113
+ * update rights management dependencies ([14d06fb](https://github.com/twinfoundation/engine/commit/14d06fb6604ad04e4094da7b51b61a01a0280b8b))
114
+
115
+
116
+ ### Dependencies
117
+
118
+ * The following workspace dependencies were updated
119
+ * dependencies
120
+ * @twin.org/engine-core bumped from 0.0.2-next.12 to 0.0.2-next.13
121
+ * @twin.org/engine-models bumped from 0.0.2-next.12 to 0.0.2-next.13
122
+
123
+ ## [0.0.2-next.12](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.11...engine-types-v0.0.2-next.12) (2025-09-05)
124
+
125
+
126
+ ### Features
127
+
128
+ * add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
129
+
130
+
131
+ ### Dependencies
132
+
133
+ * The following workspace dependencies were updated
134
+ * dependencies
135
+ * @twin.org/engine-core bumped from 0.0.2-next.11 to 0.0.2-next.12
136
+ * @twin.org/engine-models bumped from 0.0.2-next.11 to 0.0.2-next.12
137
+
138
+ ## [0.0.2-next.11](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.10...engine-types-v0.0.2-next.11) (2025-08-29)
139
+
140
+
141
+ ### Features
142
+
143
+ * eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
144
+
145
+
146
+ ### Dependencies
147
+
148
+ * The following workspace dependencies were updated
149
+ * dependencies
150
+ * @twin.org/engine-models bumped from 0.0.2-next.10 to 0.0.2-next.11
151
+
152
+ ## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.9...engine-types-v0.0.2-next.10) (2025-08-26)
153
+
154
+
155
+ ### Features
156
+
157
+ * add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
158
+
159
+
160
+ ### Dependencies
161
+
162
+ * The following workspace dependencies were updated
163
+ * dependencies
164
+ * @twin.org/engine-models bumped from 0.0.2-next.9 to 0.0.2-next.10
165
+
166
+ ## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.8...engine-types-v0.0.2-next.9) (2025-08-25)
167
+
168
+
169
+ ### Miscellaneous Chores
170
+
171
+ * **engine-types:** Synchronize repo versions
172
+
173
+
174
+ ### Dependencies
175
+
176
+ * The following workspace dependencies were updated
177
+ * dependencies
178
+ * @twin.org/engine-models bumped from 0.0.2-next.8 to 0.0.2-next.9
179
+
180
+ ## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.7...engine-types-v0.0.2-next.8) (2025-08-22)
181
+
182
+
183
+ ### Features
184
+
185
+ * add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
186
+
187
+
188
+ ### Dependencies
189
+
190
+ * The following workspace dependencies were updated
191
+ * dependencies
192
+ * @twin.org/engine-models bumped from 0.0.2-next.7 to 0.0.2-next.8
193
+
194
+ ## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.6...engine-types-v0.0.2-next.7) (2025-08-22)
195
+
196
+
197
+ ### Miscellaneous Chores
198
+
199
+ * **engine-types:** Synchronize repo versions
200
+
201
+
202
+ ### Dependencies
203
+
204
+ * The following workspace dependencies were updated
205
+ * dependencies
206
+ * @twin.org/engine-models bumped from 0.0.2-next.6 to 0.0.2-next.7
207
+
208
+ ## [0.0.2-next.6](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.5...engine-types-v0.0.2-next.6) (2025-08-21)
209
+
210
+
211
+ ### Features
212
+
213
+ * update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
214
+
215
+
216
+ ### Dependencies
217
+
218
+ * The following workspace dependencies were updated
219
+ * dependencies
220
+ * @twin.org/engine-models bumped from 0.0.2-next.5 to 0.0.2-next.6
221
+
222
+ ## [0.0.2-next.5](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.4...engine-types-v0.0.2-next.5) (2025-08-14)
223
+
224
+
225
+ ### Features
226
+
227
+ * add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
228
+
229
+
230
+ ### Dependencies
231
+
232
+ * The following workspace dependencies were updated
233
+ * dependencies
234
+ * @twin.org/engine-models bumped from 0.0.2-next.4 to 0.0.2-next.5
235
+
236
+ ## [0.0.2-next.4](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.3...engine-types-v0.0.2-next.4) (2025-07-25)
237
+
238
+
239
+ ### Miscellaneous Chores
240
+
241
+ * **engine-types:** Synchronize repo versions
242
+
243
+
244
+ ### Dependencies
245
+
246
+ * The following workspace dependencies were updated
247
+ * dependencies
248
+ * @twin.org/engine-models bumped from 0.0.2-next.3 to 0.0.2-next.4
249
+
250
+ ## [0.0.2-next.3](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.2...engine-types-v0.0.2-next.3) (2025-07-24)
251
+
252
+
253
+ ### Miscellaneous Chores
254
+
255
+ * **engine-types:** Synchronize repo versions
256
+
257
+
258
+ ### Dependencies
259
+
260
+ * The following workspace dependencies were updated
261
+ * dependencies
262
+ * @twin.org/engine-models bumped from 0.0.2-next.2 to 0.0.2-next.3
263
+
3
264
  ## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.1...engine-types-v0.0.2-next.2) (2025-07-21)
4
265
 
5
266
 
@@ -0,0 +1,61 @@
1
+ # Class: EngineTypeHelper
2
+
3
+ Helper methods for engine config types.
4
+
5
+ ## Constructors
6
+
7
+ ### Constructor
8
+
9
+ > **new EngineTypeHelper**(): `EngineTypeHelper`
10
+
11
+ #### Returns
12
+
13
+ `EngineTypeHelper`
14
+
15
+ ## Properties
16
+
17
+ ### CLASS\_NAME
18
+
19
+ > `readonly` `static` **CLASS\_NAME**: `string`
20
+
21
+ Runtime name for the class.
22
+
23
+ ## Methods
24
+
25
+ ### getConfigOfType()
26
+
27
+ > `static` **getConfigOfType**\<`T`\>(`engineConfig`, `component`, `type`): `undefined` \| `IEngineCoreTypeConfig`\<`T`\>
28
+
29
+ Get the config for the specified component and type.
30
+
31
+ #### Type Parameters
32
+
33
+ ##### T
34
+
35
+ `T` *extends* `IEngineCoreTypeBaseConfig`\<`unknown`\>
36
+
37
+ #### Parameters
38
+
39
+ ##### engineConfig
40
+
41
+ [`IEngineConfig`](../interfaces/IEngineConfig.md)
42
+
43
+ The engine configuration.
44
+
45
+ ##### component
46
+
47
+ `string`
48
+
49
+ The component name.
50
+
51
+ ##### type
52
+
53
+ `string`
54
+
55
+ The type name.
56
+
57
+ #### Returns
58
+
59
+ `undefined` \| `IEngineCoreTypeConfig`\<`T`\>
60
+
61
+ The config for the specified component and type or undefined if it does not exist.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAttestationComponent()
2
2
 
3
- > **initialiseAttestationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseAttestationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the attestation component.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAttestationConnector()
2
2
 
3
- > **initialiseAttestationConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseAttestationConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IAttestationConnector`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the attestation connector.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IAttestationConnector`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the connector type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuditableItemGraphComponent()
2
2
 
3
- > **initialiseAuditableItemGraphComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseAuditableItemGraphComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the auditable item graph component.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseAuditableItemStreamComponent()
2
2
 
3
- > **initialiseAuditableItemStreamComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseAuditableItemStreamComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the auditable item stream component.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseAuthenticationGeneratorComponent()
2
+
3
+ > **initialiseAuthenticationGeneratorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IAuthenticationGenerator`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the authentication generator component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`AuthenticationGeneratorComponentConfig`](../type-aliases/AuthenticationGeneratorComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IAuthenticationGenerator`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseBackgroundTaskConnector()
2
2
 
3
- > **initialiseBackgroundTaskConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseBackgroundTaskConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBackgroundTaskConnector`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise a background task connector.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBackgroundTaskConnector`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the connector type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseBlobStorageComponent()
2
2
 
3
- > **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the blob storage component.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseBlobStorageConnector()
2
2
 
3
- > **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBlobStorageConnector`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the blob storage connector.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBlobStorageConnector`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the connector type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseDataConverterConnector()
2
2
 
3
- > **initialiseDataConverterConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseDataConverterConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataConverterConnector`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the data converter connector.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataConverterConnector`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the connector type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseDataExtractorConnector()
2
2
 
3
- > **initialiseDataExtractorConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseDataExtractorConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataExtractorConnector`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the data extractor connector.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataExtractorConnector`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the connector type is unknown.
31
+ The instance created and the factory for it.
@@ -1,6 +1,6 @@
1
1
  # Function: initialiseDataProcessingComponent()
2
2
 
3
- > **initialiseDataProcessingComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
3
+ > **initialiseDataProcessingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
5
  Initialise the data processing component.
6
6
 
@@ -24,18 +24,8 @@ The context for the engine.
24
24
 
25
25
  The instance config.
26
26
 
27
- ### overrideInstanceType?
28
-
29
- `string`
30
-
31
- The instance type to override the default.
32
-
33
27
  ## Returns
34
28
 
35
- `undefined` \| `string`
36
-
37
- The name of the instance created.
38
-
39
- ## Throws
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
40
30
 
41
- GeneralError if the component type is unknown.
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseDataSpaceConnectorComponent()
2
+
3
+ > **initialiseDataSpaceConnectorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the data space connector component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`DataSpaceConnectorComponentConfig`](../type-aliases/DataSpaceConnectorComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.