@twin.org/dataspace-models 0.0.3-next.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +63 -0
- package/dist/es/entities/transferProcess.js +137 -0
- package/dist/es/entities/transferProcess.js.map +1 -0
- package/dist/es/factories/dataspaceAppFactory.js +9 -0
- package/dist/es/factories/dataspaceAppFactory.js.map +1 -0
- package/dist/es/index.js +58 -0
- package/dist/es/index.js.map +1 -0
- package/dist/es/models/IActivityLogDates.js +4 -0
- package/dist/es/models/IActivityLogDates.js.map +1 -0
- package/dist/es/models/IActivityLogDetails.js +4 -0
- package/dist/es/models/IActivityLogDetails.js.map +1 -0
- package/dist/es/models/IActivityLogEntry.js +2 -0
- package/dist/es/models/IActivityLogEntry.js.map +1 -0
- package/dist/es/models/IActivityLogStatusNotification.js +2 -0
- package/dist/es/models/IActivityLogStatusNotification.js.map +1 -0
- package/dist/es/models/IActivityTask.js +2 -0
- package/dist/es/models/IActivityTask.js.map +1 -0
- package/dist/es/models/IDataAssetItemList.js +2 -0
- package/dist/es/models/IDataAssetItemList.js.map +1 -0
- package/dist/es/models/IDataAssetItemListResult.js +2 -0
- package/dist/es/models/IDataAssetItemListResult.js.map +1 -0
- package/dist/es/models/IEntitySet.js +4 -0
- package/dist/es/models/IEntitySet.js.map +1 -0
- package/dist/es/models/IExecutionPayload.js +2 -0
- package/dist/es/models/IExecutionPayload.js.map +1 -0
- package/dist/es/models/IFilteringQuery.js +2 -0
- package/dist/es/models/IFilteringQuery.js.map +1 -0
- package/dist/es/models/ITaskApp.js +4 -0
- package/dist/es/models/ITaskApp.js.map +1 -0
- package/dist/es/models/activityProcessingStatus.js +29 -0
- package/dist/es/models/activityProcessingStatus.js.map +1 -0
- package/dist/es/models/api/IActivityLogEntryGetRequest.js +4 -0
- package/dist/es/models/api/IActivityLogEntryGetRequest.js.map +1 -0
- package/dist/es/models/api/IActivityLogEntryGetResponse.js +2 -0
- package/dist/es/models/api/IActivityLogEntryGetResponse.js.map +1 -0
- package/dist/es/models/api/IActivityLogStatusNotificationPayload.js +2 -0
- package/dist/es/models/api/IActivityLogStatusNotificationPayload.js.map +1 -0
- package/dist/es/models/api/IActivityLogStatusRequest.js +4 -0
- package/dist/es/models/api/IActivityLogStatusRequest.js.map +1 -0
- package/dist/es/models/api/IActivityStreamNotifyRequest.js +2 -0
- package/dist/es/models/api/IActivityStreamNotifyRequest.js.map +1 -0
- package/dist/es/models/api/IDataAssetEntitiesResponse.js +2 -0
- package/dist/es/models/api/IDataAssetEntitiesResponse.js.map +1 -0
- package/dist/es/models/api/IDataAssetGetEntitiesRequest.js +2 -0
- package/dist/es/models/api/IDataAssetGetEntitiesRequest.js.map +1 -0
- package/dist/es/models/api/IDataAssetQueryRequest.js +2 -0
- package/dist/es/models/api/IDataAssetQueryRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/ICompleteTransferRequest.js +2 -0
- package/dist/es/models/api/control-plane/ICompleteTransferRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/ICompleteTransferResponse.js +2 -0
- package/dist/es/models/api/control-plane/ICompleteTransferResponse.js.map +1 -0
- package/dist/es/models/api/control-plane/IGetTransferProcessRequest.js +2 -0
- package/dist/es/models/api/control-plane/IGetTransferProcessRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/IGetTransferProcessResponse.js +2 -0
- package/dist/es/models/api/control-plane/IGetTransferProcessResponse.js.map +1 -0
- package/dist/es/models/api/control-plane/IRequestTransferRequest.js +2 -0
- package/dist/es/models/api/control-plane/IRequestTransferRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/IRequestTransferResponse.js +2 -0
- package/dist/es/models/api/control-plane/IRequestTransferResponse.js.map +1 -0
- package/dist/es/models/api/control-plane/IStartTransferRequest.js +2 -0
- package/dist/es/models/api/control-plane/IStartTransferRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/IStartTransferResponse.js +2 -0
- package/dist/es/models/api/control-plane/IStartTransferResponse.js.map +1 -0
- package/dist/es/models/api/control-plane/ISuspendTransferRequest.js +2 -0
- package/dist/es/models/api/control-plane/ISuspendTransferRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/ISuspendTransferResponse.js +2 -0
- package/dist/es/models/api/control-plane/ISuspendTransferResponse.js.map +1 -0
- package/dist/es/models/api/control-plane/ITerminateTransferRequest.js +2 -0
- package/dist/es/models/api/control-plane/ITerminateTransferRequest.js.map +1 -0
- package/dist/es/models/api/control-plane/ITerminateTransferResponse.js +2 -0
- package/dist/es/models/api/control-plane/ITerminateTransferResponse.js.map +1 -0
- package/dist/es/models/app/IActivityQuery.js +4 -0
- package/dist/es/models/app/IActivityQuery.js.map +1 -0
- package/dist/es/models/app/IDataAssetEntitiesRequest.js +2 -0
- package/dist/es/models/app/IDataAssetEntitiesRequest.js.map +1 -0
- package/dist/es/models/app/IDataAssetQuery.js +4 -0
- package/dist/es/models/app/IDataAssetQuery.js.map +1 -0
- package/dist/es/models/app/IDataRequest.js +2 -0
- package/dist/es/models/app/IDataRequest.js.map +1 -0
- package/dist/es/models/app/IDataspaceApp.js +2 -0
- package/dist/es/models/app/IDataspaceApp.js.map +1 -0
- package/dist/es/models/app/IQueryDataAssetRequest.js +2 -0
- package/dist/es/models/app/IQueryDataAssetRequest.js.map +1 -0
- package/dist/es/models/app/dataRequestType.js +17 -0
- package/dist/es/models/app/dataRequestType.js.map +1 -0
- package/dist/es/models/control-plane/IDataspaceControlPlaneComponent.js +2 -0
- package/dist/es/models/control-plane/IDataspaceControlPlaneComponent.js.map +1 -0
- package/dist/es/models/control-plane/IDataspaceControlPlaneResolverComponent.js +2 -0
- package/dist/es/models/control-plane/IDataspaceControlPlaneResolverComponent.js.map +1 -0
- package/dist/es/models/control-plane/INegotiationCallback.js +4 -0
- package/dist/es/models/control-plane/INegotiationCallback.js.map +1 -0
- package/dist/es/models/control-plane/ITransferContext.js +2 -0
- package/dist/es/models/control-plane/ITransferContext.js.map +1 -0
- package/dist/es/models/control-plane/ITransferProcess.js +2 -0
- package/dist/es/models/control-plane/ITransferProcess.js.map +1 -0
- package/dist/es/models/control-plane/api/ITransferContextResponse.js +2 -0
- package/dist/es/models/control-plane/api/ITransferContextResponse.js.map +1 -0
- package/dist/es/models/control-plane/transferProcessRole.js +18 -0
- package/dist/es/models/control-plane/transferProcessRole.js.map +1 -0
- package/dist/es/models/data-plane/IDataspaceDataPlaneComponent.js +2 -0
- package/dist/es/models/data-plane/IDataspaceDataPlaneComponent.js.map +1 -0
- package/dist/types/entities/transferProcess.d.ts +71 -0
- package/dist/types/factories/dataspaceAppFactory.d.ts +6 -0
- package/dist/types/index.d.ts +49 -0
- package/dist/types/models/IActivityLogDates.d.ts +13 -0
- package/dist/types/models/IActivityLogDetails.d.ts +29 -0
- package/dist/types/models/IActivityLogEntry.d.ts +40 -0
- package/dist/types/models/IActivityLogStatusNotification.d.ts +31 -0
- package/dist/types/models/IActivityTask.d.ts +14 -0
- package/dist/types/models/IDataAssetItemList.d.ts +21 -0
- package/dist/types/models/IDataAssetItemListResult.d.ts +16 -0
- package/dist/types/models/IEntitySet.d.ts +13 -0
- package/dist/types/models/IExecutionPayload.d.ts +18 -0
- package/dist/types/models/IFilteringQuery.d.ts +18 -0
- package/dist/types/models/ITaskApp.d.ts +13 -0
- package/dist/types/models/activityProcessingStatus.d.ts +29 -0
- package/dist/types/models/api/IActivityLogEntryGetRequest.d.ts +14 -0
- package/dist/types/models/api/IActivityLogEntryGetResponse.d.ts +10 -0
- package/dist/types/models/api/IActivityLogStatusNotificationPayload.d.ts +10 -0
- package/dist/types/models/api/IActivityLogStatusRequest.d.ts +18 -0
- package/dist/types/models/api/IActivityStreamNotifyRequest.d.ts +10 -0
- package/dist/types/models/api/IDataAssetEntitiesResponse.d.ts +17 -0
- package/dist/types/models/api/IDataAssetGetEntitiesRequest.d.ts +43 -0
- package/dist/types/models/api/IDataAssetQueryRequest.d.ts +42 -0
- package/dist/types/models/api/control-plane/ICompleteTransferRequest.d.ts +26 -0
- package/dist/types/models/api/control-plane/ICompleteTransferResponse.d.ts +15 -0
- package/dist/types/models/api/control-plane/IGetTransferProcessRequest.d.ts +21 -0
- package/dist/types/models/api/control-plane/IGetTransferProcessResponse.d.ts +15 -0
- package/dist/types/models/api/control-plane/IRequestTransferRequest.d.ts +17 -0
- package/dist/types/models/api/control-plane/IRequestTransferResponse.d.ts +15 -0
- package/dist/types/models/api/control-plane/IStartTransferRequest.d.ts +26 -0
- package/dist/types/models/api/control-plane/IStartTransferResponse.d.ts +15 -0
- package/dist/types/models/api/control-plane/ISuspendTransferRequest.d.ts +26 -0
- package/dist/types/models/api/control-plane/ISuspendTransferResponse.d.ts +15 -0
- package/dist/types/models/api/control-plane/ITerminateTransferRequest.d.ts +26 -0
- package/dist/types/models/api/control-plane/ITerminateTransferResponse.d.ts +15 -0
- package/dist/types/models/app/IActivityQuery.d.ts +17 -0
- package/dist/types/models/app/IDataAssetEntitiesRequest.d.ts +20 -0
- package/dist/types/models/app/IDataAssetQuery.d.ts +15 -0
- package/dist/types/models/app/IDataRequest.d.ts +6 -0
- package/dist/types/models/app/IDataspaceApp.d.ts +43 -0
- package/dist/types/models/app/IQueryDataAssetRequest.d.ts +20 -0
- package/dist/types/models/app/dataRequestType.d.ts +17 -0
- package/dist/types/models/control-plane/IDataspaceControlPlaneComponent.d.ts +179 -0
- package/dist/types/models/control-plane/IDataspaceControlPlaneResolverComponent.d.ts +55 -0
- package/dist/types/models/control-plane/INegotiationCallback.d.ts +37 -0
- package/dist/types/models/control-plane/ITransferContext.d.ts +52 -0
- package/dist/types/models/control-plane/ITransferProcess.d.ts +81 -0
- package/dist/types/models/control-plane/api/ITransferContextResponse.d.ts +12 -0
- package/dist/types/models/control-plane/transferProcessRole.d.ts +18 -0
- package/dist/types/models/data-plane/IDataspaceDataPlaneComponent.d.ts +65 -0
- package/docs/changelog.md +162 -0
- package/docs/examples.md +1 -0
- package/docs/reference/classes/TransferProcess.md +137 -0
- package/docs/reference/index.md +65 -0
- package/docs/reference/interfaces/IActivityLogDates.md +19 -0
- package/docs/reference/interfaces/IActivityLogDetails.md +55 -0
- package/docs/reference/interfaces/IActivityLogEntry.md +119 -0
- package/docs/reference/interfaces/IActivityLogEntryGetRequest.md +17 -0
- package/docs/reference/interfaces/IActivityLogEntryGetResponse.md +11 -0
- package/docs/reference/interfaces/IActivityLogStatusNotification.md +45 -0
- package/docs/reference/interfaces/IActivityLogStatusNotificationPayload.md +11 -0
- package/docs/reference/interfaces/IActivityLogStatusRequest.md +23 -0
- package/docs/reference/interfaces/IActivityQuery.md +27 -0
- package/docs/reference/interfaces/IActivityStreamNotifyRequest.md +11 -0
- package/docs/reference/interfaces/IActivityTask.md +19 -0
- package/docs/reference/interfaces/ICompleteTransferRequest.md +37 -0
- package/docs/reference/interfaces/ICompleteTransferResponse.md +19 -0
- package/docs/reference/interfaces/IDataAssetEntitiesRequest.md +27 -0
- package/docs/reference/interfaces/IDataAssetEntitiesResponse.md +23 -0
- package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md +61 -0
- package/docs/reference/interfaces/IDataAssetItemList.md +28 -0
- package/docs/reference/interfaces/IDataAssetItemListResult.md +21 -0
- package/docs/reference/interfaces/IDataAssetQuery.md +19 -0
- package/docs/reference/interfaces/IDataAssetQueryRequest.md +58 -0
- package/docs/reference/interfaces/IDataspaceApp.md +111 -0
- package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +402 -0
- package/docs/reference/interfaces/IDataspaceControlPlaneResolverComponent.md +113 -0
- package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +200 -0
- package/docs/reference/interfaces/IEntitySet.md +19 -0
- package/docs/reference/interfaces/IExecutionPayload.md +27 -0
- package/docs/reference/interfaces/IFilteringQuery.md +27 -0
- package/docs/reference/interfaces/IGetTransferProcessRequest.md +29 -0
- package/docs/reference/interfaces/IGetTransferProcessResponse.md +19 -0
- package/docs/reference/interfaces/INegotiationCallback.md +106 -0
- package/docs/reference/interfaces/IQueryDataAssetRequest.md +27 -0
- package/docs/reference/interfaces/IRequestTransferRequest.md +23 -0
- package/docs/reference/interfaces/IRequestTransferResponse.md +19 -0
- package/docs/reference/interfaces/IStartTransferRequest.md +37 -0
- package/docs/reference/interfaces/IStartTransferResponse.md +19 -0
- package/docs/reference/interfaces/ISuspendTransferRequest.md +37 -0
- package/docs/reference/interfaces/ISuspendTransferResponse.md +19 -0
- package/docs/reference/interfaces/ITaskApp.md +19 -0
- package/docs/reference/interfaces/ITerminateTransferRequest.md +37 -0
- package/docs/reference/interfaces/ITerminateTransferResponse.md +19 -0
- package/docs/reference/interfaces/ITransferContext.md +84 -0
- package/docs/reference/interfaces/ITransferContextResponse.md +13 -0
- package/docs/reference/interfaces/ITransferProcess.md +137 -0
- package/docs/reference/type-aliases/ActivityProcessingStatus.md +5 -0
- package/docs/reference/type-aliases/DataRequestType.md +5 -0
- package/docs/reference/type-aliases/IDataRequest.md +5 -0
- package/docs/reference/type-aliases/TransferProcessRole.md +5 -0
- package/docs/reference/variables/ActivityProcessingStatus.md +37 -0
- package/docs/reference/variables/DataRequestType.md +19 -0
- package/docs/reference/variables/DataspaceAppFactory.md +5 -0
- package/docs/reference/variables/TransferProcessRole.md +20 -0
- package/package.json +62 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activityProcessingStatus.js","sourceRoot":"","sources":["../../../src/models/activityProcessingStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACvC;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,WAAW,EAAE,aAAa;CACjB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Activity processing statuses.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ActivityProcessingStatus = {\n\t/**\n\t * Pending: Activity Processing has not started yet.\n\t */\n\tPending: \"pending\",\n\n\t/**\n\t * Running Activity processing is running.\n\t */\n\tRunning: \"running\",\n\n\t/**\n\t * Completed: Activity processing completed without error.\n\t */\n\tCompleted: \"completed\",\n\n\t/**\n\t * Error: Activity processing cannot be performed and marked as in error. (Depends on application).\n\t */\n\tError: \"error\",\n\n\t/**\n\t * Transient state. The background tasks associated with the activity are still being registered.\n\t */\n\tRegistering: \"registering\"\n} as const;\n\n/**\n * The type exported.\n */\nexport type ActivityProcessingStatus =\n\t(typeof ActivityProcessingStatus)[keyof typeof ActivityProcessingStatus];\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityLogEntryGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IActivityLogEntryGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get Request for an Activity Log Entry.\n */\nexport interface IActivityLogEntryGetRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The ID of the entry to get.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityLogEntryGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IActivityLogEntryGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IActivityLogEntry } from \"../IActivityLogEntry.js\";\n\n/**\n * Service Offering response\n */\nexport interface IActivityLogEntryGetResponse {\n\t/**\n\t * The response payload.\n\t */\n\tbody: IActivityLogEntry;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityLogStatusNotificationPayload.js","sourceRoot":"","sources":["../../../../src/models/api/IActivityLogStatusNotificationPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IActivityLogStatusNotification } from \"../IActivityLogStatusNotification.js\";\n\n/**\n * The status supplied to clients of the Dataspace Data Plane\n */\nexport interface IActivityLogStatusNotificationPayload {\n\t/**\n\t * Body\n\t */\n\tbody: IActivityLogStatusNotification;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityLogStatusRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IActivityLogStatusRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Activity log status\n */\nexport interface IActivityLogStatusRequest {\n\t/**\n\t * Empty body.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The operation to perform.\n\t\t */\n\t\toperation: \"subscribe\" | \"unsubscribe\";\n\n\t\t/**\n\t\t * The subscription Id.\n\t\t */\n\t\tsubscriptionId: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityStreamNotifyRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IActivityStreamNotifyRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\n\n/**\n * Activity Stream Notify Request.\n */\nexport interface IActivityStreamNotifyRequest {\n\t/**\n\t * The Activity sent to the Stream.\n\t */\n\tbody: IActivityStreamsActivity;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataAssetEntitiesResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDataAssetEntitiesResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\nimport type { IDataAssetItemList } from \"../IDataAssetItemList.js\";\n\n/**\n * Response containing data asset entities with optional pagination Link header.\n */\nexport interface IDataAssetEntitiesResponse {\n\t/**\n\t * Optional headers.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * The response payload.\n\t */\n\tbody: IDataAssetItemList;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataAssetGetEntitiesRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataAssetGetEntitiesRequest.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 * Get Request Data Asset Entities\n */\nexport interface IDataAssetGetEntitiesRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The parameters from the query.\n\t */\n\tquery: {\n\t\t/**\n\t\t * The ID of the entity(ies) to get. (comma separated list)\n\t\t */\n\t\tid?: string;\n\n\t\t/**\n\t\t * The type of the entity to get.\n\t\t */\n\t\ttype: string;\n\n\t\t/**\n\t\t * The consumer Process ID from the DSP Transfer Process.\n\t\t * Mandatory - used to determine the Dataset, Distribution, and Agreement.\n\t\t * The datasetId is resolved from the Transfer Process using this ID.\n\t\t */\n\t\tconsumerPid: string;\n\n\t\t/**\n\t\t * The Id of the data service that offers the data asset\n\t\t */\n\t\tdataServiceId?: string;\n\n\t\t/**\n\t\t * The maximum number of entities to retrieve.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * Cursor to control pagination.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataAssetQueryRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDataAssetQueryRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\nimport type { IFilteringQuery } from \"../IFilteringQuery.js\";\n\n/**\n * Request to query data asset entities.\n */\nexport interface IDataAssetQueryRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * Request body containing the data asset and query criteria.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The consumer Process ID from the DSP Transfer Process.\n\t\t * Mandatory - used to determine the Dataset, Distribution, and Agreement.\n\t\t * The datasetId is resolved from the Transfer Process using this ID.\n\t\t */\n\t\tconsumerPid: string;\n\n\t\t/**\n\t\t * The filtering query.\n\t\t */\n\t\tquery: IFilteringQuery;\n\t};\n\n\t/**\n\t * Optional query parameters for pagination.\n\t * Used when following Link header URLs.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Opaque cursor token for pagination.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Maximum number of items to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityQuery.js","sourceRoot":"","sources":["../../../../src/models/app/IActivityQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * (Activity,Object,Target) query for denoting combinations to be handled by a Dataspace App.\n */\nexport interface IActivityQuery {\n\t/**\n\t * FQN of the Activity type.\n\t */\n\tactivityType?: string;\n\n\t/**\n\t * FQN of the Object Type.\n\t */\n\tobjectType: string;\n\n\t/**\n\t * FQN of the target type.\n\t */\n\ttargetType?: string;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataAssetEntitiesRequest.js","sourceRoot":"","sources":["../../../../src/models/app/IDataAssetEntitiesRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IEntitySet } from \"../IEntitySet.js\";\nimport type { DataRequestType } from \"./dataRequestType.js\";\n\n/**\n * Data Request type for representing data requests received by Dataspace Apps.\n */\nexport interface IDataAssetEntitiesRequest {\n\t/**\n\t * Data Asset Entities type.\n\t */\n\ttype: typeof DataRequestType.DataAssetEntities;\n\n\t/**\n\t * The data asset we are referring to.\n\t */\n\tdataAsset: IDataspaceProtocolDataset;\n\n\t/**\n\t * The entity set.\n\t * */\n\tentitySet: IEntitySet;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataAssetQuery.js","sourceRoot":"","sources":["../../../../src/models/app/IDataAssetQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Data Asset query for internal service matching of datasets to apps.\n *\n * This interface is used internally by the Dataspace Data Plane service to match\n * datasets with their corresponding apps. Apps should use `datasetsHandled(): IDataset[]`\n * to declare which datasets they handle.\n *\n * @see IDataspaceDataPlaneApp.datasetsHandled\n */\nexport interface IDataAssetQuery {\n\t/**\n\t * Id of the dataset in the Catalogue (dataset @id).\n\t */\n\tdatasetId: string;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataRequest.js","sourceRoot":"","sources":["../../../../src/models/app/IDataRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataAssetEntitiesRequest } from \"./IDataAssetEntitiesRequest.js\";\nimport type { IQueryDataAssetRequest } from \"./IQueryDataAssetRequest.js\";\n\n/**\n * Data Request type for representing data requests received by Dataspace Data Plane Apps.\n */\nexport type IDataRequest = IDataAssetEntitiesRequest | IQueryDataAssetRequest;\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataspaceApp.js","sourceRoot":"","sources":["../../../../src/models/app/IDataspaceApp.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\nimport type { IActivityQuery } from \"./IActivityQuery.js\";\nimport type { IDataRequest } from \"./IDataRequest.js\";\n\n/**\n * Interface describes a Dataspace App.\n */\nexport interface IDataspaceApp extends IComponent {\n\t/**\n\t * The activities handled by the App.\n\t * @returns A query that describes the set of activities handled by the App.\n\t */\n\tactivitiesHandled(): IActivityQuery[];\n\n\t/**\n\t * The datasets handled by the App.\n\t * @returns The Dataspace Protocol compliant datasets handled by the App.\n\t */\n\tdatasetsHandled(): Promise<IDataspaceProtocolDataset[]>;\n\n\t/**\n\t * The types of queries supported.\n\t * @returns The types of queries supported by the Dataspace App to retrieve data.\n\t */\n\tsupportedQueryTypes(): string[];\n\n\t/**\n\t * Handles an Activity and report about results through the Dataspace Data Plane Callback\n\t * @param activity The Activity to be handled\n\t * @returns The result of executing the Activity.\n\t */\n\thandleActivity?<T>(activity: IActivityStreamsActivity): Promise<T>;\n\n\t/**\n\t * Handles a Data Request.\n\t * @param dataRequest The data request.\n\t * @param cursor Cursor that points to the next item in the result set.\n\t * @param limit Maximum number of entries retrieved or to be retrieved.\n\t * @returns Data as JSON-Ld.\n\t */\n\thandleDataRequest?(\n\t\tdataRequest: IDataRequest,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ data: IJsonLdDocument; cursor?: string }>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IQueryDataAssetRequest.js","sourceRoot":"","sources":["../../../../src/models/app/IQueryDataAssetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IFilteringQuery } from \"../IFilteringQuery.js\";\nimport type { DataRequestType } from \"./dataRequestType.js\";\n\n/**\n * Data Request type for representing data requests received by Dataspace Apps.\n */\nexport interface IQueryDataAssetRequest {\n\t/**\n\t * Data Asset Entities type.\n\t */\n\ttype: typeof DataRequestType.QueryDataAsset;\n\n\t/**\n\t * The data asset we are referring to.\n\t */\n\tdataAsset: IDataspaceProtocolDataset;\n\n\t/**\n\t * Query to perform filtering.\n\t */\n\tquery: IFilteringQuery;\n}\n"]}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* Data Request Types.
|
|
5
|
+
*/
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
export const DataRequestType = {
|
|
8
|
+
/**
|
|
9
|
+
* Data Asset Entities
|
|
10
|
+
*/
|
|
11
|
+
DataAssetEntities: "DataAssetEntities",
|
|
12
|
+
/**
|
|
13
|
+
* Query over a data asset
|
|
14
|
+
*/
|
|
15
|
+
QueryDataAsset: "QueryDataAsset"
|
|
16
|
+
};
|
|
17
|
+
//# sourceMappingURL=dataRequestType.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dataRequestType.js","sourceRoot":"","sources":["../../../../src/models/app/dataRequestType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;IACtC;;OAEG;IACH,cAAc,EAAE,gBAAgB;CACvB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Data Request Types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataRequestType = {\n\t/**\n\t * Data Asset Entities\n\t */\n\tDataAssetEntities: \"DataAssetEntities\",\n\t/**\n\t * Query over a data asset\n\t */\n\tQueryDataAsset: \"QueryDataAsset\"\n} as const;\n\n/**\n * Data Request Types.\n */\nexport type DataRequestType = (typeof DataRequestType)[keyof typeof DataRequestType];\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
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 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\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"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataspaceControlPlaneResolverComponent.js","sourceRoot":"","sources":["../../../../src/models/control-plane/IDataspaceControlPlaneResolverComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { ITransferContext } from \"./ITransferContext.js\";\n\n/**\n * Dataspace Control Plane Resolver Component interface.\n * Provides methods for resolving transfer process information.\n * Used by dataspace-data-plane to retrieve dataset and policy information for data access.\n *\n * These methods are NOT part of the Eclipse Dataspace Protocol specification.\n * They are TWIN-specific extensions for internal service communication.\n *\n * IMPORTANT: This interface has NO REST client implementation - methods are only\n * accessible via ComponentFactory.get() for local, in-process service access.\n */\nexport interface IDataspaceControlPlaneResolverComponent extends IComponent {\n\t/**\n\t * Resolve consumerPid to Transfer Context.\n\t * Returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * Validates that Agreement assigner matches current organization ID for security.\n\t * This method is called by the dataspace-data-plane to resolve a consumerPid\n\t * to the corresponding Agreement and dataset information for data retrieval (pull mode).\n\t *\n\t * This method is only available via ComponentFactory.get().\n\t * There is no REST client implementation.\n\t *\n\t * @param consumerPid Consumer Process ID from the transfer request.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * The trust service handles verification and extracts identity and token.\n\t * @returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * @throws NotFoundError if Transfer Process not found.\n\t * @throws UnauthorizedError if trust verification fails or Agreement assigner doesn't match current organization.\n\t * @throws GeneralError if Transfer Process is terminated or Agreement lookup fails.\n\t */\n\tresolveConsumerPid(consumerPid: string, trustPayload: unknown): Promise<ITransferContext>;\n\n\t/**\n\t * Resolve providerPid to Transfer Context.\n\t * Returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * Used for push mode data transfer where Provider needs to push data to Consumer via Activity Stream.\n\t * Validates that Agreement assigner matches current organization ID and assignee matches expected consumer for security.\n\t *\n\t * This method is called by the Provider's dataspace-data-plane when it receives an Activity\n\t * referencing a providerPid and needs to resolve it to get Agreement, dataset, and consumer's dataAddress.\n\t *\n\t * This method is only available via ComponentFactory.get().\n\t * There is no REST client implementation.\n\t *\n\t * @param providerPid Provider Process ID from the transfer process.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * The trust service handles verification and extracts identity and token.\n\t * @returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * @throws NotFoundError if Transfer Process not found.\n\t * @throws UnauthorizedError if trust verification fails, Agreement assigner doesn't match current organization, or assignee doesn't match expected consumer.\n\t * @throws GeneralError if Transfer Process is terminated or Agreement lookup fails.\n\t */\n\tresolveProviderPid(providerPid: string, trustPayload: unknown): Promise<ITransferContext>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"INegotiationCallback.js","sourceRoot":"","sources":["../../../../src/models/control-plane/INegotiationCallback.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport type { DataspaceProtocolContractNegotiationStateType } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IOdrlAgreement, IOdrlOffer } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Callback interface for negotiation state change notifications.\n * Upstream modules register an implementation of this interface\n * via IDataspaceControlPlaneComponent.registerNegotiationCallback()\n * to be notified when PNP callbacks fire.\n */\nexport interface INegotiationCallback {\n\t/**\n\t * Called when the negotiation state changes (offer received, agreement received).\n\t * @param negotiationId The negotiation ID.\n\t * @param state The new state.\n\t * @param data Optional data associated with the state change.\n\t * @param data.offer The offer received from the provider.\n\t * @param data.agreement The agreement received from the provider.\n\t * @returns Nothing.\n\t */\n\tonStateChanged(\n\t\tnegotiationId: string,\n\t\tstate: DataspaceProtocolContractNegotiationStateType,\n\t\tdata?: { offer?: IOdrlOffer; agreement?: IOdrlAgreement }\n\t): Promise<void>;\n\n\t/**\n\t * Called when the negotiation completes successfully (finalized).\n\t * @param negotiationId The negotiation ID.\n\t * @param agreementId The agreement ID (from agreement.uid).\n\t * @returns Nothing.\n\t */\n\tonCompleted(negotiationId: string, agreementId: string): Promise<void>;\n\n\t/**\n\t * Called when the negotiation fails (terminated or stalled).\n\t * @param negotiationId The negotiation ID.\n\t * @param reason The failure reason.\n\t * @returns Nothing.\n\t */\n\tonFailed(negotiationId: string, reason: string): Promise<void>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ITransferContext.js","sourceRoot":"","sources":["../../../../src/models/control-plane/ITransferContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolDataAddress\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { IOdrlAgreement } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Transfer Context data structure.\n * Contains all information needed by DSC to execute queries.\n * This is NOT part of the DSP protocol - it's a TWIN internal API\n * used by dataspace-control-plane to resolve consumerPid to datasetId and policies.\n */\nexport interface ITransferContext {\n\t/**\n\t * Consumer Process ID.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * Provider Process ID.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * Agreement associated with this Transfer Process.\n\t * Contains permissions, obligations, and prohibitions that DSC uses for runtime policy enforcement.\n\t */\n\tagreement: IOdrlAgreement;\n\n\t/**\n\t * Dataset ID - what the DSC needs to execute the query.\n\t * Convenience field extracted from agreement.target for quick access.\n\t */\n\tdatasetId: string;\n\n\t/**\n\t * Offer ID.\n\t */\n\tofferId: string;\n\n\t/**\n\t * Current Transfer Process state.\n\t * DSC should only allow queries if state is STARTED.\n\t */\n\tstate: DataspaceProtocolTransferProcessStateType;\n\n\t/**\n\t * Consumer identity (for auditing).\n\t */\n\tconsumerIdentity?: string;\n\n\t/**\n\t * Provider identity (for auditing).\n\t * Extracted from Agreement's assigner field.\n\t */\n\tproviderIdentity?: string;\n\n\t/**\n\t * Data address for push mode transfers.\n\t * Contains endpoint information where data should be pushed (for Activity Stream push mode).\n\t * Only present when format is Http-Push-Activity-Stream-Format or Http-Post-Activity-Stream-Format.\n\t */\n\tdataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ITransferProcess.js","sourceRoot":"","sources":["../../../../src/models/control-plane/ITransferProcess.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolDataAddress\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Transfer Process for internal storage.\n * Combines DSP protocol fields with internal TWIN fields.\n * This is NOT the DSP wire format (use ITransferProcess from standards for that).\n */\nexport interface ITransferProcess {\n\t/**\n\t * Internal UUID (primary key for entity storage).\n\t */\n\tid: string;\n\n\t// === DSP Protocol fields (public) ===\n\n\t/**\n\t * Consumer Process ID from the DSP protocol.\n\t * Refers to the transfer identifier on the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * Provider Process ID from the DSP protocol.\n\t * Refers to the transfer identifier on the Provider side.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * Transfer Process state from the DSP protocol.\n\t * One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.\n\t */\n\tstate: DataspaceProtocolTransferProcessStateType;\n\n\t// === Internal TWIN fields (NOT in DSP protocol) ===\n\n\t/**\n\t * Agreement ID linking to the rights-management Agreement.\n\t * Used to resolve policies and permissions.\n\t */\n\tagreementId: string;\n\n\t/**\n\t * Dataset ID for DSC resolution.\n\t * Identifies the dataset being transferred.\n\t */\n\tdatasetId: string;\n\n\t/**\n\t * Offer ID from the original Catalog offer.\n\t */\n\tofferId: string;\n\n\t/**\n\t * Policies from the Agreement.\n\t * Used by DSC for runtime policy enforcement.\n\t */\n\tpolicies?: IOdrlPolicy[];\n\n\t/**\n\t * Consumer identity (DID or URI).\n\t * Used for auditing and access control.\n\t */\n\tconsumerIdentity?: string;\n\n\t/**\n\t * Provider identity (DID or URI).\n\t * Used for auditing.\n\t */\n\tproviderIdentity?: string;\n\n\t/**\n\t * Callback address for Consumer notifications.\n\t * URI where messages to the Consumer should be sent.\n\t */\n\tcallbackAddress?: string;\n\n\t/**\n\t * Data format from the Dataset Distribution.\n\t * Specified by a Distribution for the Dataset associated with the Agreement.\n\t */\n\tformat?: string;\n\n\t/**\n\t * Data address for push mode transfers.\n\t * Contains endpoint information where data should be pushed (for Activity Stream push mode).\n\t * Only present when format is Http-Push-Activity-Stream-Format or Http-Post-Activity-Stream-Format.\n\t */\n\tdataAddress?: IDataspaceProtocolDataAddress;\n\n\t/**\n\t * Creation timestamp.\n\t */\n\tdateCreated: Date;\n\n\t/**\n\t * Last update timestamp.\n\t */\n\tdateModified: Date;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ITransferContextResponse.js","sourceRoot":"","sources":["../../../../../src/models/control-plane/api/ITransferContextResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITransferContext } from \"../ITransferContext.js\";\n\n/**\n * Transfer Context Response (INTERNAL API for DSC).\n * This is NOT part of the DSP protocol - it's a TWIN internal API\n * used by dataspace-control-plane to resolve consumerPid to datasetId and policies.\n */\nexport interface ITransferContextResponse {\n\t/**\n\t * Request body\n\t */\n\tbody: ITransferContext;\n}\n"]}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* The role of a participant in a Transfer Process.
|
|
5
|
+
* Determines whether the party is acting as Consumer or Provider.
|
|
6
|
+
*/
|
|
7
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
8
|
+
export const TransferProcessRole = {
|
|
9
|
+
/**
|
|
10
|
+
* Consumer role - the party requesting data.
|
|
11
|
+
*/
|
|
12
|
+
Consumer: "consumer",
|
|
13
|
+
/**
|
|
14
|
+
* Provider role - the party providing data.
|
|
15
|
+
*/
|
|
16
|
+
Provider: "provider"
|
|
17
|
+
};
|
|
18
|
+
//# sourceMappingURL=transferProcessRole.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transferProcessRole.js","sourceRoot":"","sources":["../../../../src/models/control-plane/transferProcessRole.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The role of a participant in a Transfer Process.\n * Determines whether the party is acting as Consumer or Provider.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const TransferProcessRole = {\n\t/**\n\t * Consumer role - the party requesting data.\n\t */\n\tConsumer: \"consumer\",\n\n\t/**\n\t * Provider role - the party providing data.\n\t */\n\tProvider: \"provider\"\n} as const;\n\n/**\n * Type for TransferProcessRole values.\n */\nexport type TransferProcessRole = (typeof TransferProcessRole)[keyof typeof TransferProcessRole];\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IDataspaceDataPlaneComponent.js","sourceRoot":"","sources":["../../../../src/models/data-plane/IDataspaceDataPlaneComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\nimport type { IActivityLogEntry } from \"../IActivityLogEntry.js\";\nimport type { IActivityLogStatusNotification } from \"../IActivityLogStatusNotification.js\";\nimport type { IDataAssetItemListResult } from \"../IDataAssetItemListResult.js\";\nimport type { IEntitySet } from \"../IEntitySet.js\";\nimport type { IFilteringQuery } from \"../IFilteringQuery.js\";\n\n/**\n * Dataspace Data Plane component interface.\n * Implements the Data Plane functionality for the Eclipse Dataspace Protocol.\n */\nexport interface IDataspaceDataPlaneComponent extends IComponent {\n\t/**\n\t * Notify an Activity to the Dataspace Data Plane Activity Stream.\n\t * @param activity The Activity notified.\n\t * @returns The Activity's identifier.\n\t */\n\tnotifyActivity(activity: IActivityStreamsActivity): Promise<string>;\n\n\t/**\n\t * Subscribes to the activity log.\n\t * @param callback The callback to be called when Activity Log is called.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tsubscribeToActivityLog(\n\t\tcallback: (notification: IActivityLogStatusNotification) => Promise<void>,\n\t\tsubscriptionId?: string\n\t): Promise<string>;\n\n\t/**\n\t * Unsubscribes to the activity log.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tunSubscribeToActivityLog(subscriptionId: string): Promise<void>;\n\n\t/**\n\t * Returns Activity Log Entry which contains the Activity processing details.\n\t * @param logEntryId The Id of the Activity Log Entry (a URI).\n\t * @returns the Activity Log Entry with the processing details.\n\t * @throws NotFoundError if activity log entry is not known.\n\t */\n\tgetActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry>;\n\n\t/**\n\t * Get Data Asset entities. Allows to retrieve entities by their type or id.\n\t * @param entitySet The set of entities to be retrieved.\n\t * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tgetDataAssetEntities(\n\t\tentitySet: IEntitySet & {\n\t\t\tjsonLdContext?: IJsonLdContextDefinitionElement[];\n\t\t},\n\t\tconsumerPid: string,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult>;\n\n\t/**\n\t * Queries a data asset controlled by this Dataspace App.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param query The filtering query.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tqueryDataAsset(\n\t\tconsumerPid: string,\n\t\tquery: IFilteringQuery,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult>;\n}\n"]}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import type { DataspaceProtocolTransferProcessStateType, IDataspaceProtocolDataAddress } from "@twin.org/standards-dataspace-protocol";
|
|
2
|
+
import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
|
|
3
|
+
/**
|
|
4
|
+
* Transfer Process for shared storage between Control Plane and Data Plane.
|
|
5
|
+
* This entity is the persistent representation of ITransferProcess.
|
|
6
|
+
*/
|
|
7
|
+
export declare class TransferProcess {
|
|
8
|
+
/**
|
|
9
|
+
* The consumer PID is the primary key.
|
|
10
|
+
* Used for direct lookup by consumerPid.
|
|
11
|
+
*/
|
|
12
|
+
consumerPid: string;
|
|
13
|
+
/**
|
|
14
|
+
* Internal UUID for storage (secondary key for providerPid lookup).
|
|
15
|
+
*/
|
|
16
|
+
id: string;
|
|
17
|
+
/**
|
|
18
|
+
* Provider Process ID from the DSP protocol.
|
|
19
|
+
* Indexed for lookup by providerPid.
|
|
20
|
+
*/
|
|
21
|
+
providerPid: string;
|
|
22
|
+
/**
|
|
23
|
+
* Agreement ID linking to the rights-management Agreement.
|
|
24
|
+
*/
|
|
25
|
+
agreementId: string;
|
|
26
|
+
/**
|
|
27
|
+
* Transfer Process state from the DSP protocol.
|
|
28
|
+
* One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
|
|
29
|
+
*/
|
|
30
|
+
state: DataspaceProtocolTransferProcessStateType;
|
|
31
|
+
/**
|
|
32
|
+
* Dataset ID for DSC resolution.
|
|
33
|
+
*/
|
|
34
|
+
datasetId: string;
|
|
35
|
+
/**
|
|
36
|
+
* Offer ID from the original Catalog offer.
|
|
37
|
+
*/
|
|
38
|
+
offerId: string;
|
|
39
|
+
/**
|
|
40
|
+
* Consumer identity (DID or URI).
|
|
41
|
+
*/
|
|
42
|
+
consumerIdentity?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Provider identity (DID or URI).
|
|
45
|
+
*/
|
|
46
|
+
providerIdentity?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Data format from the Dataset Distribution.
|
|
49
|
+
*/
|
|
50
|
+
format?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Callback address for Consumer notifications.
|
|
53
|
+
*/
|
|
54
|
+
callbackAddress?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Creation timestamp (ISO string format).
|
|
57
|
+
*/
|
|
58
|
+
dateCreated: string;
|
|
59
|
+
/**
|
|
60
|
+
* Last update timestamp (ISO string format).
|
|
61
|
+
*/
|
|
62
|
+
dateModified: string;
|
|
63
|
+
/**
|
|
64
|
+
* Policies from the Agreement (stored as JSON).
|
|
65
|
+
*/
|
|
66
|
+
policies?: IOdrlPolicy[];
|
|
67
|
+
/**
|
|
68
|
+
* Data address for push mode transfers (stored as JSON).
|
|
69
|
+
*/
|
|
70
|
+
dataAddress?: IDataspaceProtocolDataAddress;
|
|
71
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
export * from "./entities/transferProcess.js";
|
|
2
|
+
export * from "./models/control-plane/IDataspaceControlPlaneComponent.js";
|
|
3
|
+
export * from "./models/control-plane/IDataspaceControlPlaneResolverComponent.js";
|
|
4
|
+
export * from "./models/control-plane/INegotiationCallback.js";
|
|
5
|
+
export * from "./models/control-plane/ITransferProcess.js";
|
|
6
|
+
export * from "./models/control-plane/transferProcessRole.js";
|
|
7
|
+
export * from "./models/control-plane/ITransferContext.js";
|
|
8
|
+
export * from "./models/control-plane/api/ITransferContextResponse.js";
|
|
9
|
+
export * from "./models/data-plane/IDataspaceDataPlaneComponent.js";
|
|
10
|
+
export * from "./factories/dataspaceAppFactory.js";
|
|
11
|
+
export * from "./models/app/IDataspaceApp.js";
|
|
12
|
+
export * from "./models/activityProcessingStatus.js";
|
|
13
|
+
export * from "./models/api/IActivityLogEntryGetRequest.js";
|
|
14
|
+
export * from "./models/api/IActivityLogEntryGetResponse.js";
|
|
15
|
+
export * from "./models/api/IActivityLogStatusNotificationPayload.js";
|
|
16
|
+
export * from "./models/api/IActivityLogStatusRequest.js";
|
|
17
|
+
export * from "./models/api/IActivityStreamNotifyRequest.js";
|
|
18
|
+
export * from "./models/api/IDataAssetEntitiesResponse.js";
|
|
19
|
+
export * from "./models/api/IDataAssetGetEntitiesRequest.js";
|
|
20
|
+
export * from "./models/api/IDataAssetQueryRequest.js";
|
|
21
|
+
export * from "./models/api/control-plane/IRequestTransferRequest.js";
|
|
22
|
+
export * from "./models/api/control-plane/IRequestTransferResponse.js";
|
|
23
|
+
export * from "./models/api/control-plane/IStartTransferRequest.js";
|
|
24
|
+
export * from "./models/api/control-plane/IStartTransferResponse.js";
|
|
25
|
+
export * from "./models/api/control-plane/ICompleteTransferRequest.js";
|
|
26
|
+
export * from "./models/api/control-plane/ICompleteTransferResponse.js";
|
|
27
|
+
export * from "./models/api/control-plane/ISuspendTransferRequest.js";
|
|
28
|
+
export * from "./models/api/control-plane/ISuspendTransferResponse.js";
|
|
29
|
+
export * from "./models/api/control-plane/ITerminateTransferRequest.js";
|
|
30
|
+
export * from "./models/api/control-plane/ITerminateTransferResponse.js";
|
|
31
|
+
export * from "./models/api/control-plane/IGetTransferProcessRequest.js";
|
|
32
|
+
export * from "./models/api/control-plane/IGetTransferProcessResponse.js";
|
|
33
|
+
export * from "./models/app/dataRequestType.js";
|
|
34
|
+
export * from "./models/app/IActivityQuery.js";
|
|
35
|
+
export * from "./models/app/IDataAssetEntitiesRequest.js";
|
|
36
|
+
export * from "./models/app/IDataAssetQuery.js";
|
|
37
|
+
export * from "./models/app/IQueryDataAssetRequest.js";
|
|
38
|
+
export * from "./models/app/IDataRequest.js";
|
|
39
|
+
export * from "./models/IActivityLogDates.js";
|
|
40
|
+
export * from "./models/IActivityLogDetails.js";
|
|
41
|
+
export * from "./models/IActivityLogEntry.js";
|
|
42
|
+
export * from "./models/IActivityLogStatusNotification.js";
|
|
43
|
+
export * from "./models/IActivityTask.js";
|
|
44
|
+
export * from "./models/IDataAssetItemList.js";
|
|
45
|
+
export * from "./models/IDataAssetItemListResult.js";
|
|
46
|
+
export * from "./models/IEntitySet.js";
|
|
47
|
+
export * from "./models/IExecutionPayload.js";
|
|
48
|
+
export * from "./models/IFilteringQuery.js";
|
|
49
|
+
export * from "./models/ITaskApp.js";
|