@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.
Files changed (316) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/catalogDataTypes.js +93 -20
  3. package/dist/es/dataTypes/catalogDataTypes.js.map +1 -1
  4. package/dist/es/dataTypes/contractNegotiationDataTypes.js +58 -62
  5. package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +1 -1
  6. package/dist/es/dataTypes/dataspaceProtocolDataTypes.js +10 -1
  7. package/dist/es/dataTypes/dataspaceProtocolDataTypes.js.map +1 -1
  8. package/dist/es/dataTypes/transferProcessDataTypes.js +53 -56
  9. package/dist/es/dataTypes/transferProcessDataTypes.js.map +1 -1
  10. package/dist/es/index.js +45 -28
  11. package/dist/es/index.js.map +1 -1
  12. package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js +2 -0
  13. package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js.map +1 -0
  14. package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js +2 -0
  15. package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js.map +1 -0
  16. package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js +2 -0
  17. package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js.map +1 -0
  18. package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +54 -0
  19. package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js.map +1 -0
  20. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js +2 -0
  21. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js.map +1 -0
  22. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js +2 -0
  23. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js.map +1 -0
  24. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js +2 -0
  25. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js.map +1 -0
  26. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js +2 -0
  27. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js.map +1 -0
  28. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js +2 -0
  29. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js.map +1 -0
  30. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js +2 -0
  31. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js.map +1 -0
  32. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js +2 -0
  33. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js.map +1 -0
  34. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js +2 -0
  35. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js.map +1 -0
  36. package/dist/es/models/contractNegotiation/{contractNegotiationTypes.js → dataspaceProtocolContractNegotiationTypes.js} +2 -2
  37. package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js.map +1 -0
  38. package/dist/es/models/contractNegotiation/types/{contractNegotiationEventType.js → dataspaceProtocolContractNegotiationEventType.js} +2 -2
  39. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js.map +1 -0
  40. package/dist/es/models/contractNegotiation/types/{contractNegotiationStateType.js → dataspaceProtocolContractNegotiationStateType.js} +2 -2
  41. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js.map +1 -0
  42. package/dist/es/models/dataspaceProtocolContextType.js.map +1 -1
  43. package/dist/es/models/dataspaceProtocolContexts.js +12 -4
  44. package/dist/es/models/dataspaceProtocolContexts.js.map +1 -1
  45. package/dist/es/models/dcat3/IDataspaceProtocolCatalog.js +2 -0
  46. package/dist/es/models/dcat3/IDataspaceProtocolCatalog.js.map +1 -0
  47. package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js +2 -0
  48. package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js.map +1 -0
  49. package/dist/es/models/dcat3/IDataspaceProtocolDataService.js +2 -0
  50. package/dist/es/models/dcat3/IDataspaceProtocolDataService.js.map +1 -0
  51. package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js +2 -0
  52. package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js.map +1 -0
  53. package/dist/es/models/dcat3/IDataspaceProtocolDataset.js +2 -0
  54. package/dist/es/models/dcat3/IDataspaceProtocolDataset.js.map +1 -0
  55. package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js +2 -0
  56. package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js.map +1 -0
  57. package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js +2 -0
  58. package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js.map +1 -0
  59. package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js +2 -0
  60. package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js.map +1 -0
  61. package/dist/es/models/odrl/IDataspaceProtocolAgreement.js +2 -0
  62. package/dist/es/models/odrl/IDataspaceProtocolAgreement.js.map +1 -0
  63. package/dist/es/models/odrl/IDataspaceProtocolOffer.js +2 -0
  64. package/dist/es/models/odrl/IDataspaceProtocolOffer.js.map +1 -0
  65. package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js +2 -0
  66. package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js.map +1 -0
  67. package/dist/es/models/odrl/IDataspaceProtocolPolicy.js +2 -0
  68. package/dist/es/models/odrl/IDataspaceProtocolPolicy.js.map +1 -0
  69. package/dist/es/models/odrl/IDataspaceProtocolSet.js +2 -0
  70. package/dist/es/models/odrl/IDataspaceProtocolSet.js.map +1 -0
  71. package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js +2 -0
  72. package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js.map +1 -0
  73. package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js +2 -0
  74. package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js.map +1 -0
  75. package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js +2 -0
  76. package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js.map +1 -0
  77. package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js +2 -0
  78. package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js.map +1 -0
  79. package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js +2 -0
  80. package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js.map +1 -0
  81. package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js +2 -0
  82. package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js.map +1 -0
  83. package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js +2 -0
  84. package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js.map +1 -0
  85. package/dist/es/models/transferProcess/{ITransferSuspensionMessage.js → IDataspaceProtocolTransferSuspensionMessage.js} +1 -1
  86. package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js.map +1 -0
  87. package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js +2 -0
  88. package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js.map +1 -0
  89. package/dist/es/models/transferProcess/{transferProcessTypes.js → dataspaceProtocolTransferProcessTypes.js} +2 -2
  90. package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js.map +1 -0
  91. package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js +89 -0
  92. package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js.map +1 -0
  93. package/dist/es/models/transferProcess/types/{transferProcessStateType.js → dataspaceProtocolTransferProcessStateType.js} +2 -2
  94. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -0
  95. package/dist/es/schemas/DataspaceProtocolAgreement.json +207 -0
  96. package/dist/es/schemas/DataspaceProtocolCatalog.json +21 -0
  97. package/dist/es/schemas/DataspaceProtocolCatalogBase.json +428 -0
  98. package/dist/es/schemas/DataspaceProtocolCatalogError.json +31 -0
  99. package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +26 -0
  100. package/dist/es/schemas/DataspaceProtocolContextType.json +30 -0
  101. package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +225 -0
  102. package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json +31 -0
  103. package/dist/es/schemas/DataspaceProtocolContractNegotiation.json +36 -0
  104. package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json +40 -0
  105. package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json +36 -0
  106. package/dist/es/schemas/DataspaceProtocolContractNegotiationEventType.json +16 -0
  107. package/dist/es/schemas/DataspaceProtocolContractNegotiationStateType.json +36 -0
  108. package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json +40 -0
  109. package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json +39 -0
  110. package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json +39 -0
  111. package/dist/es/schemas/{DataAddress.json → DataspaceProtocolDataAddress.json} +5 -6
  112. package/dist/es/schemas/DataspaceProtocolDataService.json +21 -0
  113. package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +279 -0
  114. package/dist/es/schemas/DataspaceProtocolDataset.json +21 -0
  115. package/dist/es/schemas/DataspaceProtocolDatasetBase.json +330 -0
  116. package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +26 -0
  117. package/dist/es/schemas/DataspaceProtocolDistribution.json +26 -0
  118. package/dist/es/schemas/DataspaceProtocolDistributionBase.json +164 -0
  119. package/dist/es/schemas/{EndpointProperty.json → DataspaceProtocolEndpointProperty.json} +4 -5
  120. package/dist/es/schemas/DataspaceProtocolOffer.json +26 -0
  121. package/dist/es/schemas/DataspaceProtocolOfferBase.json +219 -0
  122. package/dist/es/schemas/DataspaceProtocolPolicy.json +231 -0
  123. package/dist/es/schemas/DataspaceProtocolSet.json +243 -0
  124. package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +31 -0
  125. package/dist/es/schemas/DataspaceProtocolTransferError.json +40 -0
  126. package/dist/es/schemas/DataspaceProtocolTransferProcess.json +36 -0
  127. package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +45 -0
  128. package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +35 -0
  129. package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +40 -0
  130. package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +40 -0
  131. package/dist/es/utils/dataspaceProtocolHelper.js +108 -0
  132. package/dist/es/utils/dataspaceProtocolHelper.js.map +1 -0
  133. package/dist/types/index.d.ts +43 -28
  134. package/dist/types/models/catalog/{ICatalogError.d.ts → IDataspaceProtocolCatalogError.d.ts} +3 -3
  135. package/dist/types/models/catalog/{ICatalogRequestMessage.d.ts → IDataspaceProtocolCatalogRequestMessage.d.ts} +3 -3
  136. package/dist/types/models/catalog/{IDatasetRequestMessage.d.ts → IDataspaceProtocolDatasetRequestMessage.d.ts} +3 -3
  137. package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +54 -0
  138. package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts} +6 -5
  139. package/dist/types/models/contractNegotiation/{IContractAgreementVerificationMessage.d.ts → IDataspaceProtocolContractAgreementVerificationMessage.d.ts} +3 -3
  140. package/dist/types/models/contractNegotiation/{IContractNegotiation.d.ts → IDataspaceProtocolContractNegotiation.d.ts} +5 -5
  141. package/dist/types/models/contractNegotiation/{IContractNegotiationError.d.ts → IDataspaceProtocolContractNegotiationError.d.ts} +3 -3
  142. package/dist/types/models/contractNegotiation/{IContractNegotiationEventMessage.d.ts → IDataspaceProtocolContractNegotiationEventMessage.d.ts} +5 -5
  143. package/dist/types/models/contractNegotiation/{IContractNegotiationTerminationMessage.d.ts → IDataspaceProtocolContractNegotiationTerminationMessage.d.ts} +3 -3
  144. package/dist/types/models/contractNegotiation/{IContractOfferMessage.d.ts → IDataspaceProtocolContractOfferMessage.d.ts} +5 -5
  145. package/dist/types/models/contractNegotiation/{IContractRequestMessage.d.ts → IDataspaceProtocolContractRequestMessage.d.ts} +5 -5
  146. package/dist/types/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts +50 -0
  147. package/dist/types/models/contractNegotiation/types/{contractNegotiationEventType.d.ts → dataspaceProtocolContractNegotiationEventType.d.ts} +2 -2
  148. package/dist/types/models/contractNegotiation/types/{contractNegotiationStateType.d.ts → dataspaceProtocolContractNegotiationStateType.d.ts} +2 -2
  149. package/dist/types/models/dataspaceProtocolContextType.d.ts +2 -9
  150. package/dist/types/models/dataspaceProtocolContexts.d.ts +12 -4
  151. package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +28 -0
  152. package/dist/types/models/dcat3/IDataspaceProtocolCatalogBase.d.ts +58 -0
  153. package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +28 -0
  154. package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +44 -0
  155. package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +38 -0
  156. package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +62 -0
  157. package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +42 -0
  158. package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +66 -0
  159. package/dist/types/models/odrl/IDataspaceProtocolAgreement.d.ts +17 -0
  160. package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +22 -0
  161. package/dist/types/models/odrl/IDataspaceProtocolOfferBase.d.ts +18 -0
  162. package/dist/types/models/odrl/IDataspaceProtocolPolicy.d.ts +17 -0
  163. package/dist/types/models/odrl/IDataspaceProtocolSet.d.ts +17 -0
  164. package/dist/types/models/transferProcess/{IDataAddress.d.ts → IDataspaceProtocolDataAddress.d.ts} +5 -5
  165. package/dist/types/models/transferProcess/{IEndpointProperty.d.ts → IDataspaceProtocolEndpointProperty.d.ts} +3 -3
  166. package/dist/types/models/transferProcess/{ITransferCompletionMessage.d.ts → IDataspaceProtocolTransferCompletionMessage.d.ts} +3 -3
  167. package/dist/types/models/transferProcess/{ITransferError.d.ts → IDataspaceProtocolTransferError.d.ts} +3 -3
  168. package/dist/types/models/transferProcess/{ITransferProcess.d.ts → IDataspaceProtocolTransferProcess.d.ts} +5 -5
  169. package/dist/types/models/transferProcess/{ITransferRequestMessage.d.ts → IDataspaceProtocolTransferRequestMessage.d.ts} +5 -5
  170. package/dist/types/models/transferProcess/{ITransferStartMessage.d.ts → IDataspaceProtocolTransferStartMessage.d.ts} +5 -5
  171. package/dist/types/models/transferProcess/{ITransferSuspensionMessage.d.ts → IDataspaceProtocolTransferSuspensionMessage.d.ts} +3 -3
  172. package/dist/types/models/transferProcess/{ITransferTerminationMessage.d.ts → IDataspaceProtocolTransferTerminationMessage.d.ts} +3 -3
  173. package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts +46 -0
  174. package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts +89 -0
  175. package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts +30 -0
  176. package/dist/types/utils/dataspaceProtocolHelper.d.ts +19 -0
  177. package/docs/changelog.md +991 -12
  178. package/docs/examples.md +44 -1
  179. package/docs/reference/classes/CatalogDataTypes.md +1 -1
  180. package/docs/reference/classes/ContractNegotiationDataTypes.md +1 -1
  181. package/docs/reference/classes/DataspaceProtocolDataTypes.md +2 -2
  182. package/docs/reference/classes/DataspaceProtocolHelper.md +57 -0
  183. package/docs/reference/classes/TransferProcessDataTypes.md +1 -1
  184. package/docs/reference/index.md +48 -32
  185. package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +179 -0
  186. package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +598 -0
  187. package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +570 -0
  188. package/docs/reference/interfaces/{ICatalogError.md → IDataspaceProtocolCatalogError.md} +6 -6
  189. package/docs/reference/interfaces/{ICatalogRequestMessage.md → IDataspaceProtocolCatalogRequestMessage.md} +5 -5
  190. package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +10 -10
  191. package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +6 -6
  192. package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +8 -8
  193. package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +10 -10
  194. package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +8 -8
  195. package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +10 -10
  196. package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +11 -11
  197. package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +11 -11
  198. package/docs/reference/interfaces/{IDataAddress.md → IDataspaceProtocolDataAddress.md} +8 -8
  199. package/docs/reference/interfaces/IDataspaceProtocolDataService.md +403 -0
  200. package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +387 -0
  201. package/docs/reference/interfaces/IDataspaceProtocolDataset.md +500 -0
  202. package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +484 -0
  203. package/docs/reference/interfaces/{IDatasetRequestMessage.md → IDataspaceProtocolDatasetRequestMessage.md} +4 -4
  204. package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +400 -0
  205. package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +381 -0
  206. package/docs/reference/interfaces/{IEndpointProperty.md → IDataspaceProtocolEndpointProperty.md} +5 -5
  207. package/docs/reference/interfaces/IDataspaceProtocolOffer.md +178 -0
  208. package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +171 -0
  209. package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +180 -0
  210. package/docs/reference/interfaces/IDataspaceProtocolSet.md +179 -0
  211. package/docs/reference/interfaces/{ITransferCompletionMessage.md → IDataspaceProtocolTransferCompletionMessage.md} +6 -6
  212. package/docs/reference/interfaces/{ITransferError.md → IDataspaceProtocolTransferError.md} +10 -10
  213. package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +44 -0
  214. package/docs/reference/interfaces/{ITransferRequestMessage.md → IDataspaceProtocolTransferRequestMessage.md} +10 -10
  215. package/docs/reference/interfaces/{ITransferStartMessage.md → IDataspaceProtocolTransferStartMessage.md} +8 -8
  216. package/docs/reference/interfaces/{ITransferSuspensionMessage.md → IDataspaceProtocolTransferSuspensionMessage.md} +10 -10
  217. package/docs/reference/interfaces/{ITransferTerminationMessage.md → IDataspaceProtocolTransferTerminationMessage.md} +10 -10
  218. package/docs/reference/type-aliases/DataspaceProtocolCatalogTypes.md +5 -0
  219. package/docs/reference/type-aliases/DataspaceProtocolContextType.md +1 -1
  220. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationEventType.md +5 -0
  221. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationStateType.md +5 -0
  222. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationTypes.md +5 -0
  223. package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +12 -0
  224. package/docs/reference/type-aliases/DataspaceProtocolTransferProcessStateType.md +5 -0
  225. package/docs/reference/type-aliases/DataspaceProtocolTransferProcessTypes.md +5 -0
  226. package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +74 -0
  227. package/docs/reference/variables/DataspaceProtocolContexts.md +18 -6
  228. package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md} +4 -4
  229. package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md} +9 -9
  230. package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +68 -0
  231. package/docs/reference/variables/DataspaceProtocolEndpointType.md +96 -0
  232. package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +38 -0
  233. package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +62 -0
  234. package/locales/en.json +10 -1
  235. package/package.json +6 -6
  236. package/dist/es/models/catalog/ICatalogError.js +0 -2
  237. package/dist/es/models/catalog/ICatalogError.js.map +0 -1
  238. package/dist/es/models/catalog/ICatalogRequestMessage.js +0 -2
  239. package/dist/es/models/catalog/ICatalogRequestMessage.js.map +0 -1
  240. package/dist/es/models/catalog/IDatasetRequestMessage.js +0 -2
  241. package/dist/es/models/catalog/IDatasetRequestMessage.js.map +0 -1
  242. package/dist/es/models/catalog/catalogTypes.js +0 -22
  243. package/dist/es/models/catalog/catalogTypes.js.map +0 -1
  244. package/dist/es/models/contractNegotiation/IContractAgreementMessage.js +0 -2
  245. package/dist/es/models/contractNegotiation/IContractAgreementMessage.js.map +0 -1
  246. package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js +0 -2
  247. package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js.map +0 -1
  248. package/dist/es/models/contractNegotiation/IContractNegotiation.js +0 -2
  249. package/dist/es/models/contractNegotiation/IContractNegotiation.js.map +0 -1
  250. package/dist/es/models/contractNegotiation/IContractNegotiationError.js +0 -2
  251. package/dist/es/models/contractNegotiation/IContractNegotiationError.js.map +0 -1
  252. package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js +0 -2
  253. package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js.map +0 -1
  254. package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js +0 -2
  255. package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js.map +0 -1
  256. package/dist/es/models/contractNegotiation/IContractOfferMessage.js +0 -2
  257. package/dist/es/models/contractNegotiation/IContractOfferMessage.js.map +0 -1
  258. package/dist/es/models/contractNegotiation/IContractRequestMessage.js +0 -2
  259. package/dist/es/models/contractNegotiation/IContractRequestMessage.js.map +0 -1
  260. package/dist/es/models/contractNegotiation/contractNegotiationTypes.js.map +0 -1
  261. package/dist/es/models/contractNegotiation/types/contractNegotiationEventType.js.map +0 -1
  262. package/dist/es/models/contractNegotiation/types/contractNegotiationStateType.js.map +0 -1
  263. package/dist/es/models/transferProcess/IDataAddress.js +0 -2
  264. package/dist/es/models/transferProcess/IDataAddress.js.map +0 -1
  265. package/dist/es/models/transferProcess/IEndpointProperty.js +0 -2
  266. package/dist/es/models/transferProcess/IEndpointProperty.js.map +0 -1
  267. package/dist/es/models/transferProcess/ITransferCompletionMessage.js +0 -2
  268. package/dist/es/models/transferProcess/ITransferCompletionMessage.js.map +0 -1
  269. package/dist/es/models/transferProcess/ITransferError.js +0 -2
  270. package/dist/es/models/transferProcess/ITransferError.js.map +0 -1
  271. package/dist/es/models/transferProcess/ITransferProcess.js +0 -2
  272. package/dist/es/models/transferProcess/ITransferProcess.js.map +0 -1
  273. package/dist/es/models/transferProcess/ITransferRequestMessage.js +0 -2
  274. package/dist/es/models/transferProcess/ITransferRequestMessage.js.map +0 -1
  275. package/dist/es/models/transferProcess/ITransferStartMessage.js +0 -2
  276. package/dist/es/models/transferProcess/ITransferStartMessage.js.map +0 -1
  277. package/dist/es/models/transferProcess/ITransferSuspensionMessage.js.map +0 -1
  278. package/dist/es/models/transferProcess/ITransferTerminationMessage.js +0 -2
  279. package/dist/es/models/transferProcess/ITransferTerminationMessage.js.map +0 -1
  280. package/dist/es/models/transferProcess/transferProcessTypes.js.map +0 -1
  281. package/dist/es/models/transferProcess/types/transferProcessStateType.js.map +0 -1
  282. package/dist/es/schemas/CatalogError.json +0 -74
  283. package/dist/es/schemas/CatalogRequestMessage.json +0 -69
  284. package/dist/es/schemas/ContractAgreementMessage.json +0 -83
  285. package/dist/es/schemas/ContractAgreementVerificationMessage.json +0 -74
  286. package/dist/es/schemas/ContractNegotiation.json +0 -79
  287. package/dist/es/schemas/ContractNegotiationError.json +0 -83
  288. package/dist/es/schemas/ContractNegotiationEventMessage.json +0 -79
  289. package/dist/es/schemas/ContractNegotiationEventType.json +0 -10
  290. package/dist/es/schemas/ContractNegotiationStateType.json +0 -15
  291. package/dist/es/schemas/ContractNegotiationTerminationMessage.json +0 -83
  292. package/dist/es/schemas/ContractOfferMessage.json +0 -82
  293. package/dist/es/schemas/ContractRequestMessage.json +0 -82
  294. package/dist/es/schemas/DatasetRequestMessage.json +0 -69
  295. package/dist/es/schemas/TransferCompletionMessage.json +0 -74
  296. package/dist/es/schemas/TransferError.json +0 -83
  297. package/dist/es/schemas/TransferProcess.json +0 -109
  298. package/dist/es/schemas/TransferRequestMessage.json +0 -88
  299. package/dist/es/schemas/TransferStartMessage.json +0 -78
  300. package/dist/es/schemas/TransferSuspensionMessage.json +0 -83
  301. package/dist/es/schemas/TransferTerminationMessage.json +0 -83
  302. package/dist/types/models/catalog/catalogTypes.d.ts +0 -22
  303. package/dist/types/models/contractNegotiation/contractNegotiationTypes.d.ts +0 -50
  304. package/dist/types/models/transferProcess/transferProcessTypes.d.ts +0 -46
  305. package/dist/types/models/transferProcess/types/transferProcessStateType.d.ts +0 -30
  306. package/docs/reference/interfaces/ITransferProcess.md +0 -74
  307. package/docs/reference/type-aliases/CatalogTypes.md +0 -5
  308. package/docs/reference/type-aliases/ContractNegotiationEventType.md +0 -5
  309. package/docs/reference/type-aliases/ContractNegotiationStateType.md +0 -5
  310. package/docs/reference/type-aliases/ContractNegotiationTypes.md +0 -5
  311. package/docs/reference/type-aliases/TransferProcessStateType.md +0 -5
  312. package/docs/reference/type-aliases/TransferProcessTypes.md +0 -5
  313. package/docs/reference/variables/CatalogTypes.md +0 -26
  314. package/docs/reference/variables/ContractNegotiationTypes.md +0 -68
  315. package/docs/reference/variables/TransferProcessStateType.md +0 -38
  316. package/docs/reference/variables/TransferProcessTypes.md +0 -62
