@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,37 @@
|
|
|
1
|
+
# Class: DataspaceProtocolDataTypes
|
|
2
|
+
|
|
3
|
+
Handle all the data types for Dataspace Protocol.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new DataspaceProtocolDataTypes**(): `DataspaceProtocolDataTypes`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`DataspaceProtocolDataTypes`
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
### registerRedirects()
|
|
18
|
+
|
|
19
|
+
> `static` **registerRedirects**(): `void`
|
|
20
|
+
|
|
21
|
+
Register the JSON-LD Redirects.
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`void`
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### registerTypes()
|
|
30
|
+
|
|
31
|
+
> `static` **registerTypes**(): `void`
|
|
32
|
+
|
|
33
|
+
Register all the data types.
|
|
34
|
+
|
|
35
|
+
#### Returns
|
|
36
|
+
|
|
37
|
+
`void`
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Abstract Class: DataspaceProtocolHelper
|
|
2
|
+
|
|
3
|
+
Dataspace protocol helper.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new DataspaceProtocolHelper**(): `DataspaceProtocolHelper`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`DataspaceProtocolHelper`
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
### checkConformance()
|
|
18
|
+
|
|
19
|
+
> `static` **checkConformance**(`object`, `validationFailures`): `Promise`\<`boolean`\>
|
|
20
|
+
|
|
21
|
+
Checks whether the object passed as parameter is conformant to the DS Protocol definitions.
|
|
22
|
+
|
|
23
|
+
#### Parameters
|
|
24
|
+
|
|
25
|
+
##### object
|
|
26
|
+
|
|
27
|
+
`IJsonLdNodeObject`
|
|
28
|
+
|
|
29
|
+
The object to check
|
|
30
|
+
|
|
31
|
+
##### validationFailures
|
|
32
|
+
|
|
33
|
+
`IValidationFailure`[]
|
|
34
|
+
|
|
35
|
+
the Validation failures obtained during the conformance checking.
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
`Promise`\<`boolean`\>
|
|
40
|
+
|
|
41
|
+
true or false depending whether the object is conformant or not
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### normalize()
|
|
46
|
+
|
|
47
|
+
> `static` **normalize**(`object`): `Promise`\<`IJsonLdNodeObject`\>
|
|
48
|
+
|
|
49
|
+
Normalizes the input object making it compliant with the DS Protocol specifications.
|
|
50
|
+
|
|
51
|
+
#### Parameters
|
|
52
|
+
|
|
53
|
+
##### object
|
|
54
|
+
|
|
55
|
+
`IJsonLdNodeObject`
|
|
56
|
+
|
|
57
|
+
The input object.
|
|
58
|
+
|
|
59
|
+
#### Returns
|
|
60
|
+
|
|
61
|
+
`Promise`\<`IJsonLdNodeObject`\>
|
|
62
|
+
|
|
63
|
+
The input object normalized.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Class: TransferProcessDataTypes
|
|
2
|
+
|
|
3
|
+
Handle all the transfer process data types for Dataspace Protocol.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new TransferProcessDataTypes**(): `TransferProcessDataTypes`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`TransferProcessDataTypes`
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
### registerTypes()
|
|
18
|
+
|
|
19
|
+
> `static` **registerTypes**(): `void`
|
|
20
|
+
|
|
21
|
+
Register all the data types.
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`void`
|
package/docs/reference/index.md
CHANGED
|
@@ -2,30 +2,58 @@
|
|
|
2
2
|
|
|
3
3
|
## Classes
|
|
4
4
|
|
|
5
|
+
- [CatalogDataTypes](classes/CatalogDataTypes.md)
|
|
5
6
|
- [ContractNegotiationDataTypes](classes/ContractNegotiationDataTypes.md)
|
|
7
|
+
- [DataspaceProtocolDataTypes](classes/DataspaceProtocolDataTypes.md)
|
|
8
|
+
- [TransferProcessDataTypes](classes/TransferProcessDataTypes.md)
|
|
9
|
+
- [DataspaceProtocolHelper](classes/DataspaceProtocolHelper.md)
|
|
6
10
|
|
|
7
11
|
## Interfaces
|
|
8
12
|
|
|
9
|
-
- [
|
|
10
|
-
- [
|
|
11
|
-
- [
|
|
12
|
-
- [
|
|
13
|
-
- [
|
|
14
|
-
- [
|
|
15
|
-
- [
|
|
16
|
-
- [
|
|
13
|
+
- [IDataspaceProtocolCatalog](interfaces/IDataspaceProtocolCatalog.md)
|
|
14
|
+
- [IDataspaceProtocolCatalogError](interfaces/IDataspaceProtocolCatalogError.md)
|
|
15
|
+
- [IDataspaceProtocolCatalogRequestMessage](interfaces/IDataspaceProtocolCatalogRequestMessage.md)
|
|
16
|
+
- [IDataspaceProtocolDataService](interfaces/IDataspaceProtocolDataService.md)
|
|
17
|
+
- [IDataspaceProtocolDataset](interfaces/IDataspaceProtocolDataset.md)
|
|
18
|
+
- [IDataspaceProtocolDatasetRequestMessage](interfaces/IDataspaceProtocolDatasetRequestMessage.md)
|
|
19
|
+
- [IDataspaceProtocolDistribution](interfaces/IDataspaceProtocolDistribution.md)
|
|
20
|
+
- [IDataspaceProtocolContractAgreementMessage](interfaces/IDataspaceProtocolContractAgreementMessage.md)
|
|
21
|
+
- [IDataspaceProtocolContractAgreementVerificationMessage](interfaces/IDataspaceProtocolContractAgreementVerificationMessage.md)
|
|
22
|
+
- [IDataspaceProtocolContractNegotiation](interfaces/IDataspaceProtocolContractNegotiation.md)
|
|
23
|
+
- [IDataspaceProtocolContractNegotiationError](interfaces/IDataspaceProtocolContractNegotiationError.md)
|
|
24
|
+
- [IDataspaceProtocolContractNegotiationEventMessage](interfaces/IDataspaceProtocolContractNegotiationEventMessage.md)
|
|
25
|
+
- [IDataspaceProtocolContractNegotiationTerminationMessage](interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md)
|
|
26
|
+
- [IDataspaceProtocolContractOfferMessage](interfaces/IDataspaceProtocolContractOfferMessage.md)
|
|
27
|
+
- [IDataspaceProtocolContractRequestMessage](interfaces/IDataspaceProtocolContractRequestMessage.md)
|
|
28
|
+
- [IDataspaceProtocolDataAddress](interfaces/IDataspaceProtocolDataAddress.md)
|
|
29
|
+
- [IDataspaceProtocolEndpointProperty](interfaces/IDataspaceProtocolEndpointProperty.md)
|
|
30
|
+
- [IDataspaceProtocolTransferCompletionMessage](interfaces/IDataspaceProtocolTransferCompletionMessage.md)
|
|
31
|
+
- [IDataspaceProtocolTransferError](interfaces/IDataspaceProtocolTransferError.md)
|
|
32
|
+
- [IDataspaceProtocolTransferProcess](interfaces/IDataspaceProtocolTransferProcess.md)
|
|
33
|
+
- [IDataspaceProtocolTransferRequestMessage](interfaces/IDataspaceProtocolTransferRequestMessage.md)
|
|
34
|
+
- [IDataspaceProtocolTransferStartMessage](interfaces/IDataspaceProtocolTransferStartMessage.md)
|
|
35
|
+
- [IDataspaceProtocolTransferSuspensionMessage](interfaces/IDataspaceProtocolTransferSuspensionMessage.md)
|
|
36
|
+
- [IDataspaceProtocolTransferTerminationMessage](interfaces/IDataspaceProtocolTransferTerminationMessage.md)
|
|
17
37
|
|
|
18
38
|
## Type Aliases
|
|
19
39
|
|
|
20
|
-
- [
|
|
21
|
-
- [
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [
|
|
40
|
+
- [DataspaceProtocolCatalogTypes](type-aliases/DataspaceProtocolCatalogTypes.md)
|
|
41
|
+
- [DataspaceProtocolContractNegotiationTypes](type-aliases/DataspaceProtocolContractNegotiationTypes.md)
|
|
42
|
+
- [DataspaceProtocolContractNegotiationEventType](type-aliases/DataspaceProtocolContractNegotiationEventType.md)
|
|
43
|
+
- [DataspaceProtocolContractNegotiationStateType](type-aliases/DataspaceProtocolContractNegotiationStateType.md)
|
|
44
|
+
- [DataspaceProtocolContextType](type-aliases/DataspaceProtocolContextType.md)
|
|
45
|
+
- [DataspaceProtocolContexts](type-aliases/DataspaceProtocolContexts.md)
|
|
46
|
+
- [DataspaceProtocolTransferProcessTypes](type-aliases/DataspaceProtocolTransferProcessTypes.md)
|
|
47
|
+
- [DataspaceProtocolEndpointType](type-aliases/DataspaceProtocolEndpointType.md)
|
|
48
|
+
- [DataspaceProtocolTransferProcessStateType](type-aliases/DataspaceProtocolTransferProcessStateType.md)
|
|
25
49
|
|
|
26
50
|
## Variables
|
|
27
51
|
|
|
28
|
-
- [
|
|
29
|
-
- [
|
|
30
|
-
- [
|
|
31
|
-
- [
|
|
52
|
+
- [DataspaceProtocolCatalogTypes](variables/DataspaceProtocolCatalogTypes.md)
|
|
53
|
+
- [DataspaceProtocolContractNegotiationTypes](variables/DataspaceProtocolContractNegotiationTypes.md)
|
|
54
|
+
- [DataspaceProtocolContractNegotiationEventType](variables/DataspaceProtocolContractNegotiationEventType.md)
|
|
55
|
+
- [DataspaceProtocolContractNegotiationStateType](variables/DataspaceProtocolContractNegotiationStateType.md)
|
|
56
|
+
- [DataspaceProtocolContexts](variables/DataspaceProtocolContexts.md)
|
|
57
|
+
- [DataspaceProtocolTransferProcessTypes](variables/DataspaceProtocolTransferProcessTypes.md)
|
|
58
|
+
- [DataspaceProtocolEndpointType](variables/DataspaceProtocolEndpointType.md)
|
|
59
|
+
- [DataspaceProtocolTransferProcessStateType](variables/DataspaceProtocolTransferProcessStateType.md)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolCatalog
|
|
2
|
+
|
|
3
|
+
Catalog interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
|
|
5
|
+
This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
6
|
+
by overriding properties with more specific types and constraints.
|
|
7
|
+
|
|
8
|
+
**Requirements per DS Protocol:**
|
|
9
|
+
- `@id` MUST be present for dataset identification (REQUIRED)
|
|
10
|
+
- participantId MUST be present (REQUIRED)
|
|
11
|
+
|
|
12
|
+
**Type System Design:**
|
|
13
|
+
- Interface extension allows TypeScript to override inherited property types
|
|
14
|
+
- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
15
|
+
- DS Protocol-specific constraints are defined here
|
|
16
|
+
|
|
17
|
+
## See
|
|
18
|
+
|
|
19
|
+
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
20
|
+
- https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
21
|
+
|
|
22
|
+
## Extends
|
|
23
|
+
|
|
24
|
+
- `Omit`\<`IDcatCatalog`, `"@type"` \| `"@context"` \| `"dcat:catalog"` \| `"dcat:dataset"` \| `"dcat:distribution"` \| `"dcat:service"`\>
|
|
25
|
+
|
|
26
|
+
## Indexable
|
|
27
|
+
|
|
28
|
+
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
29
|
+
|
|
30
|
+
\[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
|
|
31
|
+
|
|
32
|
+
## Properties
|
|
33
|
+
|
|
34
|
+
### @context
|
|
35
|
+
|
|
36
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
37
|
+
|
|
38
|
+
LD Context. Required per Eclipse Data Space Protocol.
|
|
39
|
+
|
|
40
|
+
***
|
|
41
|
+
|
|
42
|
+
### @type
|
|
43
|
+
|
|
44
|
+
> **@type**: `"Catalog"`
|
|
45
|
+
|
|
46
|
+
The type identifier for the Catalog.
|
|
47
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
48
|
+
|
|
49
|
+
***
|
|
50
|
+
|
|
51
|
+
### @id
|
|
52
|
+
|
|
53
|
+
> **@id**: `string`
|
|
54
|
+
|
|
55
|
+
Unique identifier for the dataset.
|
|
56
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
57
|
+
|
|
58
|
+
***
|
|
59
|
+
|
|
60
|
+
### participantId
|
|
61
|
+
|
|
62
|
+
> **participantId**: `string`
|
|
63
|
+
|
|
64
|
+
Participant Id
|
|
65
|
+
|
|
66
|
+
***
|
|
67
|
+
|
|
68
|
+
### catalog?
|
|
69
|
+
|
|
70
|
+
> `optional` **catalog**: `ObjectOrArray`\<`Omit`\<`IDataspaceProtocolCatalog`, `"@context"`\>\>
|
|
71
|
+
|
|
72
|
+
Other concerned catalogs
|
|
73
|
+
|
|
74
|
+
***
|
|
75
|
+
|
|
76
|
+
### dataset?
|
|
77
|
+
|
|
78
|
+
> `optional` **dataset**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md), `"@context"`\>\>
|
|
79
|
+
|
|
80
|
+
Datasets registered
|
|
81
|
+
|
|
82
|
+
***
|
|
83
|
+
|
|
84
|
+
### distribution?
|
|
85
|
+
|
|
86
|
+
> `optional` **distribution**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md), `"@context"`\>\>
|
|
87
|
+
|
|
88
|
+
Catalog's distributions
|
|
89
|
+
|
|
90
|
+
***
|
|
91
|
+
|
|
92
|
+
### service?
|
|
93
|
+
|
|
94
|
+
> `optional` **service**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md), `"@context"`\>\>
|
|
95
|
+
|
|
96
|
+
Data services registered-
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolCatalogError
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Catalog Error.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
The JSON-LD context.
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"CatalogError"`
|
|
19
|
+
|
|
20
|
+
The type of the message.
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### code
|
|
25
|
+
|
|
26
|
+
> **code**: `string`
|
|
27
|
+
|
|
28
|
+
The error code.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### reason?
|
|
33
|
+
|
|
34
|
+
> `optional` **reason**: `any`[]
|
|
35
|
+
|
|
36
|
+
The error reason(s).
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolCatalogRequestMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Catalog Request Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
The JSON-LD context.
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"CatalogRequestMessage"`
|
|
19
|
+
|
|
20
|
+
The type of the message.
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### filter?
|
|
25
|
+
|
|
26
|
+
> `optional` **filter**: `unknown`[]
|
|
27
|
+
|
|
28
|
+
An implementation-specific query or filter expression.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractAgreementMessage
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Agreement Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractAgreementMessage"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractAgreementVerificationMessage
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Agreement Verification Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractAgreementVerificationMessage"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractNegotiation
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Agreement Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractNegotiation"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -39,6 +39,6 @@ The consumer id for the contract.
|
|
|
39
39
|
|
|
40
40
|
### state
|
|
41
41
|
|
|
42
|
-
> **state**: [`
|
|
42
|
+
> **state**: [`DataspaceProtocolContractNegotiationStateType`](../type-aliases/DataspaceProtocolContractNegotiationStateType.md)
|
|
43
43
|
|
|
44
44
|
The offer being requested.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractNegotiationError
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Negotiation Error Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#erro
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractNegotiationError"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -47,30 +47,6 @@ The error code.
|
|
|
47
47
|
|
|
48
48
|
### reason?
|
|
49
49
|
|
|
50
|
-
> `optional` **reason**: `
|
|
50
|
+
> `optional` **reason**: `any`[]
|
|
51
51
|
|
|
52
52
|
The error reason(s).
|
|
53
|
-
|
|
54
|
-
#### @value
|
|
55
|
-
|
|
56
|
-
> **@value**: `string`
|
|
57
|
-
|
|
58
|
-
#### @language?
|
|
59
|
-
|
|
60
|
-
> `optional` **@language**: `string`
|
|
61
|
-
|
|
62
|
-
***
|
|
63
|
-
|
|
64
|
-
### description?
|
|
65
|
-
|
|
66
|
-
> `optional` **description**: `object`[]
|
|
67
|
-
|
|
68
|
-
The error description(s).
|
|
69
|
-
|
|
70
|
-
#### @value
|
|
71
|
-
|
|
72
|
-
> **@value**: `string`
|
|
73
|
-
|
|
74
|
-
#### @language?
|
|
75
|
-
|
|
76
|
-
> `optional` **@language**: `string`
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractNegotiationEventMessage
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Negotiation Event Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractNegotiationEventMessage"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -39,6 +39,6 @@ The consumer id for the contract.
|
|
|
39
39
|
|
|
40
40
|
### event
|
|
41
41
|
|
|
42
|
-
> **event**: [`
|
|
42
|
+
> **event**: [`DataspaceProtocolContractNegotiationEventType`](../type-aliases/DataspaceProtocolContractNegotiationEventType.md)
|
|
43
43
|
|
|
44
44
|
The event type.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractNegotiationTerminationMessage
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Negotiation Termination Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractNegotiationTerminationMessage"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractOfferMessage
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Offer Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractOfferMessage"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IDataspaceProtocolContractRequestMessage
|
|
2
2
|
|
|
3
3
|
Interface for Dataspace Protocol Contract Request Messages.
|
|
4
4
|
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
|
|
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
|
|
|
7
7
|
|
|
8
8
|
### @context
|
|
9
9
|
|
|
10
|
-
> **@context**: [`
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
11
|
|
|
12
12
|
The JSON-LD context.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ The JSON-LD context.
|
|
|
15
15
|
|
|
16
16
|
### @type
|
|
17
17
|
|
|
18
|
-
> **@type**: `
|
|
18
|
+
> **@type**: `"ContractRequestMessage"`
|
|
19
19
|
|
|
20
20
|
The type of the message.
|
|
21
21
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolDataAddress
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @type
|
|
9
|
+
|
|
10
|
+
> **@type**: `"DataAddress"`
|
|
11
|
+
|
|
12
|
+
LD Type
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### endpointType
|
|
17
|
+
|
|
18
|
+
> **endpointType**: `string`
|
|
19
|
+
|
|
20
|
+
The type of endpoint of this data address.
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### endpoint?
|
|
25
|
+
|
|
26
|
+
> `optional` **endpoint**: `string`
|
|
27
|
+
|
|
28
|
+
The endpoint of the data address
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### endpointProperties?
|
|
33
|
+
|
|
34
|
+
> `optional` **endpointProperties**: [`IDataspaceProtocolEndpointProperty`](IDataspaceProtocolEndpointProperty.md)[]
|
|
35
|
+
|
|
36
|
+
Properties associated to the endpoint which might depend on the endpoint type.
|