@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.60

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 (321) 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 +46 -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/dataspaceProtocolTransferFormat.js +22 -0
  94. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferFormat.js.map +1 -0
  95. package/dist/es/models/transferProcess/types/{transferProcessStateType.js → dataspaceProtocolTransferProcessStateType.js} +2 -2
  96. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -0
  97. package/dist/es/schemas/DataspaceProtocolAgreement.json +207 -0
  98. package/dist/es/schemas/DataspaceProtocolCatalog.json +21 -0
  99. package/dist/es/schemas/DataspaceProtocolCatalogBase.json +428 -0
  100. package/dist/es/schemas/DataspaceProtocolCatalogError.json +31 -0
  101. package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +26 -0
  102. package/dist/es/schemas/DataspaceProtocolContextType.json +30 -0
  103. package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +225 -0
  104. package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json +31 -0
  105. package/dist/es/schemas/DataspaceProtocolContractNegotiation.json +36 -0
  106. package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json +40 -0
  107. package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json +36 -0
  108. package/dist/es/schemas/DataspaceProtocolContractNegotiationEventType.json +16 -0
  109. package/dist/es/schemas/DataspaceProtocolContractNegotiationStateType.json +36 -0
  110. package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json +40 -0
  111. package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json +39 -0
  112. package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json +39 -0
  113. package/dist/es/schemas/{DataAddress.json → DataspaceProtocolDataAddress.json} +5 -6
  114. package/dist/es/schemas/DataspaceProtocolDataService.json +21 -0
  115. package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +279 -0
  116. package/dist/es/schemas/DataspaceProtocolDataset.json +21 -0
  117. package/dist/es/schemas/DataspaceProtocolDatasetBase.json +330 -0
  118. package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +26 -0
  119. package/dist/es/schemas/DataspaceProtocolDistribution.json +26 -0
  120. package/dist/es/schemas/DataspaceProtocolDistributionBase.json +164 -0
  121. package/dist/es/schemas/{EndpointProperty.json → DataspaceProtocolEndpointProperty.json} +4 -5
  122. package/dist/es/schemas/DataspaceProtocolOffer.json +26 -0
  123. package/dist/es/schemas/DataspaceProtocolOfferBase.json +219 -0
  124. package/dist/es/schemas/DataspaceProtocolPolicy.json +231 -0
  125. package/dist/es/schemas/DataspaceProtocolSet.json +243 -0
  126. package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +31 -0
  127. package/dist/es/schemas/DataspaceProtocolTransferError.json +40 -0
  128. package/dist/es/schemas/DataspaceProtocolTransferProcess.json +36 -0
  129. package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +45 -0
  130. package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +35 -0
  131. package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +40 -0
  132. package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +40 -0
  133. package/dist/es/utils/dataspaceProtocolHelper.js +108 -0
  134. package/dist/es/utils/dataspaceProtocolHelper.js.map +1 -0
  135. package/dist/types/index.d.ts +44 -28
  136. package/dist/types/models/catalog/{ICatalogError.d.ts → IDataspaceProtocolCatalogError.d.ts} +3 -3
  137. package/dist/types/models/catalog/{ICatalogRequestMessage.d.ts → IDataspaceProtocolCatalogRequestMessage.d.ts} +3 -3
  138. package/dist/types/models/catalog/{IDatasetRequestMessage.d.ts → IDataspaceProtocolDatasetRequestMessage.d.ts} +3 -3
  139. package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +54 -0
  140. package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts} +6 -5
  141. package/dist/types/models/contractNegotiation/{IContractAgreementVerificationMessage.d.ts → IDataspaceProtocolContractAgreementVerificationMessage.d.ts} +3 -3
  142. package/dist/types/models/contractNegotiation/{IContractNegotiation.d.ts → IDataspaceProtocolContractNegotiation.d.ts} +5 -5
  143. package/dist/types/models/contractNegotiation/{IContractNegotiationError.d.ts → IDataspaceProtocolContractNegotiationError.d.ts} +3 -3
  144. package/dist/types/models/contractNegotiation/{IContractNegotiationEventMessage.d.ts → IDataspaceProtocolContractNegotiationEventMessage.d.ts} +5 -5
  145. package/dist/types/models/contractNegotiation/{IContractNegotiationTerminationMessage.d.ts → IDataspaceProtocolContractNegotiationTerminationMessage.d.ts} +3 -3
  146. package/dist/types/models/contractNegotiation/{IContractOfferMessage.d.ts → IDataspaceProtocolContractOfferMessage.d.ts} +5 -5
  147. package/dist/types/models/contractNegotiation/{IContractRequestMessage.d.ts → IDataspaceProtocolContractRequestMessage.d.ts} +5 -5
  148. package/dist/types/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts +50 -0
  149. package/dist/types/models/contractNegotiation/types/{contractNegotiationEventType.d.ts → dataspaceProtocolContractNegotiationEventType.d.ts} +2 -2
  150. package/dist/types/models/contractNegotiation/types/{contractNegotiationStateType.d.ts → dataspaceProtocolContractNegotiationStateType.d.ts} +2 -2
  151. package/dist/types/models/dataspaceProtocolContextType.d.ts +2 -9
  152. package/dist/types/models/dataspaceProtocolContexts.d.ts +12 -4
  153. package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +28 -0
  154. package/dist/types/models/dcat3/IDataspaceProtocolCatalogBase.d.ts +58 -0
  155. package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +28 -0
  156. package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +44 -0
  157. package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +38 -0
  158. package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +62 -0
  159. package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +42 -0
  160. package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +66 -0
  161. package/dist/types/models/odrl/IDataspaceProtocolAgreement.d.ts +17 -0
  162. package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +22 -0
  163. package/dist/types/models/odrl/IDataspaceProtocolOfferBase.d.ts +18 -0
  164. package/dist/types/models/odrl/IDataspaceProtocolPolicy.d.ts +17 -0
  165. package/dist/types/models/odrl/IDataspaceProtocolSet.d.ts +17 -0
  166. package/dist/types/models/transferProcess/{IDataAddress.d.ts → IDataspaceProtocolDataAddress.d.ts} +5 -5
  167. package/dist/types/models/transferProcess/{IEndpointProperty.d.ts → IDataspaceProtocolEndpointProperty.d.ts} +3 -3
  168. package/dist/types/models/transferProcess/{ITransferCompletionMessage.d.ts → IDataspaceProtocolTransferCompletionMessage.d.ts} +3 -3
  169. package/dist/types/models/transferProcess/{ITransferError.d.ts → IDataspaceProtocolTransferError.d.ts} +3 -3
  170. package/dist/types/models/transferProcess/{ITransferProcess.d.ts → IDataspaceProtocolTransferProcess.d.ts} +5 -5
  171. package/dist/types/models/transferProcess/{ITransferRequestMessage.d.ts → IDataspaceProtocolTransferRequestMessage.d.ts} +5 -5
  172. package/dist/types/models/transferProcess/{ITransferStartMessage.d.ts → IDataspaceProtocolTransferStartMessage.d.ts} +5 -5
  173. package/dist/types/models/transferProcess/{ITransferSuspensionMessage.d.ts → IDataspaceProtocolTransferSuspensionMessage.d.ts} +3 -3
  174. package/dist/types/models/transferProcess/{ITransferTerminationMessage.d.ts → IDataspaceProtocolTransferTerminationMessage.d.ts} +3 -3
  175. package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts +46 -0
  176. package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts +89 -0
  177. package/dist/types/models/transferProcess/types/dataspaceProtocolTransferFormat.d.ts +22 -0
  178. package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts +30 -0
  179. package/dist/types/utils/dataspaceProtocolHelper.d.ts +19 -0
  180. package/docs/changelog.md +962 -0
  181. package/docs/examples.md +44 -1
  182. package/docs/reference/classes/CatalogDataTypes.md +1 -1
  183. package/docs/reference/classes/ContractNegotiationDataTypes.md +1 -1
  184. package/docs/reference/classes/DataspaceProtocolDataTypes.md +2 -2
  185. package/docs/reference/classes/DataspaceProtocolHelper.md +57 -0
  186. package/docs/reference/classes/TransferProcessDataTypes.md +1 -1
  187. package/docs/reference/index.md +50 -32
  188. package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +179 -0
  189. package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +598 -0
  190. package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +570 -0
  191. package/docs/reference/interfaces/{ICatalogError.md → IDataspaceProtocolCatalogError.md} +6 -6
  192. package/docs/reference/interfaces/{ICatalogRequestMessage.md → IDataspaceProtocolCatalogRequestMessage.md} +5 -5
  193. package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +10 -10
  194. package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +6 -6
  195. package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +8 -8
  196. package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +10 -10
  197. package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +8 -8
  198. package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +10 -10
  199. package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +11 -11
  200. package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +11 -11
  201. package/docs/reference/interfaces/{IDataAddress.md → IDataspaceProtocolDataAddress.md} +8 -8
  202. package/docs/reference/interfaces/IDataspaceProtocolDataService.md +403 -0
  203. package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +387 -0
  204. package/docs/reference/interfaces/IDataspaceProtocolDataset.md +500 -0
  205. package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +484 -0
  206. package/docs/reference/interfaces/{IDatasetRequestMessage.md → IDataspaceProtocolDatasetRequestMessage.md} +4 -4
  207. package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +400 -0
  208. package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +381 -0
  209. package/docs/reference/interfaces/{IEndpointProperty.md → IDataspaceProtocolEndpointProperty.md} +5 -5
  210. package/docs/reference/interfaces/IDataspaceProtocolOffer.md +178 -0
  211. package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +171 -0
  212. package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +180 -0
  213. package/docs/reference/interfaces/IDataspaceProtocolSet.md +179 -0
  214. package/docs/reference/interfaces/{ITransferCompletionMessage.md → IDataspaceProtocolTransferCompletionMessage.md} +6 -6
  215. package/docs/reference/interfaces/{ITransferError.md → IDataspaceProtocolTransferError.md} +10 -10
  216. package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +44 -0
  217. package/docs/reference/interfaces/{ITransferRequestMessage.md → IDataspaceProtocolTransferRequestMessage.md} +10 -10
  218. package/docs/reference/interfaces/{ITransferStartMessage.md → IDataspaceProtocolTransferStartMessage.md} +8 -8
  219. package/docs/reference/interfaces/{ITransferSuspensionMessage.md → IDataspaceProtocolTransferSuspensionMessage.md} +10 -10
  220. package/docs/reference/interfaces/{ITransferTerminationMessage.md → IDataspaceProtocolTransferTerminationMessage.md} +10 -10
  221. package/docs/reference/type-aliases/DataspaceProtocolCatalogTypes.md +5 -0
  222. package/docs/reference/type-aliases/DataspaceProtocolContextType.md +1 -1
  223. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationEventType.md +5 -0
  224. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationStateType.md +5 -0
  225. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationTypes.md +5 -0
  226. package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +12 -0
  227. package/docs/reference/type-aliases/DataspaceProtocolTransferFormat.md +5 -0
  228. package/docs/reference/type-aliases/DataspaceProtocolTransferProcessStateType.md +5 -0
  229. package/docs/reference/type-aliases/DataspaceProtocolTransferProcessTypes.md +5 -0
  230. package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +74 -0
  231. package/docs/reference/variables/DataspaceProtocolContexts.md +18 -6
  232. package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md} +4 -4
  233. package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md} +9 -9
  234. package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +68 -0
  235. package/docs/reference/variables/DataspaceProtocolEndpointType.md +96 -0
  236. package/docs/reference/variables/DataspaceProtocolTransferFormat.md +26 -0
  237. package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +38 -0
  238. package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +62 -0
  239. package/locales/en.json +10 -1
  240. package/package.json +4 -4
  241. package/dist/es/models/catalog/ICatalogError.js +0 -2
  242. package/dist/es/models/catalog/ICatalogError.js.map +0 -1
  243. package/dist/es/models/catalog/ICatalogRequestMessage.js +0 -2
  244. package/dist/es/models/catalog/ICatalogRequestMessage.js.map +0 -1
  245. package/dist/es/models/catalog/IDatasetRequestMessage.js +0 -2
  246. package/dist/es/models/catalog/IDatasetRequestMessage.js.map +0 -1
  247. package/dist/es/models/catalog/catalogTypes.js +0 -22
  248. package/dist/es/models/catalog/catalogTypes.js.map +0 -1
  249. package/dist/es/models/contractNegotiation/IContractAgreementMessage.js +0 -2
  250. package/dist/es/models/contractNegotiation/IContractAgreementMessage.js.map +0 -1
  251. package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js +0 -2
  252. package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js.map +0 -1
  253. package/dist/es/models/contractNegotiation/IContractNegotiation.js +0 -2
  254. package/dist/es/models/contractNegotiation/IContractNegotiation.js.map +0 -1
  255. package/dist/es/models/contractNegotiation/IContractNegotiationError.js +0 -2
  256. package/dist/es/models/contractNegotiation/IContractNegotiationError.js.map +0 -1
  257. package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js +0 -2
  258. package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js.map +0 -1
  259. package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js +0 -2
  260. package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js.map +0 -1
  261. package/dist/es/models/contractNegotiation/IContractOfferMessage.js +0 -2
  262. package/dist/es/models/contractNegotiation/IContractOfferMessage.js.map +0 -1
  263. package/dist/es/models/contractNegotiation/IContractRequestMessage.js +0 -2
  264. package/dist/es/models/contractNegotiation/IContractRequestMessage.js.map +0 -1
  265. package/dist/es/models/contractNegotiation/contractNegotiationTypes.js.map +0 -1
  266. package/dist/es/models/contractNegotiation/types/contractNegotiationEventType.js.map +0 -1
  267. package/dist/es/models/contractNegotiation/types/contractNegotiationStateType.js.map +0 -1
  268. package/dist/es/models/transferProcess/IDataAddress.js +0 -2
  269. package/dist/es/models/transferProcess/IDataAddress.js.map +0 -1
  270. package/dist/es/models/transferProcess/IEndpointProperty.js +0 -2
  271. package/dist/es/models/transferProcess/IEndpointProperty.js.map +0 -1
  272. package/dist/es/models/transferProcess/ITransferCompletionMessage.js +0 -2
  273. package/dist/es/models/transferProcess/ITransferCompletionMessage.js.map +0 -1
  274. package/dist/es/models/transferProcess/ITransferError.js +0 -2
  275. package/dist/es/models/transferProcess/ITransferError.js.map +0 -1
  276. package/dist/es/models/transferProcess/ITransferProcess.js +0 -2
  277. package/dist/es/models/transferProcess/ITransferProcess.js.map +0 -1
  278. package/dist/es/models/transferProcess/ITransferRequestMessage.js +0 -2
  279. package/dist/es/models/transferProcess/ITransferRequestMessage.js.map +0 -1
  280. package/dist/es/models/transferProcess/ITransferStartMessage.js +0 -2
  281. package/dist/es/models/transferProcess/ITransferStartMessage.js.map +0 -1
  282. package/dist/es/models/transferProcess/ITransferSuspensionMessage.js.map +0 -1
  283. package/dist/es/models/transferProcess/ITransferTerminationMessage.js +0 -2
  284. package/dist/es/models/transferProcess/ITransferTerminationMessage.js.map +0 -1
  285. package/dist/es/models/transferProcess/transferProcessTypes.js.map +0 -1
  286. package/dist/es/models/transferProcess/types/transferProcessStateType.js.map +0 -1
  287. package/dist/es/schemas/CatalogError.json +0 -74
  288. package/dist/es/schemas/CatalogRequestMessage.json +0 -69
  289. package/dist/es/schemas/ContractAgreementMessage.json +0 -83
  290. package/dist/es/schemas/ContractAgreementVerificationMessage.json +0 -74
  291. package/dist/es/schemas/ContractNegotiation.json +0 -79
  292. package/dist/es/schemas/ContractNegotiationError.json +0 -83
  293. package/dist/es/schemas/ContractNegotiationEventMessage.json +0 -79
  294. package/dist/es/schemas/ContractNegotiationEventType.json +0 -10
  295. package/dist/es/schemas/ContractNegotiationStateType.json +0 -15
  296. package/dist/es/schemas/ContractNegotiationTerminationMessage.json +0 -83
  297. package/dist/es/schemas/ContractOfferMessage.json +0 -82
  298. package/dist/es/schemas/ContractRequestMessage.json +0 -82
  299. package/dist/es/schemas/DatasetRequestMessage.json +0 -69
  300. package/dist/es/schemas/TransferCompletionMessage.json +0 -74
  301. package/dist/es/schemas/TransferError.json +0 -83
  302. package/dist/es/schemas/TransferProcess.json +0 -109
  303. package/dist/es/schemas/TransferRequestMessage.json +0 -88
  304. package/dist/es/schemas/TransferStartMessage.json +0 -78
  305. package/dist/es/schemas/TransferSuspensionMessage.json +0 -83
  306. package/dist/es/schemas/TransferTerminationMessage.json +0 -83
  307. package/dist/types/models/catalog/catalogTypes.d.ts +0 -22
  308. package/dist/types/models/contractNegotiation/contractNegotiationTypes.d.ts +0 -50
  309. package/dist/types/models/transferProcess/transferProcessTypes.d.ts +0 -46
  310. package/dist/types/models/transferProcess/types/transferProcessStateType.d.ts +0 -30
  311. package/docs/reference/interfaces/ITransferProcess.md +0 -74
  312. package/docs/reference/type-aliases/CatalogTypes.md +0 -5
  313. package/docs/reference/type-aliases/ContractNegotiationEventType.md +0 -5
  314. package/docs/reference/type-aliases/ContractNegotiationStateType.md +0 -5
  315. package/docs/reference/type-aliases/ContractNegotiationTypes.md +0 -5
  316. package/docs/reference/type-aliases/TransferProcessStateType.md +0 -5
  317. package/docs/reference/type-aliases/TransferProcessTypes.md +0 -5
  318. package/docs/reference/variables/CatalogTypes.md +0 -26
  319. package/docs/reference/variables/ContractNegotiationTypes.md +0 -68
  320. package/docs/reference/variables/TransferProcessStateType.md +0 -38
  321. package/docs/reference/variables/TransferProcessTypes.md +0 -62
