@twin.org/standards-dataspace-protocol 0.0.3-next.67 → 0.0.3-next.69

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 (167) hide show
  1. package/dist/es/models/catalog/IDataspaceProtocolCatalogError.js.map +1 -1
  2. package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js.map +1 -1
  3. package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js.map +1 -1
  4. package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +2 -2
  5. package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js.map +1 -1
  6. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js.map +1 -1
  7. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js.map +1 -1
  8. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js.map +1 -1
  9. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js.map +1 -1
  10. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js.map +1 -1
  11. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js.map +1 -1
  12. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js.map +1 -1
  13. package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js.map +1 -1
  14. package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js +2 -2
  15. package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js.map +1 -1
  16. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js +2 -2
  17. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js.map +1 -1
  18. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js +2 -2
  19. package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js.map +1 -1
  20. package/dist/es/models/dataspaceProtocolContexts.js +1 -1
  21. package/dist/es/models/dataspaceProtocolContexts.js.map +1 -1
  22. package/dist/es/models/dcat3/IDataspaceProtocolCatalog.js.map +1 -1
  23. package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js.map +1 -1
  24. package/dist/es/models/dcat3/IDataspaceProtocolDataService.js.map +1 -1
  25. package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js.map +1 -1
  26. package/dist/es/models/dcat3/IDataspaceProtocolDataset.js.map +1 -1
  27. package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js.map +1 -1
  28. package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js.map +1 -1
  29. package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js.map +1 -1
  30. package/dist/es/models/odrl/IDataspaceProtocolAgreement.js.map +1 -1
  31. package/dist/es/models/odrl/IDataspaceProtocolOffer.js.map +1 -1
  32. package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js.map +1 -1
  33. package/dist/es/models/odrl/IDataspaceProtocolPolicy.js.map +1 -1
  34. package/dist/es/models/odrl/IDataspaceProtocolSet.js.map +1 -1
  35. package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js.map +1 -1
  36. package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js.map +1 -1
  37. package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js.map +1 -1
  38. package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js.map +1 -1
  39. package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js.map +1 -1
  40. package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js.map +1 -1
  41. package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js.map +1 -1
  42. package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js.map +1 -1
  43. package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js.map +1 -1
  44. package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js +2 -2
  45. package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js.map +1 -1
  46. package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js +5 -59
  47. package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js.map +1 -1
  48. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js +2 -2
  49. package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -1
  50. package/dist/es/schemas/DataspaceProtocolAgreement.json +1 -1
  51. package/dist/es/schemas/DataspaceProtocolCatalog.json +2 -2
  52. package/dist/es/schemas/DataspaceProtocolCatalogBase.json +6 -6
  53. package/dist/es/schemas/DataspaceProtocolCatalogError.json +1 -1
  54. package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +1 -1
  55. package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +1 -1
  56. package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json +1 -1
  57. package/dist/es/schemas/DataspaceProtocolContractNegotiation.json +2 -2
  58. package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json +1 -1
  59. package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json +1 -1
  60. package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json +1 -1
  61. package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json +1 -1
  62. package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json +1 -1
  63. package/dist/es/schemas/DataspaceProtocolDataAddress.json +5 -5
  64. package/dist/es/schemas/DataspaceProtocolDataService.json +2 -2
  65. package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +1 -1
  66. package/dist/es/schemas/DataspaceProtocolDataset.json +2 -2
  67. package/dist/es/schemas/DataspaceProtocolDatasetBase.json +3 -3
  68. package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +1 -1
  69. package/dist/es/schemas/DataspaceProtocolDistribution.json +3 -3
  70. package/dist/es/schemas/DataspaceProtocolDistributionBase.json +5 -5
  71. package/dist/es/schemas/DataspaceProtocolEndpointProperty.json +4 -4
  72. package/dist/es/schemas/DataspaceProtocolOffer.json +2 -2
  73. package/dist/es/schemas/DataspaceProtocolOfferBase.json +1 -1
  74. package/dist/es/schemas/DataspaceProtocolPolicy.json +1 -1
  75. package/dist/es/schemas/DataspaceProtocolSet.json +1 -1
  76. package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +3 -3
  77. package/dist/es/schemas/DataspaceProtocolTransferError.json +3 -3
  78. package/dist/es/schemas/DataspaceProtocolTransferProcess.json +3 -3
  79. package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +3 -3
  80. package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +3 -3
  81. package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +3 -3
  82. package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +3 -3
  83. package/dist/types/models/catalog/IDataspaceProtocolCatalogError.d.ts +2 -2
  84. package/dist/types/models/catalog/IDataspaceProtocolCatalogRequestMessage.d.ts +2 -2
  85. package/dist/types/models/catalog/IDataspaceProtocolDatasetRequestMessage.d.ts +2 -2
  86. package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +2 -2
  87. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.d.ts +2 -2
  88. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.d.ts +2 -2
  89. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiation.d.ts +3 -3
  90. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.d.ts +2 -2
  91. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.d.ts +2 -2
  92. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.d.ts +2 -2
  93. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.d.ts +2 -2
  94. package/dist/types/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.d.ts +2 -2
  95. package/dist/types/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts +2 -2
  96. package/dist/types/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.d.ts +2 -2
  97. package/dist/types/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.d.ts +2 -2
  98. package/dist/types/models/dataspaceProtocolContexts.d.ts +1 -1
  99. package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +2 -17
  100. package/dist/types/models/dcat3/IDataspaceProtocolCatalogBase.d.ts +6 -21
  101. package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +2 -17
  102. package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +1 -16
  103. package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +2 -27
  104. package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +3 -34
  105. package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +3 -28
  106. package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +5 -38
  107. package/dist/types/models/odrl/IDataspaceProtocolAgreement.d.ts +1 -6
  108. package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +2 -7
  109. package/dist/types/models/odrl/IDataspaceProtocolOfferBase.d.ts +1 -7
  110. package/dist/types/models/odrl/IDataspaceProtocolPolicy.d.ts +1 -6
  111. package/dist/types/models/odrl/IDataspaceProtocolSet.d.ts +1 -6
  112. package/dist/types/models/transferProcess/IDataspaceProtocolDataAddress.d.ts +6 -6
  113. package/dist/types/models/transferProcess/IDataspaceProtocolEndpointProperty.d.ts +5 -5
  114. package/dist/types/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.d.ts +4 -4
  115. package/dist/types/models/transferProcess/IDataspaceProtocolTransferError.d.ts +4 -4
  116. package/dist/types/models/transferProcess/IDataspaceProtocolTransferProcess.d.ts +4 -4
  117. package/dist/types/models/transferProcess/IDataspaceProtocolTransferRequestMessage.d.ts +4 -4
  118. package/dist/types/models/transferProcess/IDataspaceProtocolTransferStartMessage.d.ts +4 -4
  119. package/dist/types/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.d.ts +4 -4
  120. package/dist/types/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.d.ts +4 -4
  121. package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts +2 -2
  122. package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts +6 -60
  123. package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts +2 -2
  124. package/docs/changelog.md +34 -0
  125. package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +2 -7
  126. package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +8 -21
  127. package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +7 -20
  128. package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +4 -1
  129. package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +4 -1
  130. package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md +4 -1
  131. package/docs/reference/interfaces/IDataspaceProtocolContractAgreementVerificationMessage.md +4 -1
  132. package/docs/reference/interfaces/IDataspaceProtocolContractNegotiation.md +5 -2
  133. package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationError.md +4 -1
  134. package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationEventMessage.md +4 -1
  135. package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md +4 -1
  136. package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md +4 -1
  137. package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md +4 -1
  138. package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +8 -5
  139. package/docs/reference/interfaces/IDataspaceProtocolDataService.md +3 -16
  140. package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +2 -15
  141. package/docs/reference/interfaces/IDataspaceProtocolDataset.md +5 -36
  142. package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +4 -35
  143. package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md +4 -1
  144. package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +7 -39
  145. package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +6 -39
  146. package/docs/reference/interfaces/IDataspaceProtocolEndpointProperty.md +7 -4
  147. package/docs/reference/interfaces/IDataspaceProtocolOffer.md +3 -8
  148. package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +1 -7
  149. package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +2 -7
  150. package/docs/reference/interfaces/IDataspaceProtocolSet.md +2 -7
  151. package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md +6 -3
  152. package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +6 -3
  153. package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +6 -3
  154. package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +6 -3
  155. package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +6 -3
  156. package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +6 -3
  157. package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +6 -3
  158. package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +1 -8
  159. package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +5 -2
  160. package/docs/reference/variables/DataspaceProtocolContexts.md +1 -1
  161. package/docs/reference/variables/DataspaceProtocolContractNegotiationEventType.md +5 -2
  162. package/docs/reference/variables/DataspaceProtocolContractNegotiationStateType.md +5 -2
  163. package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +5 -2
  164. package/docs/reference/variables/DataspaceProtocolEndpointType.md +11 -56
  165. package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +5 -2
  166. package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +5 -2
  167. package/package.json +3 -3
