@twin.org/standards-dataspace-protocol 0.0.3-next.55 → 0.0.3-next.57

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 (42) hide show
  1. package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js.map +1 -1
  2. package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js.map +1 -1
  3. package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js.map +1 -1
  4. package/dist/es/schemas/DataspaceProtocolAgreement.json +3 -3
  5. package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +3 -3
  6. package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +6 -12
  7. package/dist/es/schemas/DataspaceProtocolDatasetBase.json +12 -24
  8. package/dist/es/schemas/DataspaceProtocolDistributionBase.json +6 -12
  9. package/dist/es/schemas/DataspaceProtocolOfferBase.json +3 -3
  10. package/dist/es/schemas/DataspaceProtocolPolicy.json +4 -4
  11. package/dist/es/schemas/DataspaceProtocolSet.json +3 -3
  12. package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +2 -2
  13. package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +4 -3
  14. package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +2 -2
  15. package/docs/changelog.md +34 -0
  16. package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +8 -8
  17. package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +34 -34
  18. package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +34 -34
  19. package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +1 -1
  20. package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +1 -1
  21. package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md +1 -1
  22. package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationError.md +2 -2
  23. package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md +2 -2
  24. package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md +2 -2
  25. package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md +2 -2
  26. package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +2 -2
  27. package/docs/reference/interfaces/IDataspaceProtocolDataService.md +21 -21
  28. package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +21 -21
  29. package/docs/reference/interfaces/IDataspaceProtocolDataset.md +27 -27
  30. package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +27 -27
  31. package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +19 -19
  32. package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +20 -20
  33. package/docs/reference/interfaces/IDataspaceProtocolOffer.md +9 -9
  34. package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +9 -9
  35. package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +11 -11
  36. package/docs/reference/interfaces/IDataspaceProtocolSet.md +10 -10
  37. package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +2 -2
  38. package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +1 -1
  39. package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +1 -1
  40. package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +2 -2
  41. package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +2 -2
  42. package/package.json +3 -3
package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md CHANGED
@@ -57,7 +57,7 @@ Required for Offer policies.
57
57
 
58
58
  ### profile? {#profile}
59
59
 
60
- > `optional` **profile**: `ObjectOrArray`\<`string`\>
60
+ > `optional` **profile?**: `ObjectOrArray`\<`string`\>
61
61
 
62
62
  The profile(s) this policy conforms to.
63
63
  IRIs identifying the ODRL Profile(s).
@@ -70,7 +70,7 @@ IRIs identifying the ODRL Profile(s).
70
70
 
71
71
  ### assignee? {#assignee}
72
72
 
73
- > `optional` **assignee**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
73
+ > `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
74
74
 
75
75
  The assignee of the policy.
76
76
  Applies to all rules unless overridden at rule level.
@@ -83,7 +83,7 @@ Applies to all rules unless overridden at rule level.
83
83
 
84
84
  ### target? {#target}
85
85
 
86
- > `optional` **target**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
86
+ > `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
87
87
 
88
88
  The target asset for the rule.
89
89
 
@@ -95,7 +95,7 @@ The target asset for the rule.
95
95
 
96
96
  ### action? {#action}
97
97
 
98
- > `optional` **action**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
98
+ > `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
99
99
 
100
100
  The action associated with the rule.
101
101
 
@@ -107,7 +107,7 @@ The action associated with the rule.
107
107
 
108
108
  ### inheritFrom? {#inheritfrom}
109
109
 
110
- > `optional` **inheritFrom**: `ObjectOrArray`\<`string`\>
110
+ > `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
111
111
 
112
112
  The parent policy(ies) this policy inherits from.
113
113
  IRIs identifying the parent Policy(ies).
@@ -120,7 +120,7 @@ IRIs identifying the parent Policy(ies).
120
120
 
121
121
  ### conflict? {#conflict}
122
122
 
123
- > `optional` **conflict**: `ConflictStrategyType`
123
+ > `optional` **conflict?**: `OdrlConflictStrategyType`
124
124
 
125
125
  The conflict resolution strategy.
126
126
  - perm: Permissions override Prohibitions