@@ -1,11 +1,11 @@
1
- # Interface: IContractAgreementVerificationMessage
1
+ # Interface: IDataspaceProtocolContractAgreementVerificationMessage
2
2
 
3
3
  Interface for Dataspace Protocol Contract Agreement Verification Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,15 +13,15 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractAgreementVerificationMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid
24
+ ### providerPid {#providerpid}
25
25
 
26
26
  > **providerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid
32
+ ### consumerPid {#consumerpid}
33
33
 
34
34
  > **consumerPid**: `string`
35
35
 
@@ -1,11 +1,11 @@
1
- # Interface: IContractNegotiation
1
+ # Interface: IDataspaceProtocolContractNegotiation
2
2
 
3
3
  Interface for Dataspace Protocol Contract Agreement Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,15 +13,15 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiation"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid
24
+ ### providerPid {#providerpid}
25
25
 
26
26
  > **providerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid
32
+ ### consumerPid {#consumerpid}
33
33
 
34
34
  > **consumerPid**: `string`
35
35
 
@@ -37,8 +37,8 @@ The consumer id for the contract.
37
37
 
38
38
  ***
39
39
 
40
- ### state
40
+ ### state {#state}
41
41
 
42
- > **state**: [`ContractNegotiationStateType`](../type-aliases/ContractNegotiationStateType.md)
42
+ > **state**: [`DataspaceProtocolContractNegotiationStateType`](../type-aliases/DataspaceProtocolContractNegotiationStateType.md)
43
43
 
