@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,72 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolDataService
|
|
2
|
+
|
|
3
|
+
Data Service interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
|
|
5
|
+
This interface extends IDataService 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
|
+
- endpointURL 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`\<`IDcatDataService`, `"@type"` \| `"@context"` \| `"dcat:servesDataset"` \| `"dcat:endpointURL"`\>
|
|
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**: `"DataService"`
|
|
45
|
+
|
|
46
|
+
The type identifier for the Data Service.
|
|
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
|
+
### endpointURL
|
|
61
|
+
|
|
62
|
+
> **endpointURL**: `string`
|
|
63
|
+
|
|
64
|
+
Endpoint URL
|
|
65
|
+
|
|
66
|
+
***
|
|
67
|
+
|
|
68
|
+
### servesDataset?
|
|
69
|
+
|
|
70
|
+
> `optional` **servesDataset**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md), `"@context"`\>\>
|
|
71
|
+
|
|
72
|
+
Datasets served.
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolDataset
|
|
2
|
+
|
|
3
|
+
Dataset interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
|
|
5
|
+
This interface extends IDataset 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
|
+
- `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
|
|
11
|
+
- Array MUST contain at least one IOdrlOffer
|
|
12
|
+
- Each Offer MUST have `@type`: "Offer"
|
|
13
|
+
- Each Offer MUST have `@id` or `uid` for identification
|
|
14
|
+
- `dcat:distribution` MUST be present (REQUIRED)
|
|
15
|
+
|
|
16
|
+
**Type System Design:**
|
|
17
|
+
- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
18
|
+
- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
19
|
+
- Interface extension allows TypeScript to override inherited property types
|
|
20
|
+
- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
21
|
+
- DS Protocol-specific constraints are defined here
|
|
22
|
+
|
|
23
|
+
**Future Compatibility:**
|
|
24
|
+
- Currently only one Offer per dataset is supported
|
|
25
|
+
- Array structure allows future support for multiple offers
|
|
26
|
+
|
|
27
|
+
## See
|
|
28
|
+
|
|
29
|
+
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
30
|
+
- https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
31
|
+
- IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
32
|
+
- IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
33
|
+
|
|
34
|
+
## Extends
|
|
35
|
+
|
|
36
|
+
- `Omit`\<`IDcatDataset`, `"odrl:hasPolicy"` \| `"dcat:distribution"` \| `"@type"` \| `"@context"`\>
|
|
37
|
+
|
|
38
|
+
## Indexable
|
|
39
|
+
|
|
40
|
+
\[`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`
|
|
41
|
+
|
|
42
|
+
\[`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`
|
|
43
|
+
|
|
44
|
+
## Properties
|
|
45
|
+
|
|
46
|
+
### @context
|
|
47
|
+
|
|
48
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
49
|
+
|
|
50
|
+
LD Context. Required per Eclipse Data Space Protocol.
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### @type
|
|
55
|
+
|
|
56
|
+
> **@type**: `"Dataset"`
|
|
57
|
+
|
|
58
|
+
The type identifier for the dataset.
|
|
59
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### @id
|
|
64
|
+
|
|
65
|
+
> **@id**: `string`
|
|
66
|
+
|
|
67
|
+
Unique identifier for the dataset.
|
|
68
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
69
|
+
|
|
70
|
+
***
|
|
71
|
+
|
|
72
|
+
### hasPolicy
|
|
73
|
+
|
|
74
|
+
> **hasPolicy**: `ObjectOrArray`\<`Omit`\<`IOdrlOffer`, `"@context"`\>\>
|
|
75
|
+
|
|
76
|
+
Array of ODRL policies (Offers) as required by DS Protocol.
|
|
77
|
+
|
|
78
|
+
REQUIRED per Eclipse Data Space Protocol spec.
|
|
79
|
+
Must contain at least one IOdrlOffer.
|
|
80
|
+
Currently only single offer is supported, but array structure
|
|
81
|
+
allows for future multi-offer support.
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### distribution
|
|
86
|
+
|
|
87
|
+
> **distribution**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md), `"@context"`\>\>
|
|
88
|
+
|
|
89
|
+
Distribution of the dataset.
|
|
90
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolDatasetRequestMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Dataset Request Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-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**: `"DatasetRequestMessage"`
|
|
19
|
+
|
|
20
|
+
The type of the message.
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### dataset
|
|
25
|
+
|
|
26
|
+
> **dataset**: `string`
|
|
27
|
+
|
|
28
|
+
The identifier of the dataset.
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolDistribution
|
|
2
|
+
|
|
3
|
+
Distribution interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
|
|
5
|
+
This interface extends IDistribution 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
|
+
- `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
|
|
11
|
+
- Array MUST contain at least one IOdrlOffer
|
|
12
|
+
- Each Offer MUST have `@type`: "Offer"
|
|
13
|
+
- `format` is REQUIRED.
|
|
14
|
+
|
|
15
|
+
**Type System Design:**
|
|
16
|
+
- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
17
|
+
- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
18
|
+
- Interface extension allows TypeScript to override inherited property types
|
|
19
|
+
- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
20
|
+
- DS Protocol-specific constraints are defined here
|
|
21
|
+
|
|
22
|
+
**Future Compatibility:**
|
|
23
|
+
- Currently only one Offer per dataset is supported
|
|
24
|
+
- Array structure allows future support for multiple offers
|
|
25
|
+
|
|
26
|
+
## See
|
|
27
|
+
|
|
28
|
+
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
29
|
+
- https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
30
|
+
- IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
31
|
+
- IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
32
|
+
|
|
33
|
+
## Extends
|
|
34
|
+
|
|
35
|
+
- `Omit`\<`IDcatDistribution`, `"odrl:hasPolicy"` \| `"@type"` \| `"@context"` \| `"dcterms:format"`\>
|
|
36
|
+
|
|
37
|
+
## Indexable
|
|
38
|
+
|
|
39
|
+
\[`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`
|
|
40
|
+
|
|
41
|
+
\[`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`
|
|
42
|
+
|
|
43
|
+
## Properties
|
|
44
|
+
|
|
45
|
+
### @context
|
|
46
|
+
|
|
47
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
48
|
+
|
|
49
|
+
LD Context. Required per Eclipse Data Space Protocol.
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### @type
|
|
54
|
+
|
|
55
|
+
> **@type**: `"Distribution"`
|
|
56
|
+
|
|
57
|
+
The type identifier for the Distribution.
|
|
58
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### @id
|
|
63
|
+
|
|
64
|
+
> **@id**: `string`
|
|
65
|
+
|
|
66
|
+
Unique identifier for the dataset.
|
|
67
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
68
|
+
|
|
69
|
+
***
|
|
70
|
+
|
|
71
|
+
### hasPolicy?
|
|
72
|
+
|
|
73
|
+
> `optional` **hasPolicy**: `ObjectOrArray`\<`Omit`\<`IOdrlOffer`, `"@context"`\>\>
|
|
74
|
+
|
|
75
|
+
Array of ODRL policies (Offers) as required by DS Protocol.
|
|
76
|
+
|
|
77
|
+
REQUIRED per Eclipse Data Space Protocol spec.
|
|
78
|
+
Must contain at least one IOdrlOffer.
|
|
79
|
+
Currently only single offer is supported, but array structure
|
|
80
|
+
allows for future multi-offer support.
|
|
81
|
+
|
|
82
|
+
***
|
|
83
|
+
|
|
84
|
+
### accessService
|
|
85
|
+
|
|
86
|
+
> **accessService**: `string` \| `Omit`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md), `"@context"`\>
|
|
87
|
+
|
|
88
|
+
Access service.
|
|
89
|
+
It can be a URI pointing to an access service or inline the access service itself
|
|
90
|
+
|
|
91
|
+
***
|
|
92
|
+
|
|
93
|
+
### format
|
|
94
|
+
|
|
95
|
+
> **format**: `string`
|
|
96
|
+
|
|
97
|
+
Distribution format.
|
|
98
|
+
REQUIRED per Eclipse Data Space Protocol.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolEndpointProperty
|
|
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**: `"EndpointProperty"`
|
|
11
|
+
|
|
12
|
+
LD Type.
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### name
|
|
17
|
+
|
|
18
|
+
> **name**: `string`
|
|
19
|
+
|
|
20
|
+
Property name.
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### value
|
|
25
|
+
|
|
26
|
+
> **value**: `string`
|
|
27
|
+
|
|
28
|
+
Property value.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferCompletionMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferCompletionMessage"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### consumerPid
|
|
25
|
+
|
|
26
|
+
> **consumerPid**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerPid
|
|
33
|
+
|
|
34
|
+
> **providerPid**: `string`
|
|
35
|
+
|
|
36
|
+
MUST refer to the transfer identifier of the Provider side.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferError
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferError"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### consumerPid
|
|
25
|
+
|
|
26
|
+
> **consumerPid**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerPid
|
|
33
|
+
|
|
34
|
+
> **providerPid**: `string`
|
|
35
|
+
|
|
36
|
+
MUST refer to the transfer identifier of the Provider side.
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### code?
|
|
41
|
+
|
|
42
|
+
> `optional` **code**: `string`
|
|
43
|
+
|
|
44
|
+
The error code.
|
|
45
|
+
|
|
46
|
+
***
|
|
47
|
+
|
|
48
|
+
### reason?
|
|
49
|
+
|
|
50
|
+
> `optional` **reason**: `any`[]
|
|
51
|
+
|
|
52
|
+
The error reason(s).
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferProcess
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferProcess"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### consumerPid
|
|
25
|
+
|
|
26
|
+
> **consumerPid**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerPid
|
|
33
|
+
|
|
34
|
+
> **providerPid**: `string`
|
|
35
|
+
|
|
36
|
+
MUST refer to the transfer identifier of the Provider side.
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### state
|
|
41
|
+
|
|
42
|
+
> **state**: [`DataspaceProtocolTransferProcessStateType`](../type-aliases/DataspaceProtocolTransferProcessStateType.md)
|
|
43
|
+
|
|
44
|
+
The transfer process state.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferRequestMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferRequestMessage"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### agreementId
|
|
25
|
+
|
|
26
|
+
> **agreementId**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to an existing Agreement between the Consumer and Provider.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### callbackAddress
|
|
33
|
+
|
|
34
|
+
> **callbackAddress**: `string`
|
|
35
|
+
|
|
36
|
+
MUST be a URI indicating where messages to the Consumer SHOULD be sent.
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### consumerPid
|
|
41
|
+
|
|
42
|
+
> **consumerPid**: `string`
|
|
43
|
+
|
|
44
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
45
|
+
|
|
46
|
+
***
|
|
47
|
+
|
|
48
|
+
### format
|
|
49
|
+
|
|
50
|
+
> **format**: `string`
|
|
51
|
+
|
|
52
|
+
The format property is a format specified by a Distribution for the Dataset associated with the Agreement.
|
|
53
|
+
This is generally obtained from the Provider's Catalog.
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### dataAddress?
|
|
58
|
+
|
|
59
|
+
> `optional` **dataAddress**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
|
|
60
|
+
|
|
61
|
+
If defined MUST contain a transport-specific set of properties for pushing the data.
|
|
62
|
+
It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferStartMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferStartMessage"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### consumerPid
|
|
25
|
+
|
|
26
|
+
> **consumerPid**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerPid
|
|
33
|
+
|
|
34
|
+
> **providerPid**: `string`
|
|
35
|
+
|
|
36
|
+
MUST refer to the transfer identifier of the Provider side.
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### dataAddress?
|
|
41
|
+
|
|
42
|
+
> `optional` **dataAddress**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
|
|
43
|
+
|
|
44
|
+
MUST be provided if the current transfer is a pull transfer and
|
|
45
|
+
contains a transport-specific endpoint address for obtaining the data.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferSuspensionMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferSuspensionMessage"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### consumerPid
|
|
25
|
+
|
|
26
|
+
> **consumerPid**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerPid
|
|
33
|
+
|
|
34
|
+
> **providerPid**: `string`
|
|
35
|
+
|
|
36
|
+
MUST refer to the transfer identifier of the Provider side.
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### code?
|
|
41
|
+
|
|
42
|
+
> `optional` **code**: `string`
|
|
43
|
+
|
|
44
|
+
The suspension code.
|
|
45
|
+
|
|
46
|
+
***
|
|
47
|
+
|
|
48
|
+
### reason?
|
|
49
|
+
|
|
50
|
+
> `optional` **reason**: `any`[]
|
|
51
|
+
|
|
52
|
+
The suspension reason(s).
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolTransferTerminationMessage
|
|
2
|
+
|
|
3
|
+
Interface for Dataspace Protocol Transfer Messages.
|
|
4
|
+
https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
### @context
|
|
9
|
+
|
|
10
|
+
> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
|
|
11
|
+
|
|
12
|
+
LD Context
|
|
13
|
+
|
|
14
|
+
***
|
|
15
|
+
|
|
16
|
+
### @type
|
|
17
|
+
|
|
18
|
+
> **@type**: `"TransferTerminationMessage"`
|
|
19
|
+
|
|
20
|
+
LD Type
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### consumerPid
|
|
25
|
+
|
|
26
|
+
> **consumerPid**: `string`
|
|
27
|
+
|
|
28
|
+
MUST refer to the transfer identifier of the Consumer side.
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### providerPid
|
|
33
|
+
|
|
34
|
+
> **providerPid**: `string`
|
|
35
|
+
|
|
36
|
+
MUST refer to the transfer identifier of the Provider side.
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### code?
|
|
41
|
+
|
|
42
|
+
> `optional` **code**: `string`
|
|
43
|
+
|
|
44
|
+
The termination code.
|
|
45
|
+
|
|
46
|
+
***
|
|
47
|
+
|
|
48
|
+
### reason?
|
|
49
|
+
|
|
50
|
+
> `optional` **reason**: `any`[]
|
|
51
|
+
|
|
52
|
+
The termination reason(s).
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: DataspaceProtocolCatalogTypes
|
|
2
|
+
|
|
3
|
+
> **DataspaceProtocolCatalogTypes** = *typeof* [`DataspaceProtocolCatalogTypes`](../variables/DataspaceProtocolCatalogTypes.md)\[keyof *typeof* [`DataspaceProtocolCatalogTypes`](../variables/DataspaceProtocolCatalogTypes.md)\]
|
|
4
|
+
|
|
5
|
+
The types for Dataspace Protocol Catalog Protocol.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: DataspaceProtocolContextType
|
|
2
|
+
|
|
3
|
+
> **DataspaceProtocolContextType** = *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context) \| \[*typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context)\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context), `...IJsonLdContextDefinitionElement[]`\]
|
|
4
|
+
|
|
5
|
+
The Dataspace Protocol JSON-LD context type.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: DataspaceProtocolContexts
|
|
2
|
+
|
|
3
|
+
> **DataspaceProtocolContexts** = *typeof* [`DataspaceProtocolContexts`](../variables/DataspaceProtocolContexts.md)\[keyof *typeof* [`DataspaceProtocolContexts`](../variables/DataspaceProtocolContexts.md)\]
|
|
4
|
+
|
|
5
|
+
The contexts for Dataspace Protocol Protocol.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: DataspaceProtocolContractNegotiationEventType
|
|
2
|
+
|
|
3
|
+
> **DataspaceProtocolContractNegotiationEventType** = *typeof* [`DataspaceProtocolContractNegotiationEventType`](../variables/DataspaceProtocolContractNegotiationEventType.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationEventType`](../variables/DataspaceProtocolContractNegotiationEventType.md)\]
|
|
4
|
+
|
|
5
|
+
The types for Dataspace Protocol Contract Negotiation Events.
|