@twin.org/standards-dataspace-protocol 0.0.3-next.2 → 0.0.3-next.20

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 (223) hide show
  1. package/dist/es/dataTypes/catalogDataTypes.js +44 -0
  2. package/dist/es/dataTypes/catalogDataTypes.js.map +1 -0
  3. package/dist/es/dataTypes/contractNegotiationDataTypes.js +59 -71
  4. package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +1 -1
  5. package/dist/es/dataTypes/dataspaceProtocolDataTypes.js +30 -0
  6. package/dist/es/dataTypes/dataspaceProtocolDataTypes.js.map +1 -0
  7. package/dist/es/dataTypes/transferProcessDataTypes.js +64 -0
  8. package/dist/es/dataTypes/transferProcessDataTypes.js.map +1 -0
  9. package/dist/es/index.js +40 -14
  10. package/dist/es/index.js.map +1 -1
  11. package/dist/es/models/catalog/IDataspaceProtocolCatalog.js +2 -0
  12. package/dist/es/models/catalog/IDataspaceProtocolCatalog.js.map +1 -0
  13. package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js +2 -0
  14. package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js.map +1 -0
  15. package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js +2 -0
  16. package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js.map +1 -0
  17. package/dist/es/models/catalog/IDataspaceProtocolDataService.js +2 -0
  18. package/dist/es/models/catalog/IDataspaceProtocolDataService.js.map +1 -0
  19. package/dist/es/models/catalog/IDataspaceProtocolDataset.js +2 -0
  20. package/dist/es/models/catalog/IDataspaceProtocolDataset.js.map +1 -0
  21. package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js +2 -0
  22. package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js.map +1 -0
  23. package/dist/es/models/catalog/IDataspaceProtocolDistribution.js +2 -0
  24. package/dist/es/models/catalog/IDataspaceProtocolDistribution.js.map +1 -0
  25. package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +38 -0
  26. package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js.map +1 -0
  27. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js +2 -0
  28. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js.map +1 -0
  29. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js +2 -0
  30. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js.map +1 -0
  31. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js +2 -0
  32. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js.map +1 -0
  33. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js +2 -0
  34. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js.map +1 -0
  35. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js +2 -0
  36. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js.map +1 -0
  37. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js +2 -0
  38. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js.map +1 -0
  39. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js +2 -0
  40. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js.map +1 -0
  41. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js +2 -0
  42. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js.map +1 -0
  43. package/dist/es/models/contractNegotiation/{contractNegotiationTypes.js → dataspaceProtocolContractNegotiationTypes.js} +3 -3
  44. package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js.map +1 -0
  45. package/dist/es/models/contractNegotiation/types/{contractNegotiationEventType.js → dataspaceProtocolContractNegotiationEventType.js} +3 -3
  46. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js.map +1 -0
  47. package/dist/es/models/contractNegotiation/types/{contractNegotiationStateType.js → dataspaceProtocolContractNegotiationStateType.js} +3 -3
  48. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js.map +1 -0
  49. package/dist/es/models/dataspaceProtocolContextType.js +2 -0
  50. package/dist/es/models/dataspaceProtocolContextType.js.map +1 -0
  51. package/dist/es/models/dataspaceProtocolContexts.js +21 -0
  52. package/dist/es/models/dataspaceProtocolContexts.js.map +1 -0
  53. package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js +2 -0
  54. package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js.map +1 -0
  55. package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js +2 -0
  56. package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js.map +1 -0
  57. package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js +2 -0
  58. package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js.map +1 -0
  59. package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js +2 -0
  60. package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js.map +1 -0
  61. package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js +2 -0
  62. package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js.map +1 -0
  63. package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js +2 -0
  64. package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js.map +1 -0
  65. package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js +2 -0
  66. package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js.map +1 -0
  67. package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js +4 -0
  68. package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js.map +1 -0
  69. package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js +2 -0
  70. package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js.map +1 -0
  71. package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js +46 -0
  72. package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js.map +1 -0
  73. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js +30 -0
  74. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -0
  75. package/dist/es/schemas/DataspaceProtocolCatalog.json +11 -0
  76. package/dist/es/schemas/DataspaceProtocolCatalogError.json +78 -0
  77. package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +73 -0
  78. package/dist/es/schemas/{ContractAgreementMessage.json → DataspaceProtocolContractAgreementMessage.json} +14 -5
  79. package/dist/es/schemas/{ContractAgreementVerificationMessage.json → DataspaceProtocolContractAgreementVerificationMessage.json} +14 -5
  80. package/dist/es/schemas/{ContractNegotiation.json → DataspaceProtocolContractNegotiation.json} +15 -6
  81. package/dist/es/schemas/{ContractNegotiationError.json → DataspaceProtocolContractNegotiationError.json} +15 -39
  82. package/dist/es/schemas/{ContractNegotiationEventMessage.json → DataspaceProtocolContractNegotiationEventMessage.json} +15 -6
  83. package/dist/es/schemas/{ContractNegotiationEventType.json → DataspaceProtocolContractNegotiationEventType.json} +1 -1
  84. package/dist/es/schemas/{ContractNegotiationStateType.json → DataspaceProtocolContractNegotiationStateType.json} +1 -1
  85. package/dist/es/schemas/{ContractNegotiationTerminationMessage.json → DataspaceProtocolContractNegotiationTerminationMessage.json} +14 -5
  86. package/dist/es/schemas/{ContractOfferMessage.json → DataspaceProtocolContractOfferMessage.json} +14 -5
  87. package/dist/es/schemas/{ContractRequestMessage.json → DataspaceProtocolContractRequestMessage.json} +14 -5
  88. package/dist/es/schemas/DataspaceProtocolDataAddress.json +33 -0
  89. package/dist/es/schemas/DataspaceProtocolDataset.json +11 -0
  90. package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +73 -0
  91. package/dist/es/schemas/DataspaceProtocolEndpointProperty.json +27 -0
  92. package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +78 -0
  93. package/dist/es/schemas/DataspaceProtocolTransferError.json +87 -0
  94. package/dist/es/schemas/DataspaceProtocolTransferProcess.json +83 -0
  95. package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +92 -0
  96. package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +82 -0
  97. package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +87 -0
  98. package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +87 -0
  99. package/dist/es/schemas-src/DataspaceProtocolDataService.json +11 -0
  100. package/dist/es/schemas-src/DataspaceProtocolDistribution.json +11 -0
  101. package/dist/es/utils/dataspaceProtocolHelper.js +110 -0
  102. package/dist/es/utils/dataspaceProtocolHelper.js.map +1 -0
  103. package/dist/types/dataTypes/catalogDataTypes.d.ts +9 -0
  104. package/dist/types/dataTypes/contractNegotiationDataTypes.d.ts +1 -5
  105. package/dist/types/dataTypes/dataspaceProtocolDataTypes.d.ts +13 -0
  106. package/dist/types/dataTypes/transferProcessDataTypes.d.ts +9 -0
  107. package/dist/types/index.d.ts +36 -13
  108. package/dist/types/models/catalog/IDataspaceProtocolCatalog.d.ts +63 -0
  109. package/dist/types/models/catalog/IDataspaceProtocolCatalogError.d.ts +24 -0
  110. package/dist/types/models/catalog/IDataspaceProtocolCatalogRequestMessage.d.ts +20 -0
  111. package/dist/types/models/catalog/IDataspaceProtocolDataService.d.ts +49 -0
  112. package/dist/types/models/catalog/IDataspaceProtocolDataset.d.ts +66 -0
  113. package/dist/types/models/catalog/IDataspaceProtocolDatasetRequestMessage.d.ts +20 -0
  114. package/dist/types/models/catalog/IDataspaceProtocolDistribution.d.ts +70 -0
  115. package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +38 -0
  116. package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts} +5 -5
  117. package/dist/types/models/contractNegotiation/{IContractAgreementVerificationMessage.d.ts → IDataspaceProtocolContractAgreementVerificationMessage.d.ts} +5 -5
  118. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiation.d.ts +29 -0
  119. package/dist/types/models/contractNegotiation/{IContractNegotiationError.d.ts → IDataspaceProtocolContractNegotiationError.d.ts} +6 -16
  120. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.d.ts +29 -0
  121. package/dist/types/models/contractNegotiation/{IContractNegotiationTerminationMessage.d.ts → IDataspaceProtocolContractNegotiationTerminationMessage.d.ts} +5 -5
  122. package/dist/types/models/contractNegotiation/{IContractOfferMessage.d.ts → IDataspaceProtocolContractOfferMessage.d.ts} +5 -5
  123. package/dist/types/models/contractNegotiation/{IContractRequestMessage.d.ts → IDataspaceProtocolContractRequestMessage.d.ts} +5 -5
  124. package/dist/types/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts +50 -0
  125. package/dist/types/models/contractNegotiation/types/{contractNegotiationEventType.d.ts → dataspaceProtocolContractNegotiationEventType.d.ts} +2 -2
  126. package/dist/types/models/contractNegotiation/types/{contractNegotiationStateType.d.ts → dataspaceProtocolContractNegotiationStateType.d.ts} +2 -2
  127. package/dist/types/models/dataspaceProtocolContextType.d.ts +14 -0
  128. package/dist/types/models/dataspaceProtocolContexts.d.ts +21 -0
  129. package/dist/types/models/transferProcess/IDataspaceProtocolDataAddress.d.ts +24 -0
  130. package/dist/types/models/transferProcess/IDataspaceProtocolEndpointProperty.d.ts +19 -0
  131. package/dist/types/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.d.ts +24 -0
  132. package/dist/types/models/transferProcess/IDataspaceProtocolTransferError.d.ts +32 -0
  133. package/dist/types/models/transferProcess/IDataspaceProtocolTransferProcess.d.ts +29 -0
  134. package/dist/types/models/transferProcess/IDataspaceProtocolTransferRequestMessage.d.ts +39 -0
  135. package/dist/types/models/transferProcess/IDataspaceProtocolTransferStartMessage.d.ts +30 -0
  136. package/dist/types/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.d.ts +32 -0
  137. package/dist/types/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.d.ts +32 -0
  138. package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts +46 -0
  139. package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts +30 -0
  140. package/dist/types/utils/dataspaceProtocolHelper.d.ts +20 -0
  141. package/docs/changelog.md +314 -0
  142. package/docs/reference/classes/CatalogDataTypes.md +25 -0
  143. package/docs/reference/classes/ContractNegotiationDataTypes.md +1 -13
  144. package/docs/reference/classes/DataspaceProtocolDataTypes.md +37 -0
  145. package/docs/reference/classes/DataspaceProtocolHelper.md +63 -0
  146. package/docs/reference/classes/TransferProcessDataTypes.md +25 -0
  147. package/docs/reference/index.md +43 -17
  148. package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +96 -0
  149. package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +36 -0
  150. package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +28 -0
  151. package/docs/reference/interfaces/{IContractAgreementMessage.md → IDataspaceProtocolContractAgreementMessage.md} +3 -3
  152. package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} +3 -3
  153. package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} +4 -4
  154. package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} +4 -28
  155. package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} +4 -4
  156. package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} +3 -3
  157. package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} +3 -3
  158. package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} +3 -3
  159. package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +36 -0
  160. package/docs/reference/interfaces/IDataspaceProtocolDataService.md +72 -0
  161. package/docs/reference/interfaces/IDataspaceProtocolDataset.md +90 -0
  162. package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md +28 -0
  163. package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +98 -0
  164. package/docs/reference/interfaces/IDataspaceProtocolEndpointProperty.md +28 -0
  165. package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md +36 -0
  166. package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +52 -0
  167. package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +44 -0
  168. package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +62 -0
  169. package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +45 -0
  170. package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +52 -0
  171. package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +52 -0
  172. package/docs/reference/type-aliases/DataspaceProtocolCatalogTypes.md +5 -0
  173. package/docs/reference/type-aliases/DataspaceProtocolContextType.md +5 -0
  174. package/docs/reference/type-aliases/DataspaceProtocolContexts.md +5 -0
  175. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationEventType.md +5 -0
  176. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationStateType.md +5 -0
  177. package/docs/reference/type-aliases/DataspaceProtocolContractNegotiationTypes.md +5 -0
  178. package/docs/reference/type-aliases/DataspaceProtocolTransferProcessStateType.md +5 -0
  179. package/docs/reference/type-aliases/DataspaceProtocolTransferProcessTypes.md +5 -0
  180. package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +50 -0
  181. package/docs/reference/variables/DataspaceProtocolContexts.md +25 -0
  182. package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md} +2 -2
  183. package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md} +2 -2
  184. package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +68 -0
  185. package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +38 -0
  186. package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +62 -0
  187. package/locales/en.json +7 -1
  188. package/package.json +3 -2
  189. package/dist/es/models/contractNegotiation/IContractAgreementMessage.js +0 -2
  190. package/dist/es/models/contractNegotiation/IContractAgreementMessage.js.map +0 -1
  191. package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js +0 -2
  192. package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js.map +0 -1
  193. package/dist/es/models/contractNegotiation/IContractNegotiation.js +0 -2
  194. package/dist/es/models/contractNegotiation/IContractNegotiation.js.map +0 -1
  195. package/dist/es/models/contractNegotiation/IContractNegotiationError.js +0 -2
  196. package/dist/es/models/contractNegotiation/IContractNegotiationError.js.map +0 -1
  197. package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js +0 -2
  198. package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js.map +0 -1
  199. package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js +0 -2
  200. package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js.map +0 -1
  201. package/dist/es/models/contractNegotiation/IContractOfferMessage.js +0 -2
  202. package/dist/es/models/contractNegotiation/IContractOfferMessage.js.map +0 -1
  203. package/dist/es/models/contractNegotiation/IContractRequestMessage.js +0 -2
  204. package/dist/es/models/contractNegotiation/IContractRequestMessage.js.map +0 -1
  205. package/dist/es/models/contractNegotiation/contractNegotiationContextType.js +0 -2
  206. package/dist/es/models/contractNegotiation/contractNegotiationContextType.js.map +0 -1
  207. package/dist/es/models/contractNegotiation/contractNegotiationContexts.js +0 -17
  208. package/dist/es/models/contractNegotiation/contractNegotiationContexts.js.map +0 -1
  209. package/dist/es/models/contractNegotiation/contractNegotiationTypes.js.map +0 -1
  210. package/dist/es/models/contractNegotiation/types/contractNegotiationEventType.js.map +0 -1
  211. package/dist/es/models/contractNegotiation/types/contractNegotiationStateType.js.map +0 -1
  212. package/dist/types/models/contractNegotiation/IContractNegotiation.d.ts +0 -29
  213. package/dist/types/models/contractNegotiation/IContractNegotiationEventMessage.d.ts +0 -29
  214. package/dist/types/models/contractNegotiation/contractNegotiationContextType.d.ts +0 -14
  215. package/dist/types/models/contractNegotiation/contractNegotiationContexts.d.ts +0 -17
  216. package/dist/types/models/contractNegotiation/contractNegotiationTypes.d.ts +0 -50
  217. package/docs/reference/type-aliases/ContractNegotiationContextType.md +0 -5
  218. package/docs/reference/type-aliases/ContractNegotiationContexts.md +0 -5
  219. package/docs/reference/type-aliases/ContractNegotiationEventType.md +0 -5
  220. package/docs/reference/type-aliases/ContractNegotiationStateType.md +0 -5
  221. package/docs/reference/type-aliases/ContractNegotiationTypes.md +0 -5
  222. package/docs/reference/variables/ContractNegotiationContexts.md +0 -19
  223. package/docs/reference/variables/ContractNegotiationTypes.md +0 -68