44
44
  The offer being requested.
@@ -1,11 +1,11 @@
1
- # Interface: IContractNegotiationError
1
+ # Interface: IDataspaceProtocolContractNegotiationError
2
2
 
3
3
  Interface for Dataspace Protocol Contract Negotiation Error Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,15 +13,15 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiationError"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid
24
+ ### providerPid {#providerpid}
25
25
 
26
26
  > **providerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid
32
+ ### consumerPid {#consumerpid}
33
33
 
34
34
  > **consumerPid**: `string`
35
35
 
@@ -37,16 +37,16 @@ The consumer id for the contract.
37
37
 
38
38
  ***
39
39
 
40
- ### code?
40
+ ### code? {#code}
41
41
 
42
- > `optional` **code**: `string`
42
+ > `optional` **code?**: `string`
43
43
 
44
44
  The error code.
45
45
 
46
46
  ***
47
47
 
48
- ### reason?
48
+ ### reason? {#reason}
49
49
 
50
- > `optional` **reason**: `any`[]
50
+ > `optional` **reason?**: `any`[]
51
51
 
52
52
  The error reason(s).
@@ -1,11 +1,11 @@
1
- # Interface: IContractNegotiationEventMessage
1
+ # Interface: IDataspaceProtocolContractNegotiationEventMessage
2
2
 
