@twin.org/standards-w3c-odrl 0.0.1 → 0.0.2-next.10

package/dist/types/index.d.ts

@@ -11,7 +11,6 @@ export * from "./models/IOdrlParty";
 export * from "./models/IOdrlPartyCollection";
 export * from "./models/IOdrlPermission";
 export * from "./models/IOdrlPolicy";
-export * from "./models/IOdrlPolicyMetadata";
 export * from "./models/IOdrlProhibition";
 export * from "./models/IOdrlRule";
 export * from "./models/IOdrlSet";
@@ -27,4 +26,3 @@ export * from "./models/types/policyType";
 export * from "./models/types/rightOperandType";
 export * from "./models/types/ruleType";
 export * from "./models/types/statusType";
-export * from "./models/types/uriActionType";

package/dist/types/models/IOdrlAction.d.ts

@@ -4,6 +4,7 @@ import type { IOdrlLogicalConstraint } from "./IOdrlLogicalConstraint";
 import type { ActionType } from "./types/actionType";
 /**
  * Interface for ODRL Actions.
+ * https://www.w3.org/TR/odrl-model/#action
  */
 export interface IOdrlAction extends IJsonLdNodeObject {
     /**
@@ -25,9 +26,9 @@ export interface IOdrlAction extends IJsonLdNodeObject {
     /**
      * Reference to the action this action is included in.
      */
-    includedIn?: ActionType;
+    includedIn?: ActionType | string;
     /**
      * References to actions this action implies.
      */
-    implies?: ActionType[];
+    implies?: (ActionType | string)[];
 }

package/dist/types/models/IOdrlAgreement.d.ts

