@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.61
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/README.md +1 -1
- package/dist/es/dataTypes/catalogDataTypes.js +93 -20
- package/dist/es/dataTypes/catalogDataTypes.js.map +1 -1
- package/dist/es/dataTypes/contractNegotiationDataTypes.js +58 -62
- package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +1 -1
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js +10 -1
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js.map +1 -1
- package/dist/es/dataTypes/transferProcessDataTypes.js +53 -56
- package/dist/es/dataTypes/transferProcessDataTypes.js.map +1 -1
- package/dist/es/index.js +45 -28
- package/dist/es/index.js.map +1 -1
- 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/IDataspaceProtocolDatasetRequestMessage.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js.map +1 -0
- package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +54 -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} +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/dcat3/IDataspaceProtocolCatalog.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolCatalog.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataService.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataService.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataset.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataset.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js.map +1 -0
- package/dist/es/models/odrl/IDataspaceProtocolAgreement.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolAgreement.js.map +1 -0
- package/dist/es/models/odrl/IDataspaceProtocolOffer.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolOffer.js.map +1 -0
- package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js.map +1 -0
- package/dist/es/models/odrl/IDataspaceProtocolPolicy.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolPolicy.js.map +1 -0
- package/dist/es/models/odrl/IDataspaceProtocolSet.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolSet.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/{ITransferSuspensionMessage.js → IDataspaceProtocolTransferSuspensionMessage.js} +1 -1
- 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/{transferProcessTypes.js → dataspaceProtocolTransferProcessTypes.js} +2 -2
- 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/{transferProcessStateType.js → dataspaceProtocolTransferProcessStateType.js} +2 -2
- package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -0
- package/dist/es/schemas/DataspaceProtocolAgreement.json +207 -0
- package/dist/es/schemas/DataspaceProtocolCatalog.json +21 -0
- package/dist/es/schemas/DataspaceProtocolCatalogBase.json +428 -0
- package/dist/es/schemas/DataspaceProtocolCatalogError.json +31 -0
- package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +26 -0
- package/dist/es/schemas/DataspaceProtocolContextType.json +30 -0
- package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +225 -0
- package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json +31 -0
- package/dist/es/schemas/DataspaceProtocolContractNegotiation.json +36 -0
- package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json +40 -0
- package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json +36 -0
- package/dist/es/schemas/DataspaceProtocolContractNegotiationEventType.json +16 -0
- package/dist/es/schemas/DataspaceProtocolContractNegotiationStateType.json +36 -0
- package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json +40 -0
- package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json +39 -0
- package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json +39 -0
- package/dist/es/schemas/{DataAddress.json → DataspaceProtocolDataAddress.json} +5 -6
- package/dist/es/schemas/DataspaceProtocolDataService.json +21 -0
- package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +279 -0
- package/dist/es/schemas/DataspaceProtocolDataset.json +21 -0
- package/dist/es/schemas/DataspaceProtocolDatasetBase.json +330 -0
- package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +26 -0
- package/dist/es/schemas/DataspaceProtocolDistribution.json +26 -0
- package/dist/es/schemas/DataspaceProtocolDistributionBase.json +164 -0
- package/dist/es/schemas/{EndpointProperty.json → DataspaceProtocolEndpointProperty.json} +4 -5
- package/dist/es/schemas/DataspaceProtocolOffer.json +26 -0
- package/dist/es/schemas/DataspaceProtocolOfferBase.json +219 -0
- package/dist/es/schemas/DataspaceProtocolPolicy.json +231 -0
- package/dist/es/schemas/DataspaceProtocolSet.json +243 -0
- package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +31 -0
- package/dist/es/schemas/DataspaceProtocolTransferError.json +40 -0
- package/dist/es/schemas/DataspaceProtocolTransferProcess.json +36 -0
- package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +45 -0
- package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +35 -0
- package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +40 -0
- package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +40 -0
- package/dist/es/utils/dataspaceProtocolHelper.js +108 -0
- package/dist/es/utils/dataspaceProtocolHelper.js.map +1 -0
- package/dist/types/index.d.ts +43 -28
- package/dist/types/models/catalog/{ICatalogError.d.ts → IDataspaceProtocolCatalogError.d.ts} +3 -3
- package/dist/types/models/catalog/{ICatalogRequestMessage.d.ts → IDataspaceProtocolCatalogRequestMessage.d.ts} +3 -3
- package/dist/types/models/catalog/{IDatasetRequestMessage.d.ts → IDataspaceProtocolDatasetRequestMessage.d.ts} +3 -3
- package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +54 -0
- package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts} +6 -5
- 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} +3 -3
- 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} +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 +2 -9
- package/dist/types/models/dataspaceProtocolContexts.d.ts +12 -4
- package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +28 -0
- package/dist/types/models/dcat3/IDataspaceProtocolCatalogBase.d.ts +58 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +28 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +44 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +38 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +62 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +42 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +66 -0
- package/dist/types/models/odrl/IDataspaceProtocolAgreement.d.ts +17 -0
- package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +22 -0
- package/dist/types/models/odrl/IDataspaceProtocolOfferBase.d.ts +18 -0
- package/dist/types/models/odrl/IDataspaceProtocolPolicy.d.ts +17 -0
- package/dist/types/models/odrl/IDataspaceProtocolSet.d.ts +17 -0
- package/dist/types/models/transferProcess/{IDataAddress.d.ts → IDataspaceProtocolDataAddress.d.ts} +5 -5
- package/dist/types/models/transferProcess/{IEndpointProperty.d.ts → IDataspaceProtocolEndpointProperty.d.ts} +3 -3
- package/dist/types/models/transferProcess/{ITransferCompletionMessage.d.ts → IDataspaceProtocolTransferCompletionMessage.d.ts} +3 -3
- package/dist/types/models/transferProcess/{ITransferError.d.ts → IDataspaceProtocolTransferError.d.ts} +3 -3
- package/dist/types/models/transferProcess/{ITransferProcess.d.ts → IDataspaceProtocolTransferProcess.d.ts} +5 -5
- package/dist/types/models/transferProcess/{ITransferRequestMessage.d.ts → IDataspaceProtocolTransferRequestMessage.d.ts} +5 -5
- package/dist/types/models/transferProcess/{ITransferStartMessage.d.ts → IDataspaceProtocolTransferStartMessage.d.ts} +5 -5
- package/dist/types/models/transferProcess/{ITransferSuspensionMessage.d.ts → IDataspaceProtocolTransferSuspensionMessage.d.ts} +3 -3
- package/dist/types/models/transferProcess/{ITransferTerminationMessage.d.ts → IDataspaceProtocolTransferTerminationMessage.d.ts} +3 -3
- 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 +19 -0
- package/docs/changelog.md +991 -12
- package/docs/examples.md +44 -1
- package/docs/reference/classes/CatalogDataTypes.md +1 -1
- package/docs/reference/classes/ContractNegotiationDataTypes.md +1 -1
- package/docs/reference/classes/DataspaceProtocolDataTypes.md +2 -2
- package/docs/reference/classes/DataspaceProtocolHelper.md +57 -0
- package/docs/reference/classes/TransferProcessDataTypes.md +1 -1
- package/docs/reference/index.md +48 -32
- package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +179 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +598 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +570 -0
- package/docs/reference/interfaces/{ICatalogError.md → IDataspaceProtocolCatalogError.md} +6 -6
- package/docs/reference/interfaces/{ICatalogRequestMessage.md → IDataspaceProtocolCatalogRequestMessage.md} +5 -5
- package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +10 -10
- package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +6 -6
- package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +8 -8
- package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +10 -10
- package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +8 -8
- package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +10 -10
- package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +11 -11
- package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +11 -11
- package/docs/reference/interfaces/{IDataAddress.md → IDataspaceProtocolDataAddress.md} +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +403 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +387 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +500 -0
- package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +484 -0
- package/docs/reference/interfaces/{IDatasetRequestMessage.md → IDataspaceProtocolDatasetRequestMessage.md} +4 -4
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +400 -0
- package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +381 -0
- package/docs/reference/interfaces/{IEndpointProperty.md → IDataspaceProtocolEndpointProperty.md} +5 -5
- package/docs/reference/interfaces/IDataspaceProtocolOffer.md +178 -0
- package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +171 -0
- package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +180 -0
- package/docs/reference/interfaces/IDataspaceProtocolSet.md +179 -0
- package/docs/reference/interfaces/{ITransferCompletionMessage.md → IDataspaceProtocolTransferCompletionMessage.md} +6 -6
- package/docs/reference/interfaces/{ITransferError.md → IDataspaceProtocolTransferError.md} +10 -10
- package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +44 -0
- package/docs/reference/interfaces/{ITransferRequestMessage.md → IDataspaceProtocolTransferRequestMessage.md} +10 -10
- package/docs/reference/interfaces/{ITransferStartMessage.md → IDataspaceProtocolTransferStartMessage.md} +8 -8
- package/docs/reference/interfaces/{ITransferSuspensionMessage.md → IDataspaceProtocolTransferSuspensionMessage.md} +10 -10
- package/docs/reference/interfaces/{ITransferTerminationMessage.md → IDataspaceProtocolTransferTerminationMessage.md} +10 -10
- package/docs/reference/type-aliases/DataspaceProtocolCatalogTypes.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContextType.md +1 -1
- 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 +74 -0
- package/docs/reference/variables/DataspaceProtocolContexts.md +18 -6
- package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md} +4 -4
- package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md} +9 -9
- 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 +10 -1
- package/package.json +6 -6
- 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 +0 -22
- 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/es/models/transferProcess/IDataAddress.js +0 -2
- package/dist/es/models/transferProcess/IDataAddress.js.map +0 -1
- package/dist/es/models/transferProcess/IEndpointProperty.js +0 -2
- package/dist/es/models/transferProcess/IEndpointProperty.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferCompletionMessage.js +0 -2
- package/dist/es/models/transferProcess/ITransferCompletionMessage.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferError.js +0 -2
- package/dist/es/models/transferProcess/ITransferError.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferProcess.js +0 -2
- package/dist/es/models/transferProcess/ITransferProcess.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferRequestMessage.js +0 -2
- package/dist/es/models/transferProcess/ITransferRequestMessage.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferStartMessage.js +0 -2
- package/dist/es/models/transferProcess/ITransferStartMessage.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferSuspensionMessage.js.map +0 -1
- package/dist/es/models/transferProcess/ITransferTerminationMessage.js +0 -2
- package/dist/es/models/transferProcess/ITransferTerminationMessage.js.map +0 -1
- package/dist/es/models/transferProcess/transferProcessTypes.js.map +0 -1
- package/dist/es/models/transferProcess/types/transferProcessStateType.js.map +0 -1
- package/dist/es/schemas/CatalogError.json +0 -74
- package/dist/es/schemas/CatalogRequestMessage.json +0 -69
- package/dist/es/schemas/ContractAgreementMessage.json +0 -83
- package/dist/es/schemas/ContractAgreementVerificationMessage.json +0 -74
- package/dist/es/schemas/ContractNegotiation.json +0 -79
- package/dist/es/schemas/ContractNegotiationError.json +0 -83
- package/dist/es/schemas/ContractNegotiationEventMessage.json +0 -79
- package/dist/es/schemas/ContractNegotiationEventType.json +0 -10
- package/dist/es/schemas/ContractNegotiationStateType.json +0 -15
- package/dist/es/schemas/ContractNegotiationTerminationMessage.json +0 -83
- package/dist/es/schemas/ContractOfferMessage.json +0 -82
- package/dist/es/schemas/ContractRequestMessage.json +0 -82
- package/dist/es/schemas/DatasetRequestMessage.json +0 -69
- package/dist/es/schemas/TransferCompletionMessage.json +0 -74
- package/dist/es/schemas/TransferError.json +0 -83
- package/dist/es/schemas/TransferProcess.json +0 -109
- package/dist/es/schemas/TransferRequestMessage.json +0 -88
- package/dist/es/schemas/TransferStartMessage.json +0 -78
- package/dist/es/schemas/TransferSuspensionMessage.json +0 -83
- package/dist/es/schemas/TransferTerminationMessage.json +0 -83
- package/dist/types/models/catalog/catalogTypes.d.ts +0 -22
- package/dist/types/models/contractNegotiation/contractNegotiationTypes.d.ts +0 -50
- package/dist/types/models/transferProcess/transferProcessTypes.d.ts +0 -46
- package/dist/types/models/transferProcess/types/transferProcessStateType.d.ts +0 -30
- package/docs/reference/interfaces/ITransferProcess.md +0 -74
- 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/type-aliases/TransferProcessStateType.md +0 -5
- package/docs/reference/type-aliases/TransferProcessTypes.md +0 -5
- package/docs/reference/variables/CatalogTypes.md +0 -26
- package/docs/reference/variables/ContractNegotiationTypes.md +0 -68
- package/docs/reference/variables/TransferProcessStateType.md +0 -38
- package/docs/reference/variables/TransferProcessTypes.md +0 -62
|
@@ -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,7 @@
|
|
|
1
|
+
import type { SingleOccurrenceArray } from "@twin.org/core";
|
|
1
2
|
import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
|
|
2
3
|
import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
|
|
3
4
|
/**
|
|
4
5
|
* The Dataspace Protocol JSON-LD context type.
|
|
5
6
|
*/
|
|
6
|
-
export type DataspaceProtocolContextType =
|
|
7
|
-
...IJsonLdContextDefinitionElement[],
|
|
8
|
-
typeof DataspaceProtocolContexts.ContextRoot,
|
|
9
|
-
IJsonLdContextDefinitionElement
|
|
10
|
-
] | [
|
|
11
|
-
IJsonLdContextDefinitionElement,
|
|
12
|
-
typeof DataspaceProtocolContexts.ContextRoot,
|
|
13
|
-
...IJsonLdContextDefinitionElement[]
|
|
14
|
-
];
|
|
7
|
+
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.Context | SingleOccurrenceArray<IJsonLdContextDefinitionElement, typeof DataspaceProtocolContexts.Context>;
|
|
@@ -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,28 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { IDataspaceProtocolCatalogBase } from "./IDataspaceProtocolCatalogBase.js";
|
|
3
|
+
/**
|
|
4
|
+
* Catalog interface compliant with Eclipse Data Space Protocol.
|
|
5
|
+
*
|
|
6
|
+
* This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
7
|
+
* by overriding properties with more specific types and constraints.
|
|
8
|
+
*
|
|
9
|
+
* **Requirements per DS Protocol:**
|
|
10
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
+
* - participantId MUST be present (REQUIRED)
|
|
12
|
+
*
|
|
13
|
+
* **Type System Design:**
|
|
14
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
15
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
16
|
+
* - DS Protocol-specific constraints are defined here
|
|
17
|
+
*
|
|
18
|
+
*
|
|
19
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
20
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
export interface IDataspaceProtocolCatalog extends IDataspaceProtocolCatalogBase {
|
|
24
|
+
/**
|
|
25
|
+
* LD Context. Required per Eclipse Data Space Protocol.
|
|
26
|
+
*/
|
|
27
|
+
"@context": DataspaceProtocolContextType;
|
|
28
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type { ObjectOrArray } from "@twin.org/core";
|
|
2
|
+
import type { IDcatCatalogBase } from "@twin.org/standards-w3c-dcat";
|
|
3
|
+
import type { IDataspaceProtocolDataServiceBase } from "./IDataspaceProtocolDataServiceBase.js";
|
|
4
|
+
import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetBase.js";
|
|
5
|
+
import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDistributionBase.js";
|
|
6
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
7
|
+
/**
|
|
8
|
+
* Catalog interface compliant with Eclipse Data Space Protocol.
|
|
9
|
+
*
|
|
10
|
+
* This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
11
|
+
* by overriding properties with more specific types and constraints.
|
|
12
|
+
*
|
|
13
|
+
* **Requirements per DS Protocol:**
|
|
14
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
15
|
+
* - participantId MUST be present (REQUIRED)
|
|
16
|
+
*
|
|
17
|
+
* **Type System Design:**
|
|
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
|
+
*
|
|
23
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
24
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export interface IDataspaceProtocolCatalogBase extends Omit<IDcatCatalogBase, "@type" | "dcat:catalog" | "dcat:dataset" | "dcat:distribution" | "dcat:service"> {
|
|
28
|
+
/**
|
|
29
|
+
* The type identifier for the Catalog.
|
|
30
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
31
|
+
*/
|
|
32
|
+
"@type": typeof DataspaceProtocolCatalogTypes.Catalog;
|
|
33
|
+
/**
|
|
34
|
+
* Unique identifier for the dataset.
|
|
35
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
36
|
+
*/
|
|
37
|
+
"@id": string;
|
|
38
|
+
/**
|
|
39
|
+
* Participant Id
|
|
40
|
+
*/
|
|
41
|
+
participantId: string;
|
|
42
|
+
/**
|
|
43
|
+
* Other concerned catalogs
|
|
44
|
+
*/
|
|
45
|
+
catalog?: ObjectOrArray<IDataspaceProtocolCatalogBase>;
|
|
46
|
+
/**
|
|
47
|
+
* Datasets registered
|
|
48
|
+
*/
|
|
49
|
+
dataset?: ObjectOrArray<IDataspaceProtocolDatasetBase>;
|
|
50
|
+
/**
|
|
51
|
+
* Catalog's distributions
|
|
52
|
+
*/
|
|
53
|
+
distribution?: ObjectOrArray<IDataspaceProtocolDistributionBase>;
|
|
54
|
+
/**
|
|
55
|
+
* Data services registered-
|
|
56
|
+
*/
|
|
57
|
+
service?: ObjectOrArray<IDataspaceProtocolDataServiceBase>;
|
|
58
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { IDataspaceProtocolDataServiceBase } from "./IDataspaceProtocolDataServiceBase.js";
|
|
3
|
+
/**
|
|
4
|
+
* Data Service interface compliant with Eclipse Data Space Protocol.
|
|
5
|
+
*
|
|
6
|
+
* This interface extends IDataService and enforces DS Protocol-specific requirements
|
|
7
|
+
* by overriding properties with more specific types and constraints.
|
|
8
|
+
*
|
|
9
|
+
* **Requirements per DS Protocol:**
|
|
10
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
+
* - endpointURL MUST be present (REQUIRED)
|
|
12
|
+
*
|
|
13
|
+
* **Type System Design:**
|
|
14
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
15
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
16
|
+
* - DS Protocol-specific constraints are defined here
|
|
17
|
+
*
|
|
18
|
+
*
|
|
19
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
20
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
export interface IDataspaceProtocolDataService extends IDataspaceProtocolDataServiceBase {
|
|
24
|
+
/**
|
|
25
|
+
* LD Context. Required per Eclipse Data Space Protocol.
|
|
26
|
+
*/
|
|
27
|
+
"@context": DataspaceProtocolContextType;
|
|
28
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { IDcatDataServiceBase } from "@twin.org/standards-w3c-dcat";
|
|
2
|
+
import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetBase.js";
|
|
3
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
4
|
+
/**
|
|
5
|
+
* Data Service interface compliant with Eclipse Data Space Protocol.
|
|
6
|
+
*
|
|
7
|
+
* This interface extends IDataService and enforces DS Protocol-specific requirements
|
|
8
|
+
* by overriding properties with more specific types and constraints.
|
|
9
|
+
*
|
|
10
|
+
* **Requirements per DS Protocol:**
|
|
11
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
12
|
+
* - endpointURL MUST be present (REQUIRED)
|
|
13
|
+
*
|
|
14
|
+
* **Type System Design:**
|
|
15
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
16
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
17
|
+
* - DS Protocol-specific constraints are defined here
|
|
18
|
+
*
|
|
19
|
+
*
|
|
20
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
21
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
export interface IDataspaceProtocolDataServiceBase extends Omit<IDcatDataServiceBase, "@type" | "dcat:servesDataset" | "dcat:endpointURL"> {
|
|
25
|
+
/**
|
|
26
|
+
* The type identifier for the Data Service.
|
|
27
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
28
|
+
*/
|
|
29
|
+
"@type": typeof DataspaceProtocolCatalogTypes.DataService;
|
|
30
|
+
/**
|
|
31
|
+
* Unique identifier for the dataset.
|
|
32
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
33
|
+
*/
|
|
34
|
+
"@id": string;
|
|
35
|
+
/**
|
|
36
|
+
* Endpoint URL.
|
|
37
|
+
*/
|
|
38
|
+
endpointURL: string;
|
|
39
|
+
/**
|
|
40
|
+
* Datasets served.
|
|
41
|
+
* @json-schema minItems:1
|
|
42
|
+
*/
|
|
43
|
+
servesDataset?: IDataspaceProtocolDatasetBase[];
|
|
44
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetBase.js";
|
|
3
|
+
/**
|
|
4
|
+
* Dataset interface compliant with Eclipse Data Space Protocol.
|
|
5
|
+
*
|
|
6
|
+
* This interface extends IDataset and enforces DS Protocol-specific requirements
|
|
7
|
+
* by overriding properties with more specific types and constraints.
|
|
8
|
+
*
|
|
9
|
+
* **Requirements per DS Protocol:**
|
|
10
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
+
* - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
|
|
12
|
+
* - Array MUST contain at least one IOdrlOffer
|
|
13
|
+
* - Each Offer MUST have `@type`: "Offer"
|
|
14
|
+
* - Each Offer MUST have `@id`
|
|
15
|
+
* - `dcat:distribution` MUST be present (REQUIRED)
|
|
16
|
+
*
|
|
17
|
+
* **Type System Design:**
|
|
18
|
+
* - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
19
|
+
* - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
20
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
21
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
22
|
+
* - DS Protocol-specific constraints are defined here
|
|
23
|
+
*
|
|
24
|
+
* **Future Compatibility:**
|
|
25
|
+
* - Currently only one Offer per dataset is supported
|
|
26
|
+
* - Array structure allows future support for multiple offers
|
|
27
|
+
*
|
|
28
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
29
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
30
|
+
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
31
|
+
* @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
32
|
+
*/
|
|
33
|
+
export interface IDataspaceProtocolDataset extends IDataspaceProtocolDatasetBase {
|
|
34
|
+
/**
|
|
35
|
+
* LD Context. Required per Eclipse Data Space Protocol.
|
|
36
|
+
*/
|
|
37
|
+
"@context": DataspaceProtocolContextType;
|
|
38
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { IDcatDatasetBase } from "@twin.org/standards-w3c-dcat";
|
|
2
|
+
import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDistributionBase.js";
|
|
3
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
4
|
+
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
5
|
+
/**
|
|
6
|
+
* Dataset interface compliant with Eclipse Data Space Protocol.
|
|
7
|
+
*
|
|
8
|
+
* This interface extends IDataset and enforces DS Protocol-specific requirements
|
|
9
|
+
* by overriding properties with more specific types and constraints.
|
|
10
|
+
*
|
|
11
|
+
* **Requirements per DS Protocol:**
|
|
12
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
13
|
+
* - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
|
|
14
|
+
* - Array MUST contain at least one IOdrlOffer
|
|
15
|
+
* - Each Offer MUST have `@type`: "Offer"
|
|
16
|
+
* - Each Offer MUST have `@id`
|
|
17
|
+
* - `dcat:distribution` MUST be present (REQUIRED)
|
|
18
|
+
*
|
|
19
|
+
* **Type System Design:**
|
|
20
|
+
* - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
21
|
+
* - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
22
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
23
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
24
|
+
* - DS Protocol-specific constraints are defined here
|
|
25
|
+
*
|
|
26
|
+
* **Future Compatibility:**
|
|
27
|
+
* - Currently only one Offer per dataset is supported
|
|
28
|
+
* - Array structure allows future support for multiple offers
|
|
29
|
+
*
|
|
30
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
31
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
32
|
+
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
33
|
+
* @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
34
|
+
*/
|
|
35
|
+
export interface IDataspaceProtocolDatasetBase extends Omit<IDcatDatasetBase, "odrl:hasPolicy" | "dcat:distribution" | "@type"> {
|
|
36
|
+
/**
|
|
37
|
+
* The type identifier for the dataset.
|
|
38
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
39
|
+
*/
|
|
40
|
+
"@type": typeof DataspaceProtocolCatalogTypes.Dataset;
|
|
41
|
+
/**
|
|
42
|
+
* Unique identifier for the dataset.
|
|
43
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
44
|
+
*/
|
|
45
|
+
"@id": string;
|
|
46
|
+
/**
|
|
47
|
+
* Array of ODRL policies (Offers) as required by DS Protocol.
|
|
48
|
+
*
|
|
49
|
+
* REQUIRED per Eclipse Data Space Protocol spec.
|
|
50
|
+
* Must contain at least one IOdrlOffer.
|
|
51
|
+
* Currently only single offer is supported, but array structure
|
|
52
|
+
* allows for future multi-offer support.
|
|
53
|
+
* @json-schema minItems:1
|
|
54
|
+
*/
|
|
55
|
+
hasPolicy: IDataspaceProtocolOfferBase[];
|
|
56
|
+
/**
|
|
57
|
+
* Distribution of the dataset.
|
|
58
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
59
|
+
* @json-schema minItems:1
|
|
60
|
+
*/
|
|
61
|
+
distribution: IDataspaceProtocolDistributionBase[];
|
|
62
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDistributionBase.js";
|
|
3
|
+
/**
|
|
4
|
+
* Distribution interface compliant with Eclipse Data Space Protocol.
|
|
5
|
+
*
|
|
6
|
+
* This interface extends IDistribution and enforces DS Protocol-specific requirements
|
|
7
|
+
* by overriding properties with more specific types and constraints.
|
|
8
|
+
*
|
|
9
|
+
* **Requirements per DS Protocol:**
|
|
10
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
+
* - `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
|
|
12
|
+
* - Array MUST contain at least one IOdrlOffer
|
|
13
|
+
* - Each Offer MUST have `@type`: "Offer"
|
|
14
|
+
* - `format` is 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 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
28
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
29
|
+
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
30
|
+
* @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
31
|
+
*/
|
|
32
|
+
export interface IDataspaceProtocolDistribution extends IDataspaceProtocolDistributionBase {
|
|
33
|
+
/**
|
|
34
|
+
* LD Context. Required per Eclipse Data Space Protocol.
|
|
35
|
+
*/
|
|
36
|
+
"@context": DataspaceProtocolContextType;
|
|
37
|
+
/**
|
|
38
|
+
* Unique identifier for the distribution.
|
|
39
|
+
* REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
|
|
40
|
+
*/
|
|
41
|
+
"@id": string;
|
|
42
|
+
}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { IDcatDistributionBase } from "@twin.org/standards-w3c-dcat";
|
|
2
|
+
import type { IDataspaceProtocolDataServiceBase } from "./IDataspaceProtocolDataServiceBase.js";
|
|
3
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
4
|
+
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
5
|
+
/**
|
|
6
|
+
* Distribution interface compliant with Eclipse Data Space Protocol.
|
|
7
|
+
*
|
|
8
|
+
* This interface extends IDistribution and enforces DS Protocol-specific requirements
|
|
9
|
+
* by overriding properties with more specific types and constraints.
|
|
10
|
+
*
|
|
11
|
+
* **Requirements per DS Protocol:**
|
|
12
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
13
|
+
* - `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
|
|
14
|
+
* - Array MUST contain at least one IOdrlOffer
|
|
15
|
+
* - Each Offer MUST have `@type`: "Offer"
|
|
16
|
+
* - `format` is REQUIRED.
|
|
17
|
+
*
|
|
18
|
+
* **Type System Design:**
|
|
19
|
+
* - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
20
|
+
* - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
21
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
22
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
23
|
+
* - DS Protocol-specific constraints are defined here
|
|
24
|
+
*
|
|
25
|
+
* **Future Compatibility:**
|
|
26
|
+
* - Currently only one Offer per dataset is supported
|
|
27
|
+
* - Array structure allows future support for multiple offers
|
|
28
|
+
*
|
|
29
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
30
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
31
|
+
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
32
|
+
* @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
33
|
+
*/
|
|
34
|
+
export interface IDataspaceProtocolDistributionBase extends Omit<IDcatDistributionBase, "odrl:hasPolicy" | "@type" | "dcterms:format"> {
|
|
35
|
+
/**
|
|
36
|
+
* The type identifier for the Distribution.
|
|
37
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
38
|
+
*/
|
|
39
|
+
"@type": typeof DataspaceProtocolCatalogTypes.Distribution;
|
|
40
|
+
/**
|
|
41
|
+
* Unique identifier for the distribution.
|
|
42
|
+
* OPTIONAL for embedded distributions (may use JSON-LD blank nodes).
|
|
43
|
+
* REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
|
|
44
|
+
*/
|
|
45
|
+
"@id"?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Array of ODRL policies (Offers) as required by DS Protocol.
|
|
48
|
+
*
|
|
49
|
+
* REQUIRED per Eclipse Data Space Protocol spec.
|
|
50
|
+
* Must contain at least one IOdrlOffer.
|
|
51
|
+
* Currently only single offer is supported, but array structure
|
|
52
|
+
* allows for future multi-offer support.
|
|
53
|
+
* @json-schema minItems:1
|
|
54
|
+
*/
|
|
55
|
+
hasPolicy?: IDataspaceProtocolOfferBase[];
|
|
56
|
+
/**
|
|
57
|
+
* Access service.
|
|
58
|
+
* It can be a URI pointing to an access service or inline the access service itself.
|
|
59
|
+
*/
|
|
60
|
+
accessService: string | IDataspaceProtocolDataServiceBase;
|
|
61
|
+
/**
|
|
62
|
+
* Distribution format.
|
|
63
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
64
|
+
*/
|
|
65
|
+
format: string;
|
|
66
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
|
|
2
|
+
/**
|
|
3
|
+
* Agreement interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
*
|
|
5
|
+
* Extends IOdrlAgreement with DS Protocol-specific constraints:
|
|
6
|
+
* - `@id` is REQUIRED (used as the primary agreement identifier in DS Protocol)
|
|
7
|
+
* - `@context` is omitted (inherited from the parent Dataset/Distribution)
|
|
8
|
+
*
|
|
9
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
10
|
+
* @see IOdrlAgreement from @twin.org/standards-w3c-odrl
|
|
11
|
+
*/
|
|
12
|
+
export interface IDataspaceProtocolAgreement extends Omit<IOdrlAgreement, "uid"> {
|
|
13
|
+
/**
|
|
14
|
+
* Unique identifier for the agreement.
|
|
15
|
+
*/
|
|
16
|
+
"@id": string;
|
|
17
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { OdrlContextType } from "@twin.org/standards-w3c-odrl";
|
|
2
|
+
import type { IDataspaceProtocolOfferBase } from "./IDataspaceProtocolOfferBase.js";
|
|
3
|
+
/**
|
|
4
|
+
* Offer interface compliant with Eclipse Data Space Protocol.
|
|
5
|
+
*
|
|
6
|
+
* Extends IOdrlOffer with DS Protocol-specific constraints:
|
|
7
|
+
* - `@id` is REQUIRED (used as the primary offer identifier in DS Protocol)
|
|
8
|
+
* - `@context` is omitted (inherited from the parent Dataset/Distribution)
|
|
9
|
+
*
|
|
10
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
11
|
+
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
12
|
+
*/
|
|
13
|
+
export interface IDataspaceProtocolOffer extends IDataspaceProtocolOfferBase {
|
|
14
|
+
/**
|
|
15
|
+
* Unique identifier for the offer.
|
|
16
|
+
*/
|
|
17
|
+
"@id": string;
|
|
18
|
+
/**
|
|
19
|
+
* LD Context.
|
|
20
|
+
*/
|
|
21
|
+
"@context": OdrlContextType;
|
|
22
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
|
+
/**
|
|
3
|
+
* Offer interface compliant with Eclipse Data Space Protocol without JSON-LD context.
|
|
4
|
+
* This is the context-free variant of IDataspaceProtocolOffer, intended for embedding
|
|
5
|
+
* offers inline within other objects where the context is provided by the enclosing document.
|
|
6
|
+
*
|
|
7
|
+
* Extends IOdrlOffer with DS Protocol-specific constraints:
|
|
8
|
+
* - '@id' is REQUIRED (used as the primary offer identifier in DS Protocol)
|
|
9
|
+
* - '@context' is omitted (context is inherited from the parent object)
|
|
10
|
+
*
|
|
11
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
12
|
+
*/
|
|
13
|
+
export interface IDataspaceProtocolOfferBase extends Omit<IOdrlOffer, "uid" | "@context"> {
|
|
14
|
+
/**
|
|
15
|
+
* Unique identifier for the offer.
|
|
16
|
+
*/
|
|
17
|
+
"@id": string;
|
|
18
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
|
|
2
|
+
/**
|
|
3
|
+
* Policy interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
*
|
|
5
|
+
* Extends IOdrlPolicy with DS Protocol-specific constraints:
|
|
6
|
+
* - `@id` is REQUIRED (used as the primary policy identifier in DS Protocol)
|
|
7
|
+
* - `@context` is omitted (inherited from the parent Dataset/Distribution)
|
|
8
|
+
*
|
|
9
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
10
|
+
* @see IOdrlPolicy from @twin.org/standards-w3c-odrl
|
|
11
|
+
*/
|
|
12
|
+
export interface IDataspaceProtocolPolicy extends Omit<IOdrlPolicy, "uid"> {
|
|
13
|
+
/**
|
|
14
|
+
* Unique identifier for the policy.
|
|
15
|
+
*/
|
|
16
|
+
"@id": string;
|
|
17
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { IOdrlSet } from "@twin.org/standards-w3c-odrl";
|
|
2
|
+
/**
|
|
3
|
+
* Set interface compliant with Eclipse Data Space Protocol.
|
|
4
|
+
*
|
|
5
|
+
* Extends IOdrlSet with DS Protocol-specific constraints:
|
|
6
|
+
* - `@id` is REQUIRED (used as the primary set identifier in DS Protocol)
|
|
7
|
+
* - `@context` is omitted (inherited from the parent Dataset/Distribution)
|
|
8
|
+
*
|
|
9
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
10
|
+
* @see IOdrlSet from @twin.org/standards-w3c-odrl
|
|
11
|
+
*/
|
|
12
|
+
export interface IDataspaceProtocolSet extends Omit<IOdrlSet, "uid"> {
|
|
13
|
+
/**
|
|
14
|
+
* Unique identifier for the set.
|
|
15
|
+
*/
|
|
16
|
+
"@id": string;
|
|
17
|
+
}
|
package/dist/types/models/transferProcess/{IDataAddress.d.ts → IDataspaceProtocolDataAddress.d.ts}
RENAMED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
2
|
+
import type { IDataspaceProtocolEndpointProperty } from "./IDataspaceProtocolEndpointProperty.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Transfer Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolDataAddress {
|
|
8
8
|
/**
|
|
9
9
|
* LD Type
|
|
10
10
|
*/
|
|
11
|
-
"@type": typeof
|
|
11
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.DataAddress;
|
|
12
12
|
/**
|
|
13
13
|
* The type of endpoint of this data address.
|
|
14
14
|
*/
|
|
@@ -20,5 +20,5 @@ export interface IDataAddress {
|
|
|
20
20
|
/**
|
|
21
21
|
* Properties associated to the endpoint which might depend on the endpoint type.
|
|
22
22
|
*/
|
|
23
|
-
endpointProperties?:
|
|
23
|
+
endpointProperties?: IDataspaceProtocolEndpointProperty[];
|
|
24
24
|
}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
|
|
2
2
|
/**
|
|
3
3
|
* Interface for Dataspace Protocol Transfer Messages.
|
|
4
4
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
|
|
5
5
|
*/
|
|
6
|
-
export interface
|
|
6
|
+
export interface IDataspaceProtocolEndpointProperty {
|
|
7
7
|
/**
|
|
8
8
|
* LD Type.
|
|
9
9
|
*/
|
|
10
|
-
"@type": typeof
|
|
10
|
+
"@type": typeof DataspaceProtocolTransferProcessTypes.EndpointProperty;
|
|
11
11
|
/**
|
|
12
12
|
* Property name.
|
|
13
13
|
*/
|