3
3
  Interface for Dataspace Protocol Contract Negotiation Event Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,15 +13,15 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiationEventMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid
24
+ ### providerPid {#providerpid}
25
25
 
26
26
  > **providerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid
32
+ ### consumerPid {#consumerpid}
33
33
 
34
34
  > **consumerPid**: `string`
35
35
 
@@ -37,8 +37,8 @@ The consumer id for the contract.
37
37
 
38
38
  ***
39
39
 
40
- ### event
40
+ ### event {#event}
41
41
 
42
- > **event**: [`ContractNegotiationEventType`](../type-aliases/ContractNegotiationEventType.md)
42
+ > **event**: [`DataspaceProtocolContractNegotiationEventType`](../type-aliases/DataspaceProtocolContractNegotiationEventType.md)
43
43
 
44
44
  The event type.
@@ -1,11 +1,11 @@
1
- # Interface: IContractNegotiationTerminationMessage
1
+ # Interface: IDataspaceProtocolContractNegotiationTerminationMessage
2
2
 
3
3
  Interface for Dataspace Protocol Contract Negotiation Termination Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,15 +13,15 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiationTerminationMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid
24
+ ### providerPid {#providerpid}
25
25
 
26
26
  > **providerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid
32
+ ### consumerPid {#consumerpid}
33
33
 