@@ -1,42 +1,17 @@
1
1
  import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
2
2
  import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDistributionBase.js";
3
3
  /**
4
- * Distribution interface compliant with Eclipse Data Space Protocol.
5
- *
6
- * This interface extends IDistribution and enforces DS Protocol-specific requirements
7
- * by overriding properties with more specific types and constraints.
8
- *
9
- * **Requirements per DS Protocol:**
10
- * - `@id` MUST be present for dataset identification (REQUIRED)
11
- * - `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
12
- * - Array MUST contain at least one IOdrlOffer
13
- * - Each Offer MUST have `@type`: "Offer"
14
- * - `format` is 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
4
+ * Distribution compliant with Eclipse Data Space Protocol, requiring an id and format.
26
5
  *
27
6
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
28
- * @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
29
- * @see IOdrlOffer from @twin.org/standards-w3c-odrl
30
- * @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
31
7
  */
32
8
  export interface IDataspaceProtocolDistribution extends IDataspaceProtocolDistributionBase {
33
9
  /**
34
- * LD Context. Required per Eclipse Data Space Protocol.
10
+ * The JSON-LD context.
35
11
  */
36
12
  "@context": DataspaceProtocolContextType;
37
13
  /**
38
- * Unique identifier for the distribution.
39
- * REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
14
+ * Unique identifier for the distribution; required on standalone distribution objects.
40
15
  */
41
16
  "@id": string;
42
17
  }
