@twin.org/dataspace-models 0.9.2-next.1 → 0.9.2-next.11

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 (46) hide show
  1. package/dist/es/entities/dataspaceAppDataset.js +1 -1
  2. package/dist/es/entities/dataspaceAppDataset.js.map +1 -1
  3. package/dist/es/entities/dataspaceAppDatasetV0.js +1 -1
  4. package/dist/es/entities/dataspaceAppDatasetV0.js.map +1 -1
  5. package/dist/es/entities/transferProcess.js +12 -19
  6. package/dist/es/entities/transferProcess.js.map +1 -1
  7. package/dist/es/entities/transferProcessV0.js +156 -0
  8. package/dist/es/entities/transferProcessV0.js.map +1 -0
  9. package/dist/es/index.js +1 -0
  10. package/dist/es/index.js.map +1 -1
  11. package/dist/es/models/IPushDeliveryPayload.js.map +1 -1
  12. package/dist/es/models/api/controlPlane/IAppDatasetCreateRequest.js.map +1 -1
  13. package/dist/es/models/controlPlane/IDataspaceControlPlaneComponent.js.map +1 -1
  14. package/dist/es/models/controlPlane/INegotiationCallback.js.map +1 -1
  15. package/dist/es/models/controlPlane/ITransferProcess.js.map +1 -1
  16. package/dist/es/models/controlPlane/dataspaceControlPlaneMetricIds.js +5 -1
  17. package/dist/es/models/controlPlane/dataspaceControlPlaneMetricIds.js.map +1 -1
  18. package/dist/es/models/controlPlane/dataspaceControlPlaneMetrics.js +5 -0
  19. package/dist/es/models/controlPlane/dataspaceControlPlaneMetrics.js.map +1 -1
  20. package/dist/es/models/dataPlane/IDataspaceDataPlaneComponent.js.map +1 -1
  21. package/dist/types/entities/dataspaceAppDataset.d.ts +1 -1
  22. package/dist/types/entities/dataspaceAppDatasetV0.d.ts +1 -1
  23. package/dist/types/entities/transferProcess.d.ts +8 -12
  24. package/dist/types/entities/transferProcessV0.d.ts +83 -0
  25. package/dist/types/index.d.ts +1 -0
  26. package/dist/types/models/IPushDeliveryPayload.d.ts +1 -1
  27. package/dist/types/models/api/controlPlane/IAppDatasetCreateRequest.d.ts +2 -2
  28. package/dist/types/models/controlPlane/IDataspaceControlPlaneComponent.d.ts +3 -3
  29. package/dist/types/models/controlPlane/INegotiationCallback.d.ts +4 -2
  30. package/dist/types/models/controlPlane/ITransferProcess.d.ts +0 -7
  31. package/dist/types/models/controlPlane/dataspaceControlPlaneMetricIds.d.ts +4 -0
  32. package/dist/types/models/dataPlane/IDataspaceDataPlaneComponent.d.ts +1 -1
  33. package/docs/changelog.md +70 -0
  34. package/docs/reference/classes/DataspaceAppDataset.md +1 -1
  35. package/docs/reference/classes/DataspaceAppDatasetV0.md +1 -1
  36. package/docs/reference/classes/TransferProcess.md +10 -17
  37. package/docs/reference/classes/TransferProcessV0.md +156 -0
  38. package/docs/reference/index.md +1 -0
  39. package/docs/reference/interfaces/IAppDatasetCreateRequest.md +2 -2
  40. package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +3 -3
  41. package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +1 -1
  42. package/docs/reference/interfaces/INegotiationCallback.md +9 -2
  43. package/docs/reference/interfaces/IPushDeliveryPayload.md +1 -1
  44. package/docs/reference/interfaces/ITransferProcess.md +0 -10
  45. package/docs/reference/variables/DataspaceControlPlaneMetricIds.md +6 -0
  46. package/package.json +3 -2
@@ -3,7 +3,7 @@
3
3
  API request to register an app dataset.
4
4
 
5
5
  The owning `tenantId` is captured automatically from the request's tenant
6
- context callers do not supply it.
6
+ context - callers do not supply it.
7
7
 
8
8
  ## Properties
9
9
 