@@ -0,0 +1,36 @@
1
+ # Interface: IDataspaceProtocolCatalogError
2
+
3
+ Interface for Dataspace Protocol Catalog Error.
4
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
5
+
6
+ ## Properties
7
+
8
+ ### @context
9
+
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
+
12
+ The JSON-LD context.
13
+
14
+ ***
15
+
16
+ ### @type
17
+
18
+ > **@type**: `"CatalogError"`
19
+
20
+ The type of the message.
21
+
22
+ ***
23
+
24
+ ### code
25
+
26
+ > **code**: `string`
27
+
28
+ The error code.
29
+
30
+ ***
31
+
32
+ ### reason?
33
+
34
+ > `optional` **reason**: `any`[]
35
+
36
+ The error reason(s).
@@ -0,0 +1,28 @@
1
+ # Interface: IDataspaceProtocolCatalogRequestMessage
2
+
3
+ Interface for Dataspace Protocol Catalog Request Messages.
4
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
5
+
6
+ ## Properties
7
+
8
+ ### @context
9
+
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
+
12
+ The JSON-LD context.
13
+
14
+ ***
15
+
16
+ ### @type
17
+
18
+ > **@type**: `"CatalogRequestMessage"`
19
+
20
+ The type of the message.
21
+
22
+ ***
23
+
24
+ ### filter?
25
+
26
+ > `optional` **filter**: `unknown`[]
27
+
28
+ An implementation-specific query or filter expression.
@@ -1,4 +1,4 @@
1
- # Interface: IContractAgreementMessage
1
+ # Interface: IDataspaceProtocolContractAgreementMessage
2
2
 
