@twin.org/standards-dataspace-protocol 0.0.3-next.43 → 0.0.3-next.45
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.
- package/dist/es/index.js +1 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolCatalog.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolDataService.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolDataset.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolDistribution.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolOffer.js +2 -0
- package/dist/es/models/catalog/IDataspaceProtocolOffer.js.map +1 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/models/catalog/IDataspaceProtocolDataset.d.ts +2 -2
- package/dist/types/models/catalog/IDataspaceProtocolDistribution.d.ts +2 -2
- package/dist/types/models/catalog/IDataspaceProtocolOffer.d.ts +22 -0
- package/docs/changelog.md +34 -0
- package/docs/reference/index.md +1 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +480 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +321 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +401 -1
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +289 -1
- package/docs/reference/interfaces/IDataspaceProtocolOffer.md +175 -0
- package/package.json +3 -3
|
@@ -68,7 +68,7 @@ REQUIRED per Eclipse Data Space Protocol.
|
|
|
68
68
|
|
|
69
69
|
### hasPolicy?
|
|
70
70
|
|
|
71
|
-
> `optional` **hasPolicy**: `ObjectOrArray
|
|
71
|
+
> `optional` **hasPolicy**: `ObjectOrArray`\<[`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)\>
|
|
72
72
|
|
|
73
73
|
Array of ODRL policies (Offers) as required by DS Protocol.
|
|
74
74
|
|
|
@@ -94,3 +94,291 @@ It can be a URI pointing to an access service or inline the access service itsel
|
|
|
94
94
|
|
|
95
95
|
Distribution format.
|
|
96
96
|
REQUIRED per Eclipse Data Space Protocol.
|
|
97
|
+
|
|
98
|
+
***
|
|
99
|
+
|
|
100
|
+
### dcterms:title?
|
|
101
|
+
|
|
102
|
+
> `optional` **dcterms:title**: `DcatLiteralType`
|
|
103
|
+
|
|
104
|
+
A name given to the distribution.
|
|
105
|
+
|
|
106
|
+
#### See
|
|
107
|
+
|
|
108
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
|
|
109
|
+
|
|
110
|
+
#### Inherited from
|
|
111
|
+
|
|
112
|
+
`Omit.dcterms:title`
|
|
113
|
+
|
|
114
|
+
***
|
|
115
|
+
|
|
116
|
+
### dcterms:description?
|
|
117
|
+
|
|
118
|
+
> `optional` **dcterms:description**: `DcatLiteralType`
|
|
119
|
+
|
|
120
|
+
A free-text account of the distribution.
|
|
121
|
+
|
|
122
|
+
#### See
|
|
123
|
+
|
|
124
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
|
|
125
|
+
|
|
126
|
+
#### Inherited from
|
|
127
|
+
|
|
128
|
+
`Omit.dcterms:description`
|
|
129
|
+
|
|
130
|
+
***
|
|
131
|
+
|
|
132
|
+
### dcterms:issued?
|
|
133
|
+
|
|
134
|
+
> `optional` **dcterms:issued**: `string`
|
|
135
|
+
|
|
136
|
+
Date of formal issuance of the distribution.
|
|
137
|
+
|
|
138
|
+
#### See
|
|
139
|
+
|
|
140
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
|
|
141
|
+
|
|
142
|
+
#### Inherited from
|
|
143
|
+
|
|
144
|
+
`Omit.dcterms:issued`
|
|
145
|
+
|
|
146
|
+
***
|
|
147
|
+
|
|
148
|
+
### dcterms:modified?
|
|
149
|
+
|
|
150
|
+
> `optional` **dcterms:modified**: `string`
|
|
151
|
+
|
|
152
|
+
Most recent date on which the distribution was changed, updated or modified.
|
|
153
|
+
|
|
154
|
+
#### See
|
|
155
|
+
|
|
156
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
|
|
157
|
+
|
|
158
|
+
#### Inherited from
|
|
159
|
+
|
|
160
|
+
`Omit.dcterms:modified`
|
|
161
|
+
|
|
162
|
+
***
|
|
163
|
+
|
|
164
|
+
### dcterms:license?
|
|
165
|
+
|
|
166
|
+
> `optional` **dcterms:license**: `string`
|
|
167
|
+
|
|
168
|
+
A legal document under which the distribution is made available.
|
|
169
|
+
|
|
170
|
+
#### See
|
|
171
|
+
|
|
172
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
|
|
173
|
+
|
|
174
|
+
#### Inherited from
|
|
175
|
+
|
|
176
|
+
`Omit.dcterms:license`
|
|
177
|
+
|
|
178
|
+
***
|
|
179
|
+
|
|
180
|
+
### dcterms:accessRights?
|
|
181
|
+
|
|
182
|
+
> `optional` **dcterms:accessRights**: `string`
|
|
183
|
+
|
|
184
|
+
Information about who can access the distribution.
|
|
185
|
+
|
|
186
|
+
#### See
|
|
187
|
+
|
|
188
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
|
|
189
|
+
|
|
190
|
+
#### Inherited from
|
|
191
|
+
|
|
192
|
+
`Omit.dcterms:accessRights`
|
|
193
|
+
|
|
194
|
+
***
|
|
195
|
+
|
|
196
|
+
### dcterms:rights?
|
|
197
|
+
|
|
198
|
+
> `optional` **dcterms:rights**: `string`
|
|
199
|
+
|
|
200
|
+
Information about rights held in and over the distribution.
|
|
201
|
+
|
|
202
|
+
#### See
|
|
203
|
+
|
|
204
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
|
|
205
|
+
|
|
206
|
+
#### Inherited from
|
|
207
|
+
|
|
208
|
+
`Omit.dcterms:rights`
|
|
209
|
+
|
|
210
|
+
***
|
|
211
|
+
|
|
212
|
+
### dcat:accessURL?
|
|
213
|
+
|
|
214
|
+
> `optional` **dcat:accessURL**: `string`
|
|
215
|
+
|
|
216
|
+
A URL of the resource that gives access to a distribution of the dataset.
|
|
217
|
+
|
|
218
|
+
#### See
|
|
219
|
+
|
|
220
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
|
|
221
|
+
|
|
222
|
+
#### Inherited from
|
|
223
|
+
|
|
224
|
+
`Omit.dcat:accessURL`
|
|
225
|
+
|
|
226
|
+
***
|
|
227
|
+
|
|
228
|
+
### dcat:accessService?
|
|
229
|
+
|
|
230
|
+
> `optional` **dcat:accessService**: `string`
|
|
231
|
+
|
|
232
|
+
A data service that gives access to the distribution.
|
|
233
|
+
|
|
234
|
+
#### See
|
|
235
|
+
|
|
236
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
|
|
237
|
+
|
|
238
|
+
#### Inherited from
|
|
239
|
+
|
|
240
|
+
`Omit.dcat:accessService`
|
|
241
|
+
|
|
242
|
+
***
|
|
243
|
+
|
|
244
|
+
### dcat:downloadURL?
|
|
245
|
+
|
|
246
|
+
> `optional` **dcat:downloadURL**: `string`
|
|
247
|
+
|
|
248
|
+
The URL of the downloadable file in a given format.
|
|
249
|
+
|
|
250
|
+
#### See
|
|
251
|
+
|
|
252
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
|
|
253
|
+
|
|
254
|
+
#### Inherited from
|
|
255
|
+
|
|
256
|
+
`Omit.dcat:downloadURL`
|
|
257
|
+
|
|
258
|
+
***
|
|
259
|
+
|
|
260
|
+
### dcat:byteSize?
|
|
261
|
+
|
|
262
|
+
> `optional` **dcat:byteSize**: `number`
|
|
263
|
+
|
|
264
|
+
The size of the distribution in bytes.
|
|
265
|
+
|
|
266
|
+
#### See
|
|
267
|
+
|
|
268
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
|
|
269
|
+
|
|
270
|
+
#### Inherited from
|
|
271
|
+
|
|
272
|
+
`Omit.dcat:byteSize`
|
|
273
|
+
|
|
274
|
+
***
|
|
275
|
+
|
|
276
|
+
### dcat:spatialResolutionInMeters?
|
|
277
|
+
|
|
278
|
+
> `optional` **dcat:spatialResolutionInMeters**: `number`
|
|
279
|
+
|
|
280
|
+
The minimum spatial separation resolvable in a distribution, measured in meters.
|
|
281
|
+
|
|
282
|
+
#### See
|
|
283
|
+
|
|
284
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
|
|
285
|
+
|
|
286
|
+
#### Inherited from
|
|
287
|
+
|
|
288
|
+
`Omit.dcat:spatialResolutionInMeters`
|
|
289
|
+
|
|
290
|
+
***
|
|
291
|
+
|
|
292
|
+
### dcat:temporalResolution?
|
|
293
|
+
|
|
294
|
+
> `optional` **dcat:temporalResolution**: `string`
|
|
295
|
+
|
|
296
|
+
Minimum time period resolvable in the distribution.
|
|
297
|
+
|
|
298
|
+
#### See
|
|
299
|
+
|
|
300
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
|
|
301
|
+
|
|
302
|
+
#### Inherited from
|
|
303
|
+
|
|
304
|
+
`Omit.dcat:temporalResolution`
|
|
305
|
+
|
|
306
|
+
***
|
|
307
|
+
|
|
308
|
+
### dcterms:conformsTo?
|
|
309
|
+
|
|
310
|
+
> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
|
|
311
|
+
|
|
312
|
+
An established standard to which the distribution conforms.
|
|
313
|
+
|
|
314
|
+
#### See
|
|
315
|
+
|
|
316
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
|
|
317
|
+
|
|
318
|
+
#### Inherited from
|
|
319
|
+
|
|
320
|
+
`Omit.dcterms:conformsTo`
|
|
321
|
+
|
|
322
|
+
***
|
|
323
|
+
|
|
324
|
+
### dcat:mediaType?
|
|
325
|
+
|
|
326
|
+
> `optional` **dcat:mediaType**: `string`
|
|
327
|
+
|
|
328
|
+
The media type of the distribution as defined by IANA.
|
|
329
|
+
|
|
330
|
+
#### See
|
|
331
|
+
|
|
332
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
|
|
333
|
+
|
|
334
|
+
#### Inherited from
|
|
335
|
+
|
|
336
|
+
`Omit.dcat:mediaType`
|
|
337
|
+
|
|
338
|
+
***
|
|
339
|
+
|
|
340
|
+
### dcat:compressFormat?
|
|
341
|
+
|
|
342
|
+
> `optional` **dcat:compressFormat**: `string`
|
|
343
|
+
|
|
344
|
+
The compression format of the distribution.
|
|
345
|
+
|
|
346
|
+
#### See
|
|
347
|
+
|
|
348
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
|
|
349
|
+
|
|
350
|
+
#### Inherited from
|
|
351
|
+
|
|
352
|
+
`Omit.dcat:compressFormat`
|
|
353
|
+
|
|
354
|
+
***
|
|
355
|
+
|
|
356
|
+
### dcat:packageFormat?
|
|
357
|
+
|
|
358
|
+
> `optional` **dcat:packageFormat**: `string`
|
|
359
|
+
|
|
360
|
+
The package format of the distribution.
|
|
361
|
+
|
|
362
|
+
#### See
|
|
363
|
+
|
|
364
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
|
|
365
|
+
|
|
366
|
+
#### Inherited from
|
|
367
|
+
|
|
368
|
+
`Omit.dcat:packageFormat`
|
|
369
|
+
|
|
370
|
+
***
|
|
371
|
+
|
|
372
|
+
### spdx:checksum?
|
|
373
|
+
|
|
374
|
+
> `optional` **spdx:checksum**: `string`
|
|
375
|
+
|
|
376
|
+
The checksum property provides a mechanism to verify the data integrity.
|
|
377
|
+
|
|
378
|
+
#### See
|
|
379
|
+
|
|
380
|
+
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
|
|
381
|
+
|
|
382
|
+
#### Inherited from
|
|
383
|
+
|
|
384
|
+
`Omit.spdx:checksum`
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
# Interface: IDataspaceProtocolOffer
|
|
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)
|
|
8
|
+
- `uid` is optional (DS Protocol uses `@id` instead of ODRL `uid`)
|
|
9
|
+
|
|
10
|
+
## See
|
|
11
|
+
|
|
12
|
+
- https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
13
|
+
- IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
14
|
+
|
|
15
|
+
## Extends
|
|
16
|
+
|
|
17
|
+
- `Omit`\<`IOdrlOffer`, `"@context"` \| `"uid"`\>
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### @id
|
|
22
|
+
|
|
23
|
+
> **@id**: `string`
|
|
24
|
+
|
|
25
|
+
Unique identifier for the offer.
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### uid?
|
|
30
|
+
|
|
31
|
+
> `optional` **uid**: `string`
|
|
32
|
+
|
|
33
|
+
Unique identifier for the offer.
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### @type
|
|
38
|
+
|
|
39
|
+
> **@type**: `"Offer"`
|
|
40
|
+
|
|
41
|
+
The type must be "Offer".
|
|
42
|
+
|
|
43
|
+
#### Inherited from
|
|
44
|
+
|
|
45
|
+
`Omit.@type`
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### assigner
|
|
50
|
+
|
|
51
|
+
> **assigner**: `string` \| `IOdrlParty`
|
|
52
|
+
|
|
53
|
+
The assigner of the offer.
|
|
54
|
+
Required for Offer policies.
|
|
55
|
+
|
|
56
|
+
#### Inherited from
|
|
57
|
+
|
|
58
|
+
`Omit.assigner`
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### profile?
|
|
63
|
+
|
|
64
|
+
> `optional` **profile**: `string` \| `string`[]
|
|
65
|
+
|
|
66
|
+
The profile(s) this policy conforms to.
|
|
67
|
+
IRIs identifying the ODRL Profile(s).
|
|
68
|
+
|
|
69
|
+
#### Inherited from
|
|
70
|
+
|
|
71
|
+
`Omit.profile`
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### assignee?
|
|
76
|
+
|
|
77
|
+
> `optional` **assignee**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
|
|
78
|
+
|
|
79
|
+
The assignee of the policy.
|
|
80
|
+
Applies to all rules unless overridden at rule level.
|
|
81
|
+
|
|
82
|
+
#### Inherited from
|
|
83
|
+
|
|
84
|
+
`Omit.assignee`
|
|
85
|
+
|
|
86
|
+
***
|
|
87
|
+
|
|
88
|
+
### target?
|
|
89
|
+
|
|
90
|
+
> `optional` **target**: `string` \| `IOdrlAsset` \| `IOdrlAssetCollection` \| (`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`)[]
|
|
91
|
+
|
|
92
|
+
The target asset for the rule.
|
|
93
|
+
|
|
94
|
+
#### Inherited from
|
|
95
|
+
|
|
96
|
+
`Omit.target`
|
|
97
|
+
|
|
98
|
+
***
|
|
99
|
+
|
|
100
|
+
### action?
|
|
101
|
+
|
|
102
|
+
> `optional` **action**: `string` \| `IOdrlAction` \| (`string` \| `IOdrlAction`)[]
|
|
103
|
+
|
|
104
|
+
The action associated with the rule.
|
|
105
|
+
|
|
106
|
+
#### Inherited from
|
|
107
|
+
|
|
108
|
+
`Omit.action`
|
|
109
|
+
|
|
110
|
+
***
|
|
111
|
+
|
|
112
|
+
### inheritFrom?
|
|
113
|
+
|
|
114
|
+
> `optional` **inheritFrom**: `string` \| `string`[]
|
|
115
|
+
|
|
116
|
+
The parent policy(ies) this policy inherits from.
|
|
117
|
+
IRIs identifying the parent Policy(ies).
|
|
118
|
+
|
|
119
|
+
#### Inherited from
|
|
120
|
+
|
|
121
|
+
`Omit.inheritFrom`
|
|
122
|
+
|
|
123
|
+
***
|
|
124
|
+
|
|
125
|
+
### conflict?
|
|
126
|
+
|
|
127
|
+
> `optional` **conflict**: `ConflictStrategyType`
|
|
128
|
+
|
|
129
|
+
The conflict resolution strategy.
|
|
130
|
+
- perm: Permissions override Prohibitions
|
|
131
|
+
- prohibit: Prohibitions override Permissions
|
|
132
|
+
- invalid: Policy is void if conflicts exist (default)
|
|
133
|
+
|
|
134
|
+
#### Inherited from
|
|
135
|
+
|
|
136
|
+
`Omit.conflict`
|
|
137
|
+
|
|
138
|
+
***
|
|
139
|
+
|
|
140
|
+
### permission?
|
|
141
|
+
|
|
142
|
+
> `optional` **permission**: `IOdrlPermission` \| `IOdrlPermission`[]
|
|
143
|
+
|
|
144
|
+
The permissions in the policy.
|
|
145
|
+
At least one of permission, prohibition, or obligation must be present.
|
|
146
|
+
|
|
147
|
+
#### Inherited from
|
|
148
|
+
|
|
149
|
+
`Omit.permission`
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
### prohibition?
|
|
154
|
+
|
|
155
|
+
> `optional` **prohibition**: `IOdrlProhibition` \| `IOdrlProhibition`[]
|
|
156
|
+
|
|
157
|
+
The prohibitions in the policy.
|
|
158
|
+
At least one of permission, prohibition, or obligation must be present.
|
|
159
|
+
|
|
160
|
+
#### Inherited from
|
|
161
|
+
|
|
162
|
+
`Omit.prohibition`
|
|
163
|
+
|
|
164
|
+
***
|
|
165
|
+
|
|
166
|
+
### obligation?
|
|
167
|
+
|
|
168
|
+
> `optional` **obligation**: `IOdrlDuty` \| `IOdrlDuty`[]
|
|
169
|
+
|
|
170
|
+
The obligations in the policy.
|
|
171
|
+
At least one of permission, prohibition, or obligation must be present.
|
|
172
|
+
|
|
173
|
+
#### Inherited from
|
|
174
|
+
|
|
175
|
+
`Omit.obligation`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/standards-dataspace-protocol",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.45",
|
|
4
4
|
"description": "Models which define the structure of Dataspace Protocol",
|
|
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.
|
|
21
|
-
"@twin.org/standards-w3c-odrl": "0.0.3-next.
|
|
20
|
+
"@twin.org/standards-w3c-dcat": "0.0.3-next.45",
|
|
21
|
+
"@twin.org/standards-w3c-odrl": "0.0.3-next.45",
|
|
22
22
|
"@twin.org/web": "next"
|
|
23
23
|
},
|
|
24
24
|
"main": "./dist/es/index.js",
|