@@ -3,33 +3,9 @@ import type { IDataspaceProtocolDataServiceBase } from "./IDataspaceProtocolData
3
3
  import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
4
4
  import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
5
5
  /**
6
- * Distribution interface compliant with Eclipse Data Space Protocol.
7
- *
8
- * This interface extends IDistribution and enforces DS Protocol-specific requirements
9
- * by overriding properties with more specific types and constraints.
10
- *
11
- * **Requirements per DS Protocol:**
12
- * - `@id` MUST be present for dataset identification (REQUIRED)
13
- * - `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
14
- * - Array MUST contain at least one IOdrlOffer
15
- * - Each Offer MUST have `@type`: "Offer"
16
- * - `format` is REQUIRED.
17
- *
18
- * **Type System Design:**
19
- * - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
20
- * - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
21
- * - Interface extension allows TypeScript to override inherited property types
22
- * - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
23
- * - DS Protocol-specific constraints are defined here
24
- *
25
- * **Future Compatibility:**
26
- * - Currently only one Offer per dataset is supported
27
- * - Array structure allows future support for multiple offers
6
+ * Base distribution interface compliant with Eclipse Data Space Protocol, requiring a format and accessService.
28
7
  *
29
8
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
30
- * @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
31
- * @see IOdrlOffer from @twin.org/standards-w3c-odrl
32
- * @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
33
9
  */
