@twin.org/dataspace-models 0.0.3-next.15

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 (208) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +63 -0
  3. package/dist/es/entities/transferProcess.js +137 -0
  4. package/dist/es/entities/transferProcess.js.map +1 -0
  5. package/dist/es/factories/dataspaceAppFactory.js +9 -0
  6. package/dist/es/factories/dataspaceAppFactory.js.map +1 -0
  7. package/dist/es/index.js +58 -0
  8. package/dist/es/index.js.map +1 -0
  9. package/dist/es/models/IActivityLogDates.js +4 -0
  10. package/dist/es/models/IActivityLogDates.js.map +1 -0
  11. package/dist/es/models/IActivityLogDetails.js +4 -0
  12. package/dist/es/models/IActivityLogDetails.js.map +1 -0
  13. package/dist/es/models/IActivityLogEntry.js +2 -0
  14. package/dist/es/models/IActivityLogEntry.js.map +1 -0
  15. package/dist/es/models/IActivityLogStatusNotification.js +2 -0
  16. package/dist/es/models/IActivityLogStatusNotification.js.map +1 -0
  17. package/dist/es/models/IActivityTask.js +2 -0
  18. package/dist/es/models/IActivityTask.js.map +1 -0
  19. package/dist/es/models/IDataAssetItemList.js +2 -0
  20. package/dist/es/models/IDataAssetItemList.js.map +1 -0
  21. package/dist/es/models/IDataAssetItemListResult.js +2 -0
  22. package/dist/es/models/IDataAssetItemListResult.js.map +1 -0
  23. package/dist/es/models/IEntitySet.js +4 -0
  24. package/dist/es/models/IEntitySet.js.map +1 -0
  25. package/dist/es/models/IExecutionPayload.js +2 -0
  26. package/dist/es/models/IExecutionPayload.js.map +1 -0
  27. package/dist/es/models/IFilteringQuery.js +2 -0
  28. package/dist/es/models/IFilteringQuery.js.map +1 -0
  29. package/dist/es/models/ITaskApp.js +4 -0
  30. package/dist/es/models/ITaskApp.js.map +1 -0
  31. package/dist/es/models/activityProcessingStatus.js +29 -0
  32. package/dist/es/models/activityProcessingStatus.js.map +1 -0
  33. package/dist/es/models/api/IActivityLogEntryGetRequest.js +4 -0
  34. package/dist/es/models/api/IActivityLogEntryGetRequest.js.map +1 -0
  35. package/dist/es/models/api/IActivityLogEntryGetResponse.js +2 -0
  36. package/dist/es/models/api/IActivityLogEntryGetResponse.js.map +1 -0
  37. package/dist/es/models/api/IActivityLogStatusNotificationPayload.js +2 -0
  38. package/dist/es/models/api/IActivityLogStatusNotificationPayload.js.map +1 -0
  39. package/dist/es/models/api/IActivityLogStatusRequest.js +4 -0
  40. package/dist/es/models/api/IActivityLogStatusRequest.js.map +1 -0
  41. package/dist/es/models/api/IActivityStreamNotifyRequest.js +2 -0
  42. package/dist/es/models/api/IActivityStreamNotifyRequest.js.map +1 -0
  43. package/dist/es/models/api/IDataAssetEntitiesResponse.js +2 -0
  44. package/dist/es/models/api/IDataAssetEntitiesResponse.js.map +1 -0
  45. package/dist/es/models/api/IDataAssetGetEntitiesRequest.js +2 -0
  46. package/dist/es/models/api/IDataAssetGetEntitiesRequest.js.map +1 -0
  47. package/dist/es/models/api/IDataAssetQueryRequest.js +2 -0
  48. package/dist/es/models/api/IDataAssetQueryRequest.js.map +1 -0
  49. package/dist/es/models/api/control-plane/ICompleteTransferRequest.js +2 -0
  50. package/dist/es/models/api/control-plane/ICompleteTransferRequest.js.map +1 -0
  51. package/dist/es/models/api/control-plane/ICompleteTransferResponse.js +2 -0
  52. package/dist/es/models/api/control-plane/ICompleteTransferResponse.js.map +1 -0
  53. package/dist/es/models/api/control-plane/IGetTransferProcessRequest.js +2 -0
  54. package/dist/es/models/api/control-plane/IGetTransferProcessRequest.js.map +1 -0
  55. package/dist/es/models/api/control-plane/IGetTransferProcessResponse.js +2 -0
  56. package/dist/es/models/api/control-plane/IGetTransferProcessResponse.js.map +1 -0
  57. package/dist/es/models/api/control-plane/IRequestTransferRequest.js +2 -0
  58. package/dist/es/models/api/control-plane/IRequestTransferRequest.js.map +1 -0
  59. package/dist/es/models/api/control-plane/IRequestTransferResponse.js +2 -0
  60. package/dist/es/models/api/control-plane/IRequestTransferResponse.js.map +1 -0
  61. package/dist/es/models/api/control-plane/IStartTransferRequest.js +2 -0
  62. package/dist/es/models/api/control-plane/IStartTransferRequest.js.map +1 -0
  63. package/dist/es/models/api/control-plane/IStartTransferResponse.js +2 -0
  64. package/dist/es/models/api/control-plane/IStartTransferResponse.js.map +1 -0
  65. package/dist/es/models/api/control-plane/ISuspendTransferRequest.js +2 -0
  66. package/dist/es/models/api/control-plane/ISuspendTransferRequest.js.map +1 -0
  67. package/dist/es/models/api/control-plane/ISuspendTransferResponse.js +2 -0
  68. package/dist/es/models/api/control-plane/ISuspendTransferResponse.js.map +1 -0
  69. package/dist/es/models/api/control-plane/ITerminateTransferRequest.js +2 -0
  70. package/dist/es/models/api/control-plane/ITerminateTransferRequest.js.map +1 -0
  71. package/dist/es/models/api/control-plane/ITerminateTransferResponse.js +2 -0
  72. package/dist/es/models/api/control-plane/ITerminateTransferResponse.js.map +1 -0
  73. package/dist/es/models/app/IActivityQuery.js +4 -0
  74. package/dist/es/models/app/IActivityQuery.js.map +1 -0
  75. package/dist/es/models/app/IDataAssetEntitiesRequest.js +2 -0
  76. package/dist/es/models/app/IDataAssetEntitiesRequest.js.map +1 -0
  77. package/dist/es/models/app/IDataAssetQuery.js +4 -0
  78. package/dist/es/models/app/IDataAssetQuery.js.map +1 -0
  79. package/dist/es/models/app/IDataRequest.js +2 -0
  80. package/dist/es/models/app/IDataRequest.js.map +1 -0
  81. package/dist/es/models/app/IDataspaceApp.js +2 -0
  82. package/dist/es/models/app/IDataspaceApp.js.map +1 -0
  83. package/dist/es/models/app/IQueryDataAssetRequest.js +2 -0
  84. package/dist/es/models/app/IQueryDataAssetRequest.js.map +1 -0
  85. package/dist/es/models/app/dataRequestType.js +17 -0
  86. package/dist/es/models/app/dataRequestType.js.map +1 -0
  87. package/dist/es/models/control-plane/IDataspaceControlPlaneComponent.js +2 -0
  88. package/dist/es/models/control-plane/IDataspaceControlPlaneComponent.js.map +1 -0
  89. package/dist/es/models/control-plane/IDataspaceControlPlaneResolverComponent.js +2 -0
  90. package/dist/es/models/control-plane/IDataspaceControlPlaneResolverComponent.js.map +1 -0
  91. package/dist/es/models/control-plane/INegotiationCallback.js +4 -0
  92. package/dist/es/models/control-plane/INegotiationCallback.js.map +1 -0
  93. package/dist/es/models/control-plane/ITransferContext.js +2 -0
  94. package/dist/es/models/control-plane/ITransferContext.js.map +1 -0
  95. package/dist/es/models/control-plane/ITransferProcess.js +2 -0
  96. package/dist/es/models/control-plane/ITransferProcess.js.map +1 -0
  97. package/dist/es/models/control-plane/api/ITransferContextResponse.js +2 -0
  98. package/dist/es/models/control-plane/api/ITransferContextResponse.js.map +1 -0
  99. package/dist/es/models/control-plane/transferProcessRole.js +18 -0
  100. package/dist/es/models/control-plane/transferProcessRole.js.map +1 -0
  101. package/dist/es/models/data-plane/IDataspaceDataPlaneComponent.js +2 -0
  102. package/dist/es/models/data-plane/IDataspaceDataPlaneComponent.js.map +1 -0
  103. package/dist/types/entities/transferProcess.d.ts +71 -0
  104. package/dist/types/factories/dataspaceAppFactory.d.ts +6 -0
  105. package/dist/types/index.d.ts +49 -0
  106. package/dist/types/models/IActivityLogDates.d.ts +13 -0
  107. package/dist/types/models/IActivityLogDetails.d.ts +29 -0
  108. package/dist/types/models/IActivityLogEntry.d.ts +40 -0
  109. package/dist/types/models/IActivityLogStatusNotification.d.ts +31 -0
  110. package/dist/types/models/IActivityTask.d.ts +14 -0
  111. package/dist/types/models/IDataAssetItemList.d.ts +21 -0
  112. package/dist/types/models/IDataAssetItemListResult.d.ts +16 -0
  113. package/dist/types/models/IEntitySet.d.ts +13 -0
  114. package/dist/types/models/IExecutionPayload.d.ts +18 -0
  115. package/dist/types/models/IFilteringQuery.d.ts +18 -0
  116. package/dist/types/models/ITaskApp.d.ts +13 -0
  117. package/dist/types/models/activityProcessingStatus.d.ts +29 -0
  118. package/dist/types/models/api/IActivityLogEntryGetRequest.d.ts +14 -0
  119. package/dist/types/models/api/IActivityLogEntryGetResponse.d.ts +10 -0
  120. package/dist/types/models/api/IActivityLogStatusNotificationPayload.d.ts +10 -0
  121. package/dist/types/models/api/IActivityLogStatusRequest.d.ts +18 -0
  122. package/dist/types/models/api/IActivityStreamNotifyRequest.d.ts +10 -0
  123. package/dist/types/models/api/IDataAssetEntitiesResponse.d.ts +17 -0
  124. package/dist/types/models/api/IDataAssetGetEntitiesRequest.d.ts +43 -0
  125. package/dist/types/models/api/IDataAssetQueryRequest.d.ts +42 -0
  126. package/dist/types/models/api/control-plane/ICompleteTransferRequest.d.ts +26 -0
  127. package/dist/types/models/api/control-plane/ICompleteTransferResponse.d.ts +15 -0
  128. package/dist/types/models/api/control-plane/IGetTransferProcessRequest.d.ts +21 -0
  129. package/dist/types/models/api/control-plane/IGetTransferProcessResponse.d.ts +15 -0
  130. package/dist/types/models/api/control-plane/IRequestTransferRequest.d.ts +17 -0
  131. package/dist/types/models/api/control-plane/IRequestTransferResponse.d.ts +15 -0
  132. package/dist/types/models/api/control-plane/IStartTransferRequest.d.ts +26 -0
  133. package/dist/types/models/api/control-plane/IStartTransferResponse.d.ts +15 -0
  134. package/dist/types/models/api/control-plane/ISuspendTransferRequest.d.ts +26 -0
  135. package/dist/types/models/api/control-plane/ISuspendTransferResponse.d.ts +15 -0
  136. package/dist/types/models/api/control-plane/ITerminateTransferRequest.d.ts +26 -0
  137. package/dist/types/models/api/control-plane/ITerminateTransferResponse.d.ts +15 -0
  138. package/dist/types/models/app/IActivityQuery.d.ts +17 -0
  139. package/dist/types/models/app/IDataAssetEntitiesRequest.d.ts +20 -0
  140. package/dist/types/models/app/IDataAssetQuery.d.ts +15 -0
  141. package/dist/types/models/app/IDataRequest.d.ts +6 -0
  142. package/dist/types/models/app/IDataspaceApp.d.ts +43 -0
  143. package/dist/types/models/app/IQueryDataAssetRequest.d.ts +20 -0
  144. package/dist/types/models/app/dataRequestType.d.ts +17 -0
  145. package/dist/types/models/control-plane/IDataspaceControlPlaneComponent.d.ts +179 -0
  146. package/dist/types/models/control-plane/IDataspaceControlPlaneResolverComponent.d.ts +55 -0
  147. package/dist/types/models/control-plane/INegotiationCallback.d.ts +37 -0
  148. package/dist/types/models/control-plane/ITransferContext.d.ts +52 -0
  149. package/dist/types/models/control-plane/ITransferProcess.d.ts +81 -0
  150. package/dist/types/models/control-plane/api/ITransferContextResponse.d.ts +12 -0
  151. package/dist/types/models/control-plane/transferProcessRole.d.ts +18 -0
  152. package/dist/types/models/data-plane/IDataspaceDataPlaneComponent.d.ts +65 -0
  153. package/docs/changelog.md +162 -0
  154. package/docs/examples.md +1 -0
  155. package/docs/reference/classes/TransferProcess.md +137 -0
  156. package/docs/reference/index.md +65 -0
  157. package/docs/reference/interfaces/IActivityLogDates.md +19 -0
  158. package/docs/reference/interfaces/IActivityLogDetails.md +55 -0
  159. package/docs/reference/interfaces/IActivityLogEntry.md +119 -0
  160. package/docs/reference/interfaces/IActivityLogEntryGetRequest.md +17 -0
  161. package/docs/reference/interfaces/IActivityLogEntryGetResponse.md +11 -0
  162. package/docs/reference/interfaces/IActivityLogStatusNotification.md +45 -0
  163. package/docs/reference/interfaces/IActivityLogStatusNotificationPayload.md +11 -0
  164. package/docs/reference/interfaces/IActivityLogStatusRequest.md +23 -0
  165. package/docs/reference/interfaces/IActivityQuery.md +27 -0
  166. package/docs/reference/interfaces/IActivityStreamNotifyRequest.md +11 -0
  167. package/docs/reference/interfaces/IActivityTask.md +19 -0
  168. package/docs/reference/interfaces/ICompleteTransferRequest.md +37 -0
  169. package/docs/reference/interfaces/ICompleteTransferResponse.md +19 -0
  170. package/docs/reference/interfaces/IDataAssetEntitiesRequest.md +27 -0
  171. package/docs/reference/interfaces/IDataAssetEntitiesResponse.md +23 -0
  172. package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md +61 -0
  173. package/docs/reference/interfaces/IDataAssetItemList.md +28 -0
  174. package/docs/reference/interfaces/IDataAssetItemListResult.md +21 -0
  175. package/docs/reference/interfaces/IDataAssetQuery.md +19 -0
  176. package/docs/reference/interfaces/IDataAssetQueryRequest.md +58 -0
  177. package/docs/reference/interfaces/IDataspaceApp.md +111 -0
  178. package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +402 -0
  179. package/docs/reference/interfaces/IDataspaceControlPlaneResolverComponent.md +113 -0
  180. package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +200 -0
  181. package/docs/reference/interfaces/IEntitySet.md +19 -0
  182. package/docs/reference/interfaces/IExecutionPayload.md +27 -0
  183. package/docs/reference/interfaces/IFilteringQuery.md +27 -0
  184. package/docs/reference/interfaces/IGetTransferProcessRequest.md +29 -0
  185. package/docs/reference/interfaces/IGetTransferProcessResponse.md +19 -0
  186. package/docs/reference/interfaces/INegotiationCallback.md +106 -0
  187. package/docs/reference/interfaces/IQueryDataAssetRequest.md +27 -0
  188. package/docs/reference/interfaces/IRequestTransferRequest.md +23 -0
  189. package/docs/reference/interfaces/IRequestTransferResponse.md +19 -0
  190. package/docs/reference/interfaces/IStartTransferRequest.md +37 -0
  191. package/docs/reference/interfaces/IStartTransferResponse.md +19 -0
  192. package/docs/reference/interfaces/ISuspendTransferRequest.md +37 -0
  193. package/docs/reference/interfaces/ISuspendTransferResponse.md +19 -0
  194. package/docs/reference/interfaces/ITaskApp.md +19 -0
  195. package/docs/reference/interfaces/ITerminateTransferRequest.md +37 -0
  196. package/docs/reference/interfaces/ITerminateTransferResponse.md +19 -0
  197. package/docs/reference/interfaces/ITransferContext.md +84 -0
  198. package/docs/reference/interfaces/ITransferContextResponse.md +13 -0
  199. package/docs/reference/interfaces/ITransferProcess.md +137 -0
  200. package/docs/reference/type-aliases/ActivityProcessingStatus.md +5 -0
  201. package/docs/reference/type-aliases/DataRequestType.md +5 -0
  202. package/docs/reference/type-aliases/IDataRequest.md +5 -0
  203. package/docs/reference/type-aliases/TransferProcessRole.md +5 -0
  204. package/docs/reference/variables/ActivityProcessingStatus.md +37 -0
  205. package/docs/reference/variables/DataRequestType.md +19 -0
  206. package/docs/reference/variables/DataspaceAppFactory.md +5 -0
  207. package/docs/reference/variables/TransferProcessRole.md +20 -0
  208. package/package.json +62 -0