@@ -135,7 +135,7 @@ The conflict resolution strategy.
135
135
 
136
136
  ### permission? {#permission}
137
137
 
138
- > `optional` **permission**: `ObjectOrArray`\<`IOdrlPermission`\>
138
+ > `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
139
139
 
140
140
  The permissions in the policy.
141
141
  At least one of permission, prohibition, or obligation must be present.
@@ -148,7 +148,7 @@ At least one of permission, prohibition, or obligation must be present.
148
148
 
149
149
  ### prohibition? {#prohibition}
150
150
 
151
- > `optional` **prohibition**: `ObjectOrArray`\<`IOdrlProhibition`\>
151
+ > `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
152
152
 
153
153
  The prohibitions in the policy.
154
154
  At least one of permission, prohibition, or obligation must be present.
@@ -161,7 +161,7 @@ At least one of permission, prohibition, or obligation must be present.
161
161
 
162
162
  ### obligation? {#obligation}
163
163
 
164
- > `optional` **obligation**: `ObjectOrArray`\<`IOdrlDuty`\>
164
+ > `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
165
165
 
166
166
  The obligations in the policy.
167
167
  At least one of permission, prohibition, or obligation must be present.
package/docs/reference/interfaces/IDataspaceProtocolPolicy.md CHANGED
@@ -40,7 +40,7 @@ Must include "https://www.w3.org/ns/odrl.jsonld"
40
40
 
41
41
  ### @type {#type}
42
42
 
43
- > **@type**: `PolicyType`
43
+ > **@type**: `OdrlPolicyType`
44
44
 
45
45
  The type of policy.
46
46
  Must be one of: "Set", "Offer", "Agreement"
@@ -53,7 +53,7 @@ Must be one of: "Set", "Offer", "Agreement"
53
53
 
54
54
  ### profile? {#profile}
55
55
 
56
- > `optional` **profile**: `ObjectOrArray`\<`string`\>
56
+ > `optional` **profile?**: `ObjectOrArray`\<`string`\>
57
57
 
58
58
  The profile(s) this policy conforms to.
59
59
  IRIs identifying the ODRL Profile(s).
@@ -66,7 +66,7 @@ IRIs identifying the ODRL Profile(s).
66
66
 
67
67
  ### assigner? {#assigner}
68
68
 
69
- > `optional` **assigner**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
69
+ > `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
70
70
 
71
71
  The assigner of the policy.
72
72
  Applies to all rules unless overridden at rule level.
@@ -79,7 +79,7 @@ Applies to all rules unless overridden at rule level.
79
79
 
80
80
  ### assignee? {#assignee}
81
81
 
82
- > `optional` **assignee**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
82
+ > `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
83
83
 
84
84
  The assignee of the policy.
85
85
  Applies to all rules unless overridden at rule level.
@@ -92,7 +92,7 @@ Applies to all rules unless overridden at rule level.
92
92
 
93
93
  ### target? {#target}
94
94
 
95
- > `optional` **target**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
95
+ > `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
96
96
 
97
97
  The target asset for the rule.
98
98
 
@@ -104,7 +104,7 @@ The target asset for the rule.
104
104
 
105
105
  ### action? {#action}
106
106
 
107
- > `optional` **action**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
107
+ > `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
108
108
 
109
109
  The action associated with the rule.
110
110
 
@@ -116,7 +116,7 @@ The action associated with the rule.
116
116
 
117
117
  ### inheritFrom? {#inheritfrom}
118
118
 
119
- > `optional` **inheritFrom**: `ObjectOrArray`\<`string`\>
119
+ > `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
120
120
 
121
121
  The parent policy(ies) this policy inherits from.
122
122
  IRIs identifying the parent Policy(ies).
@@ -129,7 +129,7 @@ IRIs identifying the parent Policy(ies).
129
129
 
130
130
  ### conflict? {#conflict}
131
131
 
132
- > `optional` **conflict**: `ConflictStrategyType`
132
+ > `optional` **conflict?**: `OdrlConflictStrategyType`
133
133
 
134
134
  The conflict resolution strategy.
135
135
  - perm: Permissions override Prohibitions