34
10
  export interface IDataspaceProtocolDistributionBase extends Omit<IDcatDistributionBase, "odrl:hasPolicy" | "@type" | "dcterms:format"> {
35
11
  /**
@@ -38,29 +14,20 @@ export interface IDataspaceProtocolDistributionBase extends Omit<IDcatDistributi
38
14
  */
39
15
  "@type": typeof DataspaceProtocolCatalogTypes.Distribution;
40
16
  /**
41
- * Unique identifier for the distribution.
42
- * OPTIONAL for embedded distributions (may use JSON-LD blank nodes).
43
- * REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
17
+ * Unique identifier for the distribution; optional for embedded distributions.
44
18
  */
45
19
  "@id"?: string;
46
20
  /**
47
- * Array of ODRL policies (Offers) as required by DS Protocol.
48
- *
49
- * REQUIRED per Eclipse Data Space Protocol spec.
50
- * Must contain at least one IOdrlOffer.
51
- * Currently only single offer is supported, but array structure
52
- * allows for future multi-offer support.
21
+ * Optional array of ODRL offers; when present, must contain at least one entry.
53
22
  * @json-schema minItems:1
54
23
  */
55
24
  hasPolicy?: IDataspaceProtocolOfferBase[];
56
25
  /**
57
- * Access service.
58
- * It can be a URI pointing to an access service or inline the access service itself.
26
+ * Access service URI or inline access service definition.
59
27
  */
60
28
  accessService: string | IDataspaceProtocolDataServiceBase;
61
29
  /**
62
- * Distribution format.
63
- * REQUIRED per Eclipse Data Space Protocol.
30
+ * Distribution format identifier.
64
31
  */
65
32
  format: string;
66
33
  }
@@ -1,13 +1,8 @@
1
1
  import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
2
2
  /**
3
- * Agreement interface compliant with Eclipse Data Space Protocol.
4
- *
5
- * Extends IOdrlAgreement with DS Protocol-specific constraints:
6
- * - `@id` is REQUIRED (used as the primary agreement identifier in DS Protocol)
7
- * - `@context` is omitted (inherited from the parent Dataset/Distribution)
3
+ * Agreement interface compliant with Eclipse Data Space Protocol, requiring an id and omitting context.
8
4
  *
9
5
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
10
- * @see IOdrlAgreement from @twin.org/standards-w3c-odrl
11
6
  */
