@twin.org/standards-w3c-odrl 0.0.2-next.5 → 0.0.2-next.7
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/cjs/index.cjs +335 -613
- package/dist/esm/index.mjs +336 -613
- package/dist/types/index.d.ts +0 -2
- package/dist/types/models/IOdrlAction.d.ts +3 -2
- package/dist/types/models/IOdrlAgreement.d.ts +1 -0
- package/dist/types/models/IOdrlAsset.d.ts +1 -0
- package/dist/types/models/IOdrlAssetCollection.d.ts +1 -0
- package/dist/types/models/IOdrlConstraint.d.ts +1 -0
- package/dist/types/models/IOdrlDuty.d.ts +1 -0
- package/dist/types/models/IOdrlLogicalConstraint.d.ts +1 -0
- package/dist/types/models/IOdrlOffer.d.ts +1 -0
- package/dist/types/models/IOdrlParty.d.ts +1 -0
- package/dist/types/models/IOdrlPartyCollection.d.ts +1 -0
- package/dist/types/models/IOdrlPermission.d.ts +1 -0
- package/dist/types/models/IOdrlPolicy.d.ts +2 -1
- package/dist/types/models/IOdrlProhibition.d.ts +1 -0
- package/dist/types/models/IOdrlRule.d.ts +2 -1
- package/dist/types/models/IOdrlSet.d.ts +1 -0
- package/dist/types/models/types/actionType.d.ts +116 -97
- package/dist/types/models/types/odrlTypes.d.ts +0 -4
- package/docs/changelog.md +30 -0
- package/docs/reference/index.md +0 -3
- package/docs/reference/interfaces/IOdrlAction.md +3 -2
- package/docs/reference/interfaces/IOdrlAgreement.md +2 -1
- package/docs/reference/interfaces/IOdrlAsset.md +1 -0
- package/docs/reference/interfaces/IOdrlAssetCollection.md +1 -0
- package/docs/reference/interfaces/IOdrlConstraint.md +1 -0
- package/docs/reference/interfaces/IOdrlDuty.md +2 -1
- package/docs/reference/interfaces/IOdrlLogicalConstraint.md +1 -0
- package/docs/reference/interfaces/IOdrlOffer.md +2 -1
- package/docs/reference/interfaces/IOdrlParty.md +1 -0
- package/docs/reference/interfaces/IOdrlPartyCollection.md +1 -0
- package/docs/reference/interfaces/IOdrlPermission.md +2 -1
- package/docs/reference/interfaces/IOdrlPolicy.md +2 -1
- package/docs/reference/interfaces/IOdrlProhibition.md +2 -1
- package/docs/reference/interfaces/IOdrlRule.md +2 -1
- package/docs/reference/interfaces/IOdrlSet.md +2 -1
- package/docs/reference/variables/ActionType.md +168 -141
- package/docs/reference/variables/OdrlTypes.md +0 -6
- package/package.json +3 -3
- package/dist/types/models/IOdrlPolicyMetadata.d.ts +0 -58
- package/dist/types/models/types/uriActionType.d.ts +0 -215
- package/docs/reference/interfaces/IOdrlPolicyMetadata.md +0 -86
- package/docs/reference/type-aliases/UriActionType.md +0 -6
- package/docs/reference/variables/UriActionType.md +0 -314
package/dist/types/index.d.ts
CHANGED
|
@@ -11,7 +11,6 @@ export * from "./models/IOdrlParty";
|
|
|
11
11
|
export * from "./models/IOdrlPartyCollection";
|
|
12
12
|
export * from "./models/IOdrlPermission";
|
|
13
13
|
export * from "./models/IOdrlPolicy";
|
|
14
|
-
export * from "./models/IOdrlPolicyMetadata";
|
|
15
14
|
export * from "./models/IOdrlProhibition";
|
|
16
15
|
export * from "./models/IOdrlRule";
|
|
17
16
|
export * from "./models/IOdrlSet";
|
|
@@ -27,4 +26,3 @@ export * from "./models/types/policyType";
|
|
|
27
26
|
export * from "./models/types/rightOperandType";
|
|
28
27
|
export * from "./models/types/ruleType";
|
|
29
28
|
export * from "./models/types/statusType";
|
|
30
|
-
export * from "./models/types/uriActionType";
|
|
@@ -4,6 +4,7 @@ import type { IOdrlLogicalConstraint } from "./IOdrlLogicalConstraint";
|
|
|
4
4
|
import type { ActionType } from "./types/actionType";
|
|
5
5
|
/**
|
|
6
6
|
* Interface for ODRL Actions.
|
|
7
|
+
* https://www.w3.org/TR/odrl-model/#action
|
|
7
8
|
*/
|
|
8
9
|
export interface IOdrlAction extends IJsonLdNodeObject {
|
|
9
10
|
/**
|
|
@@ -25,9 +26,9 @@ export interface IOdrlAction extends IJsonLdNodeObject {
|
|
|
25
26
|
/**
|
|
26
27
|
* Reference to the action this action is included in.
|
|
27
28
|
*/
|
|
28
|
-
includedIn?: ActionType;
|
|
29
|
+
includedIn?: ActionType | string;
|
|
29
30
|
/**
|
|
30
31
|
* References to actions this action implies.
|
|
31
32
|
*/
|
|
32
|
-
implies?: ActionType[];
|
|
33
|
+
implies?: (ActionType | string)[];
|
|
33
34
|
}
|
|
@@ -4,6 +4,7 @@ import type { OdrlTypes } from "./types/odrlTypes";
|
|
|
4
4
|
/**
|
|
5
5
|
* Interface representing an ODRL Agreement.
|
|
6
6
|
* An Agreement requires both an assigner and assignee (both agreeing parties).
|
|
7
|
+
* https://www.w3.org/TR/odrl-model/#policy-agreement
|
|
7
8
|
*/
|
|
8
9
|
export interface IOdrlAgreement extends IOdrlPolicy {
|
|
9
10
|
/**
|
|
@@ -2,6 +2,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
|
2
2
|
import type { IOdrlAssetCollection } from "./IOdrlAssetCollection";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for ODRL Assets.
|
|
5
|
+
* https://www.w3.org/TR/odrl-model/#asset
|
|
5
6
|
*/
|
|
6
7
|
export interface IOdrlAsset extends IJsonLdNodeObject {
|
|
7
8
|
/**
|
|
@@ -4,6 +4,7 @@ import type { IOdrlConstraint } from "./IOdrlConstraint";
|
|
|
4
4
|
* Interface for ODRL Asset Collections.
|
|
5
5
|
* An AssetCollection is a single resource representing a set of member resources,
|
|
6
6
|
* where all members of the set will be the subject of the Rule.
|
|
7
|
+
* https://www.w3.org/TR/odrl-model/#asset
|
|
7
8
|
*/
|
|
8
9
|
export interface IOdrlAssetCollection extends IOdrlAsset {
|
|
9
10
|
/**
|
|
@@ -4,6 +4,7 @@ import type { OperatorType } from "./types/operatorType";
|
|
|
4
4
|
import type { StatusType } from "./types/statusType";
|
|
5
5
|
/**
|
|
6
6
|
* Interface for ODRL Constraints.
|
|
7
|
+
* https://www.w3.org/TR/odrl-model/#constraint
|
|
7
8
|
*/
|
|
8
9
|
export interface IOdrlConstraint extends IJsonLdNodeObject {
|
|
9
10
|
/**
|
|
@@ -3,6 +3,7 @@ import type { IOdrlRule } from "./IOdrlRule";
|
|
|
3
3
|
* Interface for Duty Rules.
|
|
4
4
|
* A Duty is the obligation to exercise an action, with all refinements satisfied.
|
|
5
5
|
* A Duty is fulfilled if all constraints are satisfied and if its action has been exercised.
|
|
6
|
+
* https://www.w3.org/TR/odrl-model/#duty
|
|
6
7
|
*/
|
|
7
8
|
export interface IOdrlDuty extends IOdrlRule {
|
|
8
9
|
/**
|
|
@@ -3,6 +3,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
|
3
3
|
* Interface for ODRL Logical Constraints.
|
|
4
4
|
* A Logical Constraint compares two or more existing Constraints by one logical operator.
|
|
5
5
|
* If the comparison returns a logical match, then the Logical Constraint is satisfied.
|
|
6
|
+
* https://www.w3.org/TR/odrl-model/#constraint-logical
|
|
6
7
|
*/
|
|
7
8
|
export interface IOdrlLogicalConstraint extends IJsonLdNodeObject {
|
|
8
9
|
/**
|
|
@@ -4,6 +4,7 @@ import type { OdrlTypes } from "./types/odrlTypes";
|
|
|
4
4
|
/**
|
|
5
5
|
* Interface representing an ODRL Offer.
|
|
6
6
|
* An Offer requires an assigner (the party making the offer).
|
|
7
|
+
* https://www.w3.org/TR/odrl-model/#policy-offer
|
|
7
8
|
*/
|
|
8
9
|
export interface IOdrlOffer extends IOdrlPolicy {
|
|
9
10
|
/**
|
|
@@ -2,6 +2,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
|
2
2
|
import type { IOdrlPartyCollection } from "./IOdrlPartyCollection";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for ODRL Parties.
|
|
5
|
+
* https://www.w3.org/TR/odrl-model/#party
|
|
5
6
|
*/
|
|
6
7
|
export interface IOdrlParty extends IJsonLdNodeObject {
|
|
7
8
|
/**
|
|
@@ -3,6 +3,7 @@ import type { IOdrlParty } from "./IOdrlParty";
|
|
|
3
3
|
/**
|
|
4
4
|
* Interface for ODRL Party Collections.
|
|
5
5
|
* A PartyCollection identifies a collection of entities and is a subclass of Party.
|
|
6
|
+
* https://www.w3.org/TR/odrl-model/#party
|
|
6
7
|
*/
|
|
7
8
|
export interface IOdrlPartyCollection extends IOdrlParty {
|
|
8
9
|
/**
|
|
@@ -4,6 +4,7 @@ import type { IOdrlRule } from "./IOdrlRule";
|
|
|
4
4
|
* Interface for Permission Rules.
|
|
5
5
|
* A Permission allows an action to be exercised on an Asset
|
|
6
6
|
* if all constraints are satisfied and if all duties are fulfilled.
|
|
7
|
+
* https://www.w3.org/TR/odrl-model/#permission
|
|
7
8
|
*/
|
|
8
9
|
export interface IOdrlPermission extends IOdrlRule {
|
|
9
10
|
/**
|
|
@@ -11,6 +11,7 @@ import type { ConflictStrategyType } from "./types/conflictStrategyType";
|
|
|
11
11
|
import type { PolicyType } from "./types/policyType";
|
|
12
12
|
/**
|
|
13
13
|
* Interface representing an ODRL Policy.
|
|
14
|
+
* https://www.w3.org/TR/odrl-model/#policy
|
|
14
15
|
*/
|
|
15
16
|
export interface IOdrlPolicy extends IJsonLdNodeObject {
|
|
16
17
|
/**
|
|
@@ -50,7 +51,7 @@ export interface IOdrlPolicy extends IJsonLdNodeObject {
|
|
|
50
51
|
/**
|
|
51
52
|
* The action associated with the rule.
|
|
52
53
|
*/
|
|
53
|
-
action?: ActionType | IOdrlAction | (ActionType | IOdrlAction)[];
|
|
54
|
+
action?: ActionType | string | IOdrlAction | (ActionType | string | IOdrlAction)[];
|
|
54
55
|
/**
|
|
55
56
|
* The parent policy(ies) this policy inherits from.
|
|
56
57
|
* IRIs identifying the parent Policy(ies).
|
|
@@ -6,6 +6,7 @@ import type { IOdrlParty } from "./IOdrlParty";
|
|
|
6
6
|
import type { ActionType } from "./types/actionType";
|
|
7
7
|
/**
|
|
8
8
|
* Base interface for ODRL Rules.
|
|
9
|
+
* https://www.w3.org/TR/odrl-model/#rule
|
|
9
10
|
*/
|
|
10
11
|
export interface IOdrlRule extends IJsonLdNodeObject {
|
|
11
12
|
/**
|
|
@@ -15,7 +16,7 @@ export interface IOdrlRule extends IJsonLdNodeObject {
|
|
|
15
16
|
/**
|
|
16
17
|
* The action associated with the rule.
|
|
17
18
|
*/
|
|
18
|
-
action?: ActionType | IOdrlAction | (ActionType | IOdrlAction)[];
|
|
19
|
+
action?: ActionType | string | IOdrlAction | (ActionType | string | IOdrlAction)[];
|
|
19
20
|
/**
|
|
20
21
|
* The target asset for the rule.
|
|
21
22
|
*/
|
|
@@ -3,6 +3,7 @@ import type { OdrlTypes } from "./types/odrlTypes";
|
|
|
3
3
|
/**
|
|
4
4
|
* Interface representing an ODRL Set.
|
|
5
5
|
* A Set is a basic policy type with no specific party requirements.
|
|
6
|
+
* https://www.w3.org/TR/odrl-model/#policy-set
|
|
6
7
|
*/
|
|
7
8
|
export interface IOdrlSet extends IOdrlPolicy {
|
|
8
9
|
/**
|
|
@@ -4,209 +4,228 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export declare const ActionType: {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* The act of using an asset, covering any general usage where ownership does not change.
|
|
8
|
+
* This is the parent term for most permissions and prohibitions.
|
|
8
9
|
*/
|
|
9
10
|
readonly Use: "use";
|
|
10
11
|
/**
|
|
11
|
-
*
|
|
12
|
+
* The act of transferring the ownership of an asset in perpetuity to a third party.
|
|
12
13
|
*/
|
|
13
14
|
readonly Transfer: "transfer";
|
|
14
15
|
/**
|
|
15
|
-
*
|
|
16
|
-
*/
|
|
17
|
-
readonly AcceptTracking: "acceptTracking";
|
|
18
|
-
/**
|
|
19
|
-
* To use the Asset or parts of it as part of a composite collection.
|
|
16
|
+
* The act of using an asset (or parts of it) as part of a composite collection.
|
|
20
17
|
*/
|
|
21
18
|
readonly Aggregate: "aggregate";
|
|
22
19
|
/**
|
|
23
|
-
*
|
|
20
|
+
* The act of adding explanatory notations/commentaries to the asset.
|
|
24
21
|
*/
|
|
25
22
|
readonly Annotate: "annotate";
|
|
26
23
|
/**
|
|
27
|
-
*
|
|
24
|
+
* The act of anonymising all or parts of the asset, for example, to remove identifying particulars.
|
|
28
25
|
*/
|
|
29
26
|
readonly Anonymize: "anonymize";
|
|
30
27
|
/**
|
|
31
|
-
*
|
|
28
|
+
* The act of persistently storing the asset in a non-transient form.
|
|
32
29
|
*/
|
|
33
30
|
readonly Archive: "archive";
|
|
34
31
|
/**
|
|
35
|
-
*
|
|
32
|
+
* The act of multiple concurrent use of the asset.
|
|
36
33
|
*/
|
|
37
|
-
readonly
|
|
34
|
+
readonly ConcurrentUse: "concurrentUse";
|
|
38
35
|
/**
|
|
39
|
-
*
|
|
36
|
+
* The act of using the asset in a business environment where it may be traded for profit.
|
|
40
37
|
*/
|
|
41
|
-
readonly
|
|
38
|
+
readonly Commercialize: "commercialize";
|
|
42
39
|
/**
|
|
43
|
-
*
|
|
40
|
+
* The act of making an exact reproduction of the asset. Also identified as `reproduce`.
|
|
44
41
|
*/
|
|
45
|
-
readonly
|
|
42
|
+
readonly Copy: "copy";
|
|
46
43
|
/**
|
|
47
|
-
*
|
|
44
|
+
* The act of creating a new derivative asset from the original and editing or modifying it.
|
|
48
45
|
*/
|
|
49
|
-
readonly
|
|
46
|
+
readonly Derive: "derive";
|
|
50
47
|
/**
|
|
51
|
-
*
|
|
48
|
+
* The act of producing a digital copy of an asset from its analogue form.
|
|
52
49
|
*/
|
|
53
|
-
readonly
|
|
50
|
+
readonly Digitize: "digitize";
|
|
54
51
|
/**
|
|
55
|
-
*
|
|
52
|
+
* The act of making a transient visible rendering of the asset, such as displaying an image on a screen.
|
|
53
|
+
* Also identified as `present` in earlier versions.
|
|
56
54
|
*/
|
|
57
|
-
readonly
|
|
55
|
+
readonly Display: "display";
|
|
58
56
|
/**
|
|
59
|
-
*
|
|
57
|
+
* The act of publicly distributing, displaying, or performing the asset.
|
|
60
58
|
*/
|
|
61
|
-
readonly
|
|
59
|
+
readonly Distribute: "distribute";
|
|
62
60
|
/**
|
|
63
|
-
*
|
|
61
|
+
* The act of executing the asset, such as running a program or application.
|
|
64
62
|
*/
|
|
65
|
-
readonly
|
|
63
|
+
readonly Execute: "execute";
|
|
66
64
|
/**
|
|
67
|
-
*
|
|
65
|
+
* The act of extracting (replicating) unchanged parts of the asset for reuse.
|
|
68
66
|
*/
|
|
69
|
-
readonly
|
|
67
|
+
readonly Extract: "extract";
|
|
70
68
|
/**
|
|
71
|
-
*
|
|
69
|
+
* The act of extracting unchanged character(s) from the asset.
|
|
72
70
|
*/
|
|
73
|
-
readonly
|
|
71
|
+
readonly ExtractChar: "extractChar";
|
|
74
72
|
/**
|
|
75
|
-
*
|
|
73
|
+
* The act of extracting unchanged word(s) from the asset.
|
|
76
74
|
*/
|
|
77
|
-
readonly
|
|
75
|
+
readonly ExtractWord: "extractWord";
|
|
78
76
|
/**
|
|
79
|
-
*
|
|
77
|
+
* The act of extracting unchanged page(s) from the asset.
|
|
80
78
|
*/
|
|
81
|
-
readonly
|
|
79
|
+
readonly ExtractPage: "extractPage";
|
|
82
80
|
/**
|
|
83
|
-
*
|
|
81
|
+
* The act of recording the asset in an index, for example, a search engine database.
|
|
84
82
|
*/
|
|
85
|
-
readonly
|
|
83
|
+
readonly Index: "index";
|
|
86
84
|
/**
|
|
87
|
-
*
|
|
85
|
+
* The act of loading the asset onto a storage device ready for operation.
|
|
88
86
|
*/
|
|
89
|
-
readonly
|
|
87
|
+
readonly Install: "install";
|
|
90
88
|
/**
|
|
91
|
-
*
|
|
89
|
+
* The act of granting the use of the asset to third parties. Also identified as `sublicense` in earlier versions.
|
|
92
90
|
*/
|
|
93
|
-
readonly
|
|
91
|
+
readonly License: "license";
|
|
94
92
|
/**
|
|
95
|
-
*
|
|
93
|
+
* The act of making the asset available to a third-party for a fixed period with exchange of value.
|
|
96
94
|
*/
|
|
97
|
-
readonly
|
|
95
|
+
readonly Lease: "lease";
|
|
98
96
|
/**
|
|
99
|
-
*
|
|
97
|
+
* The act of making the asset available to a third-party for a fixed period without exchange of value.
|
|
100
98
|
*/
|
|
101
|
-
readonly
|
|
99
|
+
readonly Lend: "lend";
|
|
102
100
|
/**
|
|
103
|
-
*
|
|
101
|
+
* The act of updating existing content of the asset without creating a new one.
|
|
104
102
|
*/
|
|
105
|
-
readonly
|
|
103
|
+
readonly Modify: "modify";
|
|
106
104
|
/**
|
|
107
|
-
*
|
|
105
|
+
* The act of moving the asset from one digital location to another and deleting the original.
|
|
108
106
|
*/
|
|
109
|
-
readonly
|
|
107
|
+
readonly Move: "move";
|
|
110
108
|
/**
|
|
111
|
-
*
|
|
109
|
+
* The act of rendering the asset into audio and/or video form.
|
|
112
110
|
*/
|
|
113
|
-
readonly
|
|
111
|
+
readonly Play: "play";
|
|
114
112
|
/**
|
|
115
|
-
*
|
|
113
|
+
* The act of providing a short preview of the asset.
|
|
116
114
|
*/
|
|
117
|
-
readonly
|
|
115
|
+
readonly Preview: "preview";
|
|
118
116
|
/**
|
|
119
|
-
*
|
|
117
|
+
* The act of rendering the asset onto paper or hard copy form.
|
|
120
118
|
*/
|
|
121
|
-
readonly
|
|
119
|
+
readonly Print: "print";
|
|
122
120
|
/**
|
|
123
|
-
*
|
|
121
|
+
* The act of obtaining data from the asset, such as a database record.
|
|
124
122
|
*/
|
|
125
|
-
readonly
|
|
123
|
+
readonly Read: "read";
|
|
126
124
|
/**
|
|
127
|
-
*
|
|
125
|
+
* The act of using the asset for a purpose other than its intended purpose.
|
|
128
126
|
*/
|
|
129
|
-
readonly
|
|
127
|
+
readonly SecondaryUse: "secondaryUse";
|
|
130
128
|
/**
|
|
131
|
-
*
|
|
129
|
+
* The act of non-commercial reproduction and distribution of the asset to third-parties.
|
|
132
130
|
*/
|
|
133
|
-
readonly
|
|
131
|
+
readonly Share: "share";
|
|
134
132
|
/**
|
|
135
|
-
*
|
|
133
|
+
* The act of sharing the asset to parties in close proximity to the owner.
|
|
136
134
|
*/
|
|
137
|
-
readonly
|
|
135
|
+
readonly AdhocShare: "adhocShare";
|
|
138
136
|
/**
|
|
139
|
-
*
|
|
137
|
+
* The act of distributing any derivative asset under the same terms as the original.
|
|
140
138
|
*/
|
|
141
|
-
readonly
|
|
139
|
+
readonly ShareAlike: "shareAlike";
|
|
142
140
|
/**
|
|
143
|
-
*
|
|
141
|
+
* The act of a system reading the text of the asset out loud.
|
|
144
142
|
*/
|
|
145
|
-
readonly
|
|
143
|
+
readonly TextToSpeech: "textToSpeech";
|
|
146
144
|
/**
|
|
147
|
-
*
|
|
145
|
+
* The act of translating the asset's original language into another, creating a new derivative asset.
|
|
148
146
|
*/
|
|
149
|
-
readonly
|
|
147
|
+
readonly Translate: "translate";
|
|
150
148
|
/**
|
|
151
|
-
*
|
|
149
|
+
* The act of transforming the asset into a different digital format.
|
|
152
150
|
*/
|
|
153
|
-
readonly
|
|
151
|
+
readonly Transform: "transform";
|
|
154
152
|
/**
|
|
155
|
-
*
|
|
153
|
+
* The act of unloading the asset from a storage device, making it no longer accessible.
|
|
156
154
|
*/
|
|
157
|
-
readonly
|
|
155
|
+
readonly Uninstall: "uninstall";
|
|
158
156
|
/**
|
|
159
|
-
*
|
|
157
|
+
* The act of applying a watermark to the asset.
|
|
160
158
|
*/
|
|
161
|
-
readonly
|
|
159
|
+
readonly Watermark: "watermark";
|
|
162
160
|
/**
|
|
163
|
-
*
|
|
161
|
+
* The act of writing to or modifying the asset.
|
|
164
162
|
*/
|
|
165
|
-
readonly
|
|
163
|
+
readonly Write: "write";
|
|
166
164
|
/**
|
|
167
|
-
*
|
|
165
|
+
* The act of adding to the end of an asset, for example, a database record.
|
|
166
|
+
* Also identified as `appendTo`.
|
|
167
|
+
*/
|
|
168
|
+
readonly Append: "append";
|
|
169
|
+
/**
|
|
170
|
+
* The act of giving away the asset in perpetuity without exchange of value, requiring the original to be deleted.
|
|
171
|
+
*/
|
|
172
|
+
readonly Give: "give";
|
|
173
|
+
/**
|
|
174
|
+
* The act of trading the asset in exchange for compensation, requiring the original to be deleted.
|
|
168
175
|
*/
|
|
169
176
|
readonly Sell: "sell";
|
|
170
177
|
/**
|
|
171
|
-
*
|
|
178
|
+
* The act of accepting that the use of the asset may be tracked by a specified party.
|
|
172
179
|
*/
|
|
173
|
-
readonly
|
|
180
|
+
readonly AcceptTracking: "acceptTracking";
|
|
174
181
|
/**
|
|
175
|
-
*
|
|
182
|
+
* The act of keeping a policy notice attached to the asset.
|
|
176
183
|
*/
|
|
177
|
-
readonly
|
|
184
|
+
readonly AttachPolicy: "attachPolicy";
|
|
178
185
|
/**
|
|
179
|
-
*
|
|
186
|
+
* The act of attaching the source of the asset and its derivatives.
|
|
180
187
|
*/
|
|
181
|
-
readonly
|
|
188
|
+
readonly AttachSource: "attachSource";
|
|
182
189
|
/**
|
|
183
|
-
*
|
|
190
|
+
* The act of attributing the asset to a specified party.
|
|
184
191
|
*/
|
|
185
|
-
readonly
|
|
192
|
+
readonly Attribute: "attribute";
|
|
186
193
|
/**
|
|
187
|
-
*
|
|
194
|
+
* The act of compensating a specified party by some amount for use of the asset.
|
|
188
195
|
*/
|
|
189
|
-
readonly
|
|
196
|
+
readonly Compensate: "compensate";
|
|
190
197
|
/**
|
|
191
|
-
*
|
|
198
|
+
* The act of permanently removing all copies of the asset.
|
|
192
199
|
*/
|
|
193
|
-
readonly
|
|
200
|
+
readonly Delete: "delete";
|
|
194
201
|
/**
|
|
195
|
-
*
|
|
202
|
+
* The act of requiring the assigner to ensure a permission is exclusive to the assignee.
|
|
196
203
|
*/
|
|
197
|
-
readonly
|
|
204
|
+
readonly EnsureExclusivity: "ensureExclusivity";
|
|
198
205
|
/**
|
|
199
|
-
*
|
|
206
|
+
* The act of including other related assets to fulfil the function.
|
|
200
207
|
*/
|
|
201
|
-
readonly
|
|
208
|
+
readonly Include: "include";
|
|
202
209
|
/**
|
|
203
|
-
*
|
|
210
|
+
* The act of informing a party that an action has been performed on the asset.
|
|
204
211
|
*/
|
|
205
|
-
readonly
|
|
212
|
+
readonly Inform: "inform";
|
|
206
213
|
/**
|
|
207
|
-
*
|
|
214
|
+
* The act of specifying a policy for third-party use of the asset.
|
|
208
215
|
*/
|
|
209
|
-
readonly
|
|
216
|
+
readonly NextPolicy: "nextPolicy";
|
|
217
|
+
/**
|
|
218
|
+
* The act of requiring explicit consent from a party to perform an action.
|
|
219
|
+
*/
|
|
220
|
+
readonly ObtainConsent: "obtainConsent";
|
|
221
|
+
/**
|
|
222
|
+
* The act of paying a financial amount to a party for use of the asset.
|
|
223
|
+
*/
|
|
224
|
+
readonly Pay: "pay";
|
|
225
|
+
/**
|
|
226
|
+
* The act of performing a manual review of the terms associated with the asset.
|
|
227
|
+
*/
|
|
228
|
+
readonly ReviewPolicy: "reviewPolicy";
|
|
210
229
|
};
|
|
211
230
|
/**
|
|
212
231
|
* The types for ODRL Actions.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @twin.org/standards-w3c-odrl - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.7](https://github.com/twinfoundation/standards/compare/standards-w3c-odrl-v0.0.2-next.6...standards-w3c-odrl-v0.0.2-next.7) (2025-09-15)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **standards-w3c-odrl:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/standards-w3c-vcard bumped from 0.0.2-next.6 to 0.0.2-next.7
|
|
16
|
+
* @twin.org/standards-dublin-core bumped from 0.0.2-next.6 to 0.0.2-next.7
|
|
17
|
+
|
|
18
|
+
## [0.0.2-next.6](https://github.com/twinfoundation/standards/compare/standards-w3c-odrl-v0.0.2-next.5...standards-w3c-odrl-v0.0.2-next.6) (2025-09-12)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
|
|
23
|
+
* update ODRL actions and allow custom actions ([c517dad](https://github.com/twinfoundation/standards/commit/c517dad09d68f5dee9117c6cb142f75caad098c4))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/standards-w3c-vcard bumped from 0.0.2-next.5 to 0.0.2-next.6
|
|
31
|
+
* @twin.org/standards-dublin-core bumped from 0.0.2-next.5 to 0.0.2-next.6
|
|
32
|
+
|
|
3
33
|
## [0.0.2-next.5](https://github.com/twinfoundation/standards/compare/standards-w3c-odrl-v0.0.2-next.4...standards-w3c-odrl-v0.0.2-next.5) (2025-09-12)
|
|
4
34
|
|
|
5
35
|
|
package/docs/reference/index.md
CHANGED
|
@@ -18,7 +18,6 @@
|
|
|
18
18
|
- [IOdrlPartyCollection](interfaces/IOdrlPartyCollection.md)
|
|
19
19
|
- [IOdrlPermission](interfaces/IOdrlPermission.md)
|
|
20
20
|
- [IOdrlPolicy](interfaces/IOdrlPolicy.md)
|
|
21
|
-
- [IOdrlPolicyMetadata](interfaces/IOdrlPolicyMetadata.md)
|
|
22
21
|
- [IOdrlProhibition](interfaces/IOdrlProhibition.md)
|
|
23
22
|
- [IOdrlRule](interfaces/IOdrlRule.md)
|
|
24
23
|
- [IOdrlSet](interfaces/IOdrlSet.md)
|
|
@@ -37,7 +36,6 @@
|
|
|
37
36
|
- [RightOperandType](type-aliases/RightOperandType.md)
|
|
38
37
|
- [RuleType](type-aliases/RuleType.md)
|
|
39
38
|
- [StatusType](type-aliases/StatusType.md)
|
|
40
|
-
- [UriActionType](type-aliases/UriActionType.md)
|
|
41
39
|
|
|
42
40
|
## Variables
|
|
43
41
|
|
|
@@ -52,4 +50,3 @@
|
|
|
52
50
|
- [RightOperandType](variables/RightOperandType.md)
|
|
53
51
|
- [RuleType](variables/RuleType.md)
|
|
54
52
|
- [StatusType](variables/StatusType.md)
|
|
55
|
-
- [UriActionType](variables/UriActionType.md)
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Interface: IOdrlAction
|
|
2
2
|
|
|
3
3
|
Interface for ODRL Actions.
|
|
4
|
+
https://www.w3.org/TR/odrl-model/#action
|
|
4
5
|
|
|
5
6
|
## Extends
|
|
6
7
|
|
|
@@ -48,7 +49,7 @@ Refinements applied to the action.
|
|
|
48
49
|
|
|
49
50
|
### includedIn?
|
|
50
51
|
|
|
51
|
-
> `optional` **includedIn**:
|
|
52
|
+
> `optional` **includedIn**: `string`
|
|
52
53
|
|
|
53
54
|
Reference to the action this action is included in.
|
|
54
55
|
|
|
@@ -56,6 +57,6 @@ Reference to the action this action is included in.
|
|
|
56
57
|
|
|
57
58
|
### implies?
|
|
58
59
|
|
|
59
|
-
> `optional` **implies**:
|
|
60
|
+
> `optional` **implies**: `string`[]
|
|
60
61
|
|
|
61
62
|
References to actions this action implies.
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Interface representing an ODRL Agreement.
|
|
4
4
|
An Agreement requires both an assigner and assignee (both agreeing parties).
|
|
5
|
+
https://www.w3.org/TR/odrl-model/#policy-agreement
|
|
5
6
|
|
|
6
7
|
## Extends
|
|
7
8
|
|
|
@@ -104,7 +105,7 @@ The target asset for the rule.
|
|
|
104
105
|
|
|
105
106
|
### action?
|
|
106
107
|
|
|
107
|
-
> `optional` **action**:
|
|
108
|
+
> `optional` **action**: `string` \| [`IOdrlAction`](IOdrlAction.md) \| (`string` \| [`IOdrlAction`](IOdrlAction.md))[]
|
|
108
109
|
|
|
109
110
|
The action associated with the rule.
|
|
110
111
|
|