@@ -144,7 +144,7 @@ The conflict resolution strategy.
144
144
 
145
145
  ### permission? {#permission}
146
146
 
147
- > `optional` **permission**: `ObjectOrArray`\<`IOdrlPermission`\>
147
+ > `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
148
148
 
149
149
  The permissions in the policy.
150
150
  At least one of permission, prohibition, or obligation must be present.
@@ -157,7 +157,7 @@ At least one of permission, prohibition, or obligation must be present.
157
157
 
158
158
  ### prohibition? {#prohibition}
159
159
 
160
- > `optional` **prohibition**: `ObjectOrArray`\<`IOdrlProhibition`\>
160
+ > `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
161
161
 
162
162
  The prohibitions in the policy.
163
163
  At least one of permission, prohibition, or obligation must be present.
@@ -170,7 +170,7 @@ At least one of permission, prohibition, or obligation must be present.
170
170
 
171
171
  ### obligation? {#obligation}
172
172
 
173
- > `optional` **obligation**: `ObjectOrArray`\<`IOdrlDuty`\>
173
+ > `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
174
174
 
175
175
  The obligations in the policy.
176
176
  At least one of permission, prohibition, or obligation must be present.
package/docs/reference/interfaces/IDataspaceProtocolSet.md CHANGED
@@ -40,7 +40,7 @@ Must include "https://www.w3.org/ns/odrl.jsonld"
40
40
 
41
41
  ### profile? {#profile}
42
42
 
43
- > `optional` **profile**: `ObjectOrArray`\<`string`\>
43
+ > `optional` **profile?**: `ObjectOrArray`\<`string`\>
44
44
 
45
45
  The profile(s) this policy conforms to.
46
46
  IRIs identifying the ODRL Profile(s).
@@ -53,7 +53,7 @@ IRIs identifying the ODRL Profile(s).
53
53
 
54
54
  ### assigner? {#assigner}
55
55
 
56
- > `optional` **assigner**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
56
+ > `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
57
57
 
58
58
  The assigner of the policy.
59
59
  Applies to all rules unless overridden at rule level.
@@ -66,7 +66,7 @@ Applies to all rules unless overridden at rule level.
66
66
 
67
67
  ### assignee? {#assignee}
68
68
 
69
- > `optional` **assignee**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
69
+ > `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
70
70
 
71
71
  The assignee of the policy.
72
72
  Applies to all rules unless overridden at rule level.
@@ -79,7 +79,7 @@ Applies to all rules unless overridden at rule level.
79
79
 
80
80
  ### target? {#target}
81
81
 
82
- > `optional` **target**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
82
+ > `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
83
83
 
84
84
  The target asset for the rule.
85
85
 
@@ -91,7 +91,7 @@ The target asset for the rule.
91
91
 
92
92
  ### action? {#action}
93
93
 
94
- > `optional` **action**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
94
+ > `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
95
95
 
96
96
  The action associated with the rule.
97
97
 
@@ -103,7 +103,7 @@ The action associated with the rule.
103
103
 
104
104
  ### inheritFrom? {#inheritfrom}
105
105
 
106
- > `optional` **inheritFrom**: `ObjectOrArray`\<`string`\>
106
+ > `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
107
107
 
108
108
  The parent policy(ies) this policy inherits from.
109
109
  IRIs identifying the parent Policy(ies).
@@ -116,7 +116,7 @@ IRIs identifying the parent Policy(ies).
116
116
 
117
117
  ### conflict? {#conflict}
118
118
 
119
- > `optional` **conflict**: `ConflictStrategyType`
119
+ > `optional` **conflict?**: `OdrlConflictStrategyType`
120
120
 
121
121
  The conflict resolution strategy.
122
122
  - perm: Permissions override Prohibitions
@@ -131,7 +131,7 @@ The conflict resolution strategy.
131
131
 
132
132
  ### permission? {#permission}
133
133
 