3
3
  Interface for Dataspace Protocol Contract Agreement Messages.
4
4
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractAgreementMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -1,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractAgreementVerificationMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -1,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiation"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -39,6 +39,6 @@ The consumer id for the contract.
39
39
 
40
40
  ### 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,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#erro
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiationError"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -47,30 +47,6 @@ The error code.
47
47
 
48
48
  ### reason?
49
49
 
50
- > `optional` **reason**: `object`[]
50
+ > `optional` **reason**: `any`[]
51
51
 
52
52
  The error reason(s).
53
-
54
- #### @value
55
-
56
- > **@value**: `string`
57
-
58
- #### @language?
59
-
60
- > `optional` **@language**: `string`
61
-
62
- ***
63
-
64
- ### description?
65
-
66
- > `optional` **description**: `object`[]
67
-
68
- The error description(s).
69
-
70
- #### @value
71
-
72
- > **@value**: `string`
73
-
74
- #### @language?
75
-
76
- > `optional` **@language**: `string`
@@ -1,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiationEventMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -39,6 +39,6 @@ The consumer id for the contract.
39
39
 
40
40
  ### 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,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractNegotiationTerminationMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -1,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractOfferMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -1,4 +1,4 @@
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
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#cont
7
7
 
8
8
  ### @context
