@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,34 +1,10 @@
1
1
  # Interface: IDataspaceProtocolDistributionBase
2
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
3
+ Base distribution interface compliant with Eclipse Data Space Protocol, requiring a format and accessService.
25
4
 
26
5
  ## See
27
6
 
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
7
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
32
8
 
33
9
  ## Extends
34
10
 
@@ -53,9 +29,7 @@ REQUIRED per Eclipse Data Space Protocol.
53
29
 
54
30
  > `optional` **@id?**: `string`
55
31
 
56
- Unique identifier for the distribution.
57
- OPTIONAL for embedded distributions (may use JSON-LD blank nodes).
58
- REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
32
+ Unique identifier for the distribution; optional for embedded distributions.
59
33
 
60
34
  #### Overrides
61
35
 
@@ -67,12 +41,7 @@ REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
67
41
 
68
42
  > `optional` **hasPolicy?**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)[]
69
43
 
70
- Array of ODRL policies (Offers) as required by DS Protocol.
71
-
72
- REQUIRED per Eclipse Data Space Protocol spec.
73
- Must contain at least one IOdrlOffer.
74
- Currently only single offer is supported, but array structure
75
- allows for future multi-offer support.
44
+ Optional array of ODRL offers; when present, must contain at least one entry.
76
45
 
77
46
  ***
78
47
 
@@ -80,8 +49,7 @@ allows for future multi-offer support.
80
49
 