@@ -0,0 +1,65 @@
1
+ import type { IComponent } from "@twin.org/core";
2
+ import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
3
+ import type { IActivityStreamsActivity } from "@twin.org/standards-w3c-activity-streams";
4
+ import type { IActivityLogEntry } from "../IActivityLogEntry.js";
5
+ import type { IActivityLogStatusNotification } from "../IActivityLogStatusNotification.js";
6
+ import type { IDataAssetItemListResult } from "../IDataAssetItemListResult.js";
7
+ import type { IEntitySet } from "../IEntitySet.js";
8
+ import type { IFilteringQuery } from "../IFilteringQuery.js";
9
+ /**
10
+ * Dataspace Data Plane component interface.
11
+ * Implements the Data Plane functionality for the Eclipse Dataspace Protocol.
12
+ */
13
+ export interface IDataspaceDataPlaneComponent extends IComponent {
14
+ /**
15
+ * Notify an Activity to the Dataspace Data Plane Activity Stream.
16
+ * @param activity The Activity notified.
17
+ * @returns The Activity's identifier.
18
+ */
19
+ notifyActivity(activity: IActivityStreamsActivity): Promise<string>;
20
+ /**
21
+ * Subscribes to the activity log.
22
+ * @param callback The callback to be called when Activity Log is called.
23
+ * @param subscriptionId The subscription Id.
24
+ * @returns The subscription Id.
25
+ */
26
+ subscribeToActivityLog(callback: (notification: IActivityLogStatusNotification) => Promise<void>, subscriptionId?: string): Promise<string>;
27
+ /**
28
+ * Unsubscribes to the activity log.
29
+ * @param subscriptionId The subscription Id.
30
+ * @returns The subscription Id.
31
+ */
32
+ unSubscribeToActivityLog(subscriptionId: string): Promise<void>;
33
+ /**
34
+ * Returns Activity Log Entry which contains the Activity processing details.
35
+ * @param logEntryId The Id of the Activity Log Entry (a URI).
36
+ * @returns the Activity Log Entry with the processing details.
37
+ * @throws NotFoundError if activity log entry is not known.
38
+ */
39
+ getActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry>;
40
+ /**
41
+ * Get Data Asset entities. Allows to retrieve entities by their type or id.
42
+ * @param entitySet The set of entities to be retrieved.
43
+ * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.
44
+ * @param consumerPid The consumer Process ID from the DSP Transfer Process.
45
+ * Used to resolve datasetId from the Transfer Process.
46
+ * @param cursor Pagination details - cursor.
47
+ * @param limit Pagination details - max number of entities.
48
+ * @param trustPayload Trust payload to verify the requesters identity.
49
+ * @returns The item list and optional cursor for pagination via Link headers.
50
+ */
51
+ getDataAssetEntities(entitySet: IEntitySet & {
52
+ jsonLdContext?: IJsonLdContextDefinitionElement[];
53
+ }, consumerPid: string, cursor?: string, limit?: number, trustPayload?: unknown): Promise<IDataAssetItemListResult>;
54
+ /**
55
+ * Queries a data asset controlled by this Dataspace App.
56
+ * @param consumerPid The consumer Process ID from the DSP Transfer Process.
57
+ * Used to resolve datasetId from the Transfer Process.
58
+ * @param query The filtering query.
59
+ * @param cursor Pagination details - cursor.
60
+ * @param limit Pagination details - max number of entities.
61
+ * @param trustPayload Trust payload to verify the requesters identity.
62
+ * @returns The item list and optional cursor for pagination via Link headers.
63
+ */
64
+ queryDataAsset(consumerPid: string, query: IFilteringQuery, cursor?: string, limit?: number, trustPayload?: unknown): Promise<IDataAssetItemListResult>;
65
+ }
@@ -0,0 +1,162 @@
1
+ # Changelog
2
+
3
+ ## [0.0.3-next.15](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.14...dataspace-models-v0.0.3-next.15) (2026-03-02)
4
+
5
+
6
+ ### Features
7
+
8
+ * unification of the data exchange and the data space connector ([#57](https://github.com/twinfoundation/dataspace/issues/57)) ([df2644d](https://github.com/twinfoundation/dataspace/commit/df2644d989471e07dadd83d27bef736179e31bf4))
9
+
10
+ ## [0.0.3-next.12](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.11...dataspace-models-v0.0.3-next.12) (2026-01-22)
11
+
12
+
13
+ ### Features
14
+
15
+ * allow retry of failed activities instead of treating as duplicates ([#53](https://github.com/twinfoundation/dataspace/issues/53)) ([363dddc](https://github.com/twinfoundation/dataspace/commit/363dddc0ba14a50cf1d6f233d17f19c6110fbd47))
16
+
17
+ ## [0.0.3-next.11](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.10...dataspace-models-v0.0.3-next.11) (2026-01-22)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **dataspace-models:** Synchronize repo versions
23
+
24
+ ## [0.0.3-next.10](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.9...dataspace-models-v0.0.3-next.10) (2026-01-19)
25
+
26
+
27
+ ### Features
28
+
29
+ * replace registerApp with factory pattern ([#51](https://github.com/twinfoundation/dataspace/issues/51)) ([a7ef328](https://github.com/twinfoundation/dataspace/commit/a7ef32873f5781f7b1f8aa3670f5fb612dd17018))
30
+
31
+ ## [0.0.3-next.9](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.8...dataspace-models-v0.0.3-next.9) (2026-01-19)
32
+
33
+
34
+ ### Features
35
+
36
+ * update data space connector to use trust service ([#47](https://github.com/twinfoundation/dataspace/issues/47)) ([41c5113](https://github.com/twinfoundation/dataspace/commit/41c5113512cdc477c2f9508b27dfaff84529d841))
37
+ * update order of trustPayload parameter ([0656ddd](https://github.com/twinfoundation/dataspace/commit/0656ddd328accda0370d979a6cb5f947071e700b))
38
+
39
+ ## [0.0.3-next.8](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.7...dataspace-models-v0.0.3-next.8) (2026-01-16)
40
+
41
+
42
+ ### Miscellaneous Chores
43
+
44
+ * **dataspace-models:** Synchronize repo versions
45
+
46
+ ## [0.0.3-next.7](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.6...dataspace-models-v0.0.3-next.7) (2026-01-16)
47
+
48
+
49
+ ### Features
50
+
51
+ * implement Link headers for pagination ([#43](https://github.com/twinfoundation/dataspace/issues/43)) ([ce2a31f](https://github.com/twinfoundation/dataspace/commit/ce2a31fab1b5a1338d34b8514e96a203705c68d1))
52
+
53
+ ## [0.0.3-next.6](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.5...dataspace-models-v0.0.3-next.6) (2026-01-15)
54
+
55
+
56
+ ### Features
57
+
58
+ * update contexts and namespaces ([#41](https://github.com/twinfoundation/dataspace/issues/41)) ([cad79f9](https://github.com/twinfoundation/dataspace/commit/cad79f9f18c0b1bc4a4604a951c28db1d1068f5e))
59
+
60
+ ## [0.0.3-next.5](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.4...dataspace-models-v0.0.3-next.5) (2026-01-07)
61
+
62
+
63
+ ### Miscellaneous Chores
64
+
65
+ * **dataspace-models:** Synchronize repo versions
66
+
67
+ ## [0.0.3-next.4](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.3...dataspace-models-v0.0.3-next.4) (2026-01-06)
68
+
69
+
70
+ ### Features
71
+
72
+ * rfc 004 implementation ([#34](https://github.com/twinfoundation/dataspace/issues/34)) ([3920a45](https://github.com/twinfoundation/dataspace/commit/3920a456f744610885c33cb0960e0448aea71a44))
73
+ * update standards dependencies ([8534ad7](https://github.com/twinfoundation/dataspace/commit/8534ad74b996610ed5994b5213c857989c2bf57a))
74
+
75
+ ## [0.0.3-next.3](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.2...dataspace-models-v0.0.3-next.3) (2025-12-01)
76
+
77
+
78
+ ### Features
79
+
80
+ * update background task service ([c907578](https://github.com/twinfoundation/dataspace/commit/c907578c4ff5906c62b37d788a078d99fe8a59dc))
81
+
82
+ ## [0.0.3-next.2](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.1...dataspace-models-v0.0.3-next.2) (2025-11-28)
83
+
84
+
85
+ ### Miscellaneous Chores
86
+
87
+ * **dataspace-models:** Synchronize repo versions
88
+
89
+ ## [0.0.3-next.1](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.0...dataspace-models-v0.0.3-next.1) (2025-11-12)
90
+
91
+
92
+ ### Features
93
+
94
+ * add context id features ([#26](https://github.com/twinfoundation/dataspace/issues/26)) ([6429a16](https://github.com/twinfoundation/dataspace/commit/6429a160dac9499304fdfb93a9dbdce37277ca7d))
95
+ * add rest and socket clients ([950bf70](https://github.com/twinfoundation/dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
96
+ * add validate-locales ([c0b08a7](https://github.com/twinfoundation/dataspace/commit/c0b08a73268f9fd3eb6ac3079b49d1ab0c01f118))
97
+ * dataspace ([#2](https://github.com/twinfoundation/dataspace/issues/2)) ([c2ac651](https://github.com/twinfoundation/dataspace/commit/c2ac651ceb6f35e46bd5eac97ac648bb1ee9dc0c))
98
+ * eslint migration to flat config ([b84e875](https://github.com/twinfoundation/dataspace/commit/b84e87530aa249891618096ab6e072b21ff9f63a))
99
+ * first bootstrap ([2a5bab8](https://github.com/twinfoundation/dataspace/commit/2a5bab8bc1e2313f0de4d201e842a9fe7c7bab49))
100
+ * query interface data space connector ([#18](https://github.com/twinfoundation/dataspace/issues/18)) ([b12eca1](https://github.com/twinfoundation/dataspace/commit/b12eca124a8f46d290c168e364b7ed4bf72001d8))
101
+ * update framework components ([4d9ca95](https://github.com/twinfoundation/dataspace/commit/4d9ca95879bd6cae9d031595292b6a872bf5b5fd))
102
+ * use new engine extensions config ([80bdb5b](https://github.com/twinfoundation/dataspace/commit/80bdb5b298b65b5b22fa9927a0ad031cb9a3534d))
103
+
104
+ ## [0.0.1-next.8](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.7...dataspace-models-v0.0.1-next.8) (2025-10-09)
105
+
106
+
107
+ ### Features
108
+
109
+ * add validate-locales ([c0b08a7](https://github.com/twinfoundation/dataspace/commit/c0b08a73268f9fd3eb6ac3079b49d1ab0c01f118))
110
+
111
+ ## [0.0.1-next.7](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.6...dataspace-models-v0.0.1-next.7) (2025-10-02)
112
+
113
+
114
+ ### Features
115
+
116
+ * use new engine extensions config ([80bdb5b](https://github.com/twinfoundation/dataspace/commit/80bdb5b298b65b5b22fa9927a0ad031cb9a3534d))
117
+
118
+ ## [0.0.1-next.6](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.5...dataspace-models-v0.0.1-next.6) (2025-09-29)
119
+
120
+
121
+ ### Miscellaneous Chores
122
+
123
+ * **dataspace-models:** Synchronize repo versions
124
+
125
+ ## [0.0.1-next.5](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.4...dataspace-models-v0.0.1-next.5) (2025-09-29)
126
+
127
+
128
+ ### Features
129
+
130
+ * update framework components ([4d9ca95](https://github.com/twinfoundation/dataspace/commit/4d9ca95879bd6cae9d031595292b6a872bf5b5fd))
131
+
132
+ ## [0.0.1-next.4](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.3...dataspace-models-v0.0.1-next.4) (2025-08-29)
133
+
134
+
135
+ ### Features
136
+
137
+ * eslint migration to flat config ([b84e875](https://github.com/twinfoundation/dataspace/commit/b84e87530aa249891618096ab6e072b21ff9f63a))
138
+
139
+ ## [0.0.1-next.3](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.2...dataspace-models-v0.0.1-next.3) (2025-08-25)
140
+
141
+
142
+ ### Miscellaneous Chores
143
+
144
+ * **dataspace-models:** Synchronize repo versions
145
+
146
+ ## [0.0.1-next.2](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.1...dataspace-models-v0.0.1-next.2) (2025-08-25)
147
+
148
+
149
+ ### Features
150
+
151
+ * add rest and socket clients ([950bf70](https://github.com/twinfoundation/dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
152
+ * dataspace ([#2](https://github.com/twinfoundation/dataspace/issues/2)) ([c2ac651](https://github.com/twinfoundation/dataspace/commit/c2ac651ceb6f35e46bd5eac97ac648bb1ee9dc0c))
153
+ * first bootstrap ([2a5bab8](https://github.com/twinfoundation/dataspace/commit/2a5bab8bc1e2313f0de4d201e842a9fe7c7bab49))
154
+
155
+ ## [0.0.1-next.1](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.1-next.0...dataspace-models-v0.0.1-next.1) (2025-08-25)
156
+
157
+
158
+ ### Features
159
+
160
+ * add rest and socket clients ([950bf70](https://github.com/twinfoundation/dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
161
+ * dataspace ([#2](https://github.com/twinfoundation/dataspace/issues/2)) ([c2ac651](https://github.com/twinfoundation/dataspace/commit/c2ac651ceb6f35e46bd5eac97ac648bb1ee9dc0c))
162
+ * first bootstrap ([2a5bab8](https://github.com/twinfoundation/dataspace/commit/2a5bab8bc1e2313f0de4d201e842a9fe7c7bab49))
@@ -0,0 +1 @@
1
+ # @twin.org/dataspace-models - Examples
@@ -0,0 +1,137 @@
1
+ # Class: TransferProcess
2
+
3
+ Transfer Process for shared storage between Control Plane and Data Plane.
4
+ This entity is the persistent representation of ITransferProcess.
5
+
6
+ ## Constructors
7
+
8
+ ### Constructor
9
+
10
+ > **new TransferProcess**(): `TransferProcess`
11
+
12
+ #### Returns
13
+
14
+ `TransferProcess`
15
+
16
+ ## Properties
17
+
18
+ ### consumerPid
19
+
20
+ > **consumerPid**: `string`
21
+
22
+ The consumer PID is the primary key.
23
+ Used for direct lookup by consumerPid.
24
+
25
+ ***
26
+
27
+ ### id
28
+
29
+ > **id**: `string`
30
+
31
+ Internal UUID for storage (secondary key for providerPid lookup).
32
+
33
+ ***
34
+
35
+ ### providerPid
36
+
37
+ > **providerPid**: `string`
38
+
39
+ Provider Process ID from the DSP protocol.
40
+ Indexed for lookup by providerPid.
41
+
42
+ ***
43
+
44
+ ### agreementId
45
+
46
+ > **agreementId**: `string`
47
+
48
+ Agreement ID linking to the rights-management Agreement.
49
+
50
+ ***
51
+
52
+ ### state
53
+
54
+ > **state**: `DataspaceProtocolTransferProcessStateType`
55
+
56
+ Transfer Process state from the DSP protocol.
57
+ One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
58
+
59
+ ***
60
+
61
+ ### datasetId
62
+
63
+ > **datasetId**: `string`
64
+
65
+ Dataset ID for DSC resolution.
66
+
67
+ ***
68
+
69
+ ### offerId
70
+
71
+ > **offerId**: `string`
72
+
73
+ Offer ID from the original Catalog offer.
74
+
75
+ ***
76
+
77
+ ### consumerIdentity?
78
+
79
+ > `optional` **consumerIdentity**: `string`
80
+
81
+ Consumer identity (DID or URI).
82
+
83
+ ***
84
+
85
+ ### providerIdentity?
86
+
87
+ > `optional` **providerIdentity**: `string`
88
+
89
+ Provider identity (DID or URI).
90
+
91
+ ***
92
+
93
+ ### format?
94
+
95
+ > `optional` **format**: `string`
96
+
97
+ Data format from the Dataset Distribution.
98
+
99
+ ***
100
+
101
+ ### callbackAddress?
102
+
103
+ > `optional` **callbackAddress**: `string`
104
+
105
+ Callback address for Consumer notifications.
106
+
107
+ ***
108
+
109
+ ### dateCreated
110
+
111
+ > **dateCreated**: `string`
112
+
113
+ Creation timestamp (ISO string format).
114
+
115
+ ***
116
+
117
+ ### dateModified
118
+
119
+ > **dateModified**: `string`
120
+
121
+ Last update timestamp (ISO string format).
122
+
123
+ ***
124
+
125
+ ### policies?
126
+
127
+ > `optional` **policies**: `IOdrlPolicy`[]
128
+
129
+ Policies from the Agreement (stored as JSON).
130
+
131
+ ***
132
+
133
+ ### dataAddress?
134
+
135
+ > `optional` **dataAddress**: `IDataspaceProtocolDataAddress`
136
+
137
+ Data address for push mode transfers (stored as JSON).
@@ -0,0 +1,65 @@
1
+ # @twin.org/dataspace-models
2
+
3
+ ## Classes
4
+
5
+ - [TransferProcess](classes/TransferProcess.md)
6
+
7
+ ## Interfaces
8
+
9
+ - [IActivityLogDates](interfaces/IActivityLogDates.md)
10
+ - [IActivityLogDetails](interfaces/IActivityLogDetails.md)
11
+ - [IActivityLogEntry](interfaces/IActivityLogEntry.md)
12
+ - [IActivityLogStatusNotification](interfaces/IActivityLogStatusNotification.md)
13
+ - [IActivityTask](interfaces/IActivityTask.md)
14
+ - [IDataAssetItemList](interfaces/IDataAssetItemList.md)
15
+ - [IDataAssetItemListResult](interfaces/IDataAssetItemListResult.md)
16
+ - [IEntitySet](interfaces/IEntitySet.md)
17
+ - [IExecutionPayload](interfaces/IExecutionPayload.md)
18
+ - [IFilteringQuery](interfaces/IFilteringQuery.md)
19
+ - [ITaskApp](interfaces/ITaskApp.md)
20
+ - [IActivityLogEntryGetRequest](interfaces/IActivityLogEntryGetRequest.md)
21
+ - [IActivityLogEntryGetResponse](interfaces/IActivityLogEntryGetResponse.md)
22
+ - [IActivityLogStatusNotificationPayload](interfaces/IActivityLogStatusNotificationPayload.md)
23
+ - [IActivityLogStatusRequest](interfaces/IActivityLogStatusRequest.md)
24
+ - [IActivityStreamNotifyRequest](interfaces/IActivityStreamNotifyRequest.md)
25
+ - [IDataAssetEntitiesResponse](interfaces/IDataAssetEntitiesResponse.md)
26
+ - [IDataAssetGetEntitiesRequest](interfaces/IDataAssetGetEntitiesRequest.md)
27
+ - [IDataAssetQueryRequest](interfaces/IDataAssetQueryRequest.md)
28
+ - [ICompleteTransferRequest](interfaces/ICompleteTransferRequest.md)
29
+ - [ICompleteTransferResponse](interfaces/ICompleteTransferResponse.md)
30
+ - [IGetTransferProcessRequest](interfaces/IGetTransferProcessRequest.md)
31
+ - [IGetTransferProcessResponse](interfaces/IGetTransferProcessResponse.md)
32
+ - [IRequestTransferRequest](interfaces/IRequestTransferRequest.md)
33
+ - [IRequestTransferResponse](interfaces/IRequestTransferResponse.md)
34
+ - [IStartTransferRequest](interfaces/IStartTransferRequest.md)
35
+ - [IStartTransferResponse](interfaces/IStartTransferResponse.md)
36
+ - [ISuspendTransferRequest](interfaces/ISuspendTransferRequest.md)
37
+ - [ISuspendTransferResponse](interfaces/ISuspendTransferResponse.md)
38
+ - [ITerminateTransferRequest](interfaces/ITerminateTransferRequest.md)
39
+ - [ITerminateTransferResponse](interfaces/ITerminateTransferResponse.md)
40
+ - [IActivityQuery](interfaces/IActivityQuery.md)
41
+ - [IDataAssetEntitiesRequest](interfaces/IDataAssetEntitiesRequest.md)
42
+ - [IDataAssetQuery](interfaces/IDataAssetQuery.md)
43
+ - [IDataspaceApp](interfaces/IDataspaceApp.md)
44
+ - [IQueryDataAssetRequest](interfaces/IQueryDataAssetRequest.md)
45
+ - [IDataspaceControlPlaneComponent](interfaces/IDataspaceControlPlaneComponent.md)
46
+ - [IDataspaceControlPlaneResolverComponent](interfaces/IDataspaceControlPlaneResolverComponent.md)
47
+ - [INegotiationCallback](interfaces/INegotiationCallback.md)
48
+ - [ITransferContext](interfaces/ITransferContext.md)
49
+ - [ITransferProcess](interfaces/ITransferProcess.md)
50
+ - [ITransferContextResponse](interfaces/ITransferContextResponse.md)
51
+ - [IDataspaceDataPlaneComponent](interfaces/IDataspaceDataPlaneComponent.md)
52
+
53
+ ## Type Aliases
54
+
55
+ - [ActivityProcessingStatus](type-aliases/ActivityProcessingStatus.md)
56
+ - [IDataRequest](type-aliases/IDataRequest.md)
57
+ - [DataRequestType](type-aliases/DataRequestType.md)
58
+ - [TransferProcessRole](type-aliases/TransferProcessRole.md)
59
+
60
+ ## Variables
61
+
62
+ - [DataspaceAppFactory](variables/DataspaceAppFactory.md)
63
+ - [ActivityProcessingStatus](variables/ActivityProcessingStatus.md)
64
+ - [DataRequestType](variables/DataRequestType.md)
65
+ - [TransferProcessRole](variables/TransferProcessRole.md)
@@ -0,0 +1,19 @@
1
+ # Interface: IActivityLogDates
2
+
3
+ Activity log dates.
4
+
5
+ ## Properties
6
+
7
+ ### startDate
8
+
9
+ > **startDate**: `string`
10
+
11
+ Task processing start timestamp
12
+
13
+ ***
14
+
15
+ ### endDate?
16
+
17
+ > `optional` **endDate**: `string`
18
+
19
+ Task processing end timestamp
@@ -0,0 +1,55 @@
1
+ # Interface: IActivityLogDetails
2
+
3
+ The details related to the processing of an Activity
4
+
5
+ ## Extended by
6
+
7
+ - [`IActivityLogEntry`](IActivityLogEntry.md)
8
+
9
+ ## Properties
10
+
11
+ ### id
12
+
13
+ > **id**: `string`
14
+
15
+ The Id of the Activity Log entry.
16
+
17
+ ***
18
+
19
+ ### activityId?
20
+
21
+ > `optional` **activityId**: `string`
22
+
23
+ The activity Id that this entry refers to.
24
+
25
+ ***
26
+
27
+ ### generator
28
+
29
+ > **generator**: `string`
30
+
31
+ The identity of the Activity's generator.
32
+
33
+ ***
34
+
35
+ ### dateCreated
36
+
37
+ > **dateCreated**: `string`
38
+
39
+ The creation date of this object.
40
+
41
+ ***
42
+
43
+ ### dateModified
44
+
45
+ > **dateModified**: `string`
46
+
47
+ The last update date of this object.
48
+
49
+ ***
50
+
51
+ ### retryCount?
52
+
53
+ > `optional` **retryCount**: `number`
54
+
55
+ Number of times this activity has been retried.
@@ -0,0 +1,119 @@
1
+ # Interface: IActivityLogEntry
2
+
3
+ The details related to the processing of an Activity
4
+
5
+ ## Extends
6
+
7
+ - [`IActivityLogDetails`](IActivityLogDetails.md)
8
+
9
+ ## Properties
10
+
11
+ ### id
12
+
13
+ > **id**: `string`
14
+
15
+ The Id of the Activity Log entry.
16
+
17
+ #### Inherited from
18
+
19
+ [`IActivityLogDetails`](IActivityLogDetails.md).[`id`](IActivityLogDetails.md#id)
20
+
21
+ ***
22
+
23
+ ### activityId?
24
+
25
+ > `optional` **activityId**: `string`
26
+
27
+ The activity Id that this entry refers to.
28
+
29
+ #### Inherited from
30
+
31
+ [`IActivityLogDetails`](IActivityLogDetails.md).[`activityId`](IActivityLogDetails.md#activityid)
32
+
33
+ ***
34
+
35
+ ### generator
36
+
37
+ > **generator**: `string`
38
+
39
+ The identity of the Activity's generator.
40
+
41
+ #### Inherited from
42
+
43
+ [`IActivityLogDetails`](IActivityLogDetails.md).[`generator`](IActivityLogDetails.md#generator)
44
+
45
+ ***
46
+
47
+ ### dateCreated
48
+
49
+ > **dateCreated**: `string`
50
+
51
+ The creation date of this object.
52
+
53
+ #### Inherited from
54
+
55
+ [`IActivityLogDetails`](IActivityLogDetails.md).[`dateCreated`](IActivityLogDetails.md#datecreated)
56
+
57
+ ***
58
+
59
+ ### dateModified
60
+
61
+ > **dateModified**: `string`
62
+
63
+ The last update date of this object.
64
+
65
+ #### Inherited from
66
+
67
+ [`IActivityLogDetails`](IActivityLogDetails.md).[`dateModified`](IActivityLogDetails.md#datemodified)
68
+
69
+ ***
70
+
71
+ ### retryCount?
72
+
73
+ > `optional` **retryCount**: `number`
74
+
75
+ Number of times this activity has been retried.
76
+
77
+ #### Inherited from
78
+
79
+ [`IActivityLogDetails`](IActivityLogDetails.md).[`retryCount`](IActivityLogDetails.md#retrycount)
80
+
81
+ ***
82
+
83
+ ### status
84
+
85
+ > **status**: [`ActivityProcessingStatus`](../type-aliases/ActivityProcessingStatus.md)
86
+
87
+ Status of the Activity Processing.
88
+
89
+ ***
90
+
91
+ ### pendingTasks?
92
+
93
+ > `optional` **pendingTasks**: [`ITaskApp`](ITaskApp.md)[]
94
+
95
+ The pending tasks that have to be run to process the Activity.
96
+
97
+ ***
98
+
99
+ ### runningTasks?
100
+
101
+ > `optional` **runningTasks**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md)[]
102
+
103
+ The running tasks that are processing the Activity.
104
+
105
+ ***
106
+
107
+ ### finalizedTasks?
108
+
109
+ > `optional` **finalizedTasks**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md) & `object`[]
110
+
111
+ The tasks that have already finalized.
112
+
113
+ ***
114
+
115
+ ### inErrorTasks?
116
+
117
+ > `optional` **inErrorTasks**: [`ITaskApp`](ITaskApp.md) & `object`[]
118
+
119
+ The tasks that are in error.
@@ -0,0 +1,17 @@
1
+ # Interface: IActivityLogEntryGetRequest
2
+
3
+ Get Request for an Activity Log Entry.
4
+
5
+ ## Properties
6
+
7
+ ### pathParams
8
+
9
+ > **pathParams**: `object`
10
+
11
+ The parameters from the path.
12
+
13
+ #### id
14
+
15
+ > **id**: `string`
16
+
17
+ The ID of the entry to get.
@@ -0,0 +1,11 @@
1
+ # Interface: IActivityLogEntryGetResponse
2
+
3
+ Service Offering response
4
+
5
+ ## Properties
6
+
7
+ ### body
8
+
9
+ > **body**: [`IActivityLogEntry`](IActivityLogEntry.md)
10
+
11
+ The response payload.