9
9
 
10
- > **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
11
 
12
12
  The JSON-LD context.
13
13
 
@@ -15,7 +15,7 @@ The JSON-LD context.
15
15
 
16
16
  ### @type
17
17
 
18
- > **@type**: `string`
18
+ > **@type**: `"ContractRequestMessage"`
19
19
 
20
20
  The type of the message.
21
21
 
@@ -0,0 +1,36 @@
1
+ # Interface: IDataspaceProtocolDataAddress
2
+
3
+ Interface for Dataspace Protocol Transfer Messages.
4
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
5
+
6
+ ## Properties
7
+
8
+ ### @type
9
+
10
+ > **@type**: `"DataAddress"`
11
+
12
+ LD Type
13
+
14
+ ***
15
+
16
+ ### endpointType
17
+
18
+ > **endpointType**: `string`
19
+
20
+ The type of endpoint of this data address.
21
+
22
+ ***
23
+
24
+ ### endpoint?
25
+
26
+ > `optional` **endpoint**: `string`
27
+
28
+ The endpoint of the data address
29
+
30
+ ***
31
+
32
+ ### endpointProperties?
33
+
34
+ > `optional` **endpointProperties**: [`IDataspaceProtocolEndpointProperty`](IDataspaceProtocolEndpointProperty.md)[]
35
+
36
+ Properties associated to the endpoint which might depend on the endpoint type.
@@ -0,0 +1,72 @@
1
+ # Interface: IDataspaceProtocolDataService
2
+
3
+ Data Service interface compliant with Eclipse Data Space Protocol.
4
+
5
+ This interface extends IDataService and enforces DS Protocol-specific requirements
6
+ by overriding properties with more specific types and constraints.
7
+
8
+ **Requirements per DS Protocol:**
9
+ - `@id` MUST be present for dataset identification (REQUIRED)
10
+ - endpointURL MUST be present (REQUIRED)
11
+
12
+ **Type System Design:**
13
+ - Interface extension allows TypeScript to override inherited property types
14
+ - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
15
+ - DS Protocol-specific constraints are defined here
16
+
17
+ ## See
18
+
19
+ - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
20
+ - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
21
+
22
+ ## Extends
23
+
24
+ - `Omit`\<`IDcatDataService`, `"@type"` \| `"@context"` \| `"dcat:servesDataset"` \| `"dcat:endpointURL"`\>
25
+
26
+ ## Indexable
27
+
28
+ \[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
29
+
30
+ \[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
31
+
32
+ ## Properties
33
+
34
+ ### @context
35
+
36
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
37
+
38
+ LD Context. Required per Eclipse Data Space Protocol.
39
+
40
+ ***
41
+
42
+ ### @type
43
+
44
+ > **@type**: `"DataService"`
45
+
46
+ The type identifier for the Data Service.
47
+ REQUIRED per Eclipse Data Space Protocol.
48
+
49
+ ***
50
+
51
+ ### @id
52
+
53
+ > **@id**: `string`
54
+
55
+ Unique identifier for the dataset.
56
+ REQUIRED per Eclipse Data Space Protocol.
57
+
58
+ ***
59
+
60
+ ### endpointURL
61
+
62
+ > **endpointURL**: `string`
63
+
64
+ Endpoint URL
65
+
66
+ ***
67
+
68
+ ### servesDataset?
69
+
70
+ > `optional` **servesDataset**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md), `"@context"`\>\>
71
+
72
+ Datasets served.
@@ -0,0 +1,90 @@
1
+ # Interface: IDataspaceProtocolDataset
2
+
3
+ Dataset interface compliant with Eclipse Data Space Protocol.
4
+
5
+ This interface extends IDataset and enforces DS Protocol-specific requirements
6
+ by overriding properties with more specific types and constraints.
7
+
8
+ **Requirements per DS Protocol:**
9
+ - `@id` MUST be present for dataset identification (REQUIRED)
10
+ - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
11
+ - Array MUST contain at least one IOdrlOffer
12
+ - Each Offer MUST have `@type`: "Offer"
13
+ - Each Offer MUST have `@id` or `uid` for identification
14
+ - `dcat:distribution` MUST be present (REQUIRED)
15
+
16
+ **Type System Design:**
17
+ - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
18
+ - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
19
+ - Interface extension allows TypeScript to override inherited property types
20
+ - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
21
+ - DS Protocol-specific constraints are defined here
22
+
23
+ **Future Compatibility:**
24
+ - Currently only one Offer per dataset is supported
25
+ - Array structure allows future support for multiple offers
26
+
27
+ ## See
28
+
29
+ - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
30
+ - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
31
+ - IOdrlOffer from @twin.org/standards-w3c-odrl
32
+ - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
33
+
34
+ ## Extends
35
+
36
+ - `Omit`\<`IDcatDataset`, `"odrl:hasPolicy"` \| `"dcat:distribution"` \| `"@type"` \| `"@context"`\>
37
+
38
+ ## Indexable
39
+
40
+ \[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
41
+
42
+ \[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
43
+
44
+ ## Properties
45
+
46
+ ### @context
47
+
48
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
49
+
50
+ LD Context. Required per Eclipse Data Space Protocol.
51
+
52
+ ***
53
+
54
+ ### @type
55
+
56
+ > **@type**: `"Dataset"`
57
+
58
+ The type identifier for the dataset.
59
+ REQUIRED per Eclipse Data Space Protocol.
60
+
61
+ ***
62
+
63
+ ### @id
64
+
65
+ > **@id**: `string`
66
+
67
+ Unique identifier for the dataset.
68
+ REQUIRED per Eclipse Data Space Protocol.
69
+
70
+ ***
71
+
72
+ ### hasPolicy
73
+
74
+ > **hasPolicy**: `ObjectOrArray`\<`Omit`\<`IOdrlOffer`, `"@context"`\>\>
75
+
76
+ Array of ODRL policies (Offers) as required by DS Protocol.
77
+
78
+ REQUIRED per Eclipse Data Space Protocol spec.
79
+ Must contain at least one IOdrlOffer.
80
+ Currently only single offer is supported, but array structure
81
+ allows for future multi-offer support.
82
+
83
+ ***
84
+
85
+ ### distribution
86
+
87
+ > **distribution**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md), `"@context"`\>\>
88
+
89
+ Distribution of the dataset.
90
+ REQUIRED per Eclipse Data Space Protocol.
@@ -0,0 +1,28 @@
1
+ # Interface: IDataspaceProtocolDatasetRequestMessage
2
+
3
+ Interface for Dataspace Protocol Dataset Request Messages.
4
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
5
+
6
+ ## Properties
7
+
8
+ ### @context
9
+
10
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
+
12
+ The JSON-LD context.
13
+
14
+ ***
15
+
16
+ ### @type
17
+
18
+ > **@type**: `"DatasetRequestMessage"`
19
+
20
+ The type of the message.
21
+
22
+ ***
23
+
24
+ ### dataset
25
+
26
+ > **dataset**: `string`
27
+
28
+ The identifier of the dataset.
@@ -0,0 +1,98 @@
1
+ # Interface: IDataspaceProtocolDistribution
2
+
3
+ Distribution interface compliant with Eclipse Data Space Protocol.
4
+
5
+ This interface extends IDistribution and enforces DS Protocol-specific requirements
6
+ by overriding properties with more specific types and constraints.
7
+
8
+ **Requirements per DS Protocol:**
9
+ - `@id` MUST be present for dataset identification (REQUIRED)
10
+ - `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
11
+ - Array MUST contain at least one IOdrlOffer
12
+ - Each Offer MUST have `@type`: "Offer"
13
+ - `format` is REQUIRED.
14
+
15
+ **Type System Design:**
16
+ - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
17
+ - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
18
+ - Interface extension allows TypeScript to override inherited property types
19
+ - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
20
+ - DS Protocol-specific constraints are defined here
21
+
22
+ **Future Compatibility:**
23
+ - Currently only one Offer per dataset is supported
24
+ - Array structure allows future support for multiple offers
25
+
26
+ ## See
27
+
28
+ - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
29
+ - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
30
+ - IOdrlOffer from @twin.org/standards-w3c-odrl
31
+ - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
32
+
33
+ ## Extends
34
+
35
+ - `Omit`\<`IDcatDistribution`, `"odrl:hasPolicy"` \| `"@type"` \| `"@context"` \| `"dcterms:format"`\>
36
+
37
+ ## Indexable
38
+
39
+ \[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
40
+
41
+ \[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
42
+
43
+ ## Properties
44
+
45
+ ### @context
46
+
47
+ > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
48
+
49
+ LD Context. Required per Eclipse Data Space Protocol.
50
+
51
+ ***
52
+
53
+ ### @type
54
+
55
+ > **@type**: `"Distribution"`
56
+
57
+ The type identifier for the Distribution.
58
+ REQUIRED per Eclipse Data Space Protocol.
59
+
60
+ ***
61
+
62
+ ### @id
63
+
64
+ > **@id**: `string`
65
+
66
+ Unique identifier for the dataset.
67
+ REQUIRED per Eclipse Data Space Protocol.
68
+
69
+ ***
70
+
71
+ ### hasPolicy?
72
+
73
+ > `optional` **hasPolicy**: `ObjectOrArray`\<`Omit`\<`IOdrlOffer`, `"@context"`\>\>
74
+
75
+ Array of ODRL policies (Offers) as required by DS Protocol.
76
+
77
+ REQUIRED per Eclipse Data Space Protocol spec.
78
+ Must contain at least one IOdrlOffer.
79
+ Currently only single offer is supported, but array structure
80
+ allows for future multi-offer support.
81
+
82
+ ***
83
+
84
+ ### accessService
85
+
86
+ > **accessService**: `string` \| `Omit`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md), `"@context"`\>
87
+
88
+ Access service.
89
+ It can be a URI pointing to an access service or inline the access service itself
90
+
91
+ ***
92
+
93
+ ### format
94
+
95
+ > **format**: `string`
96
+
97
+ Distribution format.
98
+ REQUIRED per Eclipse Data Space Protocol.
@@ -0,0 +1,28 @@
1
+ # Interface: IDataspaceProtocolEndpointProperty
2
+
3
+ Interface for Dataspace Protocol Transfer Messages.
4
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
5
+
6
+ ## Properties
7
+
8
+ ### @type
9
+
10
+ > **@type**: `"EndpointProperty"`
11
+
12
+ LD Type.
13
+
14
+ ***
15
+
16
+ ### name
17
+
18
+ > **name**: `string`
19
+
20
+ Property name.
21
+
22
+ ***
23
+
24
+ ### value
25
+
26
+ > **value**: `string`
27
+
28
+ Property value.