@twin.org/engine-types 0.0.3-next.5 → 0.0.3-next.7

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 (214) hide show
  1. package/dist/es/components/backgroundTask.js +9 -11
  2. package/dist/es/components/backgroundTask.js.map +1 -1
  3. package/dist/es/components/dataSpaceConnector.js +1 -1
  4. package/dist/es/components/dataSpaceConnector.js.map +1 -1
  5. package/dist/es/components/federatedCatalogue.js +1 -5
  6. package/dist/es/components/federatedCatalogue.js.map +1 -1
  7. package/dist/es/components/federatedCatalogueFilter.js +31 -0
  8. package/dist/es/components/federatedCatalogueFilter.js.map +1 -0
  9. package/dist/es/components/immutableProof.js +1 -1
  10. package/dist/es/components/immutableProof.js.map +1 -1
  11. package/dist/es/components/rightsManagementDap.js +2 -4
  12. package/dist/es/components/rightsManagementDap.js.map +1 -1
  13. package/dist/es/components/rightsManagementDarp.js +1 -0
  14. package/dist/es/components/rightsManagementDarp.js.map +1 -1
  15. package/dist/es/components/rightsManagementDataAccessHandler.js +27 -0
  16. package/dist/es/components/rightsManagementDataAccessHandler.js.map +1 -0
  17. package/dist/es/components/rightsManagementPdp.js +2 -16
  18. package/dist/es/components/rightsManagementPdp.js.map +1 -1
  19. package/dist/es/components/rightsManagementPep.js +2 -16
  20. package/dist/es/components/rightsManagementPep.js.map +1 -1
  21. package/dist/es/components/rightsManagementPip.js +2 -16
  22. package/dist/es/components/rightsManagementPip.js.map +1 -1
  23. package/dist/es/components/rightsManagementPnp.js +3 -23
  24. package/dist/es/components/rightsManagementPnp.js.map +1 -1
  25. package/dist/es/components/rightsManagementPolicyArbiter.js +27 -0
  26. package/dist/es/components/rightsManagementPolicyArbiter.js.map +1 -0
  27. package/dist/es/components/rightsManagementPolicyEnforcementProcessor.js +27 -0
  28. package/dist/es/components/rightsManagementPolicyEnforcementProcessor.js.map +1 -0
  29. package/dist/es/components/rightsManagementPolicyExecutionAction.js +27 -0
  30. package/dist/es/components/rightsManagementPolicyExecutionAction.js.map +1 -0
  31. package/dist/es/components/rightsManagementPolicyInformationSource.js +35 -0
  32. package/dist/es/components/rightsManagementPolicyInformationSource.js.map +1 -0
  33. package/dist/es/components/rightsManagementPolicyNegotiator.js +27 -0
  34. package/dist/es/components/rightsManagementPolicyNegotiator.js.map +1 -0
  35. package/dist/es/components/rightsManagementPolicyRequester.js +27 -0
  36. package/dist/es/components/rightsManagementPolicyRequester.js.map +1 -0
  37. package/dist/es/components/rightsManagementPxp.js +2 -16
  38. package/dist/es/components/rightsManagementPxp.js.map +1 -1
  39. package/dist/es/components/synchronisedStorage.js +1 -1
  40. package/dist/es/components/synchronisedStorage.js.map +1 -1
  41. package/dist/es/components/trust.js +29 -0
  42. package/dist/es/components/trust.js.map +1 -0
  43. package/dist/es/components/trustGenerator.js +28 -0
  44. package/dist/es/components/trustGenerator.js.map +1 -0
  45. package/dist/es/components/trustVerifier.js +28 -0
  46. package/dist/es/components/trustVerifier.js.map +1 -0
  47. package/dist/es/index.js +35 -2
  48. package/dist/es/index.js.map +1 -1
  49. package/dist/es/models/IEngineConfig.js.map +1 -1
  50. package/dist/es/models/config/backgroundTaskComponentConfig.js +2 -0
  51. package/dist/es/models/config/backgroundTaskComponentConfig.js.map +1 -0
  52. package/dist/es/models/config/federatedCatalogueFilterComponentConfig.js +2 -0
  53. package/dist/es/models/config/federatedCatalogueFilterComponentConfig.js.map +1 -0
  54. package/dist/es/models/config/rightsManagementDarpComponentConfig.js.map +1 -1
  55. package/dist/es/models/config/rightsManagementDataAccessHandlerComponentConfig.js +2 -0
  56. package/dist/es/models/config/rightsManagementDataAccessHandlerComponentConfig.js.map +1 -0
  57. package/dist/es/models/config/rightsManagementPdpComponentConfig.js.map +1 -1
  58. package/dist/es/models/config/rightsManagementPepComponentConfig.js.map +1 -1
  59. package/dist/es/models/config/rightsManagementPipComponentConfig.js.map +1 -1
  60. package/dist/es/models/config/rightsManagementPnpComponentConfig.js.map +1 -1
  61. package/dist/es/models/config/rightsManagementPolicyArbiterComponentConfig.js +2 -0
  62. package/dist/es/models/config/rightsManagementPolicyArbiterComponentConfig.js.map +1 -0
  63. package/dist/es/models/config/rightsManagementPolicyEnforcementProcessorComponentConfig.js +2 -0
  64. package/dist/es/models/config/rightsManagementPolicyEnforcementProcessorComponentConfig.js.map +1 -0
  65. package/dist/es/models/config/rightsManagementPolicyExecutionActionComponentConfig.js +2 -0
  66. package/dist/es/models/config/rightsManagementPolicyExecutionActionComponentConfig.js.map +1 -0
  67. package/dist/es/models/config/rightsManagementPolicyInformationSourceComponentConfig.js +2 -0
  68. package/dist/es/models/config/rightsManagementPolicyInformationSourceComponentConfig.js.map +1 -0
  69. package/dist/es/models/config/rightsManagementPolicyNegotiatorComponentConfig.js +2 -0
  70. package/dist/es/models/config/rightsManagementPolicyNegotiatorComponentConfig.js.map +1 -0
  71. package/dist/es/models/config/rightsManagementPolicyRequesterComponentConfig.js +2 -0
  72. package/dist/es/models/config/rightsManagementPolicyRequesterComponentConfig.js.map +1 -0
  73. package/dist/es/models/config/rightsManagementPxpComponentConfig.js.map +1 -1
  74. package/dist/es/models/config/trustComponentConfig.js +2 -0
  75. package/dist/es/models/config/trustComponentConfig.js.map +1 -0
  76. package/dist/es/models/config/trustGeneratorComponentConfig.js +2 -0
  77. package/dist/es/models/config/trustGeneratorComponentConfig.js.map +1 -0
  78. package/dist/es/models/config/trustVerifierComponentConfig.js +2 -0
  79. package/dist/es/models/config/trustVerifierComponentConfig.js.map +1 -0
  80. package/dist/es/models/types/backgroundTaskComponentType.js +13 -0
  81. package/dist/es/models/types/backgroundTaskComponentType.js.map +1 -0
  82. package/dist/es/models/types/federatedCatalogueFilterComponentType.js +13 -0
  83. package/dist/es/models/types/federatedCatalogueFilterComponentType.js.map +1 -0
  84. package/dist/es/models/types/rightsManagementDataAccessHandlerComponentType.js +13 -0
  85. package/dist/es/models/types/rightsManagementDataAccessHandlerComponentType.js.map +1 -0
  86. package/dist/es/models/types/rightsManagementPolicyArbiterComponentType.js +13 -0
  87. package/dist/es/models/types/rightsManagementPolicyArbiterComponentType.js.map +1 -0
  88. package/dist/es/models/types/rightsManagementPolicyEnforcementProcessorComponentType.js +13 -0
  89. package/dist/es/models/types/rightsManagementPolicyEnforcementProcessorComponentType.js.map +1 -0
  90. package/dist/es/models/types/rightsManagementPolicyExecutionActionComponentType.js +13 -0
  91. package/dist/es/models/types/rightsManagementPolicyExecutionActionComponentType.js.map +1 -0
  92. package/dist/es/models/types/rightsManagementPolicyInformationSourceComponentType.js +17 -0
  93. package/dist/es/models/types/rightsManagementPolicyInformationSourceComponentType.js.map +1 -0
  94. package/dist/es/models/types/rightsManagementPolicyNegotiatorComponentType.js +13 -0
  95. package/dist/es/models/types/rightsManagementPolicyNegotiatorComponentType.js.map +1 -0
  96. package/dist/es/models/types/rightsManagementPolicyRequesterComponentType.js +13 -0
  97. package/dist/es/models/types/rightsManagementPolicyRequesterComponentType.js.map +1 -0
  98. package/dist/es/models/types/trustComponentType.js +13 -0
  99. package/dist/es/models/types/trustComponentType.js.map +1 -0
  100. package/dist/es/models/types/trustGeneratorComponentType.js +13 -0
  101. package/dist/es/models/types/trustGeneratorComponentType.js.map +1 -0
  102. package/dist/es/models/types/trustVerifierComponentType.js +13 -0
  103. package/dist/es/models/types/trustVerifierComponentType.js.map +1 -0
  104. package/dist/types/components/backgroundTask.d.ts +5 -6
  105. package/dist/types/components/federatedCatalogueFilter.d.ts +17 -0
  106. package/dist/types/components/rightsManagementDataAccessHandler.d.ts +17 -0
  107. package/dist/types/components/rightsManagementPolicyArbiter.d.ts +17 -0
  108. package/dist/types/components/rightsManagementPolicyEnforcementProcessor.d.ts +17 -0
  109. package/dist/types/components/rightsManagementPolicyExecutionAction.d.ts +17 -0
  110. package/dist/types/components/rightsManagementPolicyInformationSource.d.ts +17 -0
  111. package/dist/types/components/rightsManagementPolicyNegotiator.d.ts +17 -0
  112. package/dist/types/components/rightsManagementPolicyRequester.d.ts +17 -0
  113. package/dist/types/components/trust.d.ts +16 -0
  114. package/dist/types/components/trustGenerator.d.ts +17 -0
  115. package/dist/types/components/trustVerifier.d.ts +17 -0
  116. package/dist/types/index.d.ts +35 -2
  117. package/dist/types/models/IEngineConfig.d.ts +58 -3
  118. package/dist/types/models/config/backgroundTaskComponentConfig.d.ts +9 -0
  119. package/dist/types/models/config/federatedCatalogueFilterComponentConfig.d.ts +9 -0
  120. package/dist/types/models/config/rightsManagementDarpComponentConfig.d.ts +1 -4
  121. package/dist/types/models/config/rightsManagementDataAccessHandlerComponentConfig.d.ts +9 -0
  122. package/dist/types/models/config/rightsManagementPdpComponentConfig.d.ts +1 -4
  123. package/dist/types/models/config/rightsManagementPepComponentConfig.d.ts +1 -4
  124. package/dist/types/models/config/rightsManagementPipComponentConfig.d.ts +1 -4
  125. package/dist/types/models/config/rightsManagementPnpComponentConfig.d.ts +1 -5
  126. package/dist/types/models/config/rightsManagementPolicyArbiterComponentConfig.d.ts +9 -0
  127. package/dist/types/models/config/rightsManagementPolicyEnforcementProcessorComponentConfig.d.ts +9 -0
  128. package/dist/types/models/config/rightsManagementPolicyExecutionActionComponentConfig.d.ts +9 -0
  129. package/dist/types/models/config/rightsManagementPolicyInformationSourceComponentConfig.d.ts +12 -0
  130. package/dist/types/models/config/rightsManagementPolicyNegotiatorComponentConfig.d.ts +9 -0
  131. package/dist/types/models/config/rightsManagementPolicyRequesterComponentConfig.d.ts +9 -0
  132. package/dist/types/models/config/rightsManagementPxpComponentConfig.d.ts +1 -4
  133. package/dist/types/models/config/trustComponentConfig.d.ts +9 -0
  134. package/dist/types/models/config/trustGeneratorComponentConfig.d.ts +9 -0
  135. package/dist/types/models/config/trustVerifierComponentConfig.d.ts +9 -0
  136. package/dist/types/models/types/backgroundTaskComponentType.d.ts +13 -0
  137. package/dist/types/models/types/federatedCatalogueFilterComponentType.d.ts +13 -0
  138. package/dist/types/models/types/rightsManagementDataAccessHandlerComponentType.d.ts +13 -0
  139. package/dist/types/models/types/rightsManagementPolicyArbiterComponentType.d.ts +13 -0
  140. package/dist/types/models/types/rightsManagementPolicyEnforcementProcessorComponentType.d.ts +13 -0
  141. package/dist/types/models/types/rightsManagementPolicyExecutionActionComponentType.d.ts +13 -0
  142. package/dist/types/models/types/rightsManagementPolicyInformationSourceComponentType.d.ts +17 -0
  143. package/dist/types/models/types/rightsManagementPolicyNegotiatorComponentType.d.ts +13 -0
  144. package/dist/types/models/types/rightsManagementPolicyRequesterComponentType.d.ts +13 -0
  145. package/dist/types/models/types/trustComponentType.d.ts +13 -0
  146. package/dist/types/models/types/trustGeneratorComponentType.d.ts +13 -0
  147. package/dist/types/models/types/trustVerifierComponentType.d.ts +13 -0
  148. package/docs/changelog.md +30 -0
  149. package/docs/reference/functions/{initialiseBackgroundTaskConnector.md → initialiseBackgroundTaskComponent.md} +5 -5
  150. package/docs/reference/functions/initialiseFederatedCatalogueFilterComponent.md +31 -0
  151. package/docs/reference/functions/initialiseRightsManagementDataAccessHandlerComponent.md +31 -0
  152. package/docs/reference/functions/initialiseRightsManagementPolicyArbiterComponent.md +31 -0
  153. package/docs/reference/functions/initialiseRightsManagementPolicyEnforcementProcessorComponent.md +31 -0
  154. package/docs/reference/functions/initialiseRightsManagementPolicyExecutionActionComponent.md +31 -0
  155. package/docs/reference/functions/initialiseRightsManagementPolicyInformationSourceComponent.md +31 -0
  156. package/docs/reference/functions/initialiseRightsManagementPolicyNegotiatorComponent.md +31 -0
  157. package/docs/reference/functions/initialiseRightsManagementPolicyRequesterComponent.md +31 -0
  158. package/docs/reference/functions/initialiseTrustComponent.md +31 -0
  159. package/docs/reference/functions/initialiseTrustGeneratorComponent.md +31 -0
  160. package/docs/reference/functions/initialiseTrustVerifierComponent.md +31 -0
  161. package/docs/reference/index.md +48 -4
  162. package/docs/reference/interfaces/IEngineConfig.md +69 -3
  163. package/docs/reference/type-aliases/BackgroundTaskComponentConfig.md +17 -0
  164. package/docs/reference/type-aliases/BackgroundTaskComponentType.md +5 -0
  165. package/docs/reference/type-aliases/FederatedCatalogueFilterComponentConfig.md +17 -0
  166. package/docs/reference/type-aliases/FederatedCatalogueFilterComponentType.md +5 -0
  167. package/docs/reference/type-aliases/RightsManagementDarpComponentConfig.md +1 -7
  168. package/docs/reference/type-aliases/RightsManagementDataAccessHandlerComponentConfig.md +17 -0
  169. package/docs/reference/type-aliases/RightsManagementDataAccessHandlerComponentType.md +5 -0
  170. package/docs/reference/type-aliases/RightsManagementPdpComponentConfig.md +1 -7
  171. package/docs/reference/type-aliases/RightsManagementPepComponentConfig.md +1 -7
  172. package/docs/reference/type-aliases/RightsManagementPipComponentConfig.md +1 -7
  173. package/docs/reference/type-aliases/RightsManagementPnpComponentConfig.md +1 -1
  174. package/docs/reference/type-aliases/RightsManagementPolicyArbiterComponentConfig.md +17 -0
  175. package/docs/reference/type-aliases/RightsManagementPolicyArbiterComponentType.md +5 -0
  176. package/docs/reference/type-aliases/RightsManagementPolicyEnforcementProcessorComponentConfig.md +17 -0
  177. package/docs/reference/type-aliases/RightsManagementPolicyEnforcementProcessorComponentType.md +5 -0
  178. package/docs/reference/type-aliases/RightsManagementPolicyExecutionActionComponentConfig.md +17 -0
  179. package/docs/reference/type-aliases/RightsManagementPolicyExecutionActionComponentType.md +5 -0
  180. package/docs/reference/type-aliases/RightsManagementPolicyInformationSourceComponentConfig.md +5 -0
  181. package/docs/reference/type-aliases/RightsManagementPolicyInformationSourceComponentType.md +5 -0
  182. package/docs/reference/type-aliases/RightsManagementPolicyNegotiatorComponentConfig.md +17 -0
  183. package/docs/reference/type-aliases/RightsManagementPolicyNegotiatorComponentType.md +5 -0
  184. package/docs/reference/type-aliases/RightsManagementPolicyRequesterComponentConfig.md +17 -0
  185. package/docs/reference/type-aliases/RightsManagementPolicyRequesterComponentType.md +5 -0
  186. package/docs/reference/type-aliases/RightsManagementPxpComponentConfig.md +1 -7
  187. package/docs/reference/type-aliases/TrustComponentConfig.md +17 -0
  188. package/docs/reference/type-aliases/TrustComponentType.md +5 -0
  189. package/docs/reference/type-aliases/TrustGeneratorComponentConfig.md +17 -0
  190. package/docs/reference/type-aliases/TrustGeneratorComponentType.md +5 -0
  191. package/docs/reference/type-aliases/TrustVerifierComponentConfig.md +17 -0
  192. package/docs/reference/type-aliases/TrustVerifierComponentType.md +5 -0
  193. package/docs/reference/variables/BackgroundTaskComponentType.md +13 -0
  194. package/docs/reference/variables/FederatedCatalogueFilterComponentType.md +13 -0
  195. package/docs/reference/variables/RightsManagementDataAccessHandlerComponentType.md +13 -0
  196. package/docs/reference/variables/RightsManagementPolicyArbiterComponentType.md +13 -0
  197. package/docs/reference/variables/RightsManagementPolicyEnforcementProcessorComponentType.md +13 -0
  198. package/docs/reference/variables/RightsManagementPolicyExecutionActionComponentType.md +13 -0
  199. package/docs/reference/variables/RightsManagementPolicyInformationSourceComponentType.md +19 -0
  200. package/docs/reference/variables/RightsManagementPolicyNegotiatorComponentType.md +13 -0
  201. package/docs/reference/variables/RightsManagementPolicyRequesterComponentType.md +13 -0
  202. package/docs/reference/variables/TrustComponentType.md +13 -0
  203. package/docs/reference/variables/TrustGeneratorComponentType.md +13 -0
  204. package/docs/reference/variables/TrustVerifierComponentType.md +13 -0
  205. package/package.json +10 -4
  206. package/dist/es/models/config/backgroundTaskConnectorConfig.js +0 -2
  207. package/dist/es/models/config/backgroundTaskConnectorConfig.js.map +0 -1
  208. package/dist/es/models/types/backgroundTaskConnectorType.js +0 -13
  209. package/dist/es/models/types/backgroundTaskConnectorType.js.map +0 -1
  210. package/dist/types/models/config/backgroundTaskConnectorConfig.d.ts +0 -9
  211. package/dist/types/models/types/backgroundTaskConnectorType.d.ts +0 -13
  212. package/docs/reference/type-aliases/BackgroundTaskConnectorConfig.md +0 -17
  213. package/docs/reference/type-aliases/BackgroundTaskConnectorType.md +0 -5
  214. package/docs/reference/variables/BackgroundTaskConnectorType.md +0 -13