34
34
  > **consumerPid**: `string`
35
35
 
@@ -37,16 +37,16 @@ The consumer id for the contract.
37
37
 
38
38
  ***
39
39
 
40
- ### code?
40
+ ### code? {#code}
41
41
 
42
- > `optional` **code**: `string`
42
+ > `optional` **code?**: `string`
43
43
 
44
44
  The termination code.
45
45
 
46
46
  ***
47
47
 
48
- ### reason?
48
+ ### reason? {#reason}
49
49
 
50
- > `optional` **reason**: `any`[]
50
+ > `optional` **reason?**: `any`[]
51
51
 
52
52
  The termination reason(s).
@@ -1,11 +1,11 @@
1
- # Interface: IContractOfferMessage
1
+ # Interface: IDataspaceProtocolContractOfferMessage
2
2
 
3
3
  Interface for Dataspace Protocol Contract Offer Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,15 +13,15 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractOfferMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid
24
+ ### providerPid {#providerpid}
25
25
 
26
26
  > **providerPid**: `string`
27
27
 
@@ -29,24 +29,24 @@ The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid?
32
+ ### consumerPid? {#consumerpid}
33
33
 
34
- > `optional` **consumerPid**: `string`
34
+ > `optional` **consumerPid?**: `string`
35
35
 
