@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,11 +1,11 @@
1
- # Interface: ITransferRequestMessage
1
+ # Interface: IDataspaceProtocolTransferRequestMessage
2
2
 
3
3
  Interface for Dataspace Protocol Transfer Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-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,15 +13,15 @@ LD Context
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"TransferRequestMessage"`
19
19
 
20
20
  LD Type
21
21
 
22
22
  ***
23
23
 
24
- ### agreementId
24
+ ### agreementId {#agreementid}
25
25
 
26
26
  > **agreementId**: `string`
27
27
 
@@ -29,7 +29,7 @@ MUST refer to an existing Agreement between the Consumer and Provider.
29
29
 
30
30
  ***
31
31
 
32
- ### callbackAddress
32
+ ### callbackAddress {#callbackaddress}
33
33
 
34
34
  > **callbackAddress**: `string`
35
35
 
@@ -37,7 +37,7 @@ MUST be a URI indicating where messages to the Consumer SHOULD be sent.
37
37
 
38
38
  ***
39
39
 
40
- ### consumerPid
40
+ ### consumerPid {#consumerpid}
41
41
 
42
42
  > **consumerPid**: `string`
43
43
 
@@ -45,7 +45,7 @@ MUST refer to the transfer identifier of the Consumer side.
45
45
 
46
46
  ***
47
47
 
48
- ### format
48
+ ### format {#format}
49
49
 
50
50
  > **format**: `string`
51
51
 
@@ -54,9 +54,9 @@ This is generally obtained from the Provider's Catalog.
54
54
 
55
55
  ***
56
56
 
57
- ### dataAddress?
57
+ ### dataAddress? {#dataaddress}
58
58
 
59
- > `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
59
+ > `optional` **dataAddress?**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
60
60
 
61
61
  If defined MUST contain a transport-specific set of properties for pushing the data.
62
62
  It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.
@@ -1,11 +1,11 @@
1
- # Interface: ITransferStartMessage
1
+ # Interface: IDataspaceProtocolTransferStartMessage
2
2
 
3
3
  Interface for Dataspace Protocol Transfer Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-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 @@ LD Context
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"TransferStartMessage"`
19
19
 
20
20
  LD Type
21
21
 
22
22
  ***
23
23
 
24
- ### consumerPid
24
+ ### consumerPid {#consumerpid}
25
25
 
26
26
  > **consumerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ MUST refer to the transfer identifier of the Consumer side.
29
29
 
30
30
  ***
31
31
 
32
- ### providerPid
32
+ ### providerPid {#providerpid}
33
33
 
34
34
  > **providerPid**: `string`
35
35
 
@@ -37,9 +37,9 @@ MUST refer to the transfer identifier of the Provider side.
37
37
 
38
38
  ***
39
39
 
40
- ### dataAddress?
40
+ ### dataAddress? {#dataaddress}
41
41
 
42
- > `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
42
+ > `optional` **dataAddress?**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
43
43
 
44
44
  MUST be provided if the current transfer is a pull transfer and
45
45
  contains a transport-specific endpoint address for obtaining the data.
@@ -1,11 +1,11 @@
1
- # Interface: ITransferSuspensionMessage
1
+ # Interface: IDataspaceProtocolTransferSuspensionMessage
2
2
 
3
3
  Interface for Dataspace Protocol Transfer Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-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 @@ LD Context
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"TransferSuspensionMessage"`
19
19
 
20
20
  LD Type
21
21
 
22
22
  ***
23
23
 
24
- ### consumerPid
24
+ ### consumerPid {#consumerpid}
25
25
 
26
26
  > **consumerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ MUST refer to the transfer identifier of the Consumer side.
29
29
 
30
30
  ***
31
31
 
32
- ### providerPid
32
+ ### providerPid {#providerpid}
33
33
 
34
34
  > **providerPid**: `string`
35
35
 
@@ -37,16 +37,16 @@ MUST refer to the transfer identifier of the Provider side.
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 suspension 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 suspension reason(s).
@@ -1,11 +1,11 @@
1
- # Interface: ITransferTerminationMessage
1
+ # Interface: IDataspaceProtocolTransferTerminationMessage
2
2
 
3
3
  Interface for Dataspace Protocol Transfer Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-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 @@ LD Context
13
13
 
14
14
  ***
15
15
 
16
- ### @type
16
+ ### @type {#type}
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"TransferTerminationMessage"`
19
19
 
