@twin.org/dataspace-control-plane-service 0.0.3-next.47 → 0.0.3-next.49
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 +2 -4
- package/dist/es/dataspaceControlPlaneRoutes.js.map +1 -1
- package/dist/es/dataspaceControlPlaneService.js +56 -45
- package/dist/es/dataspaceControlPlaneService.js.map +1 -1
- package/dist/es/models/IDataspaceControlPlaneServiceConfig.js.map +1 -1
- package/dist/es/models/IDataspaceControlPlaneServiceConstructorOptions.js.map +1 -1
- package/dist/types/dataspaceControlPlaneService.d.ts +14 -20
- package/dist/types/models/IDataspaceControlPlaneServiceConfig.d.ts +1 -1
- package/dist/types/models/IDataspaceControlPlaneServiceConstructorOptions.d.ts +4 -0
- package/docs/changelog.md +29 -0
- package/docs/reference/classes/DataspaceControlPlaneService.md +5 -36
- package/docs/reference/interfaces/IDataspaceControlPlaneServiceConfig.md +1 -1
- package/docs/reference/interfaces/IDataspaceControlPlaneServiceConstructorOptions.md +8 -0
- package/locales/en.json +1 -1
- package/package.json +3 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceControlPlaneServiceConfig.js","sourceRoot":"","sources":["../../../src/models/IDataspaceControlPlaneServiceConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Dataspace Control Plane service configuration.\n */\nexport interface IDataspaceControlPlaneServiceConfig {\n\t/**\n\t * Override the default trust generator type for token generation.\n\t * If not specified, the default trust generator configured in the trust component will be used.\n\t */\n\toverrideTrustGeneratorType?: string;\n\n\t/**\n\t * Data plane endpoint path for PULL transfers (path only, not full URL).\n\t * Will be combined with the public origin
|
|
1
|
+
{"version":3,"file":"IDataspaceControlPlaneServiceConfig.js","sourceRoot":"","sources":["../../../src/models/IDataspaceControlPlaneServiceConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Dataspace Control Plane service configuration.\n */\nexport interface IDataspaceControlPlaneServiceConfig {\n\t/**\n\t * Override the default trust generator type for token generation.\n\t * If not specified, the default trust generator configured in the trust component will be used.\n\t */\n\toverrideTrustGeneratorType?: string;\n\n\t/**\n\t * Data plane endpoint path for PULL transfers (path only, not full URL).\n\t * Will be combined with the public origin.\n\t *\n\t * REQUIRED if PULL transfers are supported.\n\t * If not specified, PULL transfers will not be available.\n\t *\n\t * Example: \"data-plane/data\" or \"api/data-plane/data\"\n\t */\n\tdataPlanePath?: string;\n\n\t/**\n\t * Control plane callback mount path (path only). Combined with this node's public origin to form the\n\t * consumer callbackAddress a provider POSTs DSP transfer messages back to (e.g.\n\t * `<origin>/<callbackPath>/transfers/:pid/start`), with `?organization=` appended for tenant routing.\n\t *\n\t * Example: \"dataspace\" or \"api/dataspace\".\n\t */\n\tcallbackPath?: string;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceControlPlaneServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IDataspaceControlPlaneServiceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceControlPlaneServiceConfig } from \"./IDataspaceControlPlaneServiceConfig.js\";\n\n/**\n * Dataspace Control Plane service constructor options.\n */\nexport interface IDataspaceControlPlaneServiceConstructorOptions {\n\t/**\n\t * Policy Administration Point component type.\n\t * Used for Agreement lookup and validation during Transfer Process initiation.\n\t * @default policy-administration-point\n\t */\n\tpolicyAdministrationPointComponentType?: string;\n\n\t/**\n\t * Policy Negotiation Point component type.\n\t * Used for contract negotiation to create agreements before transfer processes.\n\t * @default policy-negotiation-point\n\t */\n\tpolicyNegotiationPointComponentType?: string;\n\n\t/**\n\t * Policy Negotiation Admin Point component type.\n\t * Used for querying negotiation history.\n\t * @default policy-negotiation-admin-point\n\t */\n\tpolicyNegotiationAdminPointComponentType?: string;\n\n\t/**\n\t * Federated Catalogue component type.\n\t * Used for dataset validation during Transfer Process initiation.\n\t * Validates that Agreements reference valid catalog datasets.\n\t * @default federated-catalogue\n\t */\n\tfederatedCatalogueComponentType?: string;\n\n\t/**\n\t * Logging component type.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * Identity component type (for token signing/verification).\n\t * @default identity\n\t */\n\tidentityComponentType?: string;\n\n\t/**\n\t * Identity Authentication component type (for token validation).\n\t * @default identity-authentication\n\t */\n\tidentityAuthenticationComponentType?: string;\n\n\t/**\n\t * Trust component type for trust verification.\n\t * Used to verify JWT/VC tokens and extract identity information.\n\t * @default trust\n\t */\n\ttrustComponentType?: string;\n\n\t/**\n\t * Entity storage type for Transfer Process entities.\n\t * Used to persist transfer state for the consumerPid flow.\n\t * Must match the Data Plane's transferProcessEntityStorageType for shared storage.\n\t * @default transfer-process\n\t */\n\ttransferProcessEntityStorageType?: string;\n\n\t/**\n\t * Entity storage type for Dataspace App Dataset entities.\n\t * @default dataspace-app-dataset\n\t */\n\tdataspaceAppDatasetEntityStorageType?: string;\n\n\t/**\n\t * Task scheduler component type for periodic cleanup of stalled negotiations.\n\t * @default task-scheduler\n\t */\n\ttaskSchedulerComponentType?: string;\n\n\t/**\n\t * Data Plane component type, used to invoke push subscription lifecycle methods.\n\t * @default dataspace-data-plane\n\t */\n\tdataPlaneComponentType?: string;\n\n\t/**\n\t * Remote control plane component type used to make outbound DSP transfer requests.\n\t * Created dynamically via ComponentFactory.create() with the provider endpoint as config.\n\t * @default dataspace-control-plane-rest-client\n\t */\n\tremoteControlPlaneComponentType?: string;\n\n\t/**\n\t * Platform component type, used to retrieve public origin for constructing data plane URLs.\n\t * @default platform\n\t */\n\tplatformComponentType?: string;\n\n\t/**\n\t * The configuration of the Dataspace Control Plane Service.\n\t */\n\tconfig?: IDataspaceControlPlaneServiceConfig;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IDataspaceControlPlaneServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IDataspaceControlPlaneServiceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceControlPlaneServiceConfig } from \"./IDataspaceControlPlaneServiceConfig.js\";\n\n/**\n * Dataspace Control Plane service constructor options.\n */\nexport interface IDataspaceControlPlaneServiceConstructorOptions {\n\t/**\n\t * Policy Administration Point component type.\n\t * Used for Agreement lookup and validation during Transfer Process initiation.\n\t * @default policy-administration-point\n\t */\n\tpolicyAdministrationPointComponentType?: string;\n\n\t/**\n\t * Policy Negotiation Point component type.\n\t * Used for contract negotiation to create agreements before transfer processes.\n\t * @default policy-negotiation-point\n\t */\n\tpolicyNegotiationPointComponentType?: string;\n\n\t/**\n\t * Policy Negotiation Admin Point component type.\n\t * Used for querying negotiation history.\n\t * @default policy-negotiation-admin-point\n\t */\n\tpolicyNegotiationAdminPointComponentType?: string;\n\n\t/**\n\t * Federated Catalogue component type.\n\t * Used for dataset validation during Transfer Process initiation.\n\t * Validates that Agreements reference valid catalog datasets.\n\t * @default federated-catalogue\n\t */\n\tfederatedCatalogueComponentType?: string;\n\n\t/**\n\t * Logging component type.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * Identity component type (for token signing/verification).\n\t * @default identity\n\t */\n\tidentityComponentType?: string;\n\n\t/**\n\t * Identity Authentication component type (for token validation).\n\t * @default identity-authentication\n\t */\n\tidentityAuthenticationComponentType?: string;\n\n\t/**\n\t * Trust component type for trust verification.\n\t * Used to verify JWT/VC tokens and extract identity information.\n\t * @default trust\n\t */\n\ttrustComponentType?: string;\n\n\t/**\n\t * Entity storage type for Transfer Process entities.\n\t * Used to persist transfer state for the consumerPid flow.\n\t * Must match the Data Plane's transferProcessEntityStorageType for shared storage.\n\t * @default transfer-process\n\t */\n\ttransferProcessEntityStorageType?: string;\n\n\t/**\n\t * Entity storage type for Dataspace App Dataset entities.\n\t * @default dataspace-app-dataset\n\t */\n\tdataspaceAppDatasetEntityStorageType?: string;\n\n\t/**\n\t * Task scheduler component type for periodic cleanup of stalled negotiations.\n\t * @default task-scheduler\n\t */\n\ttaskSchedulerComponentType?: string;\n\n\t/**\n\t * Data Plane component type, used to invoke push subscription lifecycle methods.\n\t * @default dataspace-data-plane\n\t */\n\tdataPlaneComponentType?: string;\n\n\t/**\n\t * Remote control plane component type used to make outbound DSP transfer requests.\n\t * Created dynamically via ComponentFactory.create() with the provider endpoint as config.\n\t * @default dataspace-control-plane-rest-client\n\t */\n\tremoteControlPlaneComponentType?: string;\n\n\t/**\n\t * Platform component type, used to retrieve public origin for constructing data plane URLs.\n\t * @default platform\n\t */\n\tplatformComponentType?: string;\n\n\t/**\n\t * The component type for the optional telemetry component used for metrics, defaults to no telemetry.\n\t */\n\ttelemetryComponentType?: string;\n\n\t/**\n\t * The configuration of the Dataspace Control Plane Service.\n\t */\n\tconfig?: IDataspaceControlPlaneServiceConfig;\n}\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type IDataspaceControlPlaneComponent, type IDataspaceControlPlaneResolverComponent, type INegotiationCallback, type ITransferCallback, type
|
|
1
|
+
import { type IDataspaceAppDataset, type IDataspaceControlPlaneComponent, type IDataspaceControlPlaneResolverComponent, type INegotiationCallback, type ITransferCallback, type ITransferContext } from "@twin.org/dataspace-models";
|
|
2
2
|
import { type IDataspaceProtocolContractNegotiation, type IDataspaceProtocolContractNegotiationError, type IDataspaceProtocolDataset, type IDataspaceProtocolTransferCompletionMessage, type IDataspaceProtocolTransferError, type IDataspaceProtocolTransferProcess, type IDataspaceProtocolTransferRequestMessage, type IDataspaceProtocolTransferStartMessage, type IDataspaceProtocolTransferSuspensionMessage, type IDataspaceProtocolTransferTerminationMessage } from "@twin.org/standards-dataspace-protocol";
|
|
3
3
|
import type { IDataspaceControlPlaneServiceConstructorOptions } from "./models/IDataspaceControlPlaneServiceConstructorOptions.js";
|
|
4
4
|
/**
|
|
@@ -63,18 +63,16 @@ export declare class DataspaceControlPlaneService implements IDataspaceControlPl
|
|
|
63
63
|
* Request a Transfer Process.
|
|
64
64
|
* Creates a new Transfer Process in REQUESTED state.
|
|
65
65
|
* @param request Transfer request message (DSP compliant).
|
|
66
|
-
* @param publicOrigin The public origin of this provider node, resolved by the REST route from the
|
|
67
|
-
* hosting component; used to build the data-plane endpoint when auto-starting.
|
|
68
66
|
* @param options Request options.
|
|
69
67
|
* @param options.autoStart When true, the provider immediately starts the requested transfer (scheduled
|
|
70
68
|
* on the next tick); when omitted/false the provider start must be triggered explicitly.
|
|
71
|
-
* @param trustPayload Trust payload containing authorization information
|
|
69
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
72
70
|
* @returns Transfer Process (DSP compliant) with state REQUESTED, or TransferError if the operation fails.
|
|
73
71
|
*
|
|
74
72
|
* Role Performed: Provider
|
|
75
73
|
* Called by: Consumer when it wants to request a new Transfer Process
|
|
76
74
|
*/
|
|
77
|
-
requestTransfer(request: IDataspaceProtocolTransferRequestMessage,
|
|
75
|
+
requestTransfer(request: IDataspaceProtocolTransferRequestMessage, options: {
|
|
78
76
|
autoStart?: boolean;
|
|
79
77
|
} | undefined, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
|
|
80
78
|
/**
|
|
@@ -83,7 +81,6 @@ export declare class DataspaceControlPlaneService implements IDataspaceControlPl
|
|
|
83
81
|
* and (only if the provider accepts) persists a local TransferProcess in REQUESTED state.
|
|
84
82
|
* @param agreementId The finalized agreement ID from contract negotiation.
|
|
85
83
|
* @param providerEndpoint The provider's DSP control plane base URL.
|
|
86
|
-
* @param publicOrigin The public origin URL of this control plane (used as callbackAddress).
|
|
87
84
|
* @param format The transfer format (e.g. "HttpData-PULL", "HttpData-PUSH").
|
|
88
85
|
* @param trustPayload Trust payload for authenticating this call.
|
|
89
86
|
* @returns The consumerPid of the newly created TransferProcess.
|
|
@@ -96,20 +93,19 @@ export declare class DataspaceControlPlaneService implements IDataspaceControlPl
|
|
|
96
93
|
* registration ignores the runtime `endpoint` arg and silently POSTs to its
|
|
97
94
|
* static endpoint instead.
|
|
98
95
|
*/
|
|
99
|
-
prepareTransfer(agreementId: string, providerEndpoint: string,
|
|
96
|
+
prepareTransfer(agreementId: string, providerEndpoint: string, format: string, trustPayload: unknown): Promise<{
|
|
100
97
|
consumerPid: string;
|
|
101
98
|
}>;
|
|
102
99
|
/**
|
|
103
100
|
* Start a Transfer Process.
|
|
104
101
|
* Transitions Transfer Process from REQUESTED to STARTED state or resumes from SUSPENDED state.
|
|
105
102
|
* @param message Transfer start message (DSP compliant).
|
|
106
|
-
* @param
|
|
107
|
-
* @param trustPayload Trust payload containing authorization information (Base64-encoded token).
|
|
103
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
108
104
|
* @returns Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or TransferError if the operation fails.
|
|
109
105
|
*
|
|
110
106
|
* Role Performed: Provider / Consumer
|
|
111
107
|
*/
|
|
112
|
-
startTransfer(message: IDataspaceProtocolTransferStartMessage,
|
|
108
|
+
startTransfer(message: IDataspaceProtocolTransferStartMessage, trustPayload: unknown): Promise<IDataspaceProtocolTransferStartMessage | IDataspaceProtocolTransferError>;
|
|
113
109
|
/**
|
|
114
110
|
* Start a Transfer Process as the Provider.
|
|
115
111
|
* Builds a TransferStartMessage for a transfer already accepted by this node (REQUESTED, or
|
|
@@ -119,36 +115,35 @@ export declare class DataspaceControlPlaneService implements IDataspaceControlPl
|
|
|
119
115
|
* the provider, builds the dataAddress for PULL, persists STARTED, and delivers to the consumer).
|
|
120
116
|
* This is the provider-side mirror of prepareTransfer.
|
|
121
117
|
* @param pid The Process ID (consumerPid or providerPid) identifying the transfer to start.
|
|
122
|
-
* @param publicOrigin The public origin URL of this provider node (used to build the data plane endpoint for PULL transfers).
|
|
123
118
|
* @param trustPayload Trust payload proving the caller is the provider.
|
|
124
119
|
* @returns Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or TransferError if the operation fails.
|
|
125
120
|
*/
|
|
126
|
-
transferStarted(pid: string,
|
|
121
|
+
transferStarted(pid: string, trustPayload: unknown): Promise<IDataspaceProtocolTransferStartMessage | IDataspaceProtocolTransferError>;
|
|
127
122
|
/**
|
|
128
123
|
* Complete a Transfer Process.
|
|
129
124
|
* @param message Transfer completion message (DSP compliant).
|
|
130
|
-
* @param trustPayload Trust payload containing authorization information
|
|
125
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
131
126
|
* @returns Transfer Process (DSP compliant) with state COMPLETED, or TransferError if the operation fails.
|
|
132
127
|
*/
|
|
133
128
|
completeTransfer(message: IDataspaceProtocolTransferCompletionMessage, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
|
|
134
129
|
/**
|
|
135
130
|
* Suspend a Transfer Process.
|
|
136
131
|
* @param message Transfer suspension message (DSP compliant).
|
|
137
|
-
* @param trustPayload Trust payload containing authorization information
|
|
132
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
138
133
|
* @returns Transfer Process (DSP compliant) with state SUSPENDED, or TransferError if the operation fails.
|
|
139
134
|
*/
|
|
140
135
|
suspendTransfer(message: IDataspaceProtocolTransferSuspensionMessage, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
|
|
141
136
|
/**
|
|
142
137
|
* Terminate a Transfer Process.
|
|
143
138
|
* @param message Transfer termination message (DSP compliant).
|
|
144
|
-
* @param trustPayload Trust payload containing authorization information
|
|
139
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
145
140
|
* @returns Transfer Process (DSP compliant) with state TERMINATED, or TransferError if the operation fails.
|
|
146
141
|
*/
|
|
147
142
|
terminateTransfer(message: IDataspaceProtocolTransferTerminationMessage, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
|
|
148
143
|
/**
|
|
149
144
|
* Get Transfer Process state.
|
|
150
145
|
* @param pid Process ID (consumerPid or providerPid).
|
|
151
|
-
* @param trustPayload Trust payload containing authorization information
|
|
146
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
152
147
|
* @returns Transfer Process (DSP compliant) with current state, or TransferError if the operation fails.
|
|
153
148
|
*/
|
|
154
149
|
getTransferProcess(pid: string, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
|
|
@@ -160,11 +155,10 @@ export declare class DataspaceControlPlaneService implements IDataspaceControlPl
|
|
|
160
155
|
* @param datasetId The dataset ID from the provider's catalog.
|
|
161
156
|
* @param offerId The offer ID from the provider's catalog.
|
|
162
157
|
* @param providerEndpoint The provider's contract negotiation endpoint URL.
|
|
163
|
-
* @param publicOrigin The public origin URL of this control plane (for callbacks).
|
|
164
158
|
* @param trustPayload The trust payload for authentication.
|
|
165
159
|
* @returns The negotiation ID. Use the registered callback for completion notification.
|
|
166
160
|
*/
|
|
167
|
-
negotiateAgreement(datasetId: string, offerId: string, providerEndpoint: string,
|
|
161
|
+
negotiateAgreement(datasetId: string, offerId: string, providerEndpoint: string, trustPayload: unknown): Promise<{
|
|
168
162
|
negotiationId: string;
|
|
169
163
|
}>;
|
|
170
164
|
/**
|
|
@@ -194,14 +188,14 @@ export declare class DataspaceControlPlaneService implements IDataspaceControlPl
|
|
|
194
188
|
/**
|
|
195
189
|
* Resolve consumerPid to Transfer Context.
|
|
196
190
|
* @param consumerPid Consumer Process ID.
|
|
197
|
-
* @param trustPayload Trust payload containing authorization information
|
|
191
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
198
192
|
* @returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.
|
|
199
193
|
*/
|
|
200
194
|
resolveConsumerPid(consumerPid: string, trustPayload: unknown): Promise<ITransferContext>;
|
|
201
195
|
/**
|
|
202
196
|
* Resolve providerPid to Transfer Context.
|
|
203
197
|
* @param providerPid Provider Process ID.
|
|
204
|
-
* @param trustPayload Trust payload containing authorization information
|
|
198
|
+
* @param trustPayload Trust payload containing authorization information.
|
|
205
199
|
* @returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.
|
|
206
200
|
*/
|
|
207
201
|
resolveProviderPid(providerPid: string, trustPayload: unknown): Promise<ITransferContext>;
|
|
@@ -9,7 +9,7 @@ export interface IDataspaceControlPlaneServiceConfig {
|
|
|
9
9
|
overrideTrustGeneratorType?: string;
|
|
10
10
|
/**
|
|
11
11
|
* Data plane endpoint path for PULL transfers (path only, not full URL).
|
|
12
|
-
* Will be combined with the public origin
|
|
12
|
+
* Will be combined with the public origin.
|
|
13
13
|
*
|
|
14
14
|
* REQUIRED if PULL transfers are supported.
|
|
15
15
|
* If not specified, PULL transfers will not be available.
|
|
@@ -81,6 +81,10 @@ export interface IDataspaceControlPlaneServiceConstructorOptions {
|
|
|
81
81
|
* @default platform
|
|
82
82
|
*/
|
|
83
83
|
platformComponentType?: string;
|
|
84
|
+
/**
|
|
85
|
+
* The component type for the optional telemetry component used for metrics, defaults to no telemetry.
|
|
86
|
+
*/
|
|
87
|
+
telemetryComponentType?: string;
|
|
84
88
|
/**
|
|
85
89
|
* The configuration of the Dataspace Control Plane Service.
|
|
86
90
|
*/
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,34 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.49](https://github.com/iotaledger/twin-dataspace/compare/dataspace-control-plane-service-v0.0.3-next.48...dataspace-control-plane-service-v0.0.3-next.49) (2026-06-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add telemetry metrics to dataspace control and data plane services ([#212](https://github.com/iotaledger/twin-dataspace/issues/212)) ([b5b0248](https://github.com/iotaledger/twin-dataspace/commit/b5b024899ed12c0f639c5d51aefa3e509753eac6))
|
|
9
|
+
* remove datasetsHandled method from apps ([9fdc950](https://github.com/iotaledger/twin-dataspace/commit/9fdc95018d38ab49c4a1094642be2ee83ee0e4cd))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Dependencies
|
|
13
|
+
|
|
14
|
+
* The following workspace dependencies were updated
|
|
15
|
+
* dependencies
|
|
16
|
+
* @twin.org/dataspace-models bumped from 0.0.3-next.48 to 0.0.3-next.49
|
|
17
|
+
|
|
18
|
+
## [0.0.3-next.48](https://github.com/iotaledger/twin-dataspace/compare/dataspace-control-plane-service-v0.0.3-next.47...dataspace-control-plane-service-v0.0.3-next.48) (2026-06-18)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
|
|
23
|
+
* remove hosting component ([#209](https://github.com/iotaledger/twin-dataspace/issues/209)) ([5e19328](https://github.com/iotaledger/twin-dataspace/commit/5e1932823aa8a0f88f559f096610b9df1f3b8615))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/dataspace-models bumped from 0.0.3-next.47 to 0.0.3-next.48
|
|
31
|
+
|
|
3
32
|
## [0.0.3-next.47](https://github.com/iotaledger/twin-dataspace/compare/dataspace-control-plane-service-v0.0.3-next.46...dataspace-control-plane-service-v0.0.3-next.47) (2026-06-17)
|
|
4
33
|
|
|
5
34
|
|
|
@@ -223,7 +223,7 @@ A promise that resolves when the cleanup task has been removed.
|
|
|
223
223
|
|
|
224
224
|
### requestTransfer() {#requesttransfer}
|
|
225
225
|
|
|
226
|
-
> **requestTransfer**(`request`, `
|
|
226
|
+
> **requestTransfer**(`request`, `options`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferProcess`\>
|
|
227
227
|
|
|
228
228
|
Request a Transfer Process.
|
|
229
229
|
Creates a new Transfer Process in REQUESTED state.
|
|
@@ -236,13 +236,6 @@ Creates a new Transfer Process in REQUESTED state.
|
|
|
236
236
|
|
|
237
237
|
Transfer request message (DSP compliant).
|
|
238
238
|
|
|
239
|
-
##### publicOrigin
|
|
240
|
-
|
|
241
|
-
`string`
|
|
242
|
-
|
|
243
|
-
The public origin of this provider node, resolved by the REST route from the
|
|
244
|
-
hosting component; used to build the data-plane endpoint when auto-starting.
|
|
245
|
-
|
|
246
239
|
##### options
|
|
247
240
|
|
|
248
241
|
\{ `autoStart?`: `boolean`; \} \| `undefined`
|
|
@@ -289,7 +282,7 @@ Called by: Consumer when it wants to request a new Transfer Process
|
|
|
289
282
|
|
|
290
283
|
### prepareTransfer() {#preparetransfer}
|
|
291
284
|
|
|
292
|
-
> **prepareTransfer**(`agreementId`, `providerEndpoint`, `
|
|
285
|
+
> **prepareTransfer**(`agreementId`, `providerEndpoint`, `format`, `trustPayload`): `Promise`\<\{ `consumerPid`: `string`; \}\>
|
|
293
286
|
|
|
294
287
|
Prepare a data transfer as a Consumer.
|
|
295
288
|
Generates a consumerPid, POSTs a TransferRequestMessage to the provider's DSP endpoint,
|
|
@@ -309,12 +302,6 @@ The finalized agreement ID from contract negotiation.
|
|
|
309
302
|
|
|
310
303
|
The provider's DSP control plane base URL.
|
|
311
304
|
|
|
312
|
-
##### publicOrigin
|
|
313
|
-
|
|
314
|
-
`string`
|
|
315
|
-
|
|
316
|
-
The public origin URL of this control plane (used as callbackAddress).
|
|
317
|
-
|
|
318
305
|
##### format
|
|
319
306
|
|
|
320
307
|
`string`
|
|
@@ -349,7 +336,7 @@ static endpoint instead.
|
|
|
349
336
|
|
|
350
337
|
### startTransfer() {#starttransfer}
|
|
351
338
|
|
|
352
|
-
> **startTransfer**(`message`, `
|
|
339
|
+
> **startTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferStartMessage`\>
|
|
353
340
|
|
|
354
341
|
Start a Transfer Process.
|
|
355
342
|
Transitions Transfer Process from REQUESTED to STARTED state or resumes from SUSPENDED state.
|
|
@@ -362,12 +349,6 @@ Transitions Transfer Process from REQUESTED to STARTED state or resumes from SUS
|
|
|
362
349
|
|
|
363
350
|
Transfer start message (DSP compliant).
|
|
364
351
|
|
|
365
|
-
##### publicOrigin
|
|
366
|
-
|
|
367
|
-
`string`
|
|
368
|
-
|
|
369
|
-
The public origin URL of this service.
|
|
370
|
-
|
|
371
352
|
##### trustPayload
|
|
372
353
|
|
|
373
354
|
`unknown`
|
|
@@ -390,7 +371,7 @@ Role Performed: Provider / Consumer
|
|
|
390
371
|
|
|
391
372
|
### transferStarted() {#transferstarted}
|
|
392
373
|
|
|
393
|
-
> **transferStarted**(`pid`, `
|
|
374
|
+
> **transferStarted**(`pid`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferStartMessage`\>
|
|
394
375
|
|
|
395
376
|
Start a Transfer Process as the Provider.
|
|
396
377
|
Builds a TransferStartMessage for a transfer already accepted by this node (REQUESTED, or
|
|
@@ -408,12 +389,6 @@ This is the provider-side mirror of prepareTransfer.
|
|
|
408
389
|
|
|
409
390
|
The Process ID (consumerPid or providerPid) identifying the transfer to start.
|
|
410
391
|
|
|
411
|
-
##### publicOrigin
|
|
412
|
-
|
|
413
|
-
`string`
|
|
414
|
-
|
|
415
|
-
The public origin URL of this provider node (used to build the data plane endpoint for PULL transfers).
|
|
416
|
-
|
|
417
392
|
##### trustPayload
|
|
418
393
|
|
|
419
394
|
`unknown`
|
|
@@ -562,7 +537,7 @@ Transfer Process (DSP compliant) with current state, or TransferError if the ope
|
|
|
562
537
|
|
|
563
538
|
### negotiateAgreement() {#negotiateagreement}
|
|
564
539
|
|
|
565
|
-
> **negotiateAgreement**(`datasetId`, `offerId`, `providerEndpoint`, `
|
|
540
|
+
> **negotiateAgreement**(`datasetId`, `offerId`, `providerEndpoint`, `trustPayload`): `Promise`\<\{ `negotiationId`: `string`; \}\>
|
|
566
541
|
|
|
567
542
|
Negotiate a contract agreement with a provider.
|
|
568
543
|
Returns immediately with a negotiationId. The caller is notified
|
|
@@ -588,12 +563,6 @@ The offer ID from the provider's catalog.
|
|
|
588
563
|
|
|
589
564
|
The provider's contract negotiation endpoint URL.
|
|
590
565
|
|
|
591
|
-
##### publicOrigin
|
|
592
|
-
|
|
593
|
-
`string`
|
|
594
|
-
|
|
595
|
-
The public origin URL of this control plane (for callbacks).
|
|
596
|
-
|
|
597
566
|
##### trustPayload
|
|
598
567
|
|
|
599
568
|
`unknown`
|
|
@@ -18,7 +18,7 @@ If not specified, the default trust generator configured in the trust component
|
|
|
18
18
|
> `optional` **dataPlanePath?**: `string`
|
|
19
19
|
|
|
20
20
|
Data plane endpoint path for PULL transfers (path only, not full URL).
|
|
21
|
-
Will be combined with the public origin
|
|
21
|
+
Will be combined with the public origin.
|
|
22
22
|
|
|
23
23
|
REQUIRED if PULL transfers are supported.
|
|
24
24
|
If not specified, PULL transfers will not be available.
|
|
@@ -203,6 +203,14 @@ platform
|
|
|
203
203
|
|
|
204
204
|
***
|
|
205
205
|
|
|
206
|
+
### telemetryComponentType? {#telemetrycomponenttype}
|
|
207
|
+
|
|
208
|
+
> `optional` **telemetryComponentType?**: `string`
|
|
209
|
+
|
|
210
|
+
The component type for the optional telemetry component used for metrics, defaults to no telemetry.
|
|
211
|
+
|
|
212
|
+
***
|
|
213
|
+
|
|
206
214
|
### config? {#config}
|
|
207
215
|
|
|
208
216
|
> `optional` **config?**: [`IDataspaceControlPlaneServiceConfig`](IDataspaceControlPlaneServiceConfig.md)
|
package/locales/en.json
CHANGED
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
"invalidTransferSuspensionMessage": "Transfer Suspension Message does not conform to Dataspace Protocol specification",
|
|
72
72
|
"invalidTransferTerminationMessage": "Transfer Termination Message does not conform to Dataspace Protocol specification",
|
|
73
73
|
"agreementLookupFailed": "Failed to lookup Agreement: {agreementId}",
|
|
74
|
-
"agreementNotFound": "Agreement not found",
|
|
74
|
+
"agreementNotFound": "Agreement not found \"{notFoundId}\"",
|
|
75
75
|
"agreementMissingTarget": "Agreement is missing target (dataset): {agreementId}",
|
|
76
76
|
"agreementMultipleTargetsNotSupported": "Agreement has multiple targets which is not supported. Only single target Agreements are allowed: {agreementId}, target count: {targetCount}",
|
|
77
77
|
"agreementTargetMissingUid": "Agreement target object is missing required \"uid\" property: {agreementId}",
|
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.49",
|
|
4
4
|
"description": "Implements agreement negotiation and transfer process lifecycle management for control plane operations.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"@twin.org/context": "next",
|
|
20
20
|
"@twin.org/core": "next",
|
|
21
21
|
"@twin.org/crypto": "next",
|
|
22
|
-
"@twin.org/dataspace-models": "0.0.3-next.
|
|
22
|
+
"@twin.org/dataspace-models": "0.0.3-next.49",
|
|
23
23
|
"@twin.org/entity": "next",
|
|
24
24
|
"@twin.org/entity-storage-models": "next",
|
|
25
25
|
"@twin.org/federated-catalogue-models": "next",
|
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
"@twin.org/rights-management-models": "next",
|
|
29
29
|
"@twin.org/standards-dataspace-protocol": "next",
|
|
30
30
|
"@twin.org/standards-w3c-odrl": "next",
|
|
31
|
+
"@twin.org/telemetry-models": "next",
|
|
31
32
|
"@twin.org/trust-models": "next",
|
|
32
33
|
"@twin.org/vault-models": "next"
|
|
33
34
|
},
|