36
36
  The consumer id for the contract.
37
37
 
38
38
  ***
39
39
 
40
- ### offer
40
+ ### offer {#offer}
41
41
 
42
- > **offer**: `IOdrlOffer`
42
+ > **offer**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)
43
43
 
44
44
  The offer being requested.
45
45
 
46
46
  ***
47
47
 
48
- ### callbackAddress?
48
+ ### callbackAddress? {#callbackaddress}
49
49
 
50
- > `optional` **callbackAddress**: `string`
50
+ > `optional` **callbackAddress?**: `string`
51
51
 
52
52
  The base callback address for the provider to update the consumer on the state of the negotiation.
@@ -1,11 +1,11 @@
1
- # Interface: IContractRequestMessage
1
+ # Interface: IDataspaceProtocolContractRequestMessage
2
2
 
3
3
  Interface for Dataspace Protocol Contract Request Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @context
8
+ ### @context {#context}
9
9
 
10
10
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
@@ -13,23 +13,23 @@ The JSON-LD context.
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractRequestMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
22
22
  ***
23
23
 
24
- ### providerPid?
24
+ ### providerPid? {#providerpid}
25
25
 
26
- > `optional` **providerPid**: `string`
26
+ > `optional` **providerPid?**: `string`
27
27
 
28
28
  The provider id for the contract.
