@twin.org/standards-dataspace-protocol 0.0.3-next.4 → 0.0.3-next.41
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 +70 -0
- package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +1 -0
- 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 +37 -16
- 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/{catalogTypes.js → dataspaceProtocolCatalogTypes.js} +19 -3
- 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} +2 -2
- package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js.map +1 -0
- package/dist/es/models/contractNegotiation/types/{contractNegotiationEventType.js → dataspaceProtocolContractNegotiationEventType.js} +2 -2
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js.map +1 -0
- package/dist/es/models/contractNegotiation/types/{contractNegotiationStateType.js → dataspaceProtocolContractNegotiationStateType.js} +2 -2
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js.map +1 -0
- package/dist/es/models/dataspaceProtocolContextType.js.map +1 -1
- package/dist/es/models/dataspaceProtocolContexts.js +12 -4
- package/dist/es/models/dataspaceProtocolContexts.js.map +1 -1
- 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/{CatalogError.json → DataspaceProtocolCatalogError.json} +17 -10
- package/dist/es/schemas/{CatalogRequestMessage.json → DataspaceProtocolCatalogRequestMessage.json} +16 -5
- 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/{DatasetRequestMessage.json → DataspaceProtocolDatasetRequestMessage.json} +14 -5
- 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 +9 -0
- package/dist/types/dataTypes/transferProcessDataTypes.d.ts +9 -0
- package/dist/types/index.d.ts +36 -16
- package/dist/types/models/catalog/IDataspaceProtocolCatalog.d.ts +63 -0
- package/dist/types/models/catalog/{ICatalogError.d.ts → IDataspaceProtocolCatalogError.d.ts} +5 -5
- package/dist/types/models/catalog/{ICatalogRequestMessage.d.ts → IDataspaceProtocolCatalogRequestMessage.d.ts} +4 -4
- 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/{IDatasetRequestMessage.d.ts → IDataspaceProtocolDatasetRequestMessage.d.ts} +3 -3
- package/dist/types/models/catalog/IDataspaceProtocolDistribution.d.ts +70 -0
- package/dist/types/models/catalog/{catalogTypes.d.ts → dataspaceProtocolCatalogTypes.d.ts} +18 -2
- package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts} +3 -3
- package/dist/types/models/contractNegotiation/{IContractAgreementVerificationMessage.d.ts → IDataspaceProtocolContractAgreementVerificationMessage.d.ts} +3 -3
- package/dist/types/models/contractNegotiation/{IContractNegotiation.d.ts → IDataspaceProtocolContractNegotiation.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/{IContractNegotiationError.d.ts → IDataspaceProtocolContractNegotiationError.d.ts} +4 -14
- package/dist/types/models/contractNegotiation/{IContractNegotiationEventMessage.d.ts → IDataspaceProtocolContractNegotiationEventMessage.d.ts} +5 -5
- package/dist/types/models/contractNegotiation/{IContractNegotiationTerminationMessage.d.ts → IDataspaceProtocolContractNegotiationTerminationMessage.d.ts} +3 -3
- package/dist/types/models/contractNegotiation/{IContractOfferMessage.d.ts → IDataspaceProtocolContractOfferMessage.d.ts} +3 -3
- package/dist/types/models/contractNegotiation/{IContractRequestMessage.d.ts → IDataspaceProtocolContractRequestMessage.d.ts} +3 -3
- 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 +4 -4
- package/dist/types/models/dataspaceProtocolContexts.d.ts +12 -4
- 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 +673 -0
- package/docs/reference/classes/CatalogDataTypes.md +25 -0
- package/docs/reference/classes/ContractNegotiationDataTypes.md +25 -0
- package/docs/reference/classes/DataspaceProtocolHelper.md +63 -0
- package/docs/reference/classes/TransferProcessDataTypes.md +25 -0
- package/docs/reference/index.md +42 -19
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +96 -0
- package/docs/reference/interfaces/{ICatalogError.md → IDataspaceProtocolCatalogError.md} +4 -4
- package/docs/reference/interfaces/{ICatalogRequestMessage.md → IDataspaceProtocolCatalogRequestMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +3 -3
- package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +3 -27
- package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +2 -2
- 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/{IDatasetRequestMessage.md → IDataspaceProtocolDatasetRequestMessage.md} +1 -1
- 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 +2 -2
- 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/{CatalogTypes.md → DataspaceProtocolCatalogTypes.md} +26 -2
- package/docs/reference/variables/DataspaceProtocolContexts.md +18 -6
- 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 -3
- package/dist/es/dataTypes/dataspaceProtolDataTypes.js +0 -100
- package/dist/es/dataTypes/dataspaceProtolDataTypes.js.map +0 -1
- package/dist/es/models/catalog/ICatalogError.js +0 -2
- package/dist/es/models/catalog/ICatalogError.js.map +0 -1
- package/dist/es/models/catalog/ICatalogRequestMessage.js +0 -2
- package/dist/es/models/catalog/ICatalogRequestMessage.js.map +0 -1
- package/dist/es/models/catalog/IDatasetRequestMessage.js +0 -2
- package/dist/es/models/catalog/IDatasetRequestMessage.js.map +0 -1
- package/dist/es/models/catalog/catalogTypes.js.map +0 -1
- 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/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/contractNegotiationTypes.d.ts +0 -50
- package/docs/reference/type-aliases/CatalogTypes.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/ContractNegotiationTypes.md +0 -68
- /package/dist/types/dataTypes/{dataspaceProtolDataTypes.d.ts → dataspaceProtocolDataTypes.d.ts} +0 -0
|
@@ -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];
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
|
|
2
2
|
import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
|
|
3
3
|
/**
|
|
4
|
-
* The Dataspace Protocol
|
|
4
|
+
* The Dataspace Protocol JSON-LD context type.
|
|
5
5
|
*/
|
|
6
|
-
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.
|
|
6
|
+
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.Context | [typeof DataspaceProtocolContexts.Context] | [
|
|
7
7
|
...IJsonLdContextDefinitionElement[],
|
|
8
|
-
typeof DataspaceProtocolContexts.
|
|
8
|
+
typeof DataspaceProtocolContexts.Context,
|
|
9
9
|
IJsonLdContextDefinitionElement
|
|
10
10
|
] | [
|
|
11
11
|
IJsonLdContextDefinitionElement,
|
|
12
|
-
typeof DataspaceProtocolContexts.
|
|
12
|
+
typeof DataspaceProtocolContexts.Context,
|
|
13
13
|
...IJsonLdContextDefinitionElement[]
|
|
14
14
|
];
|
|
@@ -3,13 +3,21 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export declare const DataspaceProtocolContexts: {
|
|
5
5
|
/**
|
|
6
|
-
* The
|
|
6
|
+
* The canonical RDF namespace URI.
|
|
7
7
|
*/
|
|
8
|
-
readonly
|
|
8
|
+
readonly Namespace: "https://w3id.org/dspace/2025/1/";
|
|
9
9
|
/**
|
|
10
|
-
* The
|
|
10
|
+
* The value to use in @context.
|
|
11
11
|
*/
|
|
12
|
-
readonly
|
|
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/";
|
|
13
21
|
};
|
|
14
22
|
/**
|
|
15
23
|
* The contexts for Dataspace Protocol Protocol.
|
|
@@ -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];
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TWIN Data Space Protocol Profile endpoint type identifiers.
|
|
3
|
+
*
|
|
4
|
+
* This module defines endpoint types according to the TWIN Foundation's
|
|
5
|
+
* Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
|
|
6
|
+
* Protocol specification with TWIN-specific vocabulary.
|
|
7
|
+
*
|
|
8
|
+
* The TWIN vocabulary uses persistent identifiers under the
|
|
9
|
+
* https://schema.twindev.org namespace to provide stable, semantic
|
|
10
|
+
* identifiers for data space endpoint types.
|
|
11
|
+
*
|
|
12
|
+
* References:
|
|
13
|
+
* - TWIN RFC 006: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
|
|
14
|
+
* - TWIN DS Protocol Context: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
|
|
15
|
+
* - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
16
|
+
* - RFC 001 (Query Interface): https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
17
|
+
*/
|
|
18
|
+
export declare const DataspaceProtocolEndpointType: {
|
|
19
|
+
/**
|
|
20
|
+
* HTTPS Query Endpoint (TWIN DS Profile).
|
|
21
|
+
*
|
|
22
|
+
* Used for PULL transfers via the TWIN Data Space Connector Query interface.
|
|
23
|
+
* The consumer retrieves data by querying this endpoint using the data access token.
|
|
24
|
+
* Endpoint must implement the interface specified in RFC 001.
|
|
25
|
+
*
|
|
26
|
+
* Transfer Flow:
|
|
27
|
+
* 1. Consumer initiates transfer request
|
|
28
|
+
* 2. Provider returns this endpoint type with data access token
|
|
29
|
+
* 3. Consumer queries the endpoint with the token to retrieve data
|
|
30
|
+
*
|
|
31
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
32
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
33
|
+
*/
|
|
34
|
+
readonly HttpsQueryEndpoint: "https://schema.twindev.org/dspace/v1/Https-Query-Endpoint";
|
|
35
|
+
/**
|
|
36
|
+
* HTTPS Activity Stream Endpoint (TWIN DS Profile).
|
|
37
|
+
*
|
|
38
|
+
* Used for PUSH transfers via Activity Streams 2.0 protocol.
|
|
39
|
+
* The provider actively sends data to the consumer's Activity Stream inbox endpoint.
|
|
40
|
+
* Based on W3C Activity Streams 2.0 specification.
|
|
41
|
+
*
|
|
42
|
+
* Transfer Flow:
|
|
43
|
+
* 1. Consumer initiates transfer request with this endpoint type
|
|
44
|
+
* 2. Consumer provides their Activity Stream inbox URL
|
|
45
|
+
* 3. Provider pushes data to the consumer's inbox as Activity Stream objects
|
|
46
|
+
*
|
|
47
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
48
|
+
* @see https://www.w3.org/TR/activitystreams-core/
|
|
49
|
+
* @see https://www.w3.org/TR/activitypub/
|
|
50
|
+
*/
|
|
51
|
+
readonly HttpsActivityStreamEndpoint: "https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint";
|
|
52
|
+
/**
|
|
53
|
+
* HTTP endpoint (IDSA W3ID v4.1).
|
|
54
|
+
*
|
|
55
|
+
* Persistent identifier for HTTP-based data access endpoints.
|
|
56
|
+
* This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
57
|
+
*
|
|
58
|
+
* Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
59
|
+
* This constant is provided for interoperability with IDSA-based systems.
|
|
60
|
+
*
|
|
61
|
+
* @see https://w3id.org/idsa/v4.1/HTTP
|
|
62
|
+
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
63
|
+
*/
|
|
64
|
+
readonly HTTP: "https://w3id.org/idsa/v4.1/HTTP";
|
|
65
|
+
/**
|
|
66
|
+
* HTTPS endpoint (IDSA W3ID v4.1).
|
|
67
|
+
*
|
|
68
|
+
* Persistent identifier for HTTPS-based secure data access endpoints.
|
|
69
|
+
* This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
70
|
+
*
|
|
71
|
+
* Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
72
|
+
* This constant is provided for interoperability with IDSA-based systems.
|
|
73
|
+
*
|
|
74
|
+
* @see https://w3id.org/idsa/v4.1/HTTPS
|
|
75
|
+
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
76
|
+
*/
|
|
77
|
+
readonly HTTPS: "https://w3id.org/idsa/v4.1/HTTPS";
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Type representing all valid Dataspace Protocol endpoint types.
|
|
81
|
+
*
|
|
82
|
+
* All values are valid URIs as required by the DS Protocol JSON-LD context
|
|
83
|
+
* which defines endpointType as @type:@vocab.
|
|
84
|
+
*
|
|
85
|
+
* Includes:
|
|
86
|
+
* - TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
|
|
87
|
+
* - IDSA W3ID types: HTTP, HTTPS
|
|
88
|
+
*/
|
|
89
|
+
export type DataspaceProtocolEndpointType = (typeof DataspaceProtocolEndpointType)[keyof typeof DataspaceProtocolEndpointType];
|
package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The states for Dataspace Protocol Transfer Process.
|
|
3
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
|
|
4
|
+
*/
|
|
5
|
+
export declare const DataspaceProtocolTransferProcessStateType: {
|
|
6
|
+
/**
|
|
7
|
+
* Completed
|
|
8
|
+
*/
|
|
9
|
+
readonly COMPLETED: "COMPLETED";
|
|
10
|
+
/**
|
|
11
|
+
* Requested
|
|
12
|
+
*/
|
|
13
|
+
readonly REQUESTED: "REQUESTED";
|
|
14
|
+
/**
|
|
15
|
+
* Started
|
|
16
|
+
*/
|
|
17
|
+
readonly STARTED: "STARTED";
|
|
18
|
+
/**
|
|
19
|
+
* Suspended
|
|
20
|
+
*/
|
|
21
|
+
readonly SUSPENDED: "SUSPENDED";
|
|
22
|
+
/**
|
|
23
|
+
* Terminated
|
|
24
|
+
*/
|
|
25
|
+
readonly TERMINATED: "TERMINATED";
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* The types for Dataspace Protocol Transfer.
|
|
29
|
+
*/
|
|
30
|
+
export type DataspaceProtocolTransferProcessStateType = (typeof DataspaceProtocolTransferProcessStateType)[keyof typeof DataspaceProtocolTransferProcessStateType];
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { type IValidationFailure } from "@twin.org/core";
|
|
2
|
+
import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
3
|
+
/**
|
|
4
|
+
* Dataspace protocol helper.
|
|
5
|
+
*/
|
|
6
|
+
export declare abstract class DataspaceProtocolHelper {
|
|
7
|
+
/**
|
|
8
|
+
* Checks whether the object passed as parameter is conformant to the DS Protocol definitions.
|
|
9
|
+
* @param object The object to check
|
|
10
|
+
* @param validationFailures the Validation failures obtained during the conformance checking.
|
|
11
|
+
* @returns true or false depending whether the object is conformant or not
|
|
12
|
+
*/
|
|
13
|
+
static checkConformance(object: IJsonLdNodeObject, validationFailures: IValidationFailure[]): Promise<boolean>;
|
|
14
|
+
/**
|
|
15
|
+
* Normalizes the input object making it compliant with the DS Protocol specifications.
|
|
16
|
+
* @param object The input object.
|
|
17
|
+
* @returns The input object normalized.
|
|
18
|
+
*/
|
|
19
|
+
static normalize(object: IJsonLdNodeObject): Promise<IJsonLdNodeObject>;
|
|
20
|
+
}
|