@@ -4,6 +4,7 @@ import type { OdrlTypes } from "./types/odrlTypes";
 /**
  * Interface representing an ODRL Agreement.
  * An Agreement requires both an assigner and assignee (both agreeing parties).
+ * https://www.w3.org/TR/odrl-model/#policy-agreement
  */
 export interface IOdrlAgreement extends IOdrlPolicy {
     /**

package/dist/types/models/IOdrlAsset.d.ts

@@ -2,6 +2,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IOdrlAssetCollection } from "./IOdrlAssetCollection";
 /**
  * Interface for ODRL Assets.
+ * https://www.w3.org/TR/odrl-model/#asset
  */
 export interface IOdrlAsset extends IJsonLdNodeObject {
     /**

package/dist/types/models/IOdrlAssetCollection.d.ts

@@ -4,6 +4,7 @@ import type { IOdrlConstraint } from "./IOdrlConstraint";
  * Interface for ODRL Asset Collections.
  * An AssetCollection is a single resource representing a set of member resources,
  * where all members of the set will be the subject of the Rule.
+ * https://www.w3.org/TR/odrl-model/#asset
  */
 export interface IOdrlAssetCollection extends IOdrlAsset {
     /**

package/dist/types/models/IOdrlConstraint.d.ts

@@ -4,6 +4,7 @@ import type { OperatorType } from "./types/operatorType";
 import type { StatusType } from "./types/statusType";
 /**
  * Interface for ODRL Constraints.
+ * https://www.w3.org/TR/odrl-model/#constraint
  */
 export interface IOdrlConstraint extends IJsonLdNodeObject {
     /**

package/dist/types/models/IOdrlDuty.d.ts

@@ -3,6 +3,7 @@ import type { IOdrlRule } from "./IOdrlRule";
  * Interface for Duty Rules.
  * A Duty is the obligation to exercise an action, with all refinements satisfied.
  * A Duty is fulfilled if all constraints are satisfied and if its action has been exercised.
+ * https://www.w3.org/TR/odrl-model/#duty
  */
 export interface IOdrlDuty extends IOdrlRule {
     /**

package/dist/types/models/IOdrlLogicalConstraint.d.ts

@@ -3,6 +3,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
  * Interface for ODRL Logical Constraints.
  * A Logical Constraint compares two or more existing Constraints by one logical operator.
  * If the comparison returns a logical match, then the Logical Constraint is satisfied.
+ * https://www.w3.org/TR/odrl-model/#constraint-logical
  */
 export interface IOdrlLogicalConstraint extends IJsonLdNodeObject {
     /**

package/dist/types/models/IOdrlOffer.d.ts

@@ -4,6 +4,7 @@ import type { OdrlTypes } from "./types/odrlTypes";
 /**
  * Interface representing an ODRL Offer.
  * An Offer requires an assigner (the party making the offer).
+ * https://www.w3.org/TR/odrl-model/#policy-offer
  */
 export interface IOdrlOffer extends IOdrlPolicy {
     /**

package/dist/types/models/IOdrlParty.d.ts

@@ -2,6 +2,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IOdrlPartyCollection } from "./IOdrlPartyCollection";
 /**
  * Interface for ODRL Parties.
+ * https://www.w3.org/TR/odrl-model/#party
  */
 export interface IOdrlParty extends IJsonLdNodeObject {
     /**

package/dist/types/models/IOdrlPartyCollection.d.ts

@@ -3,6 +3,7 @@ import type { IOdrlParty } from "./IOdrlParty";
 /**
  * Interface for ODRL Party Collections.
  * A PartyCollection identifies a collection of entities and is a subclass of Party.
+ * https://www.w3.org/TR/odrl-model/#party
  */
 export interface IOdrlPartyCollection extends IOdrlParty {
     /**

package/dist/types/models/IOdrlPermission.d.ts

@@ -4,6 +4,7 @@ import type { IOdrlRule } from "./IOdrlRule";
  * Interface for Permission Rules.
  * A Permission allows an action to be exercised on an Asset
  * if all constraints are satisfied and if all duties are fulfilled.
+ * https://www.w3.org/TR/odrl-model/#permission
  */
 export interface IOdrlPermission extends IOdrlRule {
     /**

package/dist/types/models/IOdrlPolicy.d.ts

@@ -11,6 +11,7 @@ import type { ConflictStrategyType } from "./types/conflictStrategyType";
 import type { PolicyType } from "./types/policyType";
 /**
  * Interface representing an ODRL Policy.
+ * https://www.w3.org/TR/odrl-model/#policy
  */
 export interface IOdrlPolicy extends IJsonLdNodeObject {
     /**
@@ -50,7 +51,7 @@ export interface IOdrlPolicy extends IJsonLdNodeObject {
     /**
      * The action associated with the rule.
      */
-    action?: ActionType | IOdrlAction | (ActionType | IOdrlAction)[];
+    action?: ActionType | string | IOdrlAction | (ActionType | string | IOdrlAction)[];
     /**
      * The parent policy(ies) this policy inherits from.
      * IRIs identifying the parent Policy(ies).

package/dist/types/models/IOdrlProhibition.d.ts

@@ -2,6 +2,7 @@ import type { IOdrlDuty } from "./IOdrlDuty";
 import type { IOdrlRule } from "./IOdrlRule";
 /**
  * Interface for Prohibition Rules.
+ * https://www.w3.org/TR/odrl-model/#prohibition
  */
 export interface IOdrlProhibition extends IOdrlRule {
     /**

package/dist/types/models/IOdrlRule.d.ts

@@ -6,6 +6,7 @@ import type { IOdrlParty } from "./IOdrlParty";
 import type { ActionType } from "./types/actionType";
 /**
  * Base interface for ODRL Rules.
+ * https://www.w3.org/TR/odrl-model/#rule
  */
 export interface IOdrlRule extends IJsonLdNodeObject {
     /**
@@ -15,7 +16,7 @@ export interface IOdrlRule extends IJsonLdNodeObject {
     /**
      * The action associated with the rule.
      */
-    action?: ActionType | IOdrlAction | (ActionType | IOdrlAction)[];
+    action?: ActionType | string | IOdrlAction | (ActionType | string | IOdrlAction)[];
     /**
      * The target asset for the rule.
      */

package/dist/types/models/IOdrlSet.d.ts

@@ -3,6 +3,7 @@ import type { OdrlTypes } from "./types/odrlTypes";
 /**
  * Interface representing an ODRL Set.
  * A Set is a basic policy type with no specific party requirements.
+ * https://www.w3.org/TR/odrl-model/#policy-set
  */
 export interface IOdrlSet extends IOdrlPolicy {
     /**

package/dist/types/models/odrlContexts.d.ts

@@ -2,14 +2,14 @@
  * The contexts for ODRL.
  */
 export declare const OdrlContexts: {
-    /**
-     * The context root for ODRL.
-     */
-    readonly ContextRedirect: "https://www.w3.org/ns/odrl.jsonld";
     /**
      * The context root for ODRL vocabulary.
      */
     readonly ContextRoot: "https://www.w3.org/ns/odrl/2/";
+    /**
+     * The context root for ODRL.
+     */
+    readonly ContextRedirect: "https://www.w3.org/ns/odrl.jsonld";
 };
 /**
  * The contexts for ODRL.

package/dist/types/models/types/actionType.d.ts

@@ -4,209 +4,228 @@
  */
 export declare const ActionType: {
     /**
-     * To use the Asset - actions that involve general usage by parties.
+     * The act of using an asset, covering any general usage where ownership does not change.
+     * This is the parent term for most permissions and prohibitions.
      */
     readonly Use: "use";
     /**
-     * To transfer the ownership to third parties.
+     * The act of transferring the ownership of an asset in perpetuity to a third party.
      */
     readonly Transfer: "transfer";
     /**
-     * To accept that the use of the Asset may be tracked.
-     */
-    readonly AcceptTracking: "acceptTracking";
-    /**
-     * To use the Asset or parts of it as part of a composite collection.
+     * The act of using an asset (or parts of it) as part of a composite collection.
      */
     readonly Aggregate: "aggregate";
     /**
-     * To add explanatory notations/commentaries to the Asset without modifying the Asset in any other way.
+     * The act of adding explanatory notations/commentaries to the asset.
      */
     readonly Annotate: "annotate";
     /**
-     * To anonymize all or parts of the Asset.
+     * The act of anonymising all or parts of the asset, for example, to remove identifying particulars.
      */
     readonly Anonymize: "anonymize";
     /**
-     * To store the Asset (in a non-transient form).
+     * The act of persistently storing the asset in a non-transient form.
      */
     readonly Archive: "archive";
     /**
-     * To attribute the use of the Asset.
+     * The act of multiple concurrent use of the asset.
      */
-    readonly Attribute: "attribute";
+    readonly ConcurrentUse: "concurrentUse";
     /**
-     * Credit be given to copyright holder and/or author.
+     * The act of using the asset in a business environment where it may be traded for profit.
      */
-    readonly Attribution: "attribution";
+    readonly Commercialize: "commercialize";
     /**
-     * Exercising rights for commercial purposes.
+     * The act of making an exact reproduction of the asset. Also identified as `reproduce`.
      */
-    readonly CommercialUse: "commercialUse";
+    readonly Copy: "copy";
     /**
-     * To compensate by transfer of some amount of value for using or selling the Asset.
+     * The act of creating a new derivative asset from the original and editing or modifying it.
      */
-    readonly Compensate: "compensate";
+    readonly Derive: "derive";
     /**
-     * To create multiple copies of the Asset that are being concurrently used.
+     * The act of producing a digital copy of an asset from its analogue form.
      */
-    readonly ConcurrentUse: "concurrentUse";
+    readonly Digitize: "digitize";
     /**
-     * To permanently remove all copies of the Asset after it has been used.
+     * The act of making a transient visible rendering of the asset, such as displaying an image on a screen.
+     * Also identified as `present` in earlier versions.
      */
-    readonly Delete: "delete";
+    readonly Display: "display";
     /**
-     * To create a new derivative Asset from this Asset and to edit or modify the derivative.
+     * The act of publicly distributing, displaying, or performing the asset.
      */
-    readonly Derive: "derive";
+    readonly Distribute: "distribute";
     /**
-     * Distribution of derivative works.
+     * The act of executing the asset, such as running a program or application.
      */
-    readonly DerivativeWorks: "derivativeWorks";
+    readonly Execute: "execute";
     /**
-     * To produce a digital copy of (or otherwise digitize) the Asset from its analogue form.
+     * The act of extracting (replicating) unchanged parts of the asset for reuse.
      */
-    readonly Digitize: "digitize";
+    readonly Extract: "extract";
     /**
-     * To create a static and transient rendition of an Asset.
+     * The act of extracting unchanged character(s) from the asset.
      */
-    readonly Display: "display";
+    readonly ExtractChar: "extractChar";
     /**
-     * To supply the Asset to third-parties.
+     * The act of extracting unchanged word(s) from the asset.
      */
-    readonly Distribute: "distribute";
+    readonly ExtractWord: "extractWord";
     /**
-     * Distribution, public display, and publicly performance.
+     * The act of extracting unchanged page(s) from the asset.
      */
-    readonly Distribution: "distribution";
+    readonly ExtractPage: "extractPage";
     /**
-     * To ensure that the Rule on the Asset is exclusive.
+     * The act of recording the asset in an index, for example, a search engine database.
      */
-    readonly EnsureExclusivity: "ensureExclusivity";
+    readonly Index: "index";
     /**
-     * To run the computer program Asset.
+     * The act of loading the asset onto a storage device ready for operation.
      */
-    readonly Execute: "execute";
+    readonly Install: "install";
     /**
-     * To extract parts of the Asset and to use it as a new Asset.
+     * The act of granting the use of the asset to third parties. Also identified as `sublicense` in earlier versions.
      */
-    readonly Extract: "extract";
+    readonly License: "license";
     /**
-     * To transfer the ownership without compensation and while deleting the original asset.
+     * The act of making the asset available to a third-party for a fixed period with exchange of value.
      */
-    readonly Give: "give";
+    readonly Lease: "lease";
     /**
-     * To grant the use of the Asset to third parties.
+     * The act of making the asset available to a third-party for a fixed period without exchange of value.
      */
-    readonly GrantUse: "grantUse";
+    readonly Lend: "lend";
     /**
-     * To include other related assets in the Asset.
+     * The act of updating existing content of the asset without creating a new one.
      */
-    readonly Include: "include";
+    readonly Modify: "modify";
     /**
-     * To record the Asset in an index.
+     * The act of moving the asset from one digital location to another and deleting the original.
      */
-    readonly Index: "index";
+    readonly Move: "move";
     /**
-     * To inform that an action has been performed on or in relation to the Asset.
+     * The act of rendering the asset into audio and/or video form.
      */
-    readonly Inform: "inform";
+    readonly Play: "play";
     /**
-     * To load the computer program Asset onto a storage device.
+     * The act of providing a short preview of the asset.
      */
-    readonly Install: "install";
+    readonly Preview: "preview";
     /**
-     * To change existing content of the Asset without creating a new asset.
+     * The act of rendering the asset onto paper or hard copy form.
      */
-    readonly Modify: "modify";
+    readonly Print: "print";
     /**
-     * To move the Asset from one digital location to another including deleting the original copy.
+     * The act of obtaining data from the asset, such as a database record.
      */
-    readonly Move: "move";
+    readonly Read: "read";
     /**
-     * To grant the specified Policy to a third party for their use of the Asset.
+     * The act of using the asset for a purpose other than its intended purpose.
      */
-    readonly NextPolicy: "nextPolicy";
+    readonly SecondaryUse: "secondaryUse";
     /**
-     * Copyright and license notices be kept intact.
+     * The act of non-commercial reproduction and distribution of the asset to third-parties.
      */
-    readonly Notice: "notice";
+    readonly Share: "share";
     /**
-     * To obtain verifiable consent to perform the requested action.
+     * The act of sharing the asset to parties in close proximity to the owner.
      */
-    readonly ObtainConsent: "obtainConsent";
+    readonly AdhocShare: "adhocShare";
     /**
-     * To create a sequential and transient rendition of an Asset.
+     * The act of distributing any derivative asset under the same terms as the original.
      */
-    readonly Play: "play";
+    readonly ShareAlike: "shareAlike";
     /**
-     * To publicly perform the Asset.
+     * The act of a system reading the text of the asset out loud.
      */
-    readonly Present: "present";
+    readonly TextToSpeech: "textToSpeech";
     /**
-     * To create a tangible and permanent rendition of an Asset.
+     * The act of translating the asset's original language into another, creating a new derivative asset.
      */
-    readonly Print: "print";
+    readonly Translate: "translate";
     /**
-     * To obtain data from the Asset.
+     * The act of transforming the asset into a different digital format.
      */
-    readonly Read: "read";
+    readonly Transform: "transform";
     /**
-     * To make duplicate copies of the Asset in any material form.
+     * The act of unloading the asset from a storage device, making it no longer accessible.
      */
-    readonly Reproduce: "reproduce";
+    readonly Uninstall: "uninstall";
     /**
-     * Making multiple copies.
+     * The act of applying a watermark to the asset.
      */
-    readonly Reproduction: "reproduction";
+    readonly Watermark: "watermark";
     /**
-     * To review the Policy applicable to the Asset.
+     * The act of writing to or modifying the asset.
      */
-    readonly ReviewPolicy: "reviewPolicy";
+    readonly Write: "write";
     /**
-     * To transfer the ownership with compensation and while deleting the original asset.
+     * The act of adding to the end of an asset, for example, a database record.
+     * Also identified as `appendTo`.
+     */
+    readonly Append: "append";
+    /**
+     * The act of giving away the asset in perpetuity without exchange of value, requiring the original to be deleted.
+     */
+    readonly Give: "give";
+    /**
+     * The act of trading the asset in exchange for compensation, requiring the original to be deleted.
      */
     readonly Sell: "sell";
     /**
-     * Derivative works be licensed under the same terms or compatible terms.
+     * The act of accepting that the use of the asset may be tracked by a specified party.
      */
-    readonly ShareAlike: "shareAlike";
+    readonly AcceptTracking: "acceptTracking";
     /**
-     * Permits commercial derivatives, but only non-commercial distribution.
+     * The act of keeping a policy notice attached to the asset.
      */
-    readonly Sharing: "sharing";
+    readonly AttachPolicy: "attachPolicy";
     /**
-     * Source code must be provided when exercising some rights.
+     * The act of attaching the source of the asset and its derivatives.
      */
-    readonly SourceCode: "sourceCode";
+    readonly AttachSource: "attachSource";
     /**
-     * To deliver the Asset in real-time.
+     * The act of attributing the asset to a specified party.
      */
-    readonly Stream: "stream";
+    readonly Attribute: "attribute";
     /**
-     * To use the Asset in timed relations with media elements of another Asset.
+     * The act of compensating a specified party by some amount for use of the asset.
      */
-    readonly Synchronize: "synchronize";
+    readonly Compensate: "compensate";
     /**
-     * To have a text Asset read out loud.
+     * The act of permanently removing all copies of the asset.
      */
-    readonly TextToSpeech: "textToSpeech";
+    readonly Delete: "delete";
     /**
-     * To convert the Asset into a different format.
+     * The act of requiring the assigner to ensure a permission is exclusive to the assignee.
      */
-    readonly Transform: "transform";
+    readonly EnsureExclusivity: "ensureExclusivity";
     /**
-     * To translate the Asset into another natural language.
+     * The act of including other related assets to fulfil the function.
      */
-    readonly Translate: "translate";
+    readonly Include: "include";
     /**
-     * To unload and delete the computer program Asset.
+     * The act of informing a party that an action has been performed on the asset.
      */
-    readonly Uninstall: "uninstall";
+    readonly Inform: "inform";
     /**
-     * To apply a watermark to the Asset.
+     * The act of specifying a policy for third-party use of the asset.
      */
-    readonly Watermark: "watermark";
+    readonly NextPolicy: "nextPolicy";
+    /**
+     * The act of requiring explicit consent from a party to perform an action.
+     */
+    readonly ObtainConsent: "obtainConsent";
+    /**
+     * The act of paying a financial amount to a party for use of the asset.
+     */
+    readonly Pay: "pay";
+    /**
+     * The act of performing a manual review of the terms associated with the asset.
+     */
+    readonly ReviewPolicy: "reviewPolicy";
 };
 /**
  * The types for ODRL Actions.

package/dist/types/models/types/odrlTypes.d.ts

@@ -66,10 +66,6 @@ export declare const OdrlTypes: {
      * ContextType.
      */
     readonly ContextType: "ContextType";
-    /**
-     * PolicyMetadata type.
-     */
-    readonly PolicyMetadata: "PolicyMetadata";
 };
 /**
  * The types for ODRL.