134
- > `optional` **permission**: `ObjectOrArray`\<`IOdrlPermission`\>
134
+ > `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
135
135
 
136
136
  The permissions in the policy.
137
137
  At least one of permission, prohibition, or obligation must be present.
@@ -144,7 +144,7 @@ At least one of permission, prohibition, or obligation must be present.
144
144
 
145
145
  ### prohibition? {#prohibition}
146
146
 
147
- > `optional` **prohibition**: `ObjectOrArray`\<`IOdrlProhibition`\>
147
+ > `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
148
148
 
149
149
  The prohibitions in the policy.
150
150
  At least one of permission, prohibition, or obligation must be present.
@@ -157,7 +157,7 @@ At least one of permission, prohibition, or obligation must be present.
157
157
 
158
158
  ### obligation? {#obligation}
159
159
 
160
- > `optional` **obligation**: `ObjectOrArray`\<`IOdrlDuty`\>
160
+ > `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
161
161
 
162
162
  The obligations in the policy.
163
163
  At least one of permission, prohibition, or obligation must be present.
package/docs/reference/interfaces/IDataspaceProtocolTransferError.md CHANGED
@@ -39,7 +39,7 @@ MUST refer to the transfer identifier of the Provider side.
39
39
 
40
40
  ### code? {#code}
41
41
 
42
- > `optional` **code**: `string`
42
+ > `optional` **code?**: `string`
43
43
 
44
44
  The error code.
45
45
 
@@ -47,6 +47,6 @@ The error code.
47
47
 
48
48
  ### reason? {#reason}
49
49
 
50
- > `optional` **reason**: `any`[]
50
+ > `optional` **reason?**: `any`[]
51
51
 
52
52
  The error reason(s).
package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md CHANGED
@@ -56,7 +56,7 @@ This is generally obtained from the Provider's Catalog.
56
56
 
57
57
  ### dataAddress? {#dataaddress}
58
58
 
59
- > `optional` **dataAddress**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
59
+ > `optional` **dataAddress?**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
60
60
 
61
61
  If defined MUST contain a transport-specific set of properties for pushing the data.
62
62
  It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.
package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md CHANGED
@@ -39,7 +39,7 @@ MUST refer to the transfer identifier of the Provider side.
39
39
 
40
40
  ### dataAddress? {#dataaddress}
41
41
 
42
- > `optional` **dataAddress**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
42
+ > `optional` **dataAddress?**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.md)
43
43
 
44
44
  MUST be provided if the current transfer is a pull transfer and
45
45
  contains a transport-specific endpoint address for obtaining the data.
package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md CHANGED
@@ -39,7 +39,7 @@ MUST refer to the transfer identifier of the Provider side.
39
39
 
40
40
  ### code? {#code}
41
41
 
42
- > `optional` **code**: `string`
42
+ > `optional` **code?**: `string`
43
43
 
44
44
  The suspension code.
45
45
 
@@ -47,6 +47,6 @@ The suspension code.
47
47
 
48
48
  ### reason? {#reason}
49
49
 
50
- > `optional` **reason**: `any`[]
50
+ > `optional` **reason?**: `any`[]
51
51
 
52
52
  The suspension reason(s).
package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md CHANGED
@@ -39,7 +39,7 @@ MUST refer to the transfer identifier of the Provider side.
39
39
 
40
40
  ### code? {#code}
41
41
 
42
- > `optional` **code**: `string`
42
+ > `optional` **code?**: `string`
43
43
 
44
44
  The termination code.
45
45
 
@@ -47,6 +47,6 @@ The termination code.
47
47
 
48
48
  ### reason? {#reason}
49
49
 
50
- > `optional` **reason**: `any`[]
50
+ > `optional` **reason?**: `any`[]
51
51
 
52
52
  The termination reason(s).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/standards-dataspace-protocol",
3
- "version": "0.0.3-next.55",
3
+ "version": "0.0.3-next.57",
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.55",
21
- "@twin.org/standards-w3c-odrl": "0.0.3-next.55",
20
+ "@twin.org/standards-w3c-dcat": "0.0.3-next.57",
21
+ "@twin.org/standards-w3c-odrl": "0.0.3-next.57",
22
22
  "@twin.org/web": "next"
23
23
  },
24
24
  "main": "./dist/es/index.js",