12
7
  export interface IDataspaceProtocolAgreement extends Omit<IOdrlAgreement, "uid"> {
13
8
  /**
@@ -1,14 +1,9 @@
1
1
  import type { OdrlContextType } from "@twin.org/standards-w3c-odrl";
2
2
  import type { IDataspaceProtocolOfferBase } from "./IDataspaceProtocolOfferBase.js";
3
3
  /**
4
- * Offer interface compliant with Eclipse Data Space Protocol.
5
- *
6
- * Extends IOdrlOffer with DS Protocol-specific constraints:
7
- * - `@id` is REQUIRED (used as the primary offer identifier in DS Protocol)
8
- * - `@context` is omitted (inherited from the parent Dataset/Distribution)
4
+ * Offer interface compliant with Eclipse Data Space Protocol, requiring an id and context.
9
5
  *
10
6
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
11
- * @see IOdrlOffer from @twin.org/standards-w3c-odrl
12
7
  */
13
8
  export interface IDataspaceProtocolOffer extends IDataspaceProtocolOfferBase {
14
9
  /**
@@ -16,7 +11,7 @@ export interface IDataspaceProtocolOffer extends IDataspaceProtocolOfferBase {
16
11
  */
17
12
  "@id": string;
18
13
  /**
19
- * LD Context.
14
+ * The JSON-LD context.
20
15
  */
21
16
  "@context": OdrlContextType;
22
17
  }
@@ -1,12 +1,6 @@
1
1
  import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
2
2
  /**
3
- * Offer interface compliant with Eclipse Data Space Protocol without JSON-LD context.
4
- * This is the context-free variant of IDataspaceProtocolOffer, intended for embedding
5
- * offers inline within other objects where the context is provided by the enclosing document.
6
- *
7
- * Extends IOdrlOffer with DS Protocol-specific constraints:
8
- * - '@id' is REQUIRED (used as the primary offer identifier in DS Protocol)
9
- * - '@context' is omitted (context is inherited from the parent object)
3
+ * Context-free offer interface compliant with Eclipse Data Space Protocol, for embedding within parent documents.
10
4
  *
11
5
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
12
6
  */
@@ -1,13 +1,8 @@
1
1
  import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
2
2
  /**
3
- * Policy interface compliant with Eclipse Data Space Protocol.
4
- *
5
- * Extends IOdrlPolicy with DS Protocol-specific constraints:
6
- * - `@id` is REQUIRED (used as the primary policy identifier in DS Protocol)
7
- * - `@context` is omitted (inherited from the parent Dataset/Distribution)
3
+ * Policy interface compliant with Eclipse Data Space Protocol, requiring an id and omitting context.
8
4
  *
9
5
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
10
- * @see IOdrlPolicy from @twin.org/standards-w3c-odrl
11
6
  */
12
7
  export interface IDataspaceProtocolPolicy extends Omit<IOdrlPolicy, "uid"> {
13
8
  /**
@@ -1,13 +1,8 @@
1
1
  import type { IOdrlSet } from "@twin.org/standards-w3c-odrl";
2
2
  /**
3
- * Set interface compliant with Eclipse Data Space Protocol.
4
- *
5
- * Extends IOdrlSet with DS Protocol-specific constraints:
6
- * - `@id` is REQUIRED (used as the primary set identifier in DS Protocol)
7
- * - `@context` is omitted (inherited from the parent Dataset/Distribution)
3
+ * Set interface compliant with Eclipse Data Space Protocol, requiring an id and omitting context.
8
4
  *
9
5
  * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
10
- * @see IOdrlSet from @twin.org/standards-w3c-odrl
11
6
  */
12
7
  export interface IDataspaceProtocolSet extends Omit<IOdrlSet, "uid"> {
13
8
  /**
@@ -1,24 +1,24 @@
1
1
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
2
2
  import type { IDataspaceProtocolEndpointProperty } from "./IDataspaceProtocolEndpointProperty.js";
3
3
  /**
4
- * Interface for Dataspace Protocol Transfer Messages.
5
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
4
+ * Interface for a Dataspace Protocol data address.
5
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
6
6
  */
7
7
  export interface IDataspaceProtocolDataAddress {
8
8
  /**
9
- * LD Type
9
+ * The JSON-LD type.
10
10
  */
11
11
  "@type": typeof DataspaceProtocolTransferProcessTypes.DataAddress;
12
12
  /**
13
- * The type of endpoint of this data address.
13
+ * The endpoint type identifier.
14
14
  */
15
15
  endpointType: string;
16
16
  /**
17
- * The endpoint of the data address
17
+ * The endpoint URL or address.
18
18
  */
19
19
  endpoint?: string;
20
20
  /**
21
- * Properties associated to the endpoint which might depend on the endpoint type.
21
+ * Transport-specific endpoint properties.
22
22
  */
23
23
  endpointProperties?: IDataspaceProtocolEndpointProperty[];
24
24
  }
@@ -1,19 +1,19 @@
1
1
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
2
2
  /**
3
- * Interface for Dataspace Protocol Transfer Messages.
4
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
3
+ * Interface for a Dataspace Protocol endpoint property key-value pair.
4
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
5
5
  */
6
6
  export interface IDataspaceProtocolEndpointProperty {
7
7
  /**
8
- * LD Type.
8
+ * The JSON-LD type.
9
9
  */
10
10
  "@type": typeof DataspaceProtocolTransferProcessTypes.EndpointProperty;
11
11
  /**
12
- * Property name.
12
+ * The property name.
13
13
  */
14
14
  name: string;
15
15
  /**
16
- * Property value.
16
+ * The property value.
17
17
  */
18
18
  value: string;
19
19
  }
@@ -1,16 +1,16 @@
1
1
  import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  /**
4
- * Interface for Dataspace Protocol Transfer Messages.
5
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
4
+ * Interface for the Dataspace Protocol transfer completion message.
5
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
6
6
  */
7
7
  export interface IDataspaceProtocolTransferCompletionMessage {
8
8
  /**
9
- * LD Context
9
+ * The JSON-LD context.
10
10
  */
11
11
  "@context": DataspaceProtocolContextType;
12
12
  /**
13
- * LD Type
13
+ * The JSON-LD type.
14
14
  */
15
15
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferCompletionMessage;
16
16
  /**
@@ -1,16 +1,16 @@
1
1
  import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  /**
4
- * Interface for Dataspace Protocol Transfer Messages.
5
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
4
+ * Interface for the Dataspace Protocol transfer error response.
5
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
6
6
  */
7
7
  export interface IDataspaceProtocolTransferError {
8
8
  /**
9
- * LD Context
9
+ * The JSON-LD context.
10
10
  */
11
11
  "@context": DataspaceProtocolContextType;
12
12
  /**
13
- * LD Type
13
+ * The JSON-LD type.
14
14
  */
15
15
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferError;
16
16
  /**
@@ -2,16 +2,16 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  import type { DataspaceProtocolTransferProcessStateType } from "./types/dataspaceProtocolTransferProcessStateType.js";
4
4
  /**
5
- * Interface for Dataspace Protocol Transfer Messages.
6
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
5
+ * Interface for the Dataspace Protocol transfer process acknowledgment.
6
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
7
7
  */
8
8
  export interface IDataspaceProtocolTransferProcess {
9
9
  /**
10
- * LD Context
10
+ * The JSON-LD context.
11
11
  */
12
12
  "@context": DataspaceProtocolContextType;
13
13
  /**
14
- * LD Type
14
+ * The JSON-LD type.
15
15
  */
16
16
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferProcess;
17
17
  /**
@@ -2,16 +2,16 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  import type { IDataspaceProtocolDataAddress } from "./IDataspaceProtocolDataAddress.js";
4
4
  /**
5
- * Interface for Dataspace Protocol Transfer Messages.
6
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
5
+ * Interface for the Dataspace Protocol transfer request message.
6
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
7
7
  */
8
8
  export interface IDataspaceProtocolTransferRequestMessage {
9
9
  /**
10
- * LD Context
10
+ * The JSON-LD context.
11
11
  */
12
12
  "@context": DataspaceProtocolContextType;
13
13
  /**
14
- * LD Type
14
+ * The JSON-LD type.
15
15
  */
16
16
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferRequestMessage;
17
17
  /**
@@ -2,16 +2,16 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  import type { IDataspaceProtocolDataAddress } from "./IDataspaceProtocolDataAddress.js";
4
4
  /**
5
- * Interface for Dataspace Protocol Transfer Messages.
6
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
5
+ * Interface for the Dataspace Protocol transfer start message.
6
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
7
7
  */
8
8
  export interface IDataspaceProtocolTransferStartMessage {
9
9
  /**
10
- * LD Context
10
+ * The JSON-LD context.
11
11
  */
12
12
  "@context": DataspaceProtocolContextType;
13
13
  /**
14
- * LD Type
14
+ * The JSON-LD type.
15
15
  */
16
16
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferStartMessage;
17
17
  /**
@@ -1,16 +1,16 @@
1
1
  import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  /**
4
- * Interface for Dataspace Protocol Transfer Messages.
5
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
4
+ * Interface for the Dataspace Protocol transfer suspension message.
5
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
6
6
  */
7
7
  export interface IDataspaceProtocolTransferSuspensionMessage {
8
8
  /**
9
- * LD Context
9
+ * The JSON-LD context.
10
10
  */
11
11
  "@context": DataspaceProtocolContextType;
12
12
  /**
13
- * LD Type
13
+ * The JSON-LD type.
14
14
  */
15
15
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferSuspensionMessage;
16
16
  /**
@@ -1,16 +1,16 @@
1
1
  import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
2
2
  import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
3
3
  /**
4
- * Interface for Dataspace Protocol Transfer Messages.
5
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
4
+ * Interface for the Dataspace Protocol transfer termination message.
5
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
6
6
  */
7
7
  export interface IDataspaceProtocolTransferTerminationMessage {
8
8
  /**
9
- * LD Context
9
+ * The JSON-LD context.
10
10
  */
11
11
  "@context": DataspaceProtocolContextType;
12
12
  /**
13
- * LD Type
13
+ * The JSON-LD type.
14
14
  */
15
15
  "@type": typeof DataspaceProtocolTransferProcessTypes.TransferTerminationMessage;
16
16
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
- * The types for Dataspace Protocol Transfer Process.
3
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
2
+ * Type identifiers for the Dataspace Protocol Transfer Process.
3
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
4
4
  */
5
5
  export declare const DataspaceProtocolTransferProcessTypes: {
6
6
  /**
@@ -1,89 +1,35 @@
1
1
  /**
2
2
  * TWIN Data Space Protocol Profile endpoint type identifiers.
3
3
  *
4
- * This module defines endpoint types according to the TWIN Foundation's
5
- * Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
6
- * Protocol specification with TWIN-specific vocabulary.
7
- *
8
- * The TWIN vocabulary uses persistent identifiers under the
9
- * https://schema.twindev.org namespace to provide stable, semantic
10
- * identifiers for data space endpoint types.
11
- *
12
- * References:
13
- * - TWIN RFC 006: https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
14
- * - TWIN DS Protocol Context: https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
15
- * - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
16
- * - RFC 001 (Query Interface): https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
4
+ * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
17
5
  */
18
6
  export declare const DataspaceProtocolEndpointType: {
19
7
  /**
20
- * HTTPS Query Endpoint (TWIN DS Profile).
21
- *
22
- * Used for PULL transfers via the TWIN Data Space Connector Query interface.
23
- * The consumer retrieves data by querying this endpoint using the data access token.
24
- * Endpoint must implement the interface specified in RFC 001.
25
- *
26
- * Transfer Flow:
27
- * 1. Consumer initiates transfer request
28
- * 2. Provider returns this endpoint type with data access token
29
- * 3. Consumer queries the endpoint with the token to retrieve data
8
+ * HTTPS query endpoint for PULL transfers via the TWIN Data Space Connector Query interface.
30
9
  *
31
10
  * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
32
- * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
33
11
  */
34
12
  readonly HttpsQueryEndpoint: "https://schema.twindev.org/dspace/v1/Https-Query-Endpoint";
35
13
  /**
36
- * HTTPS Activity Stream Endpoint (TWIN DS Profile).
37
- *
38
- * Used for PUSH transfers via Activity Streams 2.0 protocol.
39
- * The provider actively sends data to the consumer's Activity Stream inbox endpoint.
40
- * Based on W3C Activity Streams 2.0 specification.
41
- *
42
- * Transfer Flow:
43
- * 1. Consumer initiates transfer request with this endpoint type
44
- * 2. Consumer provides their Activity Stream inbox URL
45
- * 3. Provider pushes data to the consumer's inbox as Activity Stream objects
14
+ * HTTPS Activity Stream endpoint for PUSH transfers via the Activity Streams 2.0 protocol.
46
15
  *
47
16
  * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
48
- * @see https://www.w3.org/TR/activitystreams-core/
49
- * @see https://www.w3.org/TR/activitypub/
50
17
  */
51
18
  readonly HttpsActivityStreamEndpoint: "https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint";
52
19
  /**
53
- * HTTP endpoint (IDSA W3ID v4.1).
54
- *
55
- * Persistent identifier for HTTP-based data access endpoints.
56
- * This W3ID URL is used as a semantic identifier in JSON-LD contexts.
57
- *
58
- * Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
59
- * This constant is provided for interoperability with IDSA-based systems.
20
+ * HTTP endpoint identifier from the IDSA W3ID v4.1 namespace.
60
21
  *
61
22
  * @see https://w3id.org/idsa/v4.1/HTTP
62
- * @see https://github.com/International-Data-Spaces-Association/InformationModel
63
23
  */
64
24
  readonly HTTP: "https://w3id.org/idsa/v4.1/HTTP";
65
25
  /**
66
- * HTTPS endpoint (IDSA W3ID v4.1).
67
- *
68
- * Persistent identifier for HTTPS-based secure data access endpoints.
69
- * This W3ID URL is used as a semantic identifier in JSON-LD contexts.
70
- *
71
- * Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
72
- * This constant is provided for interoperability with IDSA-based systems.
26
+ * HTTPS endpoint identifier from the IDSA W3ID v4.1 namespace.
73
27
  *
74
28
  * @see https://w3id.org/idsa/v4.1/HTTPS
75
- * @see https://github.com/International-Data-Spaces-Association/InformationModel
76
29
  */
77
30
  readonly HTTPS: "https://w3id.org/idsa/v4.1/HTTPS";
78
31
  };
79
32
  /**
80
- * Type representing all valid Dataspace Protocol endpoint types.
81
- *
82
- * All values are valid URIs as required by the DS Protocol JSON-LD context
83
- * which defines endpointType as @type:@vocab.
84
- *
85
- * Includes:
86
- * - TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
87
- * - IDSA W3ID types: HTTP, HTTPS
33
+ * All valid Dataspace Protocol endpoint type URI values.
88
34
  */
89
35
  export type DataspaceProtocolEndpointType = (typeof DataspaceProtocolEndpointType)[keyof typeof DataspaceProtocolEndpointType];
@@ -1,6 +1,6 @@
1
1
  /**
2
- * The states for Dataspace Protocol Transfer Process.
3
- * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
2
+ * State type identifiers for the Dataspace Protocol Transfer Process.
3
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
4
4
  */
5
5
  export declare const DataspaceProtocolTransferProcessStateType: {
6
6
  /**
package/docs/changelog.md CHANGED
@@ -1,5 +1,39 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.69](https://github.com/iotaledger/twin-standards/compare/standards-dataspace-protocol-v0.0.3-next.68...standards-dataspace-protocol-v0.0.3-next.69) (2026-06-22)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **standards-dataspace-protocol:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/standards-w3c-dcat bumped from 0.0.3-next.68 to 0.0.3-next.69
16
+ * @twin.org/standards-w3c-odrl bumped from 0.0.3-next.68 to 0.0.3-next.69
17
+ * devDependencies
18
+ * @twin.org/standards-ld-contexts bumped from 0.0.3-next.68 to 0.0.3-next.69
19
+
20
+ ## [0.0.3-next.68](https://github.com/iotaledger/twin-standards/compare/standards-dataspace-protocol-v0.0.3-next.67...standards-dataspace-protocol-v0.0.3-next.68) (2026-06-22)
21
+
22
+
23
+ ### Bug Fixes
24
+
25
+ * use async getStore in tests ([c5f4d53](https://github.com/iotaledger/twin-standards/commit/c5f4d533d5c9726e0cff6711fe22edbf0fc4d746))
26
+
27
+
28
+ ### Dependencies
29
+
30
+ * The following workspace dependencies were updated
31
+ * dependencies
32
+ * @twin.org/standards-w3c-dcat bumped from 0.0.3-next.67 to 0.0.3-next.68
33
+ * @twin.org/standards-w3c-odrl bumped from 0.0.3-next.67 to 0.0.3-next.68
34
+ * devDependencies
35
+ * @twin.org/standards-ld-contexts bumped from 0.0.3-next.67 to 0.0.3-next.68
36
+
3
37
  ## [0.0.3-next.67](https://github.com/iotaledger/twin-standards/compare/standards-dataspace-protocol-v0.0.3-next.66...standards-dataspace-protocol-v0.0.3-next.67) (2026-06-12)
4
38
 
5
39
 
@@ -1,15 +1,10 @@
1
1
  # Interface: IDataspaceProtocolAgreement
2
2
 
3
- Agreement interface compliant with Eclipse Data Space Protocol.
4
-
5
- Extends IOdrlAgreement with DS Protocol-specific constraints:
6
- - `@id` is REQUIRED (used as the primary agreement identifier in DS Protocol)
7
- - `@context` is omitted (inherited from the parent Dataset/Distribution)
3
+ Agreement interface compliant with Eclipse Data Space Protocol, requiring an id and omitting context.
8
4
 
9
5
  ## See
10
6
 
11
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
12
- - IOdrlAgreement from @twin.org/standards-w3c-odrl
7
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
13
8
 
14
9
  ## Extends
15
10