@twin.org/standards-dataspace-protocol 0.0.3-next.5 → 0.0.3-next.50
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 +114 -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 +4 -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 +47 -27
- 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 +86 -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/IDataspaceProtocolCatalogNoContext.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogNoContext.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/IDataspaceProtocolDataServiceNoContext.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceNoContext.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/IDataspaceProtocolDatasetNoContext.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetNoContext.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/IDataspaceProtocolDistributionNoContext.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionNoContext.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/IDataspaceProtocolAgreementNoContext.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolAgreementNoContext.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/IDataspaceProtocolOfferNoContext.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolOfferNoContext.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/IDataspaceProtocolPolicyNoContext.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolPolicyNoContext.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/odrl/IDataspaceProtocolSetNoContext.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolSetNoContext.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 +184 -0
- package/dist/es/schemas/DataspaceProtocolAgreementNoContext.json +6 -0
- package/dist/es/schemas/DataspaceProtocolCatalog.json +11 -0
- package/dist/es/schemas/{CatalogError.json → DataspaceProtocolCatalogError.json} +10 -7
- package/dist/es/schemas/DataspaceProtocolCatalogNoContext.json +6 -0
- package/dist/es/schemas/{CatalogRequestMessage.json → DataspaceProtocolCatalogRequestMessage.json} +10 -7
- package/dist/es/schemas/{ContractAgreementMessage.json → DataspaceProtocolContractAgreementMessage.json} +11 -8
- package/dist/es/schemas/{ContractAgreementVerificationMessage.json → DataspaceProtocolContractAgreementVerificationMessage.json} +10 -7
- package/dist/es/schemas/{ContractNegotiation.json → DataspaceProtocolContractNegotiation.json} +11 -8
- package/dist/es/schemas/{ContractNegotiationError.json → DataspaceProtocolContractNegotiationError.json} +10 -7
- package/dist/es/schemas/{ContractNegotiationEventMessage.json → DataspaceProtocolContractNegotiationEventMessage.json} +11 -8
- 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} +10 -7
- package/dist/es/schemas/{ContractOfferMessage.json → DataspaceProtocolContractOfferMessage.json} +11 -8
- package/dist/es/schemas/{ContractRequestMessage.json → DataspaceProtocolContractRequestMessage.json} +11 -8
- package/dist/es/schemas/{DataAddress.json → DataspaceProtocolDataAddress.json} +3 -4
- package/dist/es/schemas/DataspaceProtocolDataServiceNoContext.json +6 -0
- package/dist/es/schemas/DataspaceProtocolDataset.json +11 -0
- package/dist/es/schemas/DataspaceProtocolDatasetNoContext.json +6 -0
- package/dist/es/schemas/{DatasetRequestMessage.json → DataspaceProtocolDatasetRequestMessage.json} +10 -7
- package/dist/es/schemas/DataspaceProtocolDistributionNoContext.json +6 -0
- package/dist/es/schemas/{EndpointProperty.json → DataspaceProtocolEndpointProperty.json} +2 -3
- package/dist/es/schemas/DataspaceProtocolOffer.json +202 -0
- package/dist/es/schemas/DataspaceProtocolOfferNoContext.json +6 -0
- package/dist/es/schemas/DataspaceProtocolPolicy.json +219 -0
- package/dist/es/schemas/DataspaceProtocolPolicyNoContext.json +6 -0
- package/dist/es/schemas/DataspaceProtocolSet.json +220 -0
- package/dist/es/schemas/DataspaceProtocolSetNoContext.json +6 -0
- package/dist/es/schemas/{TransferCompletionMessage.json → DataspaceProtocolTransferCompletionMessage.json} +10 -7
- package/dist/es/schemas/{TransferError.json → DataspaceProtocolTransferError.json} +10 -7
- package/dist/es/schemas/DataspaceProtocolTransferProcess.json +82 -0
- package/dist/es/schemas/{TransferRequestMessage.json → DataspaceProtocolTransferRequestMessage.json} +11 -8
- package/dist/es/schemas/{TransferStartMessage.json → DataspaceProtocolTransferStartMessage.json} +11 -8
- package/dist/es/schemas/{TransferSuspensionMessage.json → DataspaceProtocolTransferSuspensionMessage.json} +10 -7
- package/dist/es/schemas/{TransferTerminationMessage.json → DataspaceProtocolTransferTerminationMessage.json} +10 -7
- 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/index.d.ts +44 -26
- 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 +86 -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} +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 +4 -4
- package/dist/types/models/dataspaceProtocolContexts.d.ts +12 -4
- package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +63 -0
- package/dist/types/models/dcat3/IDataspaceProtocolCatalogNoContext.d.ts +5 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +48 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataServiceNoContext.d.ts +5 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +65 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDatasetNoContext.d.ts +5 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +69 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDistributionNoContext.d.ts +5 -0
- package/dist/types/models/odrl/IDataspaceProtocolAgreement.d.ts +17 -0
- package/dist/types/models/odrl/IDataspaceProtocolAgreementNoContext.d.ts +5 -0
- package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +17 -0
- package/dist/types/models/odrl/IDataspaceProtocolOfferNoContext.d.ts +5 -0
- package/dist/types/models/odrl/IDataspaceProtocolPolicy.d.ts +17 -0
- package/dist/types/models/odrl/IDataspaceProtocolPolicyNoContext.d.ts +5 -0
- package/dist/types/models/odrl/IDataspaceProtocolSet.d.ts +17 -0
- package/dist/types/models/odrl/IDataspaceProtocolSetNoContext.d.ts +5 -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 +20 -0
- package/docs/changelog.md +806 -0
- package/docs/reference/classes/DataspaceProtocolHelper.md +63 -0
- package/docs/reference/index.md +51 -32
- package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +179 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +574 -0
- package/docs/reference/interfaces/{ICatalogError.md → IDataspaceProtocolCatalogError.md} +1 -1
- package/docs/reference/interfaces/{ICatalogRequestMessage.md → IDataspaceProtocolCatalogRequestMessage.md} +1 -1
- package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +3 -3
- package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +2 -2
- package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +2 -2
- package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +3 -3
- package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +3 -3
- package/docs/reference/interfaces/{IDataAddress.md → IDataspaceProtocolDataAddress.md} +3 -3
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +391 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +488 -0
- package/docs/reference/interfaces/{IDatasetRequestMessage.md → IDataspaceProtocolDatasetRequestMessage.md} +1 -1
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +384 -0
- package/docs/reference/interfaces/{IEndpointProperty.md → IDataspaceProtocolEndpointProperty.md} +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolOffer.md +179 -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} +2 -2
- package/docs/reference/interfaces/{ITransferError.md → IDataspaceProtocolTransferError.md} +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +44 -0
- package/docs/reference/interfaces/{ITransferRequestMessage.md → IDataspaceProtocolTransferRequestMessage.md} +3 -3
- package/docs/reference/interfaces/{ITransferStartMessage.md → IDataspaceProtocolTransferStartMessage.md} +3 -3
- package/docs/reference/interfaces/{ITransferSuspensionMessage.md → IDataspaceProtocolTransferSuspensionMessage.md} +2 -2
- package/docs/reference/interfaces/{ITransferTerminationMessage.md → IDataspaceProtocolTransferTerminationMessage.md} +2 -2
- package/docs/reference/type-aliases/DataspaceProtocolCatalogTypes.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContextType.md +2 -2
- package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationEventType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationStateType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationTypes.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +12 -0
- package/docs/reference/type-aliases/DataspaceProtocolTransferProcessStateType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolTransferProcessTypes.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolAgreementNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolCatalogNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolDataServiceNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolDatasetNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolDistributionNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolOfferNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolPolicyNoContext.md +5 -0
- package/docs/reference/type-aliases/IDataspaceProtocolSetNoContext.md +5 -0
- package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +122 -0
- package/docs/reference/variables/DataspaceProtocolContexts.md +18 -6
- package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md} +2 -2
- package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md} +2 -2
- package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +68 -0
- package/docs/reference/variables/DataspaceProtocolEndpointType.md +96 -0
- package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +38 -0
- package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +62 -0
- package/locales/en.json +7 -1
- package/package.json +3 -3
- package/dist/es/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/TransferProcess.json +0 -109
- 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
package/dist/types/models/catalog/{ICatalogError.d.ts → IDataspaceProtocolCatalogError.d.ts}
RENAMED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Catalog Error.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolCatalogError {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
@@ -12,7 +12,7 @@ export interface ICatalogError {
|
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolCatalogTypes.CatalogError;
|
|
16
16
|
/**
|
|
17
17
|
* The error code.
|
|
18
18
|
*/
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Catalog Request Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolCatalogRequestMessage {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
@@ -12,7 +12,7 @@ export interface ICatalogRequestMessage {
|
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolCatalogTypes.CatalogRequestMessage;
|
|
16
16
|
/**
|
|
17
17
|
* An implementation-specific query or filter expression.
|
|
18
18
|
*/
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Dataset Request Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolDatasetRequestMessage {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
@@ -12,7 +12,7 @@ export interface IDatasetRequestMessage {
|
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolCatalogTypes.DatasetRequestMessage;
|
|
16
16
|
/**
|
|
17
17
|
* The identifier of the dataset.
|
|
18
18
|
*/
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The types for Dataspace Protocol Catalog Protocol.
|
|
3
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
|
|
4
|
+
*/
|
|
5
|
+
export declare const DataspaceProtocolCatalogTypes: {
|
|
6
|
+
/**
|
|
7
|
+
* Catalog Request Message.
|
|
8
|
+
*/
|
|
9
|
+
readonly CatalogRequestMessage: "CatalogRequestMessage";
|
|
10
|
+
/**
|
|
11
|
+
* Dataset Request Message.
|
|
12
|
+
*/
|
|
13
|
+
readonly DatasetRequestMessage: "DatasetRequestMessage";
|
|
14
|
+
/**
|
|
15
|
+
* Catalog Error.
|
|
16
|
+
*/
|
|
17
|
+
readonly CatalogError: "CatalogError";
|
|
18
|
+
/**
|
|
19
|
+
* Dataset.
|
|
20
|
+
*/
|
|
21
|
+
readonly Dataset: "Dataset";
|
|
22
|
+
/**
|
|
23
|
+
* Dataset without JSON-LD context.
|
|
24
|
+
*/
|
|
25
|
+
readonly DatasetNoContext: "DatasetNoContext";
|
|
26
|
+
/**
|
|
27
|
+
* Data Service.
|
|
28
|
+
*/
|
|
29
|
+
readonly DataService: "DataService";
|
|
30
|
+
/**
|
|
31
|
+
* Data Service without JSON-LD context.
|
|
32
|
+
*/
|
|
33
|
+
readonly DataServiceNoContext: "DataServiceNoContext";
|
|
34
|
+
/**
|
|
35
|
+
* Distribution.
|
|
36
|
+
*/
|
|
37
|
+
readonly Distribution: "Distribution";
|
|
38
|
+
/**
|
|
39
|
+
* Distribution without JSON-LD context.
|
|
40
|
+
*/
|
|
41
|
+
readonly DistributionNoContext: "DistributionNoContext";
|
|
42
|
+
/**
|
|
43
|
+
* Catalog.
|
|
44
|
+
*/
|
|
45
|
+
readonly Catalog: "Catalog";
|
|
46
|
+
/**
|
|
47
|
+
* Catalog without JSON-LD context.
|
|
48
|
+
*/
|
|
49
|
+
readonly CatalogNoContext: "CatalogNoContext";
|
|
50
|
+
/**
|
|
51
|
+
* Policy.
|
|
52
|
+
*/
|
|
53
|
+
readonly Policy: "Policy";
|
|
54
|
+
/**
|
|
55
|
+
* Policy without JSON-LD context.
|
|
56
|
+
*/
|
|
57
|
+
readonly PolicyNoContext: "PolicyNoContext";
|
|
58
|
+
/**
|
|
59
|
+
* Offer.
|
|
60
|
+
*/
|
|
61
|
+
readonly Offer: "Offer";
|
|
62
|
+
/**
|
|
63
|
+
* Offer without JSON-LD context.
|
|
64
|
+
*/
|
|
65
|
+
readonly OfferNoContext: "OfferNoContext";
|
|
66
|
+
/**
|
|
67
|
+
* Agreement.
|
|
68
|
+
*/
|
|
69
|
+
readonly Agreement: "Agreement";
|
|
70
|
+
/**
|
|
71
|
+
* Agreement without JSON-LD context.
|
|
72
|
+
*/
|
|
73
|
+
readonly AgreementNoContext: "AgreementNoContext";
|
|
74
|
+
/**
|
|
75
|
+
* Set.
|
|
76
|
+
*/
|
|
77
|
+
readonly Set: "Set";
|
|
78
|
+
/**
|
|
79
|
+
* Set without JSON-LD context.
|
|
80
|
+
*/
|
|
81
|
+
readonly SetNoContext: "SetNoContext";
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* The types for Dataspace Protocol Catalog Protocol.
|
|
85
|
+
*/
|
|
86
|
+
export type DataspaceProtocolCatalogTypes = (typeof DataspaceProtocolCatalogTypes)[keyof typeof DataspaceProtocolCatalogTypes];
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
|
|
2
|
-
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { IDataspaceProtocolAgreementNoContext } from "../odrl/IDataspaceProtocolAgreementNoContext.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Agreement Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractAgreementMessage {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
@@ -13,7 +13,7 @@ export interface IContractAgreementMessage {
|
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractAgreementMessage;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -25,7 +25,7 @@ export interface IContractAgreementMessage {
|
|
|
25
25
|
/**
|
|
26
26
|
* The agreement being sent.
|
|
27
27
|
*/
|
|
28
|
-
agreement:
|
|
28
|
+
agreement: IDataspaceProtocolAgreementNoContext;
|
|
29
29
|
/**
|
|
30
30
|
* The base callback address for the provider to update the consumer on the state of the negotiation.
|
|
31
31
|
*/
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Agreement Verification Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolContractAgreementVerificationMessage {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
@@ -12,7 +12,7 @@ export interface IContractAgreementVerificationMessage {
|
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractAgreementVerificationMessage;
|
|
16
16
|
/**
|
|
17
17
|
* The provider id for the contract.
|
|
18
18
|
*/
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContractNegotiationStateType } from "./types/dataspaceProtocolContractNegotiationStateType.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Agreement Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractNegotiation {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
@@ -13,7 +13,7 @@ export interface IContractNegotiation {
|
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiation;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -25,5 +25,5 @@ export interface IContractNegotiation {
|
|
|
25
25
|
/**
|
|
26
26
|
* The offer being requested.
|
|
27
27
|
*/
|
|
28
|
-
state:
|
|
28
|
+
state: DataspaceProtocolContractNegotiationStateType;
|
|
29
29
|
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Negotiation Error Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolContractNegotiationError {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
@@ -12,7 +12,7 @@ export interface IContractNegotiationError {
|
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiationError;
|
|
16
16
|
/**
|
|
17
17
|
* The provider id for the contract.
|
|
18
18
|
*/
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContractNegotiationEventType } from "./types/dataspaceProtocolContractNegotiationEventType.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Negotiation Event Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractNegotiationEventMessage {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
@@ -13,7 +13,7 @@ export interface IContractNegotiationEventMessage {
|
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiationEventMessage;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -25,5 +25,5 @@ export interface IContractNegotiationEventMessage {
|
|
|
25
25
|
/**
|
|
26
26
|
* The event type.
|
|
27
27
|
*/
|
|
28
|
-
event:
|
|
28
|
+
event: DataspaceProtocolContractNegotiationEventType;
|
|
29
29
|
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Negotiation Termination Messages.
|
|
5
5
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IDataspaceProtocolContractNegotiationTerminationMessage {
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
@@ -12,7 +12,7 @@ export interface IContractNegotiationTerminationMessage {
|
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
15
|
-
"@type": typeof
|
|
15
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractNegotiationTerminationMessage;
|
|
16
16
|
/**
|
|
17
17
|
* The provider id for the contract.
|
|
18
18
|
*/
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
3
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { IDataspaceProtocolOfferNoContext } from "../odrl/IDataspaceProtocolOfferNoContext.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Offer Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractOfferMessage {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
@@ -13,7 +13,7 @@ export interface IContractOfferMessage {
|
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractOfferMessage;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -25,7 +25,7 @@ export interface IContractOfferMessage {
|
|
|
25
25
|
/**
|
|
26
26
|
* The offer being requested.
|
|
27
27
|
*/
|
|
28
|
-
offer:
|
|
28
|
+
offer: IDataspaceProtocolOfferNoContext;
|
|
29
29
|
/**
|
|
30
30
|
* The base callback address for the provider to update the consumer on the state of the negotiation.
|
|
31
31
|
*/
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
3
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
+
import type { IDataspaceProtocolOfferNoContext } from "../odrl/IDataspaceProtocolOfferNoContext.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Request Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IDataspaceProtocolContractRequestMessage {
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
@@ -13,7 +13,7 @@ export interface IContractRequestMessage {
|
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
16
|
-
"@type": typeof
|
|
16
|
+
"@type": typeof DataspaceProtocolContractNegotiationTypes.ContractRequestMessage;
|
|
17
17
|
/**
|
|
18
18
|
* The provider id for the contract.
|
|
19
19
|
*/
|
|
@@ -25,7 +25,7 @@ export interface IContractRequestMessage {
|
|
|
25
25
|
/**
|
|
26
26
|
* The offer being requested.
|
|
27
27
|
*/
|
|
28
|
-
offer:
|
|
28
|
+
offer: IDataspaceProtocolOfferNoContext;
|
|
29
29
|
/**
|
|
30
30
|
* The base callback address for the provider to update the consumer on the state of the negotiation.
|
|
31
31
|
*/
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The types for Dataspace Protocol Contract Negotiation.
|
|
3
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
|
|
4
|
+
*/
|
|
5
|
+
export declare const DataspaceProtocolContractNegotiationTypes: {
|
|
6
|
+
/**
|
|
7
|
+
* Contract Negotiation.
|
|
8
|
+
*/
|
|
9
|
+
readonly ContractNegotiation: "ContractNegotiation";
|
|
10
|
+
/**
|
|
11
|
+
* Contract Request Message.
|
|
12
|
+
*/
|
|
13
|
+
readonly ContractRequestMessage: "ContractRequestMessage";
|
|
14
|
+
/**
|
|
15
|
+
* Contract Offer Message.
|
|
16
|
+
*/
|
|
17
|
+
readonly ContractOfferMessage: "ContractOfferMessage";
|
|
18
|
+
/**
|
|
19
|
+
* Contract Agreement Message.
|
|
20
|
+
*/
|
|
21
|
+
readonly ContractAgreementMessage: "ContractAgreementMessage";
|
|
22
|
+
/**
|
|
23
|
+
* Contract Agreement Verification Message.
|
|
24
|
+
*/
|
|
25
|
+
readonly ContractAgreementVerificationMessage: "ContractAgreementVerificationMessage";
|
|
26
|
+
/**
|
|
27
|
+
* Contract Negotiation Event Message.
|
|
28
|
+
*/
|
|
29
|
+
readonly ContractNegotiationEventMessage: "ContractNegotiationEventMessage";
|
|
30
|
+
/**
|
|
31
|
+
* Contract Negotiation Termination Message.
|
|
32
|
+
*/
|
|
33
|
+
readonly ContractNegotiationTerminationMessage: "ContractNegotiationTerminationMessage";
|
|
34
|
+
/**
|
|
35
|
+
* Contract Negotiation Error.
|
|
36
|
+
*/
|
|
37
|
+
readonly ContractNegotiationError: "ContractNegotiationError";
|
|
38
|
+
/**
|
|
39
|
+
* Contract Negotiation Event Type.
|
|
40
|
+
*/
|
|
41
|
+
readonly ContractNegotiationEventType: "ContractNegotiationEventType";
|
|
42
|
+
/**
|
|
43
|
+
* Contract Negotiation State Type.
|
|
44
|
+
*/
|
|
45
|
+
readonly ContractNegotiationStateType: "ContractNegotiationStateType";
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* The types for Dataspace Protocol Contract Negotiation.
|
|
49
|
+
*/
|
|
50
|
+
export type DataspaceProtocolContractNegotiationTypes = (typeof DataspaceProtocolContractNegotiationTypes)[keyof typeof DataspaceProtocolContractNegotiationTypes];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* The types for Dataspace Protocol Contract Negotiation Events.
|
|
3
3
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
4
4
|
*/
|
|
5
|
-
export declare const
|
|
5
|
+
export declare const DataspaceProtocolContractNegotiationEventType: {
|
|
6
6
|
/**
|
|
7
7
|
* Accepted.
|
|
8
8
|
*/
|
|
@@ -15,4 +15,4 @@ export declare const ContractNegotiationEventType: {
|
|
|
15
15
|
/**
|
|
16
16
|
* The types for Dataspace Protocol Contract Negotiation Events.
|
|
17
17
|
*/
|
|
18
|
-
export type
|
|
18
|
+
export type DataspaceProtocolContractNegotiationEventType = (typeof DataspaceProtocolContractNegotiationEventType)[keyof typeof DataspaceProtocolContractNegotiationEventType];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* The types for Dataspace Protocol Contract Negotiation States.
|
|
3
3
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
|
|
4
4
|
*/
|
|
5
|
-
export declare const
|
|
5
|
+
export declare const DataspaceProtocolContractNegotiationStateType: {
|
|
6
6
|
/**
|
|
7
7
|
* Requested.
|
|
8
8
|
*/
|
|
@@ -35,4 +35,4 @@ export declare const ContractNegotiationStateType: {
|
|
|
35
35
|
/**
|
|
36
36
|
* The types for Dataspace Protocol Contract Negotiation States.
|
|
37
37
|
*/
|
|
38
|
-
export type
|
|
38
|
+
export type DataspaceProtocolContractNegotiationStateType = (typeof DataspaceProtocolContractNegotiationStateType)[keyof typeof DataspaceProtocolContractNegotiationStateType];
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
|
|
2
2
|
import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
|
|
3
3
|
/**
|
|
4
|
-
* The Dataspace Protocol
|
|
4
|
+
* The Dataspace Protocol JSON-LD context type.
|
|
5
5
|
*/
|
|
6
|
-
export type DataspaceProtocolContextType = [typeof DataspaceProtocolContexts.
|
|
6
|
+
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.Context | [typeof DataspaceProtocolContexts.Context] | [
|
|
7
7
|
...IJsonLdContextDefinitionElement[],
|
|
8
|
-
typeof DataspaceProtocolContexts.
|
|
8
|
+
typeof DataspaceProtocolContexts.Context,
|
|
9
9
|
IJsonLdContextDefinitionElement
|
|
10
10
|
] | [
|
|
11
11
|
IJsonLdContextDefinitionElement,
|
|
12
|
-
typeof DataspaceProtocolContexts.
|
|
12
|
+
typeof DataspaceProtocolContexts.Context,
|
|
13
13
|
...IJsonLdContextDefinitionElement[]
|
|
14
14
|
];
|
|
@@ -3,13 +3,21 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export declare const DataspaceProtocolContexts: {
|
|
5
5
|
/**
|
|
6
|
-
* The
|
|
6
|
+
* The canonical RDF namespace URI.
|
|
7
7
|
*/
|
|
8
|
-
readonly
|
|
8
|
+
readonly Namespace: "https://w3id.org/dspace/2025/1/";
|
|
9
9
|
/**
|
|
10
|
-
* The
|
|
10
|
+
* The value to use in @context.
|
|
11
11
|
*/
|
|
12
|
-
readonly
|
|
12
|
+
readonly Context: "https://w3id.org/dspace/2025/1/context.jsonld";
|
|
13
|
+
/**
|
|
14
|
+
* The JSON-LD Context URL.
|
|
15
|
+
*/
|
|
16
|
+
readonly JsonLdContext: "https://w3id.org/dspace/2025/1/context.jsonld";
|
|
17
|
+
/**
|
|
18
|
+
* The namespace location of the hosted version of the JSON Schema.
|
|
19
|
+
*/
|
|
20
|
+
readonly JsonSchemaNamespace: "https://schema.twindev.org/dataspace-protocol/";
|
|
13
21
|
};
|
|
14
22
|
/**
|
|
15
23
|
* The contexts for Dataspace Protocol Protocol.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import type { IDcatCatalog } from "@twin.org/standards-w3c-dcat";
|
|
2
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
4
|
+
import type { IDataspaceProtocolCatalogNoContext } from "./IDataspaceProtocolCatalogNoContext.js";
|
|
5
|
+
import type { IDataspaceProtocolDataServiceNoContext } from "./IDataspaceProtocolDataServiceNoContext.js";
|
|
6
|
+
import type { IDataspaceProtocolDatasetNoContext } from "./IDataspaceProtocolDatasetNoContext.js";
|
|
7
|
+
import type { IDataspaceProtocolDistributionNoContext } from "./IDataspaceProtocolDistributionNoContext.js";
|
|
8
|
+
/**
|
|
9
|
+
* Catalog interface compliant with Eclipse Data Space Protocol.
|
|
10
|
+
*
|
|
11
|
+
* This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
12
|
+
* by overriding properties with more specific types and constraints.
|
|
13
|
+
*
|
|
14
|
+
* **Requirements per DS Protocol:**
|
|
15
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
16
|
+
* - participantId MUST be present (REQUIRED)
|
|
17
|
+
*
|
|
18
|
+
* **Type System Design:**
|
|
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
|
+
*
|
|
24
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
25
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export interface IDataspaceProtocolCatalog extends Omit<IDcatCatalog, "@type" | "@context" | "dcat:catalog" | "dcat:dataset" | "dcat:distribution" | "dcat:service"> {
|
|
29
|
+
/**
|
|
30
|
+
* LD Context. Required per Eclipse Data Space Protocol.
|
|
31
|
+
*/
|
|
32
|
+
"@context": DataspaceProtocolContextType;
|
|
33
|
+
/**
|
|
34
|
+
* The type identifier for the Catalog.
|
|
35
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
36
|
+
*/
|
|
37
|
+
"@type": typeof DataspaceProtocolCatalogTypes.Catalog;
|
|
38
|
+
/**
|
|
39
|
+
* Unique identifier for the dataset.
|
|
40
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
41
|
+
*/
|
|
42
|
+
"@id": string;
|
|
43
|
+
/**
|
|
44
|
+
* Participant Id
|
|
45
|
+
*/
|
|
46
|
+
participantId: string;
|
|
47
|
+
/**
|
|
48
|
+
* Other concerned catalogs
|
|
49
|
+
*/
|
|
50
|
+
catalog?: IDataspaceProtocolCatalogNoContext | IDataspaceProtocolCatalogNoContext[];
|
|
51
|
+
/**
|
|
52
|
+
* Datasets registered
|
|
53
|
+
*/
|
|
54
|
+
dataset?: IDataspaceProtocolDatasetNoContext | IDataspaceProtocolDatasetNoContext[];
|
|
55
|
+
/**
|
|
56
|
+
* Catalog's distributions
|
|
57
|
+
*/
|
|
58
|
+
distribution?: IDataspaceProtocolDistributionNoContext | IDataspaceProtocolDistributionNoContext[];
|
|
59
|
+
/**
|
|
60
|
+
* Data services registered-
|
|
61
|
+
*/
|
|
62
|
+
service?: IDataspaceProtocolDataServiceNoContext | IDataspaceProtocolDataServiceNoContext[];
|
|
63
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { IDataspaceProtocolCatalog } from "./IDataspaceProtocolCatalog.js";
|
|
2
|
+
/**
|
|
3
|
+
* Catalog interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.
|
|
4
|
+
*/
|
|
5
|
+
export type IDataspaceProtocolCatalogNoContext = Omit<IDataspaceProtocolCatalog, "@context">;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { IDcatDataService } from "@twin.org/standards-w3c-dcat";
|
|
2
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
4
|
+
import type { IDataspaceProtocolDatasetNoContext } from "./IDataspaceProtocolDatasetNoContext.js";
|
|
5
|
+
/**
|
|
6
|
+
* Data Service interface compliant with Eclipse Data Space Protocol.
|
|
7
|
+
*
|
|
8
|
+
* This interface extends IDataService 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
|
+
* - endpointURL MUST be present (REQUIRED)
|
|
14
|
+
*
|
|
15
|
+
* **Type System Design:**
|
|
16
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
17
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
18
|
+
* - DS Protocol-specific constraints are defined here
|
|
19
|
+
*
|
|
20
|
+
*
|
|
21
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
22
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
export interface IDataspaceProtocolDataService extends Omit<IDcatDataService, "@type" | "@context" | "dcat:servesDataset" | "dcat:endpointURL"> {
|
|
26
|
+
/**
|
|
27
|
+
* LD Context. Required per Eclipse Data Space Protocol.
|
|
28
|
+
*/
|
|
29
|
+
"@context": DataspaceProtocolContextType;
|
|
30
|
+
/**
|
|
31
|
+
* The type identifier for the Data Service.
|
|
32
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
33
|
+
*/
|
|
34
|
+
"@type": typeof DataspaceProtocolCatalogTypes.DataService;
|
|
35
|
+
/**
|
|
36
|
+
* Unique identifier for the dataset.
|
|
37
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
38
|
+
*/
|
|
39
|
+
"@id": string;
|
|
40
|
+
/**
|
|
41
|
+
* Endpoint URL
|
|
42
|
+
*/
|
|
43
|
+
endpointURL: string;
|
|
44
|
+
/**
|
|
45
|
+
* Datasets served.
|
|
46
|
+
*/
|
|
47
|
+
servesDataset?: IDataspaceProtocolDatasetNoContext | IDataspaceProtocolDatasetNoContext[];
|
|
48
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { IDataspaceProtocolDataService } from "./IDataspaceProtocolDataService.js";
|
|
2
|
+
/**
|
|
3
|
+
* Data Service interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.
|
|
4
|
+
*/
|
|
5
|
+
export type IDataspaceProtocolDataServiceNoContext = Omit<IDataspaceProtocolDataService, "@context">;
|