29
29
 
30
30
  ***
31
31
 
32
- ### consumerPid
32
+ ### consumerPid {#consumerpid}
33
33
 
34
34
  > **consumerPid**: `string`
35
35
 
@@ -37,16 +37,16 @@ The consumer id for the contract.
37
37
 
38
38
  ***
39
39
 
40
- ### offer
40
+ ### offer {#offer}
41
41
 
42
- > **offer**: `IOdrlOffer`
42
+ > **offer**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)
43
43
 
44
44
  The offer being requested.
45
45
 
46
46
  ***
47
47
 
48
- ### callbackAddress?
48
+ ### callbackAddress? {#callbackaddress}
49
49
 
50
- > `optional` **callbackAddress**: `string`
50
+ > `optional` **callbackAddress?**: `string`
51
51
 
52
52
  The base callback address for the provider to update the consumer on the state of the negotiation.
@@ -1,19 +1,19 @@
1
- # Interface: IDataAddress
1
+ # Interface: IDataspaceProtocolDataAddress
2
2
 
3
3
  Interface for Dataspace Protocol Transfer Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
5
5
 
6
6
  ## Properties
7
7
 
8
- ### @type
8
+ ### @type {#type}
9
9
 
10
- > **@type**: `string`
10
+ > **@type**: `"DataAddress"`
11
11
 
12
12
  LD Type
13
13
 
14
14
  ***
15
15
 
16
- ### endpointType
16
+ ### endpointType {#endpointtype}
17
17
 
18
18
  > **endpointType**: `string`
19
19
 
@@ -21,16 +21,16 @@ The type of endpoint of this data address.
21
21
 
22
22
  ***
23
23
 
24
- ### endpoint?
24
+ ### endpoint? {#endpoint}
25
25
 
26
- > `optional` **endpoint**: `string`
26
+ > `optional` **endpoint?**: `string`
27
27
 
28
28
  The endpoint of the data address
29
29
 
30
30
  ***
31
31
 
32
- ### endpointProperties?
32
+ ### endpointProperties? {#endpointproperties}
33
33
 
34
- > `optional` **endpointProperties**: [`IEndpointProperty`](IEndpointProperty.md)[]
34
+ > `optional` **endpointProperties?**: [`IDataspaceProtocolEndpointProperty`](IDataspaceProtocolEndpointProperty.md)[]
35
35
 
36
36
  Properties associated to the endpoint which might depend on the endpoint type.