@twin.org/standards-dataspace-protocol 0.0.3-next.3 → 0.0.3-next.30
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/dataTypes/catalogDataTypes.js +61 -0
- package/dist/es/dataTypes/catalogDataTypes.js.map +1 -0
- package/dist/es/dataTypes/contractNegotiationDataTypes.js +60 -71
- package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +1 -1
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js +30 -0
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js.map +1 -0
- package/dist/es/dataTypes/transferProcessDataTypes.js +65 -0
- package/dist/es/dataTypes/transferProcessDataTypes.js.map +1 -0
- package/dist/es/index.js +41 -14
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolCatalog.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolCatalog.js.map +1 -0
- package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js.map +1 -0
- package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js.map +1 -0
- package/dist/es/models/catalog/IDataspaceProtocolDataService.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolDataService.js.map +1 -0
- package/dist/es/models/catalog/IDataspaceProtocolDataset.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolDataset.js.map +1 -0
- package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js.map +1 -0
- package/dist/es/models/catalog/IDataspaceProtocolDistribution.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolDistribution.js.map +1 -0
- package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +38 -0
- package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js.map +1 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js +2 -0
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js.map +1 -0
- package/dist/es/models/contractNegotiation/{contractNegotiationTypes.js → dataspaceProtocolContractNegotiationTypes.js} +3 -3
- package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js.map +1 -0
- package/dist/es/models/contractNegotiation/types/{contractNegotiationEventType.js → dataspaceProtocolContractNegotiationEventType.js} +3 -3
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js.map +1 -0
- package/dist/es/models/contractNegotiation/types/{contractNegotiationStateType.js → dataspaceProtocolContractNegotiationStateType.js} +3 -3
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js.map +1 -0
- package/dist/es/models/dataspaceProtocolContextType.js +2 -0
- package/dist/es/models/dataspaceProtocolContextType.js.map +1 -0
- package/dist/es/models/dataspaceProtocolContexts.js +25 -0
- package/dist/es/models/dataspaceProtocolContexts.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js +4 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js.map +1 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js +2 -0
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js.map +1 -0
- package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js +46 -0
- package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js.map +1 -0
- package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js +89 -0
- package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js.map +1 -0
- package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js +30 -0
- package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -0
- package/dist/es/schemas/DataspaceProtocolCatalog.json +11 -0
- package/dist/es/schemas/DataspaceProtocolCatalogError.json +78 -0
- package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +73 -0
- package/dist/es/schemas/{ContractAgreementMessage.json → DataspaceProtocolContractAgreementMessage.json} +14 -5
- package/dist/es/schemas/{ContractAgreementVerificationMessage.json → DataspaceProtocolContractAgreementVerificationMessage.json} +14 -5
- package/dist/es/schemas/{ContractNegotiation.json → DataspaceProtocolContractNegotiation.json} +15 -6
- package/dist/es/schemas/{ContractNegotiationError.json → DataspaceProtocolContractNegotiationError.json} +15 -39
- package/dist/es/schemas/{ContractNegotiationEventMessage.json → DataspaceProtocolContractNegotiationEventMessage.json} +15 -6
- package/dist/es/schemas/{ContractNegotiationEventType.json → DataspaceProtocolContractNegotiationEventType.json} +1 -1
- package/dist/es/schemas/{ContractNegotiationStateType.json → DataspaceProtocolContractNegotiationStateType.json} +1 -1
- package/dist/es/schemas/{ContractNegotiationTerminationMessage.json → DataspaceProtocolContractNegotiationTerminationMessage.json} +14 -5
- package/dist/es/schemas/{ContractOfferMessage.json → DataspaceProtocolContractOfferMessage.json} +14 -5
- package/dist/es/schemas/{ContractRequestMessage.json → DataspaceProtocolContractRequestMessage.json} +14 -5
- package/dist/es/schemas/DataspaceProtocolDataAddress.json +33 -0
- package/dist/es/schemas/DataspaceProtocolDataset.json +11 -0
- package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +73 -0
- package/dist/es/schemas/DataspaceProtocolEndpointProperty.json +27 -0
- package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +78 -0
- package/dist/es/schemas/DataspaceProtocolTransferError.json +87 -0
- package/dist/es/schemas/DataspaceProtocolTransferProcess.json +83 -0
- package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +92 -0
- package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +82 -0
- package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +87 -0
- package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +87 -0
- package/dist/es/schemas-src/DataspaceProtocolDataService.json +11 -0
- package/dist/es/schemas-src/DataspaceProtocolDistribution.json +11 -0
- package/dist/es/utils/dataspaceProtocolHelper.js +110 -0
- package/dist/es/utils/dataspaceProtocolHelper.js.map +1 -0
- package/dist/types/dataTypes/catalogDataTypes.d.ts +9 -0
- package/dist/types/dataTypes/contractNegotiationDataTypes.d.ts +1 -5
- package/dist/types/dataTypes/dataspaceProtocolDataTypes.d.ts +13 -0
- package/dist/types/dataTypes/transferProcessDataTypes.d.ts +9 -0
- package/dist/types/index.d.ts +37 -13
- package/dist/types/models/catalog/IDataspaceProtocolCatalog.d.ts +63 -0
- package/dist/types/models/catalog/IDataspaceProtocolCatalogError.d.ts +24 -0
- package/dist/types/models/catalog/IDataspaceProtocolCatalogRequestMessage.d.ts +20 -0
- package/dist/types/models/catalog/IDataspaceProtocolDataService.d.ts +49 -0
- package/dist/types/models/catalog/IDataspaceProtocolDataset.d.ts +66 -0
- package/dist/types/models/catalog/IDataspaceProtocolDatasetRequestMessage.d.ts +20 -0
- package/dist/types/models/catalog/IDataspaceProtocolDistribution.d.ts +70 -0
- package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +38 -0
- package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/{IContractAgreementVerificationMessage.d.ts → IDataspaceProtocolContractAgreementVerificationMessage.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiation.d.ts +29 -0
- package/dist/types/models/contractNegotiation/{IContractNegotiationError.d.ts → IDataspaceProtocolContractNegotiationError.d.ts} +6 -16
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.d.ts +29 -0
- package/dist/types/models/contractNegotiation/{IContractNegotiationTerminationMessage.d.ts → IDataspaceProtocolContractNegotiationTerminationMessage.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/{IContractOfferMessage.d.ts → IDataspaceProtocolContractOfferMessage.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/{IContractRequestMessage.d.ts → IDataspaceProtocolContractRequestMessage.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts +50 -0
- package/dist/types/models/contractNegotiation/types/{contractNegotiationEventType.d.ts → dataspaceProtocolContractNegotiationEventType.d.ts} +2 -2
- package/dist/types/models/contractNegotiation/types/{contractNegotiationStateType.d.ts → dataspaceProtocolContractNegotiationStateType.d.ts} +2 -2
- package/dist/types/models/dataspaceProtocolContextType.d.ts +14 -0
- package/dist/types/models/dataspaceProtocolContexts.d.ts +25 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolDataAddress.d.ts +24 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolEndpointProperty.d.ts +19 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.d.ts +24 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferError.d.ts +32 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferProcess.d.ts +29 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferRequestMessage.d.ts +39 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferStartMessage.d.ts +30 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.d.ts +32 -0
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.d.ts +32 -0
- package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts +46 -0
- package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts +89 -0
- package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts +30 -0
- package/dist/types/utils/dataspaceProtocolHelper.d.ts +20 -0
- package/docs/changelog.md +470 -0
- package/docs/reference/classes/CatalogDataTypes.md +25 -0
- package/docs/reference/classes/ContractNegotiationDataTypes.md +1 -13
- package/docs/reference/classes/DataspaceProtocolDataTypes.md +37 -0
- package/docs/reference/classes/DataspaceProtocolHelper.md +63 -0
- package/docs/reference/classes/TransferProcessDataTypes.md +25 -0
- package/docs/reference/index.md +45 -17
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +96 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +36 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +28 -0
- package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +4 -4
- package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +4 -28
- package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +4 -4
- package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +3 -3
- package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +36 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +72 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +90 -0
- package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md +28 -0
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +98 -0
- package/docs/reference/interfaces/IDataspaceProtocolEndpointProperty.md +28 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md +36 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +52 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +44 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +62 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +45 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +52 -0
- package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +52 -0
- package/docs/reference/type-aliases/DataspaceProtocolCatalogTypes.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContextType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContexts.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationEventType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationStateType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationTypes.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +12 -0
- package/docs/reference/type-aliases/DataspaceProtocolTransferProcessStateType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolTransferProcessTypes.md +5 -0
- package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +50 -0
- package/docs/reference/variables/DataspaceProtocolContexts.md +31 -0
- package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md} +2 -2
- package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md} +2 -2
- package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +68 -0
- package/docs/reference/variables/DataspaceProtocolEndpointType.md +96 -0
- package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +38 -0
- package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +62 -0
- package/locales/en.json +7 -1
- package/package.json +3 -2
- package/dist/es/models/contractNegotiation/IContractAgreementMessage.js +0 -2
- package/dist/es/models/contractNegotiation/IContractAgreementMessage.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js +0 -2
- package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractNegotiation.js +0 -2
- package/dist/es/models/contractNegotiation/IContractNegotiation.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationError.js +0 -2
- package/dist/es/models/contractNegotiation/IContractNegotiationError.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js +0 -2
- package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js +0 -2
- package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractOfferMessage.js +0 -2
- package/dist/es/models/contractNegotiation/IContractOfferMessage.js.map +0 -1
- package/dist/es/models/contractNegotiation/IContractRequestMessage.js +0 -2
- package/dist/es/models/contractNegotiation/IContractRequestMessage.js.map +0 -1
- package/dist/es/models/contractNegotiation/contractNegotiationContextType.js +0 -2
- package/dist/es/models/contractNegotiation/contractNegotiationContextType.js.map +0 -1
- package/dist/es/models/contractNegotiation/contractNegotiationContexts.js +0 -17
- package/dist/es/models/contractNegotiation/contractNegotiationContexts.js.map +0 -1
- package/dist/es/models/contractNegotiation/contractNegotiationTypes.js.map +0 -1
- package/dist/es/models/contractNegotiation/types/contractNegotiationEventType.js.map +0 -1
- package/dist/es/models/contractNegotiation/types/contractNegotiationStateType.js.map +0 -1
- package/dist/types/models/contractNegotiation/IContractNegotiation.d.ts +0 -29
- package/dist/types/models/contractNegotiation/IContractNegotiationEventMessage.d.ts +0 -29
- package/dist/types/models/contractNegotiation/contractNegotiationContextType.d.ts +0 -14
- package/dist/types/models/contractNegotiation/contractNegotiationContexts.d.ts +0 -17
- package/dist/types/models/contractNegotiation/contractNegotiationTypes.d.ts +0 -50
- package/docs/reference/type-aliases/ContractNegotiationContextType.md +0 -5
- package/docs/reference/type-aliases/ContractNegotiationContexts.md +0 -5
- package/docs/reference/type-aliases/ContractNegotiationEventType.md +0 -5
- package/docs/reference/type-aliases/ContractNegotiationStateType.md +0 -5
- package/docs/reference/type-aliases/ContractNegotiationTypes.md +0 -5
- package/docs/reference/variables/ContractNegotiationContexts.md +0 -19
- package/docs/reference/variables/ContractNegotiationTypes.md +0 -68
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContractNegotiationStateType } from "./types/dataspaceProtocolContractNegotiationStateType.js";
|
|
4
|
+
/**
|
|
5
|
+
* Interface for Dataspace Protocol Contract Agreement Messages.
|
|
6
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
|
|
7
|
+
*/
|
|
8
|
+
export interface IDataspaceProtocolContractNegotiation {
|
|
9
|
+
/**
|
|
10
|
+
* The JSON-LD context.
|
|
11
|
+
*/
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
|
+
/**
|
|
14
|
+
* The type of the message.
|
|
15
|
+
*/
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiation;
|
|
17
|
+
/**
|
|
18
|
+
* The provider id for the contract.
|
|
19
|
+
*/
|
|
20
|
+
providerPid: string;
|
|
21
|
+
/**
|
|
22
|
+
* The consumer id for the contract.
|
|
23
|
+
*/
|
|
24
|
+
consumerPid: string;
|
|
25
|
+
/**
|
|
26
|
+
* The offer being requested.
|
|
27
|
+
*/
|
|
28
|
+
state: DataspaceProtocolContractNegotiationStateType;
|
|
29
|
+
}
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Negotiation Error Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolContractNegotiationError {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
11
|
-
"@context":
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiationError;
|
|
16
16
|
/**
|
|
17
17
|
* The provider id for the contract.
|
|
18
18
|
*/
|
|
@@ -28,15 +28,5 @@ export interface IContractNegotiationError {
|
|
|
28
28
|
/**
|
|
29
29
|
* The error reason(s).
|
|
30
30
|
*/
|
|
31
|
-
reason?:
|
|
32
|
-
"@value": string;
|
|
33
|
-
"@language"?: string;
|
|
34
|
-
}[];
|
|
35
|
-
/**
|
|
36
|
-
* The error description(s).
|
|
37
|
-
*/
|
|
38
|
-
description?: {
|
|
39
|
-
"@value": string;
|
|
40
|
-
"@language"?: string;
|
|
41
|
-
}[];
|
|
31
|
+
reason?: any[];
|
|
42
32
|
}
|
package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.d.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContractNegotiationEventType } from "./types/dataspaceProtocolContractNegotiationEventType.js";
|
|
4
|
+
/**
|
|
5
|
+
* Interface for Dataspace Protocol Contract Negotiation Event Messages.
|
|
6
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
7
|
+
*/
|
|
8
|
+
export interface IDataspaceProtocolContractNegotiationEventMessage {
|
|
9
|
+
/**
|
|
10
|
+
* The JSON-LD context.
|
|
11
|
+
*/
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
|
+
/**
|
|
14
|
+
* The type of the message.
|
|
15
|
+
*/
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiationEventMessage;
|
|
17
|
+
/**
|
|
18
|
+
* The provider id for the contract.
|
|
19
|
+
*/
|
|
20
|
+
providerPid: string;
|
|
21
|
+
/**
|
|
22
|
+
* The consumer id for the contract.
|
|
23
|
+
*/
|
|
24
|
+
consumerPid: string;
|
|
25
|
+
/**
|
|
26
|
+
* The event type.
|
|
27
|
+
*/
|
|
28
|
+
event: DataspaceProtocolContractNegotiationEventType;
|
|
29
|
+
}
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Negotiation Termination Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolContractNegotiationTerminationMessage {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
11
|
-
"@context":
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiationTerminationMessage;
|
|
16
16
|
/**
|
|
17
17
|
* The provider id for the contract.
|
|
18
18
|
*/
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
3
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Offer Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractOfferMessage {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractOfferMessage;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
3
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Request Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractRequestMessage {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractRequestMessage;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The types for Dataspace Protocol Contract Negotiation.
|
|
3
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
|
|
4
|
+
*/
|
|
5
|
+
export declare const DataspaceProtocolContractNegotiationTypes: {
|
|
6
|
+
/**
|
|
7
|
+
* Contract Negotiation.
|
|
8
|
+
*/
|
|
9
|
+
readonly ContractNegotiation: "ContractNegotiation";
|
|
10
|
+
/**
|
|
11
|
+
* Contract Request Message.
|
|
12
|
+
*/
|
|
13
|
+
readonly ContractRequestMessage: "ContractRequestMessage";
|
|
14
|
+
/**
|
|
15
|
+
* Contract Offer Message.
|
|
16
|
+
*/
|
|
17
|
+
readonly ContractOfferMessage: "ContractOfferMessage";
|
|
18
|
+
/**
|
|
19
|
+
* Contract Agreement Message.
|
|
20
|
+
*/
|
|
21
|
+
readonly ContractAgreementMessage: "ContractAgreementMessage";
|
|
22
|
+
/**
|
|
23
|
+
* Contract Agreement Verification Message.
|
|
24
|
+
*/
|
|
25
|
+
readonly ContractAgreementVerificationMessage: "ContractAgreementVerificationMessage";
|
|
26
|
+
/**
|
|
27
|
+
* Contract Negotiation Event Message.
|
|
28
|
+
*/
|
|
29
|
+
readonly ContractNegotiationEventMessage: "ContractNegotiationEventMessage";
|
|
30
|
+
/**
|
|
31
|
+
* Contract Negotiation Termination Message.
|
|
32
|
+
*/
|
|
33
|
+
readonly ContractNegotiationTerminationMessage: "ContractNegotiationTerminationMessage";
|
|
34
|
+
/**
|
|
35
|
+
* Contract Negotiation Error.
|
|
36
|
+
*/
|
|
37
|
+
readonly ContractNegotiationError: "ContractNegotiationError";
|
|
38
|
+
/**
|
|
39
|
+
* Contract Negotiation Event Type.
|
|
40
|
+
*/
|
|
41
|
+
readonly ContractNegotiationEventType: "ContractNegotiationEventType";
|
|
42
|
+
/**
|
|
43
|
+
* Contract Negotiation State Type.
|
|
44
|
+
*/
|
|
45
|
+
readonly ContractNegotiationStateType: "ContractNegotiationStateType";
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* The types for Dataspace Protocol Contract Negotiation.
|
|
49
|
+
*/
|
|
50
|
+
export type DataspaceProtocolContractNegotiationTypes = (typeof DataspaceProtocolContractNegotiationTypes)[keyof typeof DataspaceProtocolContractNegotiationTypes];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* The types for Dataspace Protocol Contract Negotiation Events.
|
|
3
3
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
4
4
|
*/
|
|
5
|
-
export declare const
|
|
5
|
+
export declare const DataspaceProtocolContractNegotiationEventType: {
|
|
6
6
|
/**
|
|
7
7
|
* Accepted.
|
|
8
8
|
*/
|
|
@@ -15,4 +15,4 @@ export declare const ContractNegotiationEventType: {
|
|
|
15
15
|
/**
|
|
16
16
|
* The types for Dataspace Protocol Contract Negotiation Events.
|
|
17
17
|
*/
|
|
18
|
-
export type
|
|
18
|
+
export type DataspaceProtocolContractNegotiationEventType = (typeof DataspaceProtocolContractNegotiationEventType)[keyof typeof DataspaceProtocolContractNegotiationEventType];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* The types for Dataspace Protocol Contract Negotiation States.
|
|
3
3
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
|
|
4
4
|
*/
|
|
5
|
-
export declare const
|
|
5
|
+
export declare const DataspaceProtocolContractNegotiationStateType: {
|
|
6
6
|
/**
|
|
7
7
|
* Requested.
|
|
8
8
|
*/
|
|
@@ -35,4 +35,4 @@ export declare const ContractNegotiationStateType: {
|
|
|
35
35
|
/**
|
|
36
36
|
* The types for Dataspace Protocol Contract Negotiation States.
|
|
37
37
|
*/
|
|
38
|
-
export type
|
|
38
|
+
export type DataspaceProtocolContractNegotiationStateType = (typeof DataspaceProtocolContractNegotiationStateType)[keyof typeof DataspaceProtocolContractNegotiationStateType];
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
|
|
2
|
+
import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
|
|
3
|
+
/**
|
|
4
|
+
* The Dataspace Protocol JSON-LD context type.
|
|
5
|
+
*/
|
|
6
|
+
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.Context | [typeof DataspaceProtocolContexts.Context] | [
|
|
7
|
+
...IJsonLdContextDefinitionElement[],
|
|
8
|
+
typeof DataspaceProtocolContexts.Context,
|
|
9
|
+
IJsonLdContextDefinitionElement
|
|
10
|
+
] | [
|
|
11
|
+
IJsonLdContextDefinitionElement,
|
|
12
|
+
typeof DataspaceProtocolContexts.Context,
|
|
13
|
+
...IJsonLdContextDefinitionElement[]
|
|
14
|
+
];
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The contexts for Dataspace Protocol Protocol.
|
|
3
|
+
*/
|
|
4
|
+
export declare const DataspaceProtocolContexts: {
|
|
5
|
+
/**
|
|
6
|
+
* The canonical RDF namespace URI.
|
|
7
|
+
*/
|
|
8
|
+
readonly Namespace: "https://w3id.org/dspace/2025/1/";
|
|
9
|
+
/**
|
|
10
|
+
* The value to use in @context.
|
|
11
|
+
*/
|
|
12
|
+
readonly Context: "https://w3id.org/dspace/2025/1/context.jsonld";
|
|
13
|
+
/**
|
|
14
|
+
* The JSON-LD Context URL.
|
|
15
|
+
*/
|
|
16
|
+
readonly JsonLdContext: "https://w3id.org/dspace/2025/1/context.jsonld";
|
|
17
|
+
/**
|
|
18
|
+
* The namespace location of the hosted version of the JSON Schema.
|
|
19
|
+
*/
|
|
20
|
+
readonly JsonSchemaNamespace: "https://schema.twindev.org/dataspace-protocol/";
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* The contexts for Dataspace Protocol Protocol.
|
|
24
|
+
*/
|
|
25
|
+
export type DataspaceProtocolContexts = (typeof DataspaceProtocolContexts)[keyof typeof DataspaceProtocolContexts];
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
2
|
+
import type { IDataspaceProtocolEndpointProperty } from "./IDataspaceProtocolEndpointProperty.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
|
|
6
|
+
*/
|
|
7
|
+
export interface IDataspaceProtocolDataAddress {
|
|
8
|
+
/**
|
|
9
|
+
* LD Type
|
|
10
|
+
*/
|
|
11
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.DataAddress;
|
|
12
|
+
/**
|
|
13
|
+
* The type of endpoint of this data address.
|
|
14
|
+
*/
|
|
15
|
+
endpointType: string;
|
|
16
|
+
/**
|
|
17
|
+
* The endpoint of the data address
|
|
18
|
+
*/
|
|
19
|
+
endpoint?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Properties associated to the endpoint which might depend on the endpoint type.
|
|
22
|
+
*/
|
|
23
|
+
endpointProperties?: IDataspaceProtocolEndpointProperty[];
|
|
24
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
2
|
+
/**
|
|
3
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
|
|
5
|
+
*/
|
|
6
|
+
export interface IDataspaceProtocolEndpointProperty {
|
|
7
|
+
/**
|
|
8
|
+
* LD Type.
|
|
9
|
+
*/
|
|
10
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.EndpointProperty;
|
|
11
|
+
/**
|
|
12
|
+
* Property name.
|
|
13
|
+
*/
|
|
14
|
+
name: string;
|
|
15
|
+
/**
|
|
16
|
+
* Property value.
|
|
17
|
+
*/
|
|
18
|
+
value: string;
|
|
19
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
|
|
6
|
+
*/
|
|
7
|
+
export interface IDataspaceProtocolTransferCompletionMessage {
|
|
8
|
+
/**
|
|
9
|
+
* LD Context
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* LD Type
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferCompletionMessage;
|
|
16
|
+
/**
|
|
17
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
18
|
+
*/
|
|
19
|
+
consumerPid: string;
|
|
20
|
+
/**
|
|
21
|
+
* MUST refer to the transfer identifier of the Provider side.
|
|
22
|
+
*/
|
|
23
|
+
providerPid: string;
|
|
24
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
|
|
6
|
+
*/
|
|
7
|
+
export interface IDataspaceProtocolTransferError {
|
|
8
|
+
/**
|
|
9
|
+
* LD Context
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* LD Type
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferError;
|
|
16
|
+
/**
|
|
17
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
18
|
+
*/
|
|
19
|
+
consumerPid: string;
|
|
20
|
+
/**
|
|
21
|
+
* MUST refer to the transfer identifier of the Provider side.
|
|
22
|
+
*/
|
|
23
|
+
providerPid: string;
|
|
24
|
+
/**
|
|
25
|
+
* The error code.
|
|
26
|
+
*/
|
|
27
|
+
code?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The error reason(s).
|
|
30
|
+
*/
|
|
31
|
+
reason?: any[];
|
|
32
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
import type { DataspaceProtocolTransferProcessStateType } from "./types/dataspaceProtocolTransferProcessStateType.js";
|
|
4
|
+
/**
|
|
5
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
6
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
|
|
7
|
+
*/
|
|
8
|
+
export interface IDataspaceProtocolTransferProcess {
|
|
9
|
+
/**
|
|
10
|
+
* LD Context
|
|
11
|
+
*/
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
|
+
/**
|
|
14
|
+
* LD Type
|
|
15
|
+
*/
|
|
16
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferProcess;
|
|
17
|
+
/**
|
|
18
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
19
|
+
*/
|
|
20
|
+
consumerPid: string;
|
|
21
|
+
/**
|
|
22
|
+
* MUST refer to the transfer identifier of the Provider side.
|
|
23
|
+
*/
|
|
24
|
+
providerPid: string;
|
|
25
|
+
/**
|
|
26
|
+
* The transfer process state.
|
|
27
|
+
*/
|
|
28
|
+
state: DataspaceProtocolTransferProcessStateType;
|
|
29
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
import type { IDataspaceProtocolDataAddress } from "./IDataspaceProtocolDataAddress.js";
|
|
4
|
+
/**
|
|
5
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
6
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
|
|
7
|
+
*/
|
|
8
|
+
export interface IDataspaceProtocolTransferRequestMessage {
|
|
9
|
+
/**
|
|
10
|
+
* LD Context
|
|
11
|
+
*/
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
|
+
/**
|
|
14
|
+
* LD Type
|
|
15
|
+
*/
|
|
16
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferRequestMessage;
|
|
17
|
+
/**
|
|
18
|
+
* MUST refer to an existing Agreement between the Consumer and Provider.
|
|
19
|
+
*/
|
|
20
|
+
agreementId: string;
|
|
21
|
+
/**
|
|
22
|
+
* MUST be a URI indicating where messages to the Consumer SHOULD be sent.
|
|
23
|
+
*/
|
|
24
|
+
callbackAddress: string;
|
|
25
|
+
/**
|
|
26
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
27
|
+
*/
|
|
28
|
+
consumerPid: string;
|
|
29
|
+
/**
|
|
30
|
+
* The format property is a format specified by a Distribution for the Dataset associated with the Agreement.
|
|
31
|
+
* This is generally obtained from the Provider's Catalog.
|
|
32
|
+
*/
|
|
33
|
+
format: string;
|
|
34
|
+
/**
|
|
35
|
+
* If defined MUST contain a transport-specific set of properties for pushing the data.
|
|
36
|
+
* It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.
|
|
37
|
+
*/
|
|
38
|
+
dataAddress?: IDataspaceProtocolDataAddress;
|
|
39
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
import type { IDataspaceProtocolDataAddress } from "./IDataspaceProtocolDataAddress.js";
|
|
4
|
+
/**
|
|
5
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
6
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
|
|
7
|
+
*/
|
|
8
|
+
export interface IDataspaceProtocolTransferStartMessage {
|
|
9
|
+
/**
|
|
10
|
+
* LD Context
|
|
11
|
+
*/
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
|
+
/**
|
|
14
|
+
* LD Type
|
|
15
|
+
*/
|
|
16
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferStartMessage;
|
|
17
|
+
/**
|
|
18
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
19
|
+
*/
|
|
20
|
+
consumerPid: string;
|
|
21
|
+
/**
|
|
22
|
+
* MUST refer to the transfer identifier of the Provider side.
|
|
23
|
+
*/
|
|
24
|
+
providerPid: string;
|
|
25
|
+
/**
|
|
26
|
+
* MUST be provided if the current transfer is a pull transfer and
|
|
27
|
+
* contains a transport-specific endpoint address for obtaining the data.
|
|
28
|
+
*/
|
|
29
|
+
dataAddress?: IDataspaceProtocolDataAddress;
|
|
30
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
|
|
6
|
+
*/
|
|
7
|
+
export interface IDataspaceProtocolTransferSuspensionMessage {
|
|
8
|
+
/**
|
|
9
|
+
* LD Context
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* LD Type
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferSuspensionMessage;
|
|
16
|
+
/**
|
|
17
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
18
|
+
*/
|
|
19
|
+
consumerPid: string;
|
|
20
|
+
/**
|
|
21
|
+
* MUST refer to the transfer identifier of the Provider side.
|
|
22
|
+
*/
|
|
23
|
+
providerPid: string;
|
|
24
|
+
/**
|
|
25
|
+
* The suspension code.
|
|
26
|
+
*/
|
|
27
|
+
code?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The suspension reason(s).
|
|
30
|
+
*/
|
|
31
|
+
reason?: any[];
|
|
32
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Transfer Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
|
|
6
|
+
*/
|
|
7
|
+
export interface IDataspaceProtocolTransferTerminationMessage {
|
|
8
|
+
/**
|
|
9
|
+
* LD Context
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* LD Type
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.TransferTerminationMessage;
|
|
16
|
+
/**
|
|
17
|
+
* MUST refer to the transfer identifier of the Consumer side.
|
|
18
|
+
*/
|
|
19
|
+
consumerPid: string;
|
|
20
|
+
/**
|
|
21
|
+
* MUST refer to the transfer identifier of the Provider side.
|
|
22
|
+
*/
|
|
23
|
+
providerPid: string;
|
|
24
|
+
/**
|
|
25
|
+
* The termination code.
|
|
26
|
+
*/
|
|
27
|
+
code?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The termination reason(s).
|
|
30
|
+
*/
|
|
31
|
+
reason?: any[];
|
|
32
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The types for Dataspace Protocol Transfer Process.
|
|
3
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
|
|
4
|
+
*/
|
|
5
|
+
export declare const DataspaceProtocolTransferProcessTypes: {
|
|
6
|
+
/**
|
|
7
|
+
* Transfer Request Message.
|
|
8
|
+
*/
|
|
9
|
+
readonly TransferRequestMessage: "TransferRequestMessage";
|
|
10
|
+
/**
|
|
11
|
+
* Transfer Start Message.
|
|
12
|
+
*/
|
|
13
|
+
readonly TransferStartMessage: "TransferStartMessage";
|
|
14
|
+
/**
|
|
15
|
+
* Transfer Suspension Message.
|
|
16
|
+
*/
|
|
17
|
+
readonly TransferSuspensionMessage: "TransferSuspensionMessage";
|
|
18
|
+
/**
|
|
19
|
+
* Transfer Completion Message.
|
|
20
|
+
*/
|
|
21
|
+
readonly TransferCompletionMessage: "TransferCompletionMessage";
|
|
22
|
+
/**
|
|
23
|
+
* Transfer Termination Message.
|
|
24
|
+
*/
|
|
25
|
+
readonly TransferTerminationMessage: "TransferTerminationMessage";
|
|
26
|
+
/**
|
|
27
|
+
* Data Address
|
|
28
|
+
*/
|
|
29
|
+
readonly DataAddress: "DataAddress";
|
|
30
|
+
/**
|
|
31
|
+
* Endpoint property.
|
|
32
|
+
*/
|
|
33
|
+
readonly EndpointProperty: "EndpointProperty";
|
|
34
|
+
/**
|
|
35
|
+
* Transfer Process
|
|
36
|
+
*/
|
|
37
|
+
readonly TransferProcess: "TransferProcess";
|
|
38
|
+
/**
|
|
39
|
+
* Transfer Error.
|
|
40
|
+
*/
|
|
41
|
+
readonly TransferError: "TransferError";
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* The types for Dataspace Protocol Transfer.
|
|
45
|
+
*/
|
|
46
|
+
export type DataspaceProtocolTransferProcessTypes = (typeof DataspaceProtocolTransferProcessTypes)[keyof typeof DataspaceProtocolTransferProcessTypes];
|