@@ -1,82 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/ContractRequestMessage",
4
- "description": "Interface for Dataspace Protocol Contract Request Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "ContractRequestMessage",
56
- "description": "The type of the message."
57
- },
58
- "providerPid": {
59
- "type": "string",
60
- "description": "The provider id for the contract."
61
- },
62
- "consumerPid": {
63
- "type": "string",
64
- "description": "The consumer id for the contract."
65
- },
66
- "offer": {
67
- "$ref": "https://schema.twindev.org/dataspace-protocol/OdrlOffer",
68
- "description": "The offer being requested."
69
- },
70
- "callbackAddress": {
71
- "type": "string",
72
- "description": "The base callback address for the provider to update the consumer on the state of the negotiation."
73
- }
74
- },
75
- "required": [
76
- "@context",
77
- "@type",
78
- "consumerPid",
79
- "offer"
80
- ],
81
- "additionalProperties": false
82
- }
@@ -1,69 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/DatasetRequestMessage",
4
- "description": "Interface for Dataspace Protocol Dataset Request Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "DatasetRequestMessage",
56
- "description": "The type of the message."
57
- },
58
- "dataset": {
59
- "type": "string",
60
- "description": "The identifier of the dataset."
61
- }
62
- },
63
- "required": [
64
- "@context",
65
- "@type",
66
- "dataset"
67
- ],
68
- "additionalProperties": false
69
- }
@@ -1,74 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/TransferCompletionMessage",
4
- "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "TransferCompletionMessage",
56
- "description": "LD Type"
57
- },
58
- "consumerPid": {
59
- "type": "string",
60
- "description": "MUST refer to the transfer identifier of the Consumer side."
61
- },
62
- "providerPid": {
63
- "type": "string",
64
- "description": "MUST refer to the transfer identifier of the Provider side."
65
- }
66
- },
67
- "required": [
68
- "@context",
69
- "@type",
70
- "consumerPid",
71
- "providerPid"
72
- ],
73
- "additionalProperties": false
74
- }
@@ -1,83 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/TransferError",
4
- "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "TransferError",
56
- "description": "LD Type"
57
- },
58
- "consumerPid": {
59
- "type": "string",
60
- "description": "MUST refer to the transfer identifier of the Consumer side."
61
- },
62
- "providerPid": {
63
- "type": "string",
64
- "description": "MUST refer to the transfer identifier of the Provider side."
65
- },
66
- "code": {
67
- "type": "string",
68
- "description": "The error code."
69
- },
70
- "reason": {
71
- "type": "array",
72
- "items": {},
73
- "description": "The error reason(s)."
74
- }
75
- },
76
- "required": [
77
- "@context",
78
- "@type",
79
- "consumerPid",
80
- "providerPid"
81
- ],
82
- "additionalProperties": false
83
- }
@@ -1,109 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/TransferProcess",
4
- "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "TransferProcess",
56
- "description": "LD Type"
57
- },
58
- "consumerPid": {
59
- "type": "string",
60
- "description": "MUST refer to the transfer identifier of the Consumer side."
61
- },
62
- "providerPid": {
63
- "type": "string",
64
- "description": "MUST refer to the transfer identifier of the Provider side."
65
- },
66
- "state": {
67
- "type": "object",
68
- "properties": {
69
- "COMPLETED": {
70
- "type": "string",
71
- "const": "COMPLETED"
72
- },
73
- "REQUESTED": {
74
- "type": "string",
75
- "const": "REQUESTED"
76
- },
77
- "STARTED": {
78
- "type": "string",
79
- "const": "STARTED"
80
- },
81
- "SUSPENDED": {
82
- "type": "string",
83
- "const": "SUSPENDED"
84
- },
85
- "TERMINATED": {
86
- "type": "string",
87
- "const": "TERMINATED"
88
- }
89
- },
90
- "required": [
91
- "COMPLETED",
92
- "REQUESTED",
93
- "STARTED",
94
- "SUSPENDED",
95
- "TERMINATED"
96
- ],
97
- "additionalProperties": false,
98
- "description": "The transfer process state."
99
- }
100
- },
101
- "required": [
102
- "@context",
103
- "@type",
104
- "consumerPid",
105
- "providerPid",
106
- "state"
107
- ],
108
- "additionalProperties": false
109
- }
@@ -1,88 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/TransferRequestMessage",
4
- "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "TransferRequestMessage",
56
- "description": "LD Type"
57
- },
58
- "agreementId": {
59
- "type": "string",
60
- "description": "MUST refer to an existing Agreement between the Consumer and Provider."
61
- },
62
- "callbackAddress": {
63
- "type": "string",
64
- "description": "MUST be a URI indicating where messages to the Consumer SHOULD be sent."
65
- },
66
- "consumerPid": {
67
- "type": "string",
68
- "description": "MUST refer to the transfer identifier of the Consumer side."
69
- },
70
- "format": {
71
- "type": "string",
72
- "description": "The format property is a format specified by a Distribution for the Dataset associated with the Agreement. This is generally obtained from the Provider's Catalog."
73
- },
74
- "dataAddress": {
75
- "$ref": "https://schema.twindev.org/dataspace-protocol/DataAddress",
76
- "description": "If defined MUST contain a transport-specific set of properties for pushing the data. It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType."
77
- }
78
- },
79
- "required": [
80
- "@context",
81
- "@type",
82
- "agreementId",
83
- "callbackAddress",
84
- "consumerPid",
85
- "format"
86
- ],
87
- "additionalProperties": false
88
- }
@@ -1,78 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/TransferStartMessage",
4
- "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "TransferStartMessage",
56
- "description": "LD Type"
57
- },
58
- "consumerPid": {
59
- "type": "string",
60
- "description": "MUST refer to the transfer identifier of the Consumer side."
61
- },
62
- "providerPid": {
63
- "type": "string",
64
- "description": "MUST refer to the transfer identifier of the Provider side."
65
- },
66
- "dataAddress": {
67
- "$ref": "https://schema.twindev.org/dataspace-protocol/DataAddress",
68
- "description": "MUST be provided if the current transfer is a pull transfer and contains a transport-specific endpoint address for obtaining the data."
69
- }
70
- },
71
- "required": [
72
- "@context",
73
- "@type",
74
- "consumerPid",
75
- "providerPid"
76
- ],
77
- "additionalProperties": false
78
- }
@@ -1,83 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.twindev.org/dataspace-protocol/TransferSuspensionMessage",
4
- "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message",
5
- "type": "object",
6
- "properties": {
7
- "@context": {
8
- "description": "The Dataspace Protocol JSON-LD context type.",
9
- "anyOf": [
10
- {
11
- "type": "array",
12
- "items": {
13
- "type": "string",
14
- "const": "https://w3id.org/dspace/2025/1/context.json"
15
- },
16
- "minItems": 1,
17
- "maxItems": 1
18
- },
19
- {
20
- "type": "array",
21
- "minItems": 2,
22
- "prefixItems": [
23
- {
24
- "type": "string",
25
- "const": "https://w3id.org/dspace/2025/1/context.json"
26
- },
27
- {
28
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
29
- }
30
- ],
31
- "items": {
32
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
33
- }
34
- },
35
- {
36
- "type": "array",
37
- "minItems": 2,
38
- "prefixItems": [
39
- {
40
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
41
- },
42
- {
43
- "type": "string",
44
- "const": "https://w3id.org/dspace/2025/1/context.json"
45
- }
46
- ],
47
- "items": {
48
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
49
- }
50
- }
51
- ]
52
- },
53
- "@type": {
54
- "type": "string",
55
- "const": "TransferSuspensionMessage",
56
- "description": "LD Type"
57
- },
58
- "consumerPid": {
59
- "type": "string",
60
- "description": "MUST refer to the transfer identifier of the Consumer side."
61
- },
62
- "providerPid": {
63
- "type": "string",
64
- "description": "MUST refer to the transfer identifier of the Provider side."
65
- },
66
- "code": {
67
- "type": "string",
68
- "description": "The suspension code."
69
- },
70
- "reason": {
71
- "type": "array",
72
- "items": {},
73
- "description": "The suspension reason(s)."
74
- }
75
- },
76
- "required": [
77
- "@context",
78
- "@type",
79
- "consumerPid",
80
- "providerPid"
81
- ],
82
- "additionalProperties": false
83
- }