@twin.org/dataspace-control-plane-service 0.0.3-next.19 → 0.0.3-next.21
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/dataspaceControlPlaneRoutes.js +274 -21
- package/dist/es/dataspaceControlPlaneRoutes.js.map +1 -1
- package/dist/es/dataspaceControlPlaneService.js +13 -3
- package/dist/es/dataspaceControlPlaneService.js.map +1 -1
- package/docs/changelog.md +34 -0
- package/docs/reference/classes/DataspaceControlPlanePolicyRequester.md +9 -9
- package/docs/reference/classes/DataspaceControlPlaneService.md +17 -17
- package/docs/reference/interfaces/IDataspaceControlPlaneServiceConfig.md +2 -2
- package/docs/reference/interfaces/IDataspaceControlPlaneServiceConstructorOptions.md +11 -11
- package/docs/reference/interfaces/INegotiationState.md +5 -5
- package/package.json +2 -2
|
@@ -44,7 +44,7 @@ Optional callback interface for state change notifications.
|
|
|
44
44
|
|
|
45
45
|
## Properties
|
|
46
46
|
|
|
47
|
-
### CLASS\_NAME
|
|
47
|
+
### CLASS\_NAME {#class_name}
|
|
48
48
|
|
|
49
49
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
50
50
|
|
|
@@ -52,7 +52,7 @@ Runtime name for the class.
|
|
|
52
52
|
|
|
53
53
|
## Methods
|
|
54
54
|
|
|
55
|
-
### className()
|
|
55
|
+
### className() {#classname}
|
|
56
56
|
|
|
57
57
|
> **className**(): `string`
|
|
58
58
|
|
|
@@ -70,7 +70,7 @@ The class name of the component.
|
|
|
70
70
|
|
|
71
71
|
***
|
|
72
72
|
|
|
73
|
-
### trackNegotiation()
|
|
73
|
+
### trackNegotiation() {#tracknegotiation}
|
|
74
74
|
|
|
75
75
|
> **trackNegotiation**(`negotiationId`): `void`
|
|
76
76
|
|
|
@@ -91,7 +91,7 @@ The negotiation ID returned by PNP.sendRequestToProvider().
|
|
|
91
91
|
|
|
92
92
|
***
|
|
93
93
|
|
|
94
|
-
### getActiveNegotiations()
|
|
94
|
+
### getActiveNegotiations() {#getactivenegotiations}
|
|
95
95
|
|
|
96
96
|
> **getActiveNegotiations**(): `Map`\<`string`, [`INegotiationState`](../interfaces/INegotiationState.md)\>
|
|
97
97
|
|
|
@@ -105,7 +105,7 @@ Map of negotiationId to negotiation state.
|
|
|
105
105
|
|
|
106
106
|
***
|
|
107
107
|
|
|
108
|
-
### removeNegotiation()
|
|
108
|
+
### removeNegotiation() {#removenegotiation}
|
|
109
109
|
|
|
110
110
|
> **removeNegotiation**(`negotiationId`): `void`
|
|
111
111
|
|
|
@@ -125,7 +125,7 @@ The negotiation ID to remove.
|
|
|
125
125
|
|
|
126
126
|
***
|
|
127
127
|
|
|
128
|
-
### offer()
|
|
128
|
+
### offer() {#offer}
|
|
129
129
|
|
|
130
130
|
> **offer**(`negotiationId`, `offer`): `Promise`\<`boolean`\>
|
|
131
131
|
|
|
@@ -158,7 +158,7 @@ True if the offer was accepted, false otherwise.
|
|
|
158
158
|
|
|
159
159
|
***
|
|
160
160
|
|
|
161
|
-
### agreement()
|
|
161
|
+
### agreement() {#agreement}
|
|
162
162
|
|
|
163
163
|
> **agreement**(`negotiationId`, `agreement`): `Promise`\<`boolean`\>
|
|
164
164
|
|
|
@@ -191,7 +191,7 @@ True if the agreement was accepted, false otherwise.
|
|
|
191
191
|
|
|
192
192
|
***
|
|
193
193
|
|
|
194
|
-
### finalised()
|
|
194
|
+
### finalised() {#finalised}
|
|
195
195
|
|
|
196
196
|
> **finalised**(`negotiationId`): `Promise`\<`void`\>
|
|
197
197
|
|
|
@@ -218,7 +218,7 @@ Nothing.
|
|
|
218
218
|
|
|
219
219
|
***
|
|
220
220
|
|
|
221
|
-
### terminated()
|
|
221
|
+
### terminated() {#terminated}
|
|
222
222
|
|
|
223
223
|
> **terminated**(`negotiationId`): `Promise`\<`void`\>
|
|
224
224
|
|
|
@@ -33,7 +33,7 @@ The options for the service.
|
|
|
33
33
|
|
|
34
34
|
## Properties
|
|
35
35
|
|
|
36
|
-
### CLASS\_NAME
|
|
36
|
+
### CLASS\_NAME {#class_name}
|
|
37
37
|
|
|
38
38
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
39
39
|
|
|
@@ -41,7 +41,7 @@ Runtime name for the class.
|
|
|
41
41
|
|
|
42
42
|
## Methods
|
|
43
43
|
|
|
44
|
-
### className()
|
|
44
|
+
### className() {#classname}
|
|
45
45
|
|
|
46
46
|
> **className**(): `string`
|
|
47
47
|
|
|
@@ -59,7 +59,7 @@ The class name of the component.
|
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
62
|
-
### registerNegotiationCallback()
|
|
62
|
+
### registerNegotiationCallback() {#registernegotiationcallback}
|
|
63
63
|
|
|
64
64
|
> **registerNegotiationCallback**(`key`, `callback`): `void`
|
|
65
65
|
|
|
@@ -90,7 +90,7 @@ The callback interface to register.
|
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
93
|
-
### unregisterNegotiationCallback()
|
|
93
|
+
### unregisterNegotiationCallback() {#unregisternegotiationcallback}
|
|
94
94
|
|
|
95
95
|
> **unregisterNegotiationCallback**(`key`): `void`
|
|
96
96
|
|
|
@@ -114,7 +114,7 @@ The key used when registering the callback.
|
|
|
114
114
|
|
|
115
115
|
***
|
|
116
116
|
|
|
117
|
-
### start()
|
|
117
|
+
### start() {#start}
|
|
118
118
|
|
|
119
119
|
> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
|
|
120
120
|
|
|
@@ -140,7 +140,7 @@ The node logging component type.
|
|
|
140
140
|
|
|
141
141
|
***
|
|
142
142
|
|
|
143
|
-
### stop()
|
|
143
|
+
### stop() {#stop}
|
|
144
144
|
|
|
145
145
|
> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
|
|
146
146
|
|
|
@@ -165,7 +165,7 @@ The node logging component type.
|
|
|
165
165
|
|
|
166
166
|
***
|
|
167
167
|
|
|
168
|
-
### requestTransfer()
|
|
168
|
+
### requestTransfer() {#requesttransfer}
|
|
169
169
|
|
|
170
170
|
> **requestTransfer**(`request`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferProcess`\>
|
|
171
171
|
|
|
@@ -201,7 +201,7 @@ Called by: Consumer when it wants to request a new Transfer Process
|
|
|
201
201
|
|
|
202
202
|
***
|
|
203
203
|
|
|
204
|
-
### startTransfer()
|
|
204
|
+
### startTransfer() {#starttransfer}
|
|
205
205
|
|
|
206
206
|
> **startTransfer**(`message`, `publicOrigin`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferStartMessage`\>
|
|
207
207
|
|
|
@@ -242,7 +242,7 @@ Role Performed: Provider / Consumer
|
|
|
242
242
|
|
|
243
243
|
***
|
|
244
244
|
|
|
245
|
-
### completeTransfer()
|
|
245
|
+
### completeTransfer() {#completetransfer}
|
|
246
246
|
|
|
247
247
|
> **completeTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferProcess`\>
|
|
248
248
|
|
|
@@ -274,7 +274,7 @@ Transfer Process (DSP compliant) with state COMPLETED, or TransferError if the o
|
|
|
274
274
|
|
|
275
275
|
***
|
|
276
276
|
|
|
277
|
-
### suspendTransfer()
|
|
277
|
+
### suspendTransfer() {#suspendtransfer}
|
|
278
278
|
|
|
279
279
|
> **suspendTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferProcess`\>
|
|
280
280
|
|
|
@@ -306,7 +306,7 @@ Transfer Process (DSP compliant) with state SUSPENDED, or TransferError if the o
|
|
|
306
306
|
|
|
307
307
|
***
|
|
308
308
|
|
|
309
|
-
### terminateTransfer()
|
|
309
|
+
### terminateTransfer() {#terminatetransfer}
|
|
310
310
|
|
|
311
311
|
> **terminateTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferProcess`\>
|
|
312
312
|
|
|
@@ -338,7 +338,7 @@ Transfer Process (DSP compliant) with state TERMINATED, or TransferError if the
|
|
|
338
338
|
|
|
339
339
|
***
|
|
340
340
|
|
|
341
|
-
### getTransferProcess()
|
|
341
|
+
### getTransferProcess() {#gettransferprocess}
|
|
342
342
|
|
|
343
343
|
> **getTransferProcess**(`pid`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferProcess`\>
|
|
344
344
|
|
|
@@ -370,7 +370,7 @@ Transfer Process (DSP compliant) with current state, or TransferError if the ope
|
|
|
370
370
|
|
|
371
371
|
***
|
|
372
372
|
|
|
373
|
-
### negotiateAgreement()
|
|
373
|
+
### negotiateAgreement() {#negotiateagreement}
|
|
374
374
|
|
|
375
375
|
> **negotiateAgreement**(`datasetId`, `offerId`, `providerEndpoint`, `publicOrigin`, `trustPayload`): `Promise`\<\{ `negotiationId`: `string`; \}\>
|
|
376
376
|
|
|
@@ -422,7 +422,7 @@ The negotiation ID. Use the registered callback for completion notification.
|
|
|
422
422
|
|
|
423
423
|
***
|
|
424
424
|
|
|
425
|
-
### getNegotiation()
|
|
425
|
+
### getNegotiation() {#getnegotiation}
|
|
426
426
|
|
|
427
427
|
> **getNegotiation**(`negotiationId`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
428
428
|
|
|
@@ -454,7 +454,7 @@ Current state of the negotiation.
|
|
|
454
454
|
|
|
455
455
|
***
|
|
456
456
|
|
|
457
|
-
### getNegotiationHistory()
|
|
457
|
+
### getNegotiationHistory() {#getnegotiationhistory}
|
|
458
458
|
|
|
459
459
|
> **getNegotiationHistory**(`state`, `cursor`, `trustPayload`): `Promise`\<\{ `negotiations`: `object`[]; `cursor?`: `string`; `count`: `number`; \}\>
|
|
460
460
|
|
|
@@ -492,7 +492,7 @@ List of negotiation history entries with pagination.
|
|
|
492
492
|
|
|
493
493
|
***
|
|
494
494
|
|
|
495
|
-
### resolveConsumerPid()
|
|
495
|
+
### resolveConsumerPid() {#resolveconsumerpid}
|
|
496
496
|
|
|
497
497
|
> **resolveConsumerPid**(`consumerPid`, `trustPayload`): `Promise`\<`ITransferContext`\>
|
|
498
498
|
|
|
@@ -524,7 +524,7 @@ Transfer Context with Agreement, datasetId, and Transfer Process metadata.
|
|
|
524
524
|
|
|
525
525
|
***
|
|
526
526
|
|
|
527
|
-
### resolveProviderPid()
|
|
527
|
+
### resolveProviderPid() {#resolveproviderpid}
|
|
528
528
|
|
|
529
529
|
> **resolveProviderPid**(`providerPid`, `trustPayload`): `Promise`\<`ITransferContext`\>
|
|
530
530
|
|
|
@@ -4,7 +4,7 @@ Dataspace Control Plane service configuration.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### overrideTrustGeneratorType?
|
|
7
|
+
### overrideTrustGeneratorType? {#overridetrustgeneratortype}
|
|
8
8
|
|
|
9
9
|
> `optional` **overrideTrustGeneratorType**: `string`
|
|
10
10
|
|
|
@@ -13,7 +13,7 @@ If not specified, the default trust generator configured in the trust component
|
|
|
13
13
|
|
|
14
14
|
***
|
|
15
15
|
|
|
16
|
-
### dataPlanePath?
|
|
16
|
+
### dataPlanePath? {#dataplanepath}
|
|
17
17
|
|
|
18
18
|
> `optional` **dataPlanePath**: `string`
|
|
19
19
|
|
|
@@ -4,7 +4,7 @@ Dataspace Control Plane service constructor options.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### policyAdministrationPointComponentType?
|
|
7
|
+
### policyAdministrationPointComponentType? {#policyadministrationpointcomponenttype}
|
|
8
8
|
|
|
9
9
|
> `optional` **policyAdministrationPointComponentType**: `string`
|
|
10
10
|
|
|
@@ -13,7 +13,7 @@ Used for Agreement lookup and validation during Transfer Process initiation.
|
|
|
13
13
|
|
|
14
14
|
***
|
|
15
15
|
|
|
16
|
-
### policyNegotiationPointComponentType?
|
|
16
|
+
### policyNegotiationPointComponentType? {#policynegotiationpointcomponenttype}
|
|
17
17
|
|
|
18
18
|
> `optional` **policyNegotiationPointComponentType**: `string`
|
|
19
19
|
|
|
@@ -22,7 +22,7 @@ Used for contract negotiation to create agreements before transfer processes.
|
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
25
|
-
### policyNegotiationAdminPointComponentType?
|
|
25
|
+
### policyNegotiationAdminPointComponentType? {#policynegotiationadminpointcomponenttype}
|
|
26
26
|
|
|
27
27
|
> `optional` **policyNegotiationAdminPointComponentType**: `string`
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ Optional - if not provided, negotiation history will not be available.
|
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
35
|
-
### federatedCatalogueComponentType?
|
|
35
|
+
### federatedCatalogueComponentType? {#federatedcataloguecomponenttype}
|
|
36
36
|
|
|
37
37
|
> `optional` **federatedCatalogueComponentType**: `string`
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ Validates that Agreements reference valid catalog datasets.
|
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
|
-
### loggingComponentType?
|
|
45
|
+
### loggingComponentType? {#loggingcomponenttype}
|
|
46
46
|
|
|
47
47
|
> `optional` **loggingComponentType**: `string`
|
|
48
48
|
|
|
@@ -50,7 +50,7 @@ Logging component type.
|
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
53
|
-
### identityComponentType?
|
|
53
|
+
### identityComponentType? {#identitycomponenttype}
|
|
54
54
|
|
|
55
55
|
> `optional` **identityComponentType**: `string`
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ Identity component type (for token signing/verification).
|
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
61
|
-
### identityAuthenticationComponentType?
|
|
61
|
+
### identityAuthenticationComponentType? {#identityauthenticationcomponenttype}
|
|
62
62
|
|
|
63
63
|
> `optional` **identityAuthenticationComponentType**: `string`
|
|
64
64
|
|
|
@@ -66,7 +66,7 @@ Identity Authentication component type (for token validation).
|
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
69
|
-
### trustComponentType?
|
|
69
|
+
### trustComponentType? {#trustcomponenttype}
|
|
70
70
|
|
|
71
71
|
> `optional` **trustComponentType**: `string`
|
|
72
72
|
|
|
@@ -75,7 +75,7 @@ Used to verify JWT/VC tokens and extract identity information.
|
|
|
75
75
|
|
|
76
76
|
***
|
|
77
77
|
|
|
78
|
-
### transferProcessEntityStorageType?
|
|
78
|
+
### transferProcessEntityStorageType? {#transferprocessentitystoragetype}
|
|
79
79
|
|
|
80
80
|
> `optional` **transferProcessEntityStorageType**: `string`
|
|
81
81
|
|
|
@@ -85,7 +85,7 @@ Must match the Data Plane's transferProcessEntityStorageType for shared storage.
|
|
|
85
85
|
|
|
86
86
|
***
|
|
87
87
|
|
|
88
|
-
### taskSchedulerComponentType?
|
|
88
|
+
### taskSchedulerComponentType? {#taskschedulercomponenttype}
|
|
89
89
|
|
|
90
90
|
> `optional` **taskSchedulerComponentType**: `string`
|
|
91
91
|
|
|
@@ -93,7 +93,7 @@ Task scheduler component type for periodic cleanup of stalled negotiations.
|
|
|
93
93
|
|
|
94
94
|
***
|
|
95
95
|
|
|
96
|
-
### config?
|
|
96
|
+
### config? {#config}
|
|
97
97
|
|
|
98
98
|
> `optional` **config**: [`IDataspaceControlPlaneServiceConfig`](IDataspaceControlPlaneServiceConfig.md)
|
|
99
99
|
|
|
@@ -4,7 +4,7 @@ Negotiation state tracked internally for callback routing.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### negotiationId
|
|
7
|
+
### negotiationId {#negotiationid}
|
|
8
8
|
|
|
9
9
|
> **negotiationId**: `string`
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ The negotiation ID (self-reference for lookup).
|
|
|
12
12
|
|
|
13
13
|
***
|
|
14
14
|
|
|
15
|
-
### state
|
|
15
|
+
### state {#state}
|
|
16
16
|
|
|
17
17
|
> **state**: `DataspaceProtocolContractNegotiationStateType`
|
|
18
18
|
|
|
@@ -20,7 +20,7 @@ Current negotiation state.
|
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
### agreement?
|
|
23
|
+
### agreement? {#agreement}
|
|
24
24
|
|
|
25
25
|
> `optional` **agreement**: `IDataspaceProtocolAgreement`
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Agreement received from provider (stored until finalized).
|
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
31
|
-
### startedAt
|
|
31
|
+
### startedAt {#startedat}
|
|
32
32
|
|
|
33
33
|
> **startedAt**: `number`
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Timestamp when negotiation started.
|
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### updatedAt
|
|
39
|
+
### updatedAt {#updatedat}
|
|
40
40
|
|
|
41
41
|
> **updatedAt**: `number`
|
|
42
42
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/dataspace-control-plane-service",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.21",
|
|
4
4
|
"description": "Implements agreement negotiation and transfer process lifecycle management for control plane operations.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@twin.org/api-models": "next",
|
|
18
18
|
"@twin.org/context": "next",
|
|
19
19
|
"@twin.org/core": "next",
|
|
20
|
-
"@twin.org/dataspace-models": "0.0.3-next.
|
|
20
|
+
"@twin.org/dataspace-models": "0.0.3-next.21",
|
|
21
21
|
"@twin.org/entity": "next",
|
|
22
22
|
"@twin.org/entity-storage-models": "next",
|
|
23
23
|
"@twin.org/federated-catalogue-models": "next",
|