@twin.org/dataspace-models 0.0.3-next.21 → 0.0.3-next.23
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.
- package/dist/es/index.js +20 -20
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/api/controlPlane/ICompleteTransferRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/ICompleteTransferResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/IGetTransferProcessRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IGetTransferProcessResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/IRequestTransferRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IRequestTransferResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/IStartTransferRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IStartTransferResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/ISuspendTransferRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/ISuspendTransferResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/ITerminateTransferRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/ITerminateTransferResponse.js.map +1 -0
- package/dist/es/models/controlPlane/IDataspaceControlPlaneComponent.js.map +1 -0
- package/dist/es/models/controlPlane/IDataspaceControlPlaneResolverComponent.js.map +1 -0
- package/dist/es/models/controlPlane/INegotiationCallback.js.map +1 -0
- package/dist/es/models/controlPlane/ITransferContext.js.map +1 -0
- package/dist/es/models/controlPlane/ITransferProcess.js.map +1 -0
- package/dist/es/models/controlPlane/api/ITransferContextResponse.js.map +1 -0
- package/dist/es/models/controlPlane/transferProcessRole.js.map +1 -0
- package/dist/es/models/dataPlane/IDataspaceDataPlaneComponent.js.map +1 -0
- package/dist/es/schemas/DataspaceActivity.json +724 -18
- package/dist/types/index.d.ts +20 -20
- package/docs/changelog.md +14 -0
- package/docs/reference/classes/TransferProcess.md +6 -6
- package/docs/reference/interfaces/IActivityLogDates.md +1 -1
- package/docs/reference/interfaces/IActivityLogDetails.md +2 -2
- package/docs/reference/interfaces/IActivityLogEntry.md +6 -6
- package/docs/reference/interfaces/IActivityLogStatusNotification.md +1 -1
- package/docs/reference/interfaces/IActivityQuery.md +2 -2
- package/docs/reference/interfaces/ICompleteTransferResponse.md +1 -1
- package/docs/reference/interfaces/IDataAssetEntitiesResponse.md +2 -2
- package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md +6 -6
- package/docs/reference/interfaces/IDataAssetItemListResult.md +1 -1
- package/docs/reference/interfaces/IDataAssetQueryRequest.md +5 -5
- package/docs/reference/interfaces/IDataspaceActivity.md +1 -1
- package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +4 -4
- package/docs/reference/interfaces/IEntitySet.md +1 -1
- package/docs/reference/interfaces/IFilteringQuery.md +1 -1
- package/docs/reference/interfaces/IGetTransferProcessResponse.md +1 -1
- package/docs/reference/interfaces/IRequestTransferResponse.md +1 -1
- package/docs/reference/interfaces/IStartTransferResponse.md +1 -1
- package/docs/reference/interfaces/ISuspendTransferResponse.md +1 -1
- package/docs/reference/interfaces/ITerminateTransferResponse.md +1 -1
- package/docs/reference/interfaces/ITransferContext.md +3 -3
- package/docs/reference/interfaces/ITransferProcess.md +6 -6
- package/package.json +1 -1
- package/dist/es/models/api/control-plane/ICompleteTransferRequest.js.map +0 -1
- package/dist/es/models/api/control-plane/ICompleteTransferResponse.js.map +0 -1
- package/dist/es/models/api/control-plane/IGetTransferProcessRequest.js.map +0 -1
- package/dist/es/models/api/control-plane/IGetTransferProcessResponse.js.map +0 -1
- package/dist/es/models/api/control-plane/IRequestTransferRequest.js.map +0 -1
- package/dist/es/models/api/control-plane/IRequestTransferResponse.js.map +0 -1
- package/dist/es/models/api/control-plane/IStartTransferRequest.js.map +0 -1
- package/dist/es/models/api/control-plane/IStartTransferResponse.js.map +0 -1
- package/dist/es/models/api/control-plane/ISuspendTransferRequest.js.map +0 -1
- package/dist/es/models/api/control-plane/ISuspendTransferResponse.js.map +0 -1
- package/dist/es/models/api/control-plane/ITerminateTransferRequest.js.map +0 -1
- package/dist/es/models/api/control-plane/ITerminateTransferResponse.js.map +0 -1
- package/dist/es/models/control-plane/IDataspaceControlPlaneComponent.js.map +0 -1
- package/dist/es/models/control-plane/IDataspaceControlPlaneResolverComponent.js.map +0 -1
- package/dist/es/models/control-plane/INegotiationCallback.js.map +0 -1
- package/dist/es/models/control-plane/ITransferContext.js.map +0 -1
- package/dist/es/models/control-plane/ITransferProcess.js.map +0 -1
- package/dist/es/models/control-plane/api/ITransferContextResponse.js.map +0 -1
- package/dist/es/models/control-plane/transferProcessRole.js.map +0 -1
- package/dist/es/models/data-plane/IDataspaceDataPlaneComponent.js.map +0 -1
- /package/dist/es/models/api/{control-plane → controlPlane}/ICompleteTransferRequest.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/ICompleteTransferResponse.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/IGetTransferProcessRequest.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/IGetTransferProcessResponse.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/IRequestTransferRequest.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/IRequestTransferResponse.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/IStartTransferRequest.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/IStartTransferResponse.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/ISuspendTransferRequest.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/ISuspendTransferResponse.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/ITerminateTransferRequest.js +0 -0
- /package/dist/es/models/api/{control-plane → controlPlane}/ITerminateTransferResponse.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/IDataspaceControlPlaneComponent.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/IDataspaceControlPlaneResolverComponent.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/INegotiationCallback.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/ITransferContext.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/ITransferProcess.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/api/ITransferContextResponse.js +0 -0
- /package/dist/es/models/{control-plane → controlPlane}/transferProcessRole.js +0 -0
- /package/dist/es/models/{data-plane → dataPlane}/IDataspaceDataPlaneComponent.js +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/ICompleteTransferRequest.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/ICompleteTransferResponse.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/IGetTransferProcessRequest.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/IGetTransferProcessResponse.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/IRequestTransferRequest.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/IRequestTransferResponse.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/IStartTransferRequest.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/IStartTransferResponse.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/ISuspendTransferRequest.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/ISuspendTransferResponse.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/ITerminateTransferRequest.d.ts +0 -0
- /package/dist/types/models/api/{control-plane → controlPlane}/ITerminateTransferResponse.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/IDataspaceControlPlaneComponent.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/IDataspaceControlPlaneResolverComponent.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/INegotiationCallback.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/ITransferContext.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/ITransferProcess.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/api/ITransferContextResponse.d.ts +0 -0
- /package/dist/types/models/{control-plane → controlPlane}/transferProcessRole.d.ts +0 -0
- /package/dist/types/models/{data-plane → dataPlane}/IDataspaceDataPlaneComponent.d.ts +0 -0
package/dist/types/index.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
export * from "./entities/transferProcess.js";
|
|
2
|
-
export * from "./models/
|
|
3
|
-
export * from "./models/
|
|
4
|
-
export * from "./models/
|
|
5
|
-
export * from "./models/
|
|
6
|
-
export * from "./models/
|
|
7
|
-
export * from "./models/
|
|
8
|
-
export * from "./models/
|
|
9
|
-
export * from "./models/
|
|
2
|
+
export * from "./models/controlPlane/IDataspaceControlPlaneComponent.js";
|
|
3
|
+
export * from "./models/controlPlane/IDataspaceControlPlaneResolverComponent.js";
|
|
4
|
+
export * from "./models/controlPlane/INegotiationCallback.js";
|
|
5
|
+
export * from "./models/controlPlane/ITransferProcess.js";
|
|
6
|
+
export * from "./models/controlPlane/transferProcessRole.js";
|
|
7
|
+
export * from "./models/controlPlane/ITransferContext.js";
|
|
8
|
+
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
9
|
+
export * from "./models/dataPlane/IDataspaceDataPlaneComponent.js";
|
|
10
10
|
export * from "./models/IDataspaceActivity.js";
|
|
11
11
|
export * from "./models/dataspaceTypes.js";
|
|
12
12
|
export * from "./models/dataspaceContexts.js";
|
|
@@ -22,18 +22,18 @@ export * from "./models/api/IActivityStreamNotifyRequest.js";
|
|
|
22
22
|
export * from "./models/api/IDataAssetEntitiesResponse.js";
|
|
23
23
|
export * from "./models/api/IDataAssetGetEntitiesRequest.js";
|
|
24
24
|
export * from "./models/api/IDataAssetQueryRequest.js";
|
|
25
|
-
export * from "./models/api/
|
|
26
|
-
export * from "./models/api/
|
|
27
|
-
export * from "./models/api/
|
|
28
|
-
export * from "./models/api/
|
|
29
|
-
export * from "./models/api/
|
|
30
|
-
export * from "./models/api/
|
|
31
|
-
export * from "./models/api/
|
|
32
|
-
export * from "./models/api/
|
|
33
|
-
export * from "./models/api/
|
|
34
|
-
export * from "./models/api/
|
|
35
|
-
export * from "./models/api/
|
|
36
|
-
export * from "./models/api/
|
|
25
|
+
export * from "./models/api/controlPlane/IRequestTransferRequest.js";
|
|
26
|
+
export * from "./models/api/controlPlane/IRequestTransferResponse.js";
|
|
27
|
+
export * from "./models/api/controlPlane/IStartTransferRequest.js";
|
|
28
|
+
export * from "./models/api/controlPlane/IStartTransferResponse.js";
|
|
29
|
+
export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
|
|
30
|
+
export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
|
|
31
|
+
export * from "./models/api/controlPlane/ISuspendTransferRequest.js";
|
|
32
|
+
export * from "./models/api/controlPlane/ISuspendTransferResponse.js";
|
|
33
|
+
export * from "./models/api/controlPlane/ITerminateTransferRequest.js";
|
|
34
|
+
export * from "./models/api/controlPlane/ITerminateTransferResponse.js";
|
|
35
|
+
export * from "./models/api/controlPlane/IGetTransferProcessRequest.js";
|
|
36
|
+
export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
|
|
37
37
|
export * from "./models/app/dataRequestType.js";
|
|
38
38
|
export * from "./models/app/IActivityQuery.js";
|
|
39
39
|
export * from "./models/app/IDataAssetEntitiesRequest.js";
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.23](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.22...dataspace-models-v0.0.3-next.23) (2026-03-25)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **dataspace-models:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
## [0.0.3-next.22](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.21...dataspace-models-v0.0.3-next.22) (2026-03-20)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Miscellaneous Chores
|
|
14
|
+
|
|
15
|
+
* **dataspace-models:** Synchronize repo versions
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.21](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.20...dataspace-models-v0.0.3-next.21) (2026-03-17)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -76,7 +76,7 @@ Offer ID from the original Catalog offer.
|
|
|
76
76
|
|
|
77
77
|
### consumerIdentity? {#consumeridentity}
|
|
78
78
|
|
|
79
|
-
> `optional` **consumerIdentity
|
|
79
|
+
> `optional` **consumerIdentity?**: `string`
|
|
80
80
|
|
|
81
81
|
Consumer identity (DID or URI).
|
|
82
82
|
|
|
@@ -84,7 +84,7 @@ Consumer identity (DID or URI).
|
|
|
84
84
|
|
|
85
85
|
### providerIdentity? {#provideridentity}
|
|
86
86
|
|
|
87
|
-
> `optional` **providerIdentity
|
|
87
|
+
> `optional` **providerIdentity?**: `string`
|
|
88
88
|
|
|
89
89
|
Provider identity (DID or URI).
|
|
90
90
|
|
|
@@ -92,7 +92,7 @@ Provider identity (DID or URI).
|
|
|
92
92
|
|
|
93
93
|
### format? {#format}
|
|
94
94
|
|
|
95
|
-
> `optional` **format
|
|
95
|
+
> `optional` **format?**: `string`
|
|
96
96
|
|
|
97
97
|
Data format from the Dataset Distribution.
|
|
98
98
|
|
|
@@ -100,7 +100,7 @@ Data format from the Dataset Distribution.
|
|
|
100
100
|
|
|
101
101
|
### callbackAddress? {#callbackaddress}
|
|
102
102
|
|
|
103
|
-
> `optional` **callbackAddress
|
|
103
|
+
> `optional` **callbackAddress?**: `string`
|
|
104
104
|
|
|
105
105
|
Callback address for Consumer notifications.
|
|
106
106
|
|
|
@@ -124,7 +124,7 @@ Last update timestamp (ISO string format).
|
|
|
124
124
|
|
|
125
125
|
### policies? {#policies}
|
|
126
126
|
|
|
127
|
-
> `optional` **policies
|
|
127
|
+
> `optional` **policies?**: `IDataspaceProtocolPolicy`[]
|
|
128
128
|
|
|
129
129
|
Policies from the Agreement (stored as JSON).
|
|
130
130
|
|
|
@@ -132,6 +132,6 @@ Policies from the Agreement (stored as JSON).
|
|
|
132
132
|
|
|
133
133
|
### dataAddress? {#dataaddress}
|
|
134
134
|
|
|
135
|
-
> `optional` **dataAddress
|
|
135
|
+
> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
|
|
136
136
|
|
|
137
137
|
Data address for push mode transfers (stored as JSON).
|
|
@@ -18,7 +18,7 @@ The Id of the Activity Log entry.
|
|
|
18
18
|
|
|
19
19
|
### activityId? {#activityid}
|
|
20
20
|
|
|
21
|
-
> `optional` **activityId
|
|
21
|
+
> `optional` **activityId?**: `string`
|
|
22
22
|
|
|
23
23
|
The activity Id that this entry refers to.
|
|
24
24
|
|
|
@@ -50,6 +50,6 @@ The last update date of this object.
|
|
|
50
50
|
|
|
51
51
|
### retryCount? {#retrycount}
|
|
52
52
|
|
|
53
|
-
> `optional` **retryCount
|
|
53
|
+
> `optional` **retryCount?**: `number`
|
|
54
54
|
|
|
55
55
|
Number of times this activity has been retried.
|
|
@@ -22,7 +22,7 @@ The Id of the Activity Log entry.
|
|
|
22
22
|
|
|
23
23
|
### activityId? {#activityid}
|
|
24
24
|
|
|
25
|
-
> `optional` **activityId
|
|
25
|
+
> `optional` **activityId?**: `string`
|
|
26
26
|
|
|
27
27
|
The activity Id that this entry refers to.
|
|
28
28
|
|
|
@@ -70,7 +70,7 @@ The last update date of this object.
|
|
|
70
70
|
|
|
71
71
|
### retryCount? {#retrycount}
|
|
72
72
|
|
|
73
|
-
> `optional` **retryCount
|
|
73
|
+
> `optional` **retryCount?**: `number`
|
|
74
74
|
|
|
75
75
|
Number of times this activity has been retried.
|
|
76
76
|
|
|
@@ -90,7 +90,7 @@ Status of the Activity Processing.
|
|
|
90
90
|
|
|
91
91
|
### pendingTasks? {#pendingtasks}
|
|
92
92
|
|
|
93
|
-
> `optional` **pendingTasks
|
|
93
|
+
> `optional` **pendingTasks?**: [`ITaskApp`](ITaskApp.md)[]
|
|
94
94
|
|
|
95
95
|
The pending tasks that have to be run to process the Activity.
|
|
96
96
|
|
|
@@ -98,7 +98,7 @@ The pending tasks that have to be run to process the Activity.
|
|
|
98
98
|
|
|
99
99
|
### runningTasks? {#runningtasks}
|
|
100
100
|
|
|
101
|
-
> `optional` **runningTasks
|
|
101
|
+
> `optional` **runningTasks?**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md)[]
|
|
102
102
|
|
|
103
103
|
The running tasks that are processing the Activity.
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ The running tasks that are processing the Activity.
|
|
|
106
106
|
|
|
107
107
|
### finalizedTasks? {#finalizedtasks}
|
|
108
108
|
|
|
109
|
-
> `optional` **finalizedTasks
|
|
109
|
+
> `optional` **finalizedTasks?**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md) & `object`[]
|
|
110
110
|
|
|
111
111
|
The tasks that have already finalized.
|
|
112
112
|
|
|
@@ -114,6 +114,6 @@ The tasks that have already finalized.
|
|
|
114
114
|
|
|
115
115
|
### inErrorTasks? {#inerrortasks}
|
|
116
116
|
|
|
117
|
-
> `optional` **inErrorTasks
|
|
117
|
+
> `optional` **inErrorTasks?**: [`ITaskApp`](ITaskApp.md) & `object`[]
|
|
118
118
|
|
|
119
119
|
The tasks that are in error.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
### activityType? {#activitytype}
|
|
8
8
|
|
|
9
|
-
> `optional` **activityType
|
|
9
|
+
> `optional` **activityType?**: `string`
|
|
10
10
|
|
|
11
11
|
FQN of the Activity type.
|
|
12
12
|
|
|
@@ -22,6 +22,6 @@ FQN of the Object Type.
|
|
|
22
22
|
|
|
23
23
|
### targetType? {#targettype}
|
|
24
24
|
|
|
25
|
-
> `optional` **targetType
|
|
25
|
+
> `optional` **targetType?**: `string`
|
|
26
26
|
|
|
27
27
|
FQN of the target type.
|
|
@@ -6,13 +6,13 @@ Response containing data asset entities with optional pagination Link header.
|
|
|
6
6
|
|
|
7
7
|
### headers? {#headers}
|
|
8
8
|
|
|
9
|
-
> `optional` **headers
|
|
9
|
+
> `optional` **headers?**: `object`
|
|
10
10
|
|
|
11
11
|
Optional headers.
|
|
12
12
|
|
|
13
13
|
#### link?
|
|
14
14
|
|
|
15
|
-
> `optional` **link
|
|
15
|
+
> `optional` **link?**: `string` \| `string`[]
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -6,13 +6,13 @@ Get Request Data Asset Entities
|
|
|
6
6
|
|
|
7
7
|
### headers? {#headers}
|
|
8
8
|
|
|
9
|
-
> `optional` **headers
|
|
9
|
+
> `optional` **headers?**: `object`
|
|
10
10
|
|
|
11
11
|
The headers which can be used to determine the response data type.
|
|
12
12
|
|
|
13
13
|
#### authorization?
|
|
14
14
|
|
|
15
|
-
> `optional` **authorization
|
|
15
|
+
> `optional` **authorization?**: `string`
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -24,7 +24,7 @@ The parameters from the query.
|
|
|
24
24
|
|
|
25
25
|
#### id?
|
|
26
26
|
|
|
27
|
-
> `optional` **id
|
|
27
|
+
> `optional` **id?**: `string`
|
|
28
28
|
|
|
29
29
|
The ID of the entity(ies) to get. (comma separated list)
|
|
30
30
|
|
|
@@ -44,18 +44,18 @@ The datasetId is resolved from the Transfer Process using this ID.
|
|
|
44
44
|
|
|
45
45
|
#### dataServiceId?
|
|
46
46
|
|
|
47
|
-
> `optional` **dataServiceId
|
|
47
|
+
> `optional` **dataServiceId?**: `string`
|
|
48
48
|
|
|
49
49
|
The Id of the data service that offers the data asset
|
|
50
50
|
|
|
51
51
|
#### limit?
|
|
52
52
|
|
|
53
|
-
> `optional` **limit
|
|
53
|
+
> `optional` **limit?**: `string`
|
|
54
54
|
|
|
55
55
|
The maximum number of entities to retrieve.
|
|
56
56
|
|
|
57
57
|
#### cursor?
|
|
58
58
|
|
|
59
|
-
> `optional` **cursor
|
|
59
|
+
> `optional` **cursor?**: `string`
|
|
60
60
|
|
|
61
61
|
Cursor to control pagination.
|
|
@@ -6,13 +6,13 @@ Request to query data asset entities.
|
|
|
6
6
|
|
|
7
7
|
### headers? {#headers}
|
|
8
8
|
|
|
9
|
-
> `optional` **headers
|
|
9
|
+
> `optional` **headers?**: `object`
|
|
10
10
|
|
|
11
11
|
The headers which can be used to determine the response data type.
|
|
12
12
|
|
|
13
13
|
#### authorization?
|
|
14
14
|
|
|
15
|
-
> `optional` **authorization
|
|
15
|
+
> `optional` **authorization?**: `string`
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -40,19 +40,19 @@ The filtering query.
|
|
|
40
40
|
|
|
41
41
|
### query? {#query}
|
|
42
42
|
|
|
43
|
-
> `optional` **query
|
|
43
|
+
> `optional` **query?**: `object`
|
|
44
44
|
|
|
45
45
|
Optional query parameters for pagination.
|
|
46
46
|
Used when following Link header URLs.
|
|
47
47
|
|
|
48
48
|
#### cursor?
|
|
49
49
|
|
|
50
|
-
> `optional` **cursor
|
|
50
|
+
> `optional` **cursor?**: `string`
|
|
51
51
|
|
|
52
52
|
Opaque cursor token for pagination.
|
|
53
53
|
|
|
54
54
|
#### limit?
|
|
55
55
|
|
|
56
|
-
> `optional` **limit
|
|
56
|
+
> `optional` **limit?**: `string`
|
|
57
57
|
|
|
58
58
|
Maximum number of items to return.
|
|
@@ -168,15 +168,15 @@ Supports optional filtering by state and pagination via cursor.
|
|
|
168
168
|
|
|
169
169
|
##### state
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
`string` \| `undefined`
|
|
172
172
|
|
|
173
|
-
|
|
173
|
+
Optional filter by negotiation state (e.g., "FINALIZED", "TERMINATED").
|
|
174
174
|
|
|
175
175
|
##### cursor
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
`string` \| `undefined`
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Optional pagination cursor for fetching next page.
|
|
180
180
|
|
|
181
181
|
##### trustPayload
|
|
182
182
|
|
|
@@ -22,6 +22,6 @@ The representation of the query.
|
|
|
22
22
|
|
|
23
23
|
### jsonLdContext? {#jsonldcontext}
|
|
24
24
|
|
|
25
|
-
> `optional` **jsonLdContext
|
|
25
|
+
> `optional` **jsonLdContext?**: `IJsonLdContextDefinitionElement`[]
|
|
26
26
|
|
|
27
27
|
The JSON-LD context to be applied over the query terms.
|
|
@@ -60,7 +60,7 @@ DSC should only allow queries if state is STARTED.
|
|
|
60
60
|
|
|
61
61
|
### consumerIdentity? {#consumeridentity}
|
|
62
62
|
|
|
63
|
-
> `optional` **consumerIdentity
|
|
63
|
+
> `optional` **consumerIdentity?**: `string`
|
|
64
64
|
|
|
65
65
|
Consumer identity (for auditing).
|
|
66
66
|
|
|
@@ -68,7 +68,7 @@ Consumer identity (for auditing).
|
|
|
68
68
|
|
|
69
69
|
### providerIdentity? {#provideridentity}
|
|
70
70
|
|
|
71
|
-
> `optional` **providerIdentity
|
|
71
|
+
> `optional` **providerIdentity?**: `string`
|
|
72
72
|
|
|
73
73
|
Provider identity (for auditing).
|
|
74
74
|
Extracted from Agreement's assigner field.
|
|
@@ -77,7 +77,7 @@ Extracted from Agreement's assigner field.
|
|
|
77
77
|
|
|
78
78
|
### dataAddress? {#dataaddress}
|
|
79
79
|
|
|
80
|
-
> `optional` **dataAddress
|
|
80
|
+
> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
|
|
81
81
|
|
|
82
82
|
Data address for push mode transfers.
|
|
83
83
|
Contains endpoint information where data should be pushed (for Activity Stream push mode).
|
|
@@ -69,7 +69,7 @@ Offer ID from the original Catalog offer.
|
|
|
69
69
|
|
|
70
70
|
### policies? {#policies}
|
|
71
71
|
|
|
72
|
-
> `optional` **policies
|
|
72
|
+
> `optional` **policies?**: `IDataspaceProtocolPolicy`[]
|
|
73
73
|
|
|
74
74
|
Policies from the Agreement.
|
|
75
75
|
Used by DSC for runtime policy enforcement.
|
|
@@ -78,7 +78,7 @@ Used by DSC for runtime policy enforcement.
|
|
|
78
78
|
|
|
79
79
|
### consumerIdentity? {#consumeridentity}
|
|
80
80
|
|
|
81
|
-
> `optional` **consumerIdentity
|
|
81
|
+
> `optional` **consumerIdentity?**: `string`
|
|
82
82
|
|
|
83
83
|
Consumer identity (DID or URI).
|
|
84
84
|
Used for auditing and access control.
|
|
@@ -87,7 +87,7 @@ Used for auditing and access control.
|
|
|
87
87
|
|
|
88
88
|
### providerIdentity? {#provideridentity}
|
|
89
89
|
|
|
90
|
-
> `optional` **providerIdentity
|
|
90
|
+
> `optional` **providerIdentity?**: `string`
|
|
91
91
|
|
|
92
92
|
Provider identity (DID or URI).
|
|
93
93
|
Used for auditing.
|
|
@@ -96,7 +96,7 @@ Used for auditing.
|
|
|
96
96
|
|
|
97
97
|
### callbackAddress? {#callbackaddress}
|
|
98
98
|
|
|
99
|
-
> `optional` **callbackAddress
|
|
99
|
+
> `optional` **callbackAddress?**: `string`
|
|
100
100
|
|
|
101
101
|
Callback address for Consumer notifications.
|
|
102
102
|
URI where messages to the Consumer should be sent.
|
|
@@ -105,7 +105,7 @@ URI where messages to the Consumer should be sent.
|
|
|
105
105
|
|
|
106
106
|
### format? {#format}
|
|
107
107
|
|
|
108
|
-
> `optional` **format
|
|
108
|
+
> `optional` **format?**: `string`
|
|
109
109
|
|
|
110
110
|
Data format from the Dataset Distribution.
|
|
111
111
|
Specified by a Distribution for the Dataset associated with the Agreement.
|
|
@@ -114,7 +114,7 @@ Specified by a Distribution for the Dataset associated with the Agreement.
|
|
|
114
114
|
|
|
115
115
|
### dataAddress? {#dataaddress}
|
|
116
116
|
|
|
117
|
-
> `optional` **dataAddress
|
|
117
|
+
> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
|
|
118
118
|
|
|
119
119
|
Data address for push mode transfers.
|
|
120
120
|
Contains endpoint information where data should be pushed (for Activity Stream push mode).
|
package/package.json
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ICompleteTransferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/ICompleteTransferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolTransferCompletionMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * API request for completing a transfer process.\n */\nexport interface ICompleteTransferRequest {\n\t/**\n\t * Path parameters containing the process ID.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * Process ID (consumerPid).\n\t\t */\n\t\tpid: string;\n\t};\n\n\t/**\n\t * Authorization header containing the Base64-encoded trust payload.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Authorization]: string;\n\t};\n\n\t/**\n\t * Transfer completion message (DSP compliant).\n\t */\n\tbody: IDataspaceProtocolTransferCompletionMessage;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ICompleteTransferResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/ICompleteTransferResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolTransferProcess,\n\tIDataspaceProtocolTransferError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * API response for completing a transfer process.\n */\nexport interface ICompleteTransferResponse {\n\t/**\n\t * Transfer Process (DSP compliant) with state COMPLETED, or error.\n\t */\n\tbody: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;\n\n\t/**\n\t * HTTP status code for the response.\n\t */\n\tstatusCode?: HttpStatusCode;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IGetTransferProcessRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/IGetTransferProcessRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * API request for getting a transfer process state.\n */\nexport interface IGetTransferProcessRequest {\n\t/**\n\t * Path parameters containing the process ID.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * Process ID (consumerPid or providerPid).\n\t\t */\n\t\tpid: string;\n\t};\n\n\t/**\n\t * Authorization header containing the Base64-encoded trust payload.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Authorization]: string;\n\t};\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IGetTransferProcessResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/IGetTransferProcessResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolTransferProcess,\n\tIDataspaceProtocolTransferError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * API response for getting a transfer process state.\n */\nexport interface IGetTransferProcessResponse {\n\t/**\n\t * Transfer Process (DSP compliant) with current state, or error.\n\t */\n\tbody: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;\n\n\t/**\n\t * HTTP status code for the response.\n\t */\n\tstatusCode?: HttpStatusCode;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IRequestTransferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/IRequestTransferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolTransferRequestMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * API request for requesting a transfer process.\n */\nexport interface IRequestTransferRequest {\n\t/**\n\t * Authorization header containing the Base64-encoded trust payload.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Authorization]: string;\n\t};\n\n\t/**\n\t * Transfer request message (DSP compliant).\n\t */\n\tbody: IDataspaceProtocolTransferRequestMessage;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IRequestTransferResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/IRequestTransferResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolTransferProcess,\n\tIDataspaceProtocolTransferError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * API response for requesting a transfer process.\n */\nexport interface IRequestTransferResponse {\n\t/**\n\t * Transfer Process (DSP compliant) with state REQUESTED, or error.\n\t */\n\tbody: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;\n\n\t/**\n\t * HTTP status code for the response.\n\t */\n\tstatusCode?: HttpStatusCode;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IStartTransferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/IStartTransferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolTransferStartMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * API request for starting a transfer process.\n */\nexport interface IStartTransferRequest {\n\t/**\n\t * Path parameters containing the process ID.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * Process ID (consumerPid).\n\t\t */\n\t\tpid: string;\n\t};\n\n\t/**\n\t * Authorization header containing the Base64-encoded trust payload.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Authorization]: string;\n\t};\n\n\t/**\n\t * Transfer start message (DSP compliant).\n\t */\n\tbody: IDataspaceProtocolTransferStartMessage;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IStartTransferResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/IStartTransferResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolTransferStartMessage,\n\tIDataspaceProtocolTransferError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * API response for starting a transfer process.\n */\nexport interface IStartTransferResponse {\n\t/**\n\t * Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or error.\n\t */\n\tbody: IDataspaceProtocolTransferStartMessage | IDataspaceProtocolTransferError;\n\n\t/**\n\t * HTTP status code for the response.\n\t */\n\tstatusCode?: HttpStatusCode;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ISuspendTransferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/ISuspendTransferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolTransferSuspensionMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * API request for suspending a transfer process.\n */\nexport interface ISuspendTransferRequest {\n\t/**\n\t * Path parameters containing the process ID.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * Process ID (consumerPid).\n\t\t */\n\t\tpid: string;\n\t};\n\n\t/**\n\t * Authorization header containing the Base64-encoded trust payload.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Authorization]: string;\n\t};\n\n\t/**\n\t * Transfer suspension message (DSP compliant).\n\t */\n\tbody: IDataspaceProtocolTransferSuspensionMessage;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ISuspendTransferResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/ISuspendTransferResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolTransferProcess,\n\tIDataspaceProtocolTransferError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * API response for suspending a transfer process.\n */\nexport interface ISuspendTransferResponse {\n\t/**\n\t * Transfer Process (DSP compliant) with state SUSPENDED, or error.\n\t */\n\tbody: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;\n\n\t/**\n\t * HTTP status code for the response.\n\t */\n\tstatusCode?: HttpStatusCode;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ITerminateTransferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/ITerminateTransferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolTransferTerminationMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * API request for terminating a transfer process.\n */\nexport interface ITerminateTransferRequest {\n\t/**\n\t * Path parameters containing the process ID.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * Process ID (consumerPid).\n\t\t */\n\t\tpid: string;\n\t};\n\n\t/**\n\t * Authorization header containing the Base64-encoded trust payload.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Authorization]: string;\n\t};\n\n\t/**\n\t * Transfer termination message (DSP compliant).\n\t */\n\tbody: IDataspaceProtocolTransferTerminationMessage;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ITerminateTransferResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/control-plane/ITerminateTransferResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolTransferProcess,\n\tIDataspaceProtocolTransferError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * API response for terminating a transfer process.\n */\nexport interface ITerminateTransferResponse {\n\t/**\n\t * Transfer Process (DSP compliant) with state TERMINATED, or error.\n\t */\n\tbody: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;\n\n\t/**\n\t * HTTP status code for the response.\n\t */\n\tstatusCode?: HttpStatusCode;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceControlPlaneComponent.js","sourceRoot":"","sources":["../../../../src/models/control-plane/IDataspaceControlPlaneComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {\n\tIDataspaceProtocolContractNegotiation,\n\tIDataspaceProtocolContractNegotiationError,\n\tIDataspaceProtocolTransferCompletionMessage,\n\tIDataspaceProtocolTransferError,\n\tIDataspaceProtocolTransferProcess,\n\tIDataspaceProtocolTransferRequestMessage,\n\tIDataspaceProtocolTransferStartMessage,\n\tIDataspaceProtocolTransferSuspensionMessage,\n\tIDataspaceProtocolTransferTerminationMessage\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { INegotiationCallback } from \"./INegotiationCallback.js\";\n\n/**\n * Dataspace Control Plane Component interface.\n * Implements Eclipse Dataspace Protocol (DSP) specifications:\n * - Contract Negotiation Protocol\n * - Transfer Process Protocol\n *\n * This component acts as the Control Plane for contract negotiation and\n * data transfers between nodes in a dataspace.\n *\n * DSP 2025-1 Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/\n */\nexport interface IDataspaceControlPlaneComponent extends IComponent {\n\t// ============================================================================\n\t// CONTRACT NEGOTIATION PROTOCOL (DSP)\n\t// Methods for negotiating agreements before transfers\n\t// ============================================================================\n\n\t/**\n\t * Register a callback to receive negotiation state change notifications.\n\t * Upstream modules (e.g. supply-chain) register their callback here\n\t * to be notified when negotiations complete, fail, or change state.\n\t * @param key A unique key identifying this callback registration.\n\t * @param callback The callback interface to register.\n\t */\n\tregisterNegotiationCallback(key: string, callback: INegotiationCallback): void;\n\n\t/**\n\t * Unregister a previously registered negotiation callback.\n\t * @param key The key used when registering the callback.\n\t */\n\tunregisterNegotiationCallback(key: string): void;\n\n\t/**\n\t * Negotiate a contract agreement with a provider.\n\t * Implements DSP Contract Negotiation Protocol.\n\t *\n\t * Returns immediately with a negotiationId. The caller is notified\n\t * via the registered INegotiationCallback when the negotiation completes.\n\t * The negotiation follows DSP state machine: REQUESTED → OFFERED → AGREED → VERIFIED → FINALIZED.\n\t *\n\t * This method has NO REST client implementation — it is only accessible via ComponentFactory.get().\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#negotiation-protocol\n\t *\n\t * @param datasetId The dataset ID from the provider's catalog.\n\t * @param offerId The offer ID from the provider's catalog.\n\t * @param providerEndpoint The provider's contract negotiation endpoint URL.\n\t * @param publicOrigin The public origin URL of this control plane (for callbacks).\n\t * @param trustPayload Trust payload for authentication (JWT or Verifiable Credential).\n\t * @returns The negotiation ID for tracking. Use registered callback for completion.\n\t */\n\tnegotiateAgreement(\n\t\tdatasetId: string,\n\t\tofferId: string,\n\t\tproviderEndpoint: string,\n\t\tpublicOrigin: string,\n\t\ttrustPayload: unknown\n\t): Promise<{ negotiationId: string }>;\n\n\t/**\n\t * Get the current state of a contract negotiation.\n\t * Implements DSP Contract Negotiation Protocol.\n\t *\n\t * Queries the current state of an ongoing or completed negotiation.\n\t * Use this to monitor negotiation progress.\n\t * Returns the DSP-compliant negotiation state or error.\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#negotiation-protocol\n\t *\n\t * @param negotiationId The unique identifier of the negotiation.\n\t * @param trustPayload Trust payload for authentication.\n\t * @returns DSP ContractNegotiation with current state, or error.\n\t */\n\tgetNegotiation(\n\t\tnegotiationId: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;\n\n\t/**\n\t * Get negotiation history.\n\t * Queries past contract negotiations for audit trails and debugging.\n\t *\n\t * Returns a list of past negotiations with their states and metadata.\n\t * Supports optional filtering by state and pagination via cursor.\n\t *\n\t * @param state Optional filter by negotiation state (e.g., \"FINALIZED\", \"TERMINATED\").\n\t * @param cursor Optional pagination cursor for fetching next page.\n\t * @param trustPayload Trust payload for authentication.\n\t * @returns List of negotiation history entries with pagination cursor.\n\t */\n\tgetNegotiationHistory(\n\t\tstate: string | undefined,\n\t\tcursor: string | undefined,\n\t\ttrustPayload: unknown\n\t): Promise<{\n\t\tnegotiations: {\n\t\t\tnegotiation:\n\t\t\t\t| IDataspaceProtocolContractNegotiation\n\t\t\t\t| IDataspaceProtocolContractNegotiationError;\n\t\t\tcreatedAt: string;\n\t\t\tofferId?: string;\n\t\t\tagreementId?: string;\n\t\t}[];\n\t\tcursor?: string;\n\t\tcount: number;\n\t}>;\n\n\t// ============================================================================\n\t// TRANSFER PROCESS PROTOCOL (DSP)\n\t// Methods for managing data transfers after agreements are established\n\t// ============================================================================\n\n\t// ----------------------------------------------------------------------------\n\t// CONSUMER SIDE OPERATIONS\n\t// Methods called by the Data Consumer to initiate transfers\n\t// ----------------------------------------------------------------------------\n\n\t/**\n\t * Request a Transfer Process.\n\t * Creates a new Transfer Process in REQUESTED state.\n\t *\n\t * Role Performed: Provider\n\t * Called by: Consumer when it wants to request a new Transfer Process\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message\n\t *\n\t * @param request Transfer request message (DSP compliant) containing agreementId,\n\t * consumerPid, callbackAddress, and format.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * The consumer must prove their identity by providing a valid trust payload.\n\t * @returns Transfer Process (DSP compliant) with state REQUESTED, including\n\t * both consumerPid and providerPid, or TransferError if the operation fails.\n\t */\n\trequestTransfer(\n\t\trequest: IDataspaceProtocolTransferRequestMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;\n\n\t// ============================================================================\n\t// PROVIDER SIDE OPERATIONS\n\t// Methods called by the Data Provider to respond to transfer requests\n\t// ============================================================================\n\n\t/**\n\t * Start a Transfer Process.\n\t * Transitions Transfer Process from REQUESTED to STARTED state, or resumes from SUSPENDED state.\n\t *\n\t * Role Performed: Provider / Consumer\n\t * Called by: Provider when a Transfer Process starts, or Consumer to attempt to start a Transfer Process after it has been suspended\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message\n\t *\n\t * @param message Transfer start message (DSP compliant).\n\t * @param publicOrigin The public origin URL of this service (used to construct data plane endpoint for PULL transfers).\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * @returns Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or TransferError if the operation fails.\n\t */\n\tstartTransfer(\n\t\tmessage: IDataspaceProtocolTransferStartMessage,\n\t\tpublicOrigin: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolTransferStartMessage | IDataspaceProtocolTransferError>;\n\n\t// ============================================================================\n\t// SHARED STATE MANAGEMENT OPERATIONS\n\t// Methods that can be called by either Consumer or Provider\n\t// ============================================================================\n\n\t/**\n\t * Complete a Transfer Process.\n\t * Transitions Transfer Process to COMPLETED state.\n\t *\n\t * Role Performed: Consumer / Provider\n\t * Called by: Provider or Consumer when a Transfer process is completed on their side\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message\n\t *\n\t * @param message Transfer completion message (DSP compliant).\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * @returns Transfer Process (DSP compliant) with state COMPLETED, or TransferError if the operation fails.\n\t */\n\tcompleteTransfer(\n\t\tmessage: IDataspaceProtocolTransferCompletionMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;\n\n\t/**\n\t * Suspend a Transfer Process.\n\t * Transitions Transfer Process to SUSPENDED state.\n\t *\n\t * Role Performed: Consumer / Provider\n\t * Called by: Provider or Consumer when a Transfer process needs to be temporarily suspended on their side\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message\n\t *\n\t * @param message Transfer suspension message (DSP compliant) with optional reason.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * @returns Transfer Process (DSP compliant) with state SUSPENDED, or TransferError if the operation fails.\n\t */\n\tsuspendTransfer(\n\t\tmessage: IDataspaceProtocolTransferSuspensionMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;\n\n\t/**\n\t * Terminate a Transfer Process.\n\t * Transitions Transfer Process to TERMINATED state.\n\t *\n\t * Role Performed: Consumer / Provider\n\t * Called by: Provider or Consumer when a Transfer process needs to be terminated on their side (e.g., due to error)\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message\n\t *\n\t * @param message Transfer termination message (DSP compliant) with optional reason.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * @returns Transfer Process (DSP compliant) with state TERMINATED, or TransferError if the operation fails.\n\t */\n\tterminateTransfer(\n\t\tmessage: IDataspaceProtocolTransferTerminationMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;\n\n\t/**\n\t * Get Transfer Process State.\n\t * Query the current state of a Transfer Process.\n\t *\n\t * Role Performed: Consumer / Provider\n\t * Called by: Provider or Consumer when they need to check the status of a Transfer process on their side\n\t *\n\t * Supports role-agnostic lookup using either consumerPid or providerPid.\n\t * The service will automatically detect which role the caller is acting as\n\t * (Consumer or Provider) based on the PID provided.\n\t *\n\t * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process\n\t *\n\t * @param pid The Process ID (consumerPid or providerPid) used to identify the transfer.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * @returns Transfer Process (DSP compliant) with current state, or TransferError if the operation fails.\n\t */\n\tgetTransferProcess(\n\t\tpid: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;\n}\n"]}
|