20
20
  LD Type
21
21
 
22
22
  ***
23
23
 
24
- ### consumerPid
24
+ ### consumerPid {#consumerpid}
25
25
 
26
26
  > **consumerPid**: `string`
27
27
 
@@ -29,7 +29,7 @@ MUST refer to the transfer identifier of the Consumer side.
29
29
 
30
30
  ***
31
31
 
32
- ### providerPid
32
+ ### providerPid {#providerpid}
33
33
 
34
34
  > **providerPid**: `string`
35
35
 
@@ -37,16 +37,16 @@ MUST refer to the transfer identifier of the Provider side.
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).
@@ -0,0 +1,5 @@
1
+ # Type Alias: DataspaceProtocolCatalogTypes
2
+
3
+ > **DataspaceProtocolCatalogTypes** = *typeof* [`DataspaceProtocolCatalogTypes`](../variables/DataspaceProtocolCatalogTypes.md)\[keyof *typeof* [`DataspaceProtocolCatalogTypes`](../variables/DataspaceProtocolCatalogTypes.md)\]
4
+
5
+ The types for Dataspace Protocol Catalog Protocol.
@@ -1,5 +1,5 @@
1
1
  # Type Alias: DataspaceProtocolContextType
2
2
 
3
- > **DataspaceProtocolContextType** = \[*typeof* [`ContextRoot`](../variables/DataspaceProtocolContexts.md#contextroot)\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/DataspaceProtocolContexts.md#contextroot), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`ContextRoot`](../variables/DataspaceProtocolContexts.md#contextroot), `...IJsonLdContextDefinitionElement[]`\]
3
+ > **DataspaceProtocolContextType** = *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context) \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context)\>
4
4
 
5
5
  The Dataspace Protocol JSON-LD context type.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DataspaceProtocolContractNegotiationEventType