@@ -34,7 +34,7 @@ registered name in `DataspaceAppFactory` (typically the app's URI).
34
34
  > **dataset**: `IDataspaceProtocolDataset`
35
35
 
36
36
  The dataset payload. System-stamped fields like `dcterms:publisher`
37
- may be omitted the Control Plane fills them in at publish time.
37
+ may be omitted - the Control Plane fills them in at publish time.
38
38
 
39
39
  #### transferIdleTimeoutMs?
40
40
 
@@ -79,7 +79,7 @@ Otherwise the method returns immediately with a `negotiationId`. The caller is
79
79
  notified via the registered INegotiationCallback when the negotiation completes.
80
80
  The negotiation follows DSP state machine: REQUESTED → OFFERED → AGREED → VERIFIED → FINALIZED.
81
81
 
82
- The REST client does not support this method and throws a not supported error
82
+ The REST client does not support this method and throws a not supported error -
83
83
  use ComponentFactory.get() for the in-process service.
84
84
 
85
85
  DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#negotiation-protocol
@@ -200,7 +200,7 @@ Upstream modules register their callback here to be notified when a
200
200
  consumer-initiated transfer changes state (STARTED, COMPLETED, SUSPENDED,
201
201
  TERMINATED).
202
202
 
203
- The REST client does not support this method and throws a not supported error
203
+ The REST client does not support this method and throws a not supported error -
204
204
  use ComponentFactory.get() for the in-process service.
205
205
 
206
206
  #### Parameters
@@ -260,7 +260,7 @@ The caller is notified of subsequent state changes (STARTED, COMPLETED, etc.)
260
260
  via the registered ITransferCallback. The transfer moves to STARTED when the
261
261
  provider POSTs a TransferStartMessage back to this node's callback address.
262
262
 
263
- The REST client does not support this method and throws a not supported error
263
+ The REST client does not support this method and throws a not supported error -
264
264
  use ComponentFactory.get() for the in-process service.
265
265
 
266
266
  #### Parameters
@@ -119,7 +119,7 @@ NotFoundError if activity log entry is not known.
119
119
 
120
120
  #### Throws
121
121
 
122
- UnauthorizedError if trustPayload is absent or the verified identity is not the entry generator.
122
+ UnauthorizedError if trustPayload is absent or the verified identity is not authorised for the entry.
123
123
 
124
124
  ***
125
125
 
@@ -53,7 +53,7 @@ Nothing.
53
53
 
54
54
  ### onFinalized() {#onfinalized}
55
55
 
56
- > **onFinalized**(`negotiationId`, `agreementId`): `Promise`\<`void`\>
56
+ > **onFinalized**(`negotiationId`, `agreementId`, `offerId?`): `Promise`\<`void`\>
57
57
 
58
58
  Called when the negotiation finalizes.
59
59
 
@@ -63,7 +63,7 @@ Called when the negotiation finalizes.
63
63
 
64
64
  `string` \| `undefined`
65
65
 
66
- The negotiation ID, or undefined for implicit-trust agreements.
66
+ The negotiation ID, or undefined for implicit-trust or agreement-reuse paths.
67
67
 
68
68
  ##### agreementId
69
69
 
@@ -71,6 +71,13 @@ The negotiation ID, or undefined for implicit-trust agreements.
71
71
 
72
72
  The agreement ID (from agreement.uid).
73
73
 
74
+ ##### offerId?
75
+
76
+ `string`
77
+
78
+ The offer ID that triggered the negotiation; present when negotiationId is undefined so
79
+ callers with concurrent negotiations can discriminate which finalization belongs to them.
80
+
74
81
  #### Returns
75
82
 
76
83
  `Promise`\<`void`\>
@@ -79,7 +79,7 @@ The JSON-LD
79
79
  The tenant that owns this push delivery, captured at schedule time from the active
80
80
  `ContextIdStore` context (typically from the subscription's `tenantId` field).
81
81
  The runner re-establishes this tenant context via `ContextIdStore.run` before invoking
82
- tenant-scoped operations (PEP, trust signing, vault lookups). Optional single-tenant
82
+ tenant-scoped operations (PEP, trust signing, vault lookups). Optional - single-tenant
83
83
  nodes operate without a tenant context.
84
84
 
85
85
  ***
@@ -46,7 +46,6 @@ One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
46
46
  > **agreementId**: `string`
47
47
 
48
48
  Agreement ID linking to the rights-management Agreement.
49
- Used to resolve policies and permissions.
50
49
 
51
50
  ***
52
51
 
@@ -67,15 +66,6 @@ Offer ID from the original Catalog offer.
67
66
 
68
67
  ***
69
68
 
70
- ### policies? {#policies}
71
-
72
- > `optional` **policies?**: `IRightsManagementPolicy`[]
73
-
74
- Policies from the Agreement.
75
- Used by DSC for runtime policy enforcement.
76
-
77
- ***
78
-
79
69
  ### consumerIdentity? {#consumeridentity}
80
70
 
81
71
  > `optional` **consumerIdentity?**: `string`
@@ -65,3 +65,9 @@ Number of app datasets updated.
65
65
  > `readonly` **AppDatasetsDeleted**: `"dcp_app_datasets_deleted"` = `"dcp_app_datasets_deleted"`
66
66
 
67
67
  Number of app datasets deleted.
68
+
69
+ ### AgreementsSwept {#agreementsswept}
70
+
71
+ > `readonly` **AgreementsSwept**: `"dcp_agreements_swept"` = `"dcp_agreements_swept"`
72
+
73
+ Number of agreements removed by the agreement sweep.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/dataspace-models",
3
- "version": "0.9.2-next.1",
3
+ "version": "0.9.2-next.11",
4
4
  "description": "Defines shared entities, interfaces, and data types used by control plane and data plane components.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -26,7 +26,8 @@
26
26
  "@twin.org/standards-w3c-activity-streams": "next",
27
27
  "@twin.org/standards-w3c-dcat": "next",
28
28
  "@twin.org/standards-w3c-odrl": "next",
29
- "@twin.org/telemetry-models": "next"
29
+ "@twin.org/telemetry-models": "next",
30
+ "@twin.org/web": "next"
30
31
  },
31
32
  "main": "./dist/es/index.js",
32
33
  "types": "./dist/types/index.d.ts",