81
50
  > **accessService**: `string` \| [`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)
82
51
 
83
- Access service.
84
- It can be a URI pointing to an access service or inline the access service itself.
52
+ Access service URI or inline access service definition.
85
53
 
86
54
  ***
87
55
 
@@ -89,8 +57,7 @@ It can be a URI pointing to an access service or inline the access service itsel
89
57
 
90
58
  > **format**: `string`
91
59
 
92
- Distribution format.
93
- REQUIRED per Eclipse Data Space Protocol.
60
+ Distribution format identifier.
94
61
 
95
62
  ***
96
63
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolEndpointProperty
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for a Dataspace Protocol endpoint property key-value pair.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level
9
12
 
10
13
  > **@type**: `"EndpointProperty"`
11
14
 
12
- LD Type.
15
+ The JSON-LD type.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Type.
17
20
 
18
21
  > **name**: `string`
19
22
 
20
- Property name.
23
+ The property name.
21
24
 
22
25
  ***
23
26
 
@@ -25,4 +28,4 @@ Property name.
25
28
 
26
29
  > **value**: `string`
27
30
 
28
- Property value.
31
+ The property value.
@@ -1,15 +1,10 @@
1
1
  # Interface: IDataspaceProtocolOffer
2
2
 
3
- Offer interface compliant with Eclipse Data Space Protocol.
4
-
5
- Extends IOdrlOffer with DS Protocol-specific constraints:
6
- - `@id` is REQUIRED (used as the primary offer identifier in DS Protocol)
7
- - `@context` is omitted (inherited from the parent Dataset/Distribution)
3
+ Offer interface compliant with Eclipse Data Space Protocol, requiring an id and context.
8
4
 
9
5
  ## See
10
6
 
11
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
12
- - IOdrlOffer 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
 
@@ -33,7 +28,7 @@ Unique identifier for the offer.
33
28
 
34
29
  > **@context**: `OdrlContextType`
35
30
 
36
- LD Context.
31
+ The JSON-LD context.
37
32
 
38
33
  ***
39
34
 
@@ -1,12 +1,6 @@
1
1
  # Interface: IDataspaceProtocolOfferBase
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
12
6
 
@@ -1,15 +1,10 @@
1
1
  # Interface: IDataspaceProtocolPolicy
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
10
6
 
11
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
12
- - IOdrlPolicy 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
 
@@ -1,15 +1,10 @@
1
1
  # Interface: IDataspaceProtocolSet
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
10
6
 
11
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
12
- - IOdrlSet 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
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferCompletionMessage
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer completion message.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-co
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferCompletionMessage"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferError
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer error response.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transf
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferError"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferProcess
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer process acknowledgment.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfe
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferProcess"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferRequestMessage
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer request message.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-re
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferRequestMessage"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferStartMessage
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer start message.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-st
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferStartMessage"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferSuspensionMessage
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer suspension message.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-su
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferSuspensionMessage"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -1,6 +1,9 @@
1
1
  # Interface: IDataspaceProtocolTransferTerminationMessage
2
2
 
3
- Interface for Dataspace Protocol Transfer Messages.
3
+ Interface for the Dataspace Protocol transfer termination message.
4
+
5
+ ## See
6
+
4
7
  https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
5
8
 
6
9
  ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-te
9
12
 
10
13
  > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
11
14
 
12
- LD Context
15
+ The JSON-LD context.
13
16
 
14
17
  ***
15
18
 
@@ -17,7 +20,7 @@ LD Context
17
20
 
18
21
  > **@type**: `"TransferTerminationMessage"`
19
22
 
20
- LD Type
23
+ The JSON-LD type.
21
24
 
22
25
  ***
23
26
 
@@ -2,11 +2,4 @@
2
2
 
3
3
  > **DataspaceProtocolEndpointType** = *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\[keyof *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\]
4
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
5
+ All valid Dataspace Protocol endpoint type URI values.
@@ -2,8 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolCatalogTypes**: `object`
4
4
 
5
- The types for Dataspace Protocol Catalog Protocol.
6
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
5
+ Type identifiers for the Dataspace Protocol Catalog Protocol.
7
6
 
8
7
  ## Type Declaration
9
8
 
@@ -72,3 +71,7 @@ Agreement.
72
71
  > `readonly` **Set**: `"Set"` = `"Set"`
73
72
 
74
73
  Set.
74
+
75
+ ## See
76
+
77
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
@@ -2,7 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolContexts**: `object`
4
4
 
5
- The contexts for Dataspace Protocol Protocol.
5
+ Context URLs and namespace identifiers for the Dataspace Protocol.
6
6
 
7
7
  ## Type Declaration
8
8
 
@@ -2,8 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolContractNegotiationEventType**: `object`
4
4
 
5
- The types for Dataspace Protocol Contract Negotiation Events.
6
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
5
+ Event type identifiers for the Dataspace Protocol Contract Negotiation.
7
6
 
8
7
  ## Type Declaration
9
8
 
@@ -18,3 +17,7 @@ Accepted.
18
17
  > `readonly` **FINALIZED**: `"FINALIZED"` = `"FINALIZED"`
19
18
 
20
19
  Finalized.
20
+
21
+ ## See
22
+
23
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
@@ -2,8 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolContractNegotiationStateType**: `object`
4
4
 
5
- The types for Dataspace Protocol Contract Negotiation States.
6
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
5
+ State type identifiers for the Dataspace Protocol Contract Negotiation.
7
6
 
8
7
  ## Type Declaration
9
8
 
@@ -48,3 +47,7 @@ Finalized.
48
47
  > `readonly` **TERMINATED**: `"TERMINATED"` = `"TERMINATED"`
49
48
 
50
49
  Terminated.
50
+
51
+ ## See
52
+
53
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
@@ -2,8 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolContractNegotiationTypes**: `object`
4
4
 
5
- The types for Dataspace Protocol Contract Negotiation.
6
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
5
+ Type identifiers for the Dataspace Protocol Contract Negotiation.
7
6
 
8
7
  ## Type Declaration
9
8
 
@@ -66,3 +65,7 @@ Contract Negotiation Event Type.
66
65
  > `readonly` **ContractNegotiationStateType**: `"ContractNegotiationStateType"` = `"ContractNegotiationStateType"`
67
66
 
68
67
  Contract Negotiation State Type.
68
+
69
+ ## See
70
+
71
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
@@ -4,93 +4,48 @@
4
4
 
5
5
  TWIN Data Space Protocol Profile endpoint type identifiers.
6
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
7
  ## Type Declaration
22
8
 
23
9
  ### HttpsQueryEndpoint {#httpsqueryendpoint}
24
10
 
25
11
  > `readonly` **HttpsQueryEndpoint**: `"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint"` = `"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint"`
26
12
 
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
13
+ HTTPS query endpoint for PULL transfers via the TWIN Data Space Connector Query interface.
37
14
 
38
15
  #### See
39
16
 
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
17
+ https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
42
18
 
43
19
  ### HttpsActivityStreamEndpoint {#httpsactivitystreamendpoint}
44
20
 
45
21
  > `readonly` **HttpsActivityStreamEndpoint**: `"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint"` = `"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint"`
46
22
 
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
23
+ HTTPS Activity Stream endpoint for PUSH transfers via the Activity Streams 2.0 protocol.
57
24
 
58
25
  #### See
59
26
 
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/
27
+ https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
63
28
 
64
29
  ### HTTP {#http}
65
30
 
66
31
  > `readonly` **HTTP**: `"https://w3id.org/idsa/v4.1/HTTP"` = `"https://w3id.org/idsa/v4.1/HTTP"`
67
32
 
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.
33
+ HTTP endpoint identifier from the IDSA W3ID v4.1 namespace.
75
34
 
76
35
  #### See
77
36
 
78
- - https://w3id.org/idsa/v4.1/HTTP
79
- - https://github.com/International-Data-Spaces-Association/InformationModel
37
+ https://w3id.org/idsa/v4.1/HTTP
80
38
 
81
39
  ### HTTPS {#https}
82
40
 
83
41
  > `readonly` **HTTPS**: `"https://w3id.org/idsa/v4.1/HTTPS"` = `"https://w3id.org/idsa/v4.1/HTTPS"`
84
42
 
85
- HTTPS endpoint (IDSA W3ID v4.1).
43
+ HTTPS endpoint identifier from the IDSA W3ID v4.1 namespace.
86
44
 
87
- Persistent identifier for HTTPS-based secure data access endpoints.
88
- This W3ID URL is used as a semantic identifier in JSON-LD contexts.
45
+ #### See
89
46
 
90
- Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
91
- This constant is provided for interoperability with IDSA-based systems.
47
+ https://w3id.org/idsa/v4.1/HTTPS
92
48
 
93
- #### See
49
+ ## See
94
50
 
95
- - https://w3id.org/idsa/v4.1/HTTPS
96
- - https://github.com/International-Data-Spaces-Association/InformationModel
51
+ https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
@@ -2,8 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolTransferProcessStateType**: `object`
4
4
 
5
- The states for Dataspace Protocol Transfer Process.
6
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
5
+ State type identifiers for the Dataspace Protocol Transfer Process.
7
6
 
8
7
  ## Type Declaration
9
8
 
@@ -36,3 +35,7 @@ Suspended
36
35
  > `readonly` **TERMINATED**: `"TERMINATED"` = `"TERMINATED"`
37
36
 
38
37
  Terminated
38
+
39
+ ## See
40
+
41
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
@@ -2,8 +2,7 @@
2
2
 
3
3
  > `const` **DataspaceProtocolTransferProcessTypes**: `object`
4
4
 
5
- The types for Dataspace Protocol Transfer Process.
6
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
5
+ Type identifiers for the Dataspace Protocol Transfer Process.
7
6
 
8
7
  ## Type Declaration
9
8
 
@@ -60,3 +59,7 @@ Transfer Process
60
59
  > `readonly` **TransferError**: `"TransferError"` = `"TransferError"`
61
60
 
62
61
  Transfer Error.
62
+
63
+ ## See
64
+
65
+ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/standards-dataspace-protocol",
3
- "version": "0.0.3-next.67",
3
+ "version": "0.0.3-next.69",
4
4
  "description": "Data models for the Dataspace Protocol specification.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,8 +17,8 @@
17
17
  "@twin.org/core": "next",
18
18
  "@twin.org/data-core": "next",
19
19
  "@twin.org/data-json-ld": "next",
20
- "@twin.org/standards-w3c-dcat": "0.0.3-next.67",
21
- "@twin.org/standards-w3c-odrl": "0.0.3-next.67",
20
+ "@twin.org/standards-w3c-dcat": "0.0.3-next.69",
21
+ "@twin.org/standards-w3c-odrl": "0.0.3-next.69",
22
22
  "@twin.org/web": "next"
23
23
  },
24
24
  "main": "./dist/es/index.js",