@@ -1,5 +1,4 @@
1
1
  import type { IBaseRestClientConfig } from "@twin.org/api-models";
2
- import type { IEngineModuleConfig } from "@twin.org/engine-models";
3
2
  import type { IPolicyNegotiationPointServiceConstructorOptions } from "@twin.org/rights-management-pnp-service";
4
3
  import type { RightsManagementPnpComponentType } from "../types/rightsManagementPnpComponentType.js";
5
4
  /**
@@ -7,10 +6,7 @@ import type { RightsManagementPnpComponentType } from "../types/rightsManagement
7
6
  */
8
7
  export type RightsManagementPnpComponentConfig = {
9
8
  type: typeof RightsManagementPnpComponentType.Service;
10
- options: IPolicyNegotiationPointServiceConstructorOptions & {
11
- negotiatorModulesConfig?: IEngineModuleConfig[];
12
- requesterModulesConfig?: IEngineModuleConfig[];
13
- };
9
+ options: IPolicyNegotiationPointServiceConstructorOptions;
14
10
  } | {
15
11
  type: typeof RightsManagementPnpComponentType.RestClient;
16
12
  options: IBaseRestClientConfig;
@@ -0,0 +1,9 @@
1
+ import type { IExamplePolicyArbiterConstructorOptions } from "@twin.org/rights-management-plugins";
2
+ import type { RightsManagementPolicyArbiterComponentType } from "../types/rightsManagementPolicyArbiterComponentType.js";
3
+ /**
4
+ * Rights management policy arbiter component config types.
5
+ */
6
+ export type RightsManagementPolicyArbiterComponentConfig = {
7
+ type: typeof RightsManagementPolicyArbiterComponentType.Example;
8
+ options?: IExamplePolicyArbiterConstructorOptions;
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { IExamplePolicyEnforcementProcessorConstructorOptions } from "@twin.org/rights-management-plugins";
2
+ import type { RightsManagementPolicyEnforcementProcessorComponentType } from "../types/rightsManagementPolicyEnforcementProcessorComponentType.js";
3
+ /**
4
+ * Rights management policy enforcement processor component config types.
5
+ */
6
+ export type RightsManagementPolicyEnforcementProcessorComponentConfig = {
7
+ type: typeof RightsManagementPolicyEnforcementProcessorComponentType.Example;
8
+ options?: IExamplePolicyEnforcementProcessorConstructorOptions;
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { ILoggingPolicyExecutionActionConstructorOptions } from "@twin.org/rights-management-plugins";
2
+ import type { RightsManagementPolicyExecutionActionComponentType } from "../types/rightsManagementPolicyExecutionActionComponentType.js";
3
+ /**
4
+ * Rights management policy execution action component config types.
5
+ */
6
+ export type RightsManagementPolicyExecutionActionComponentConfig = {
7
+ type: typeof RightsManagementPolicyExecutionActionComponentType.Logging;
8
+ options?: ILoggingPolicyExecutionActionConstructorOptions;
9
+ };
@@ -0,0 +1,12 @@
1
+ import type { IIdentityPolicyInformationSourceConstructorOptions, IStaticPolicyInformationSourceConstructorOptions } from "@twin.org/rights-management-plugins";
2
+ import type { RightsManagementPolicyInformationSourceComponentType } from "../types/rightsManagementPolicyInformationSourceComponentType.js";
3
+ /**
4
+ * Rights management policy information source component config types.
5
+ */
6
+ export type RightsManagementPolicyInformationSourceComponentConfig = {
7
+ type: typeof RightsManagementPolicyInformationSourceComponentType.Identity;
8
+ options?: IIdentityPolicyInformationSourceConstructorOptions;
9
+ } | {
10
+ type: typeof RightsManagementPolicyInformationSourceComponentType.Static;
11
+ options?: IStaticPolicyInformationSourceConstructorOptions;
12
+ };
@@ -0,0 +1,9 @@
1
+ import type { IExamplePolicyNegotiatorConstructorOptions } from "@twin.org/rights-management-plugins";
2
+ import type { RightsManagementPolicyNegotiatorComponentType } from "../types/rightsManagementPolicyNegotiatorComponentType.js";
3
+ /**
4
+ * Rights management policy negotiator component config types.
5
+ */
6
+ export type RightsManagementPolicyNegotiatorComponentConfig = {
7
+ type: typeof RightsManagementPolicyNegotiatorComponentType.Example;
8
+ options?: IExamplePolicyNegotiatorConstructorOptions;
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { IExamplePolicyRequesterConstructorOptions } from "@twin.org/rights-management-plugins";
2
+ import type { RightsManagementPolicyRequesterComponentType } from "../types/rightsManagementPolicyRequesterComponentType.js";
3
+ /**
4
+ * Rights management policy requester component config types.
5
+ */
6
+ export type RightsManagementPolicyRequesterComponentConfig = {
7
+ type: typeof RightsManagementPolicyRequesterComponentType.Example;
8
+ options?: IExamplePolicyRequesterConstructorOptions;
9
+ };
@@ -1,4 +1,3 @@
1
- import type { IEngineModuleConfig } from "@twin.org/engine-models";
2
1
  import type { IPolicyExecutionPointServiceConstructorOptions } from "@twin.org/rights-management-pxp-service";
3
2
  import type { RightsManagementPxpComponentType } from "../types/rightsManagementPxpComponentType.js";
4
3
  /**
@@ -6,7 +5,5 @@ import type { RightsManagementPxpComponentType } from "../types/rightsManagement
6
5
  */
7
6
  export type RightsManagementPxpComponentConfig = {
8
7
  type: typeof RightsManagementPxpComponentType.Service;
9
- options?: IPolicyExecutionPointServiceConstructorOptions & {
10
- actionModulesConfig?: IEngineModuleConfig[];
11
- };
8
+ options?: IPolicyExecutionPointServiceConstructorOptions;
12
9
  };
@@ -0,0 +1,9 @@
1
+ import type { ITrustServiceConstructorOptions } from "@twin.org/trust-service";
2
+ import type { TrustComponentType } from "../types/trustComponentType.js";
3
+ /**
4
+ * Trust component config types.
5
+ */
6
+ export type TrustComponentConfig = {
7
+ type: typeof TrustComponentType.Service;
8
+ options?: ITrustServiceConstructorOptions;
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { IJwtVerifiableCredentialGeneratorConstructorOptions } from "@twin.org/trust-generators";
2
+ import type { TrustGeneratorComponentType } from "../types/trustGeneratorComponentType.js";
3
+ /**
4
+ * Trust Generator component config types.
5
+ */
6
+ export type TrustGeneratorComponentConfig = {
7
+ type: typeof TrustGeneratorComponentType.JwtVerifiableCredential;
8
+ options: IJwtVerifiableCredentialGeneratorConstructorOptions;
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { IJwtVerifiableCredentialVerifierConstructorOptions } from "@twin.org/trust-verifiers";
2
+ import type { TrustVerifierComponentType } from "../types/trustVerifierComponentType.js";
3
+ /**
4
+ * Trust verifier component config types.
5
+ */
6
+ export type TrustVerifierComponentConfig = {
7
+ type: typeof TrustVerifierComponentType.JwtVerifiableCredential;
8
+ options?: IJwtVerifiableCredentialVerifierConstructorOptions;
9
+ };
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Background task component types.
3
+ */
4
+ export declare const BackgroundTaskComponentType: {
5
+ /**
6
+ * Service.
7
+ */
8
+ readonly Service: "service";
9
+ };
10
+ /**
11
+ * Background task component types.
12
+ */
13
+ export type BackgroundTaskComponentType = (typeof BackgroundTaskComponentType)[keyof typeof BackgroundTaskComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Federated catalogue filter component types.
3
+ */
4
+ export declare const FederatedCatalogueFilterComponentType: {
5
+ /**
6
+ * Filter By Example.
7
+ */
8
+ readonly FilterByExample: "filter-by-example";
9
+ };
10
+ /**
11
+ * Federated catalogue filter component types.
12
+ */
13
+ export type FederatedCatalogueFilterComponentType = (typeof FederatedCatalogueFilterComponentType)[keyof typeof FederatedCatalogueFilterComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Rights management Data Access Handler component types.
3
+ */
4
+ export declare const RightsManagementDataAccessHandlerComponentType: {
5
+ /**
6
+ * Example.
7
+ */
8
+ readonly Example: "example";
9
+ };
10
+ /**
11
+ * Rights management Data Access Handler component types.
12
+ */
13
+ export type RightsManagementDataAccessHandlerComponentType = (typeof RightsManagementDataAccessHandlerComponentType)[keyof typeof RightsManagementDataAccessHandlerComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Rights management Policy Arbiter component types.
3
+ */
4
+ export declare const RightsManagementPolicyArbiterComponentType: {
5
+ /**
6
+ * Example.
7
+ */
8
+ readonly Example: "example";
9
+ };
10
+ /**
11
+ * Rights management Policy Arbiter component types.
12
+ */
13
+ export type RightsManagementPolicyArbiterComponentType = (typeof RightsManagementPolicyArbiterComponentType)[keyof typeof RightsManagementPolicyArbiterComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Rights management Policy Enforcement Processor component types.
3
+ */
4
+ export declare const RightsManagementPolicyEnforcementProcessorComponentType: {
5
+ /**
6
+ * Example.
7
+ */
8
+ readonly Example: "example";
9
+ };
10
+ /**
11
+ * Rights management Policy Enforcement Processor component types.
12
+ */
13
+ export type RightsManagementPolicyEnforcementProcessorComponentType = (typeof RightsManagementPolicyEnforcementProcessorComponentType)[keyof typeof RightsManagementPolicyEnforcementProcessorComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Rights management Policy Execution Action component types.
3
+ */
4
+ export declare const RightsManagementPolicyExecutionActionComponentType: {
5
+ /**
6
+ * Logging.
7
+ */
8
+ readonly Logging: "logging";
9
+ };
10
+ /**
11
+ * Rights management Policy Execution Action component types.
12
+ */
13
+ export type RightsManagementPolicyExecutionActionComponentType = (typeof RightsManagementPolicyExecutionActionComponentType)[keyof typeof RightsManagementPolicyExecutionActionComponentType];
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Rights management Policy Information Source component types.
3
+ */
4
+ export declare const RightsManagementPolicyInformationSourceComponentType: {
5
+ /**
6
+ * Identity.
7
+ */
8
+ readonly Identity: "identity";
9
+ /**
10
+ * Static.
11
+ */
12
+ readonly Static: "static";
13
+ };
14
+ /**
15
+ * Rights management Policy Information Source component types.
16
+ */
17
+ export type RightsManagementPolicyInformationSourceComponentType = (typeof RightsManagementPolicyInformationSourceComponentType)[keyof typeof RightsManagementPolicyInformationSourceComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Rights management Policy Negotiator component types.
3
+ */
4
+ export declare const RightsManagementPolicyNegotiatorComponentType: {
5
+ /**
6
+ * Example.
7
+ */
8
+ readonly Example: "example";
9
+ };
10
+ /**
11
+ * Rights management Policy Negotiator component types.
12
+ */
13
+ export type RightsManagementPolicyNegotiatorComponentType = (typeof RightsManagementPolicyNegotiatorComponentType)[keyof typeof RightsManagementPolicyNegotiatorComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Rights management Policy Requester component types.
3
+ */
4
+ export declare const RightsManagementPolicyRequesterComponentType: {
5
+ /**
6
+ * Example.
7
+ */
8
+ readonly Example: "example";
9
+ };
10
+ /**
11
+ * Rights management Policy Requester component types.
12
+ */
13
+ export type RightsManagementPolicyRequesterComponentType = (typeof RightsManagementPolicyRequesterComponentType)[keyof typeof RightsManagementPolicyRequesterComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Trust component types.
3
+ */
4
+ export declare const TrustComponentType: {
5
+ /**
6
+ * Service.
7
+ */
8
+ readonly Service: "service";
9
+ };
10
+ /**
11
+ * Trust component types.
12
+ */
13
+ export type TrustComponentType = (typeof TrustComponentType)[keyof typeof TrustComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Trust generator component types.
3
+ */
4
+ export declare const TrustGeneratorComponentType: {
5
+ /**
6
+ * JWT Verifiable Credential.
7
+ */
8
+ readonly JwtVerifiableCredential: "jwt-verifiable-credential";
9
+ };
10
+ /**
11
+ * Trust generator component types.
12
+ */
13
+ export type TrustGeneratorComponentType = (typeof TrustGeneratorComponentType)[keyof typeof TrustGeneratorComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Trust verifier component types.
3
+ */
4
+ export declare const TrustVerifierComponentType: {
5
+ /**
6
+ * JWT Verifiable Credential.
7
+ */
8
+ readonly JwtVerifiableCredential: "jwt-verifiable-credential";
9
+ };
10
+ /**
11
+ * Trust verifier component types.
12
+ */
13
+ export type TrustVerifierComponentType = (typeof TrustVerifierComponentType)[keyof typeof TrustVerifierComponentType];
package/docs/changelog.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @twin.org/engine-types - Changelog
2
2
 
3
+ ## [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)
4
+
5
+
6
+ ### Features
7
+
8
+ * add trust and rights management plugins ([eea0807](https://github.com/twinfoundation/engine/commit/eea0807601833220bd9fd8605b5e4383fbc0ebae))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/engine-core bumped from 0.0.3-next.6 to 0.0.3-next.7
16
+ * @twin.org/engine-models bumped from 0.0.3-next.6 to 0.0.3-next.7
17
+
18
+ ## [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)
19
+
20
+
21
+ ### Features
22
+
23
+ * add fed cat filters ([a52cbf1](https://github.com/twinfoundation/engine/commit/a52cbf1eaf85e6cad61de9ea9448932fb5ae0f43))
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/engine-core bumped from 0.0.3-next.5 to 0.0.3-next.6
31
+ * @twin.org/engine-models bumped from 0.0.3-next.5 to 0.0.3-next.6
32
+
3
33
  ## [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)
4
34
 
5
35
 
@@ -1,8 +1,8 @@
1
- # Function: initialiseBackgroundTaskConnector()
1
+ # Function: initialiseBackgroundTaskComponent()
2
2
 
3
- > **initialiseBackgroundTaskConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBackgroundTaskConnector`\>; `component?`: `IComponent`; \}\>
3
+ > **initialiseBackgroundTaskComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
4
4
 
5
- Initialise a background task connector.
5
+ Initialise a background task component.
6
6
 
7
7
  ## Parameters
8
8
 
@@ -20,12 +20,12 @@ The context for the engine.
20
20
 
21
21
  ### instanceConfig
22
22
 
23
- [`BackgroundTaskConnectorConfig`](../type-aliases/BackgroundTaskConnectorConfig.md)
23
+ [`BackgroundTaskComponentConfig`](../type-aliases/BackgroundTaskComponentConfig.md)
24
24
 
25
25
  The instance config.
26
26
 
27
27
  ## Returns
28
28
 
29
- `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IBackgroundTaskConnector`\>; `component?`: `IComponent`; \}\>
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
30
30
 
31
31
  The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseFederatedCatalogueFilterComponent()
2
+
3
+ > **initialiseFederatedCatalogueFilterComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFederatedCatalogueFilter`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the federated catalogue filter 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
+ [`FederatedCatalogueFilterComponentConfig`](../type-aliases/FederatedCatalogueFilterComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IFederatedCatalogueFilter`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementDataAccessHandlerComponent()
2
+
3
+ > **initialiseRightsManagementDataAccessHandlerComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataAccessHandler`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management data access handler 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
+ [`RightsManagementDataAccessHandlerComponentConfig`](../type-aliases/RightsManagementDataAccessHandlerComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IDataAccessHandler`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementPolicyArbiterComponent()
2
+
3
+ > **initialiseRightsManagementPolicyArbiterComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyArbiter`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management policy arbiter 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
+ [`RightsManagementPolicyArbiterComponentConfig`](../type-aliases/RightsManagementPolicyArbiterComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyArbiter`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementPolicyEnforcementProcessorComponent()
2
+
3
+ > **initialiseRightsManagementPolicyEnforcementProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyEnforcementProcessor`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management policy enforcement processor 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
+ [`RightsManagementPolicyEnforcementProcessorComponentConfig`](../type-aliases/RightsManagementPolicyEnforcementProcessorComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyEnforcementProcessor`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementPolicyExecutionActionComponent()
2
+
3
+ > **initialiseRightsManagementPolicyExecutionActionComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyExecutionAction`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management policy execution action 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
+ [`RightsManagementPolicyExecutionActionComponentConfig`](../type-aliases/RightsManagementPolicyExecutionActionComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyExecutionAction`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementPolicyInformationSourceComponent()
2
+
3
+ > **initialiseRightsManagementPolicyInformationSourceComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyInformationSource`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management policy information source 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
+ [`RightsManagementPolicyInformationSourceComponentConfig`](../type-aliases/RightsManagementPolicyInformationSourceComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyInformationSource`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementPolicyNegotiatorComponent()
2
+
3
+ > **initialiseRightsManagementPolicyNegotiatorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyNegotiator`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management policy negotiator 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
+ [`RightsManagementPolicyNegotiatorComponentConfig`](../type-aliases/RightsManagementPolicyNegotiatorComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyNegotiator`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseRightsManagementPolicyRequesterComponent()
2
+
3
+ > **initialiseRightsManagementPolicyRequesterComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyRequester`\>; `component?`: `IComponent`; \}\>
4
+
5
+ Initialise the rights management policy requester 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
+ [`RightsManagementPolicyRequesterComponentConfig`](../type-aliases/RightsManagementPolicyRequesterComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IPolicyRequester`\>; `component?`: `IComponent`; \}\>
30
+
31
+ The instance created and the factory for it.