2
+
3
+ > **DataspaceProtocolContractNegotiationEventType** = *typeof* [`DataspaceProtocolContractNegotiationEventType`](../variables/DataspaceProtocolContractNegotiationEventType.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationEventType`](../variables/DataspaceProtocolContractNegotiationEventType.md)\]
4
+
5
+ The types for Dataspace Protocol Contract Negotiation Events.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DataspaceProtocolContractNegotiationStateType
2
+
3
+ > **DataspaceProtocolContractNegotiationStateType** = *typeof* [`DataspaceProtocolContractNegotiationStateType`](../variables/DataspaceProtocolContractNegotiationStateType.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationStateType`](../variables/DataspaceProtocolContractNegotiationStateType.md)\]
4
+
5
+ The types for Dataspace Protocol Contract Negotiation States.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DataspaceProtocolContractNegotiationTypes
2
+
3
+ > **DataspaceProtocolContractNegotiationTypes** = *typeof* [`DataspaceProtocolContractNegotiationTypes`](../variables/DataspaceProtocolContractNegotiationTypes.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationTypes`](../variables/DataspaceProtocolContractNegotiationTypes.md)\]
4
+
5
+ The types for Dataspace Protocol Contract Negotiation.
@@ -0,0 +1,12 @@
1
+ # Type Alias: DataspaceProtocolEndpointType
2
+
3
+ > **DataspaceProtocolEndpointType** = *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\[keyof *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\]
4
+
5
+ Type representing all valid Dataspace Protocol endpoint types.
6
+
7
+ All values are valid URIs as required by the DS Protocol JSON-LD context
8
+ which defines endpointType as @type:@vocab.
9
+
10
+ Includes:
11
+ - TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
12
+ - IDSA W3ID types: HTTP, HTTPS
@@ -0,0 +1,5 @@
1
+ # Type Alias: DataspaceProtocolTransferProcessStateType
2
+
3
+ > **DataspaceProtocolTransferProcessStateType** = *typeof* [`DataspaceProtocolTransferProcessStateType`](../variables/DataspaceProtocolTransferProcessStateType.md)\[keyof *typeof* [`DataspaceProtocolTransferProcessStateType`](../variables/DataspaceProtocolTransferProcessStateType.md)\]
4
+
5
+ The types for Dataspace Protocol Transfer.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DataspaceProtocolTransferProcessTypes
2
+
3
+ > **DataspaceProtocolTransferProcessTypes** = *typeof* [`DataspaceProtocolTransferProcessTypes`](../variables/DataspaceProtocolTransferProcessTypes.md)\[keyof *typeof* [`DataspaceProtocolTransferProcessTypes`](../variables/DataspaceProtocolTransferProcessTypes.md)\]
4
+
5
+ The types for Dataspace Protocol Transfer.
@@ -0,0 +1,74 @@
1
+ # Variable: DataspaceProtocolCatalogTypes
2
+
3
+ > `const` **DataspaceProtocolCatalogTypes**: `object`
4
+
5
+ The types for Dataspace Protocol Catalog Protocol.
6
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
7
+
8
+ ## Type Declaration
9
+
10
+ ### CatalogRequestMessage {#catalogrequestmessage}
11
+
12
+ > `readonly` **CatalogRequestMessage**: `"CatalogRequestMessage"` = `"CatalogRequestMessage"`
13
+
14
+ Catalog Request Message.
15
+
16
+ ### DatasetRequestMessage {#datasetrequestmessage}
17
+
18
+ > `readonly` **DatasetRequestMessage**: `"DatasetRequestMessage"` = `"DatasetRequestMessage"`
19
+
20
+ Dataset Request Message.
21
+
22
+ ### CatalogError {#catalogerror}
23
+
24
+ > `readonly` **CatalogError**: `"CatalogError"` = `"CatalogError"`
25
+
26
+ Catalog Error.
27
+
28
+ ### Dataset {#dataset}
29
+
30
+ > `readonly` **Dataset**: `"Dataset"` = `"Dataset"`
31
+
32
+ Dataset.
33
+
34
+ ### DataService {#dataservice}
35
+
36
+ > `readonly` **DataService**: `"DataService"` = `"DataService"`
37
+
38
+ Data Service.
39
+
40
+ ### Distribution {#distribution}
41
+
42
+ > `readonly` **Distribution**: `"Distribution"` = `"Distribution"`
43
+
44
+ Distribution.
45
+
46
+ ### Catalog {#catalog}
47
+
48
+ > `readonly` **Catalog**: `"Catalog"` = `"Catalog"`
49
+
50
+ Catalog.
51
+
52
+ ### Policy {#policy}
53
+
54
+ > `readonly` **Policy**: `"Policy"` = `"Policy"`
55
+
56
+ Policy.
57
+
58
+ ### Offer {#offer}
59
+
60
+ > `readonly` **Offer**: `"Offer"` = `"Offer"`
61
+
62
+ Offer.
63
+
64
+ ### Agreement {#agreement}
65
+
66
+ > `readonly` **Agreement**: `"Agreement"` = `"Agreement"`
67
+
68
+ Agreement.
69
+
70
+ ### Set {#set}
71
+
72
+ > `readonly` **Set**: `"Set"` = `"Set"`
73
+
74
+ Set.
@@ -6,14 +6,26 @@ The contexts for Dataspace Protocol Protocol.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### ContextRoot
9
+ ### Namespace {#namespace}
10
10
 
11
- > `readonly` **ContextRoot**: `"https://w3id.org/dspace/2025/1/context.json"` = `"https://w3id.org/dspace/2025/1/context.json"`
11
+ > `readonly` **Namespace**: `"https://w3id.org/dspace/2025/1/"` = `"https://w3id.org/dspace/2025/1/"`
12
12
 
13
- The context root for Dataspace Protocol Protocol.
13
+ The canonical RDF namespace URI.
14
14
 
15
- ### ContextRedirect
15
+ ### Context {#context}
16
16
 
17
- > `readonly` **ContextRedirect**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
17
+ > `readonly` **Context**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
18
18
 
19
- The context redirect for Dataspace Protocol Protocol.
19
+ The value to use in @context.
20
+
21
+ ### JsonLdContext {#jsonldcontext}
22
+
23
+ > `readonly` **JsonLdContext**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
24
+
25
+ The JSON-LD Context URL.
26
+
27
+ ### JsonSchemaNamespace {#jsonschemanamespace}
28
+
29
+ > `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/dataspace-protocol/"` = `"https://schema.twindev.org/dataspace-protocol/"`
30
+
31
+ The namespace location of the hosted version of the JSON Schema.
@@ -1,19 +1,19 @@
1
- # Variable: ContractNegotiationEventType
1
+ # Variable: DataspaceProtocolContractNegotiationEventType
2
2
 
3
- > `const` **ContractNegotiationEventType**: `object`
3
+ > `const` **DataspaceProtocolContractNegotiationEventType**: `object`
4
4
 
5
5
  The types for Dataspace Protocol Contract Negotiation Events.
6
6
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
7
7
 
8
8
  ## Type Declaration
9
9
 
10
- ### ACCEPTED
10
+ ### ACCEPTED {#accepted}
11
11
 
12
12
  > `readonly` **ACCEPTED**: `"ACCEPTED"` = `"ACCEPTED"`
13
13
 
14
14
  Accepted.
15
15
 
16
- ### FINALIZED
16
+ ### FINALIZED {#finalized}
17
17
 
18
18
  > `readonly` **FINALIZED**: `"FINALIZED"` = `"FINALIZED"`
19
19
 
@@ -1,49 +1,49 @@
1
- # Variable: ContractNegotiationStateType
1
+ # Variable: DataspaceProtocolContractNegotiationStateType
2
2
 
3
- > `const` **ContractNegotiationStateType**: `object`
3
+ > `const` **DataspaceProtocolContractNegotiationStateType**: `object`
4
4
 
5
5
  The types for Dataspace Protocol Contract Negotiation States.
6
6
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
7
7
 
8
8
  ## Type Declaration
9
9
 
10
- ### REQUESTED
10
+ ### REQUESTED {#requested}
11
11
 
12
12
  > `readonly` **REQUESTED**: `"REQUESTED"` = `"REQUESTED"`
13
13
 
14
14
  Requested.
15
15
 
16
- ### OFFERED
16
+ ### OFFERED {#offered}
17
17
 
18
18
  > `readonly` **OFFERED**: `"OFFERED"` = `"OFFERED"`
19
19
 
20
20
  Offered.
21
21
 
22
- ### ACCEPTED
22
+ ### ACCEPTED {#accepted}
23
23
 
24
24
  > `readonly` **ACCEPTED**: `"ACCEPTED"` = `"ACCEPTED"`
25
25
 
26
26
  Accepted.
27
27
 
28
- ### AGREED
28
+ ### AGREED {#agreed}
29
29
 
30
30
  > `readonly` **AGREED**: `"AGREED"` = `"AGREED"`
31
31
 
32
32
  Agreed.
33
33
 
34
- ### VERIFIED
34
+ ### VERIFIED {#verified}
35
35
 
36
36
  > `readonly` **VERIFIED**: `"VERIFIED"` = `"VERIFIED"`
37
37
 
38
38
  Verified.
39
39
 
40
- ### FINALIZED
40
+ ### FINALIZED {#finalized}
41
41
 
42
42
  > `readonly` **FINALIZED**: `"FINALIZED"` = `"FINALIZED"`
43
43
 
44
44
  Finalized.
45
45
 
46
- ### TERMINATED
46
+ ### TERMINATED {#terminated}
47
47
 
48
48
  > `readonly` **TERMINATED**: `"TERMINATED"` = `"TERMINATED"`
49
49
 
@@ -0,0 +1,68 @@
1
+ # Variable: DataspaceProtocolContractNegotiationTypes
2
+
3
+ > `const` **DataspaceProtocolContractNegotiationTypes**: `object`
4
+
5
+ The types for Dataspace Protocol Contract Negotiation.
6
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
7
+
8
+ ## Type Declaration
9
+
10
+ ### ContractNegotiation {#contractnegotiation}
11
+
12
+ > `readonly` **ContractNegotiation**: `"ContractNegotiation"` = `"ContractNegotiation"`
13
+
14
+ Contract Negotiation.
15
+
16
+ ### ContractRequestMessage {#contractrequestmessage}
17
+
18
+ > `readonly` **ContractRequestMessage**: `"ContractRequestMessage"` = `"ContractRequestMessage"`
19
+
20
+ Contract Request Message.
21
+
22
+ ### ContractOfferMessage {#contractoffermessage}
23
+
24
+ > `readonly` **ContractOfferMessage**: `"ContractOfferMessage"` = `"ContractOfferMessage"`
25
+
26
+ Contract Offer Message.
27
+
28
+ ### ContractAgreementMessage {#contractagreementmessage}
29
+
30
+ > `readonly` **ContractAgreementMessage**: `"ContractAgreementMessage"` = `"ContractAgreementMessage"`
31
+
32
+ Contract Agreement Message.
33
+
34
+ ### ContractAgreementVerificationMessage {#contractagreementverificationmessage}
35
+
36
+ > `readonly` **ContractAgreementVerificationMessage**: `"ContractAgreementVerificationMessage"` = `"ContractAgreementVerificationMessage"`
37
+
38
+ Contract Agreement Verification Message.
39
+
40
+ ### ContractNegotiationEventMessage {#contractnegotiationeventmessage}
41
+
42
+ > `readonly` **ContractNegotiationEventMessage**: `"ContractNegotiationEventMessage"` = `"ContractNegotiationEventMessage"`
43
+
44
+ Contract Negotiation Event Message.
45
+
46
+ ### ContractNegotiationTerminationMessage {#contractnegotiationterminationmessage}
47
+
48
+ > `readonly` **ContractNegotiationTerminationMessage**: `"ContractNegotiationTerminationMessage"` = `"ContractNegotiationTerminationMessage"`
49
+
50
+ Contract Negotiation Termination Message.
51
+
52
+ ### ContractNegotiationError {#contractnegotiationerror}
53
+
54
+ > `readonly` **ContractNegotiationError**: `"ContractNegotiationError"` = `"ContractNegotiationError"`
55
+
56
+ Contract Negotiation Error.
57
+
58
+ ### ContractNegotiationEventType {#contractnegotiationeventtype}
59
+
60
+ > `readonly` **ContractNegotiationEventType**: `"ContractNegotiationEventType"` = `"ContractNegotiationEventType"`
61
+
62
+ Contract Negotiation Event Type.
63
+
64
+ ### ContractNegotiationStateType {#contractnegotiationstatetype}
65
+
66
+ > `readonly` **ContractNegotiationStateType**: `"ContractNegotiationStateType"` = `"ContractNegotiationStateType"`
67
+
68
+ Contract Negotiation State Type.
@@ -0,0 +1,96 @@
1
+ # Variable: DataspaceProtocolEndpointType
2
+
3
+ > `const` **DataspaceProtocolEndpointType**: `object`
4
+
5
+ TWIN Data Space Protocol Profile endpoint type identifiers.
6
+
7
+ This module defines endpoint types according to the TWIN Foundation's
8
+ Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
9
+ Protocol specification with TWIN-specific vocabulary.
10
+
11
+ The TWIN vocabulary uses persistent identifiers under the
12
+ https://schema.twindev.org namespace to provide stable, semantic
13
+ identifiers for data space endpoint types.
14
+
15
+ References:
16
+ - TWIN RFC 006: https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
17
+ - TWIN DS Protocol Context: https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
18
+ - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
19
+ - RFC 001 (Query Interface): https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
20
+
21
+ ## Type Declaration
22
+
23
+ ### HttpsQueryEndpoint {#httpsqueryendpoint}
24
+
25
+ > `readonly` **HttpsQueryEndpoint**: `"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint"` = `"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint"`
26
+
27
+ HTTPS Query Endpoint (TWIN DS Profile).
28
+
29
+ Used for PULL transfers via the TWIN Data Space Connector Query interface.
30
+ The consumer retrieves data by querying this endpoint using the data access token.
31
+ Endpoint must implement the interface specified in RFC 001.
32
+
33
+ Transfer Flow:
34
+ 1. Consumer initiates transfer request
35
+ 2. Provider returns this endpoint type with data access token
36
+ 3. Consumer queries the endpoint with the token to retrieve data
37
+
38
+ #### See
39
+
40
+ - https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
41
+ - https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
42
+
43
+ ### HttpsActivityStreamEndpoint {#httpsactivitystreamendpoint}
44
+
45
+ > `readonly` **HttpsActivityStreamEndpoint**: `"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint"` = `"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint"`
46
+
47
+ HTTPS Activity Stream Endpoint (TWIN DS Profile).
48
+
49
+ Used for PUSH transfers via Activity Streams 2.0 protocol.
50
+ The provider actively sends data to the consumer's Activity Stream inbox endpoint.
51
+ Based on W3C Activity Streams 2.0 specification.
52
+
53
+ Transfer Flow:
54
+ 1. Consumer initiates transfer request with this endpoint type
55
+ 2. Consumer provides their Activity Stream inbox URL
56
+ 3. Provider pushes data to the consumer's inbox as Activity Stream objects
57
+
58
+ #### See
59
+
60
+ - https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
61
+ - https://www.w3.org/TR/activitystreams-core/
62
+ - https://www.w3.org/TR/activitypub/
63
+
64
+ ### HTTP {#http}
65
+
66
+ > `readonly` **HTTP**: `"https://w3id.org/idsa/v4.1/HTTP"` = `"https://w3id.org/idsa/v4.1/HTTP"`
67
+
68
+ HTTP endpoint (IDSA W3ID v4.1).
69
+
70
+ Persistent identifier for HTTP-based data access endpoints.
71
+ This W3ID URL is used as a semantic identifier in JSON-LD contexts.
72
+
73
+ Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
74
+ This constant is provided for interoperability with IDSA-based systems.
75
+
76
+ #### See
77
+
78
+ - https://w3id.org/idsa/v4.1/HTTP
79
+ - https://github.com/International-Data-Spaces-Association/InformationModel
80
+
81
+ ### HTTPS {#https}
82
+
83
+ > `readonly` **HTTPS**: `"https://w3id.org/idsa/v4.1/HTTPS"` = `"https://w3id.org/idsa/v4.1/HTTPS"`
84
+
85
+ HTTPS endpoint (IDSA W3ID v4.1).
86
+
87
+ Persistent identifier for HTTPS-based secure data access endpoints.
88
+ This W3ID URL is used as a semantic identifier in JSON-LD contexts.
89
+
90
+ Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
91
+ This constant is provided for interoperability with IDSA-based systems.
92
+
93
+ #### See
94
+
95
+ - https://w3id.org/idsa/v4.1/HTTPS
96
+ - https://github.com/International-Data-Spaces-Association/InformationModel