@twin.org/standards-w3c-odrl 0.0.1-next.21

package/dist/cjs/index.cjs

@@ -0,0 +1,911 @@
+'use strict';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts for ODRL.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const OdrlContexts = {
+    /**
+     * The context root for ODRL.
+     */
+    Context: "https://www.w3.org/ns/odrl.jsonld",
+    /**
+     * The context root for ODRL vocabulary.
+     */
+    ContextVocabulary: "https://www.w3.org/ns/odrl/2/",
+    /**
+     * The context root for Dublin Core Terms.
+     */
+    ContextDcTerms: "https://purl.org/dc/terms/",
+    /**
+     * The context root for RDF.
+     */
+    ContextRdf: "https://www.w3.org/1999/02/22-rdf-syntax-ns#",
+    /**
+     * The context root for XSD.
+     */
+    ContextXsd: "https://www.w3.org/2001/XMLSchema#"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const OdrlTypes = {
+    /**
+     * Policy type.
+     */
+    Policy: "Policy",
+    /**
+     * Set type (subclass of Policy).
+     */
+    Set: "Set",
+    /**
+     * Offer type (subclass of Policy).
+     */
+    Offer: "Offer",
+    /**
+     * Agreement type (subclass of Policy).
+     */
+    Agreement: "Agreement",
+    /**
+     * Asset type.
+     */
+    Asset: "Asset",
+    /**
+     * AssetCollection type.
+     */
+    AssetCollection: "AssetCollection",
+    /**
+     * Party type.
+     */
+    Party: "Party",
+    /**
+     * PartyCollection type.
+     */
+    PartyCollection: "PartyCollection",
+    /**
+     * Action type.
+     */
+    Action: "Action",
+    /**
+     * Rule type.
+     */
+    Rule: "Rule",
+    /**
+     * Permission type (subclass of Rule).
+     */
+    Permission: "Permission",
+    /**
+     * Prohibition type (subclass of Rule).
+     */
+    Prohibition: "Prohibition",
+    /**
+     * Duty type (subclass of Rule).
+     */
+    Duty: "Duty",
+    /**
+     * Constraint type.
+     */
+    Constraint: "Constraint",
+    /**
+     * LogicalConstraint type.
+     */
+    LogicalConstraint: "LogicalConstraint"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Policies.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyType = {
+    /**
+     * Policy type.
+     */
+    Policy: "Policy",
+    /**
+     * Set type.
+     */
+    Set: "Set",
+    /**
+     * Offer type.
+     */
+    Offer: "Offer",
+    /**
+     * Agreement type.
+     */
+    Agreement: "Agreement"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Rules.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RuleType = {
+    /**
+     * Permission type.
+     */
+    Permission: "Permission",
+    /**
+     * Prohibition type.
+     */
+    Prohibition: "Prohibition",
+    /**
+     * Duty type.
+     */
+    Duty: "Duty"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Conflict Resolution Strategies.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ConflictStrategyTypes = {
+    /**
+     * Permission type.
+     */
+    Perm: "perm",
+    /**
+     * Prohibition type.
+     */
+    Prohibit: "prohibit",
+    /**
+     * Invalid type.
+     */
+    Invalid: "invalid"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Status.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const StatusType = {
+    /**
+     * Active type.
+     */
+    Active: "active",
+    /**
+     * Inactive type.
+     */
+    Inactive: "inactive",
+    /**
+     * Pending type.
+     */
+    Pending: "pending",
+    /**
+     * Revoked type.
+     */
+    Revoked: "revoked"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Operators.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const OperatorType = {
+    /**
+     * Equal type.
+     */
+    Eq: "eq",
+    /**
+     * Greater than type.
+     */
+    Gt: "gt",
+    /**
+     * Greater than or equal to type.
+     */
+    Gteq: "gteq",
+    /**
+     * Less than type.
+     */
+    Lt: "lt",
+    /**
+     * Less than or equal to type.
+     */
+    Lteq: "lteq",
+    /**
+     * Not equal to type.
+     */
+    Neq: "neq",
+    /**
+     * Is a type.
+     */
+    IsA: "isA",
+    /**
+     * Has part type.
+     */
+    HasPart: "hasPart",
+    /**
+     * Is part of type.
+     */
+    IsPartOf: "isPartOf",
+    /**
+     * Is all of type.
+     */
+    IsAllOf: "isAllOf",
+    /**
+     * Is any of type.
+     */
+    IsAnyOf: "isAnyOf",
+    /**
+     * Is none of type.
+     */
+    IsNoneOf: "isNoneOf",
+    /**
+     * Location time equal to type.
+     */
+    LocTimeEq: "locTimeEq",
+    /**
+     * Location time greater than or equal to type.
+     */
+    LocTimeGteq: "locTimeGteq"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Logical Constraints.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const LogicalConstraintType = {
+    /**
+     * And type.
+     */
+    And: "and",
+    /**
+     * Or type.
+     */
+    Or: "or",
+    /**
+     * Xone type.
+     */
+    Xone: "xone",
+    /**
+     * And sequence type.
+     */
+    AndSequence: "andSequence"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Actions.
+ * Simple action types (for direct string usage)
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ActionTypes = {
+    /**
+     * To use the Asset - actions that involve general usage by parties.
+     */
+    Use: "use",
+    /**
+     * To transfer the ownership to third parties.
+     */
+    Transfer: "transfer",
+    /**
+     * To accept that the use of the Asset may be tracked.
+     */
+    AcceptTracking: "acceptTracking",
+    /**
+     * To use the Asset or parts of it as part of a composite collection.
+     */
+    Aggregate: "aggregate",
+    /**
+     * To add explanatory notations/commentaries to the Asset without modifying the Asset in any other way.
+     */
+    Annotate: "annotate",
+    /**
+     * To anonymize all or parts of the Asset.
+     */
+    Anonymize: "anonymize",
+    /**
+     * To store the Asset (in a non-transient form).
+     */
+    Archive: "archive",
+    /**
+     * To attribute the use of the Asset.
+     */
+    Attribute: "attribute",
+    /**
+     * Credit be given to copyright holder and/or author.
+     */
+    Attribution: "attribution",
+    /**
+     * Exercising rights for commercial purposes.
+     */
+    CommercialUse: "commercialUse",
+    /**
+     * To compensate by transfer of some amount of value for using or selling the Asset.
+     */
+    Compensate: "compensate",
+    /**
+     * To create multiple copies of the Asset that are being concurrently used.
+     */
+    ConcurrentUse: "concurrentUse",
+    /**
+     * To permanently remove all copies of the Asset after it has been used.
+     */
+    Delete: "delete",
+    /**
+     * To create a new derivative Asset from this Asset and to edit or modify the derivative.
+     */
+    Derive: "derive",
+    /**
+     * Distribution of derivative works.
+     */
+    DerivativeWorks: "derivativeWorks",
+    /**
+     * To produce a digital copy of (or otherwise digitize) the Asset from its analogue form.
+     */
+    Digitize: "digitize",
+    /**
+     * To create a static and transient rendition of an Asset.
+     */
+    Display: "display",
+    /**
+     * To supply the Asset to third-parties.
+     */
+    Distribute: "distribute",
+    /**
+     * Distribution, public display, and publicly performance.
+     */
+    Distribution: "distribution",
+    /**
+     * To ensure that the Rule on the Asset is exclusive.
+     */
+    EnsureExclusivity: "ensureExclusivity",
+    /**
+     * To run the computer program Asset.
+     */
+    Execute: "execute",
+    /**
+     * To extract parts of the Asset and to use it as a new Asset.
+     */
+    Extract: "extract",
+    /**
+     * To transfer the ownership without compensation and while deleting the original asset.
+     */
+    Give: "give",
+    /**
+     * To grant the use of the Asset to third parties.
+     */
+    GrantUse: "grantUse",
+    /**
+     * To include other related assets in the Asset.
+     */
+    Include: "include",
+    /**
+     * To record the Asset in an index.
+     */
+    Index: "index",
+    /**
+     * To inform that an action has been performed on or in relation to the Asset.
+     */
+    Inform: "inform",
+    /**
+     * To load the computer program Asset onto a storage device.
+     */
+    Install: "install",
+    /**
+     * To change existing content of the Asset without creating a new asset.
+     */
+    Modify: "modify",
+    /**
+     * To move the Asset from one digital location to another including deleting the original copy.
+     */
+    Move: "move",
+    /**
+     * To grant the specified Policy to a third party for their use of the Asset.
+     */
+    NextPolicy: "nextPolicy",
+    /**
+     * Copyright and license notices be kept intact.
+     */
+    Notice: "notice",
+    /**
+     * To obtain verifiable consent to perform the requested action.
+     */
+    ObtainConsent: "obtainConsent",
+    /**
+     * To create a sequential and transient rendition of an Asset.
+     */
+    Play: "play",
+    /**
+     * To publicly perform the Asset.
+     */
+    Present: "present",
+    /**
+     * To create a tangible and permanent rendition of an Asset.
+     */
+    Print: "print",
+    /**
+     * To obtain data from the Asset.
+     */
+    Read: "read",
+    /**
+     * To make duplicate copies of the Asset in any material form.
+     */
+    Reproduce: "reproduce",
+    /**
+     * Making multiple copies.
+     */
+    Reproduction: "reproduction",
+    /**
+     * To review the Policy applicable to the Asset.
+     */
+    ReviewPolicy: "reviewPolicy",
+    /**
+     * To transfer the ownership with compensation and while deleting the original asset.
+     */
+    Sell: "sell",
+    /**
+     * Derivative works be licensed under the same terms or compatible terms.
+     */
+    ShareAlike: "shareAlike",
+    /**
+     * Permits commercial derivatives, but only non-commercial distribution.
+     */
+    Sharing: "sharing",
+    /**
+     * Source code must be provided when exercising some rights.
+     */
+    SourceCode: "sourceCode",
+    /**
+     * To deliver the Asset in real-time.
+     */
+    Stream: "stream",
+    /**
+     * To use the Asset in timed relations with media elements of another Asset.
+     */
+    Synchronize: "synchronize",
+    /**
+     * To have a text Asset read out loud.
+     */
+    TextToSpeech: "textToSpeech",
+    /**
+     * To convert the Asset into a different format.
+     */
+    Transform: "transform",
+    /**
+     * To translate the Asset into another natural language.
+     */
+    Translate: "translate",
+    /**
+     * To unload and delete the computer program Asset.
+     */
+    Uninstall: "uninstall",
+    /**
+     * To apply a watermark to the Asset.
+     */
+    Watermark: "watermark"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Data Types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DataType = {
+    /**
+     * String type.
+     */
+    String: "xsd:string",
+    /**
+     * Boolean type.
+     */
+    Boolean: "xsd:boolean",
+    /**
+     * Integer type.
+     */
+    Integer: "xsd:integer",
+    /**
+     * Decimal type.
+     */
+    Decimal: "xsd:decimal",
+    /**
+     * Double type.
+     */
+    Double: "xsd:double",
+    /**
+     * Date type.
+     */
+    Date: "xsd:date",
+    /**
+     * DateTime type.
+     */
+    DateTime: "xsd:dateTime"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Data Types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const LeftOperandType = {
+    /**
+     * Absolute Position type.
+     */
+    AbsolutePosition: "absolutePosition",
+    /**
+     * Absolute Spatial Position type.
+     */
+    AbsoluteSpatialPosition: "absoluteSpatialPosition",
+    /**
+     * Absolute Temporal Position type.
+     */
+    AbsoluteTemporalPosition: "absoluteTemporalPosition",
+    /**
+     * Absolute Size type.
+     */
+    AbsoluteSize: "absoluteSize",
+    /**
+     * Count type.
+     */
+    Count: "count",
+    /**
+     * DateTime type.
+     */
+    DateTime: "dateTime",
+    /**
+     * Delay Period type.
+     */
+    DelayPeriod: "delayPeriod",
+    /**
+     * Delivery Channel type.
+     */
+    DeliveryChannel: "deliveryChannel",
+    /**
+     * Elapsed Time type.
+     */
+    ElapsedTime: "elapsedTime",
+    /**
+     * Event type.
+     */
+    Event: "event",
+    /**
+     * File Format type.
+     */
+    FileFormat: "fileFormat",
+    /**
+     * Industry type.
+     */
+    Industry: "industry",
+    /**
+     * Language type.
+     */
+    Language: "language",
+    /**
+     * Media type.
+     */
+    Media: "media",
+    /**
+     * Metered Time type.
+     */
+    MeteredTime: "meteredTime",
+    /**
+     * Pay Amount type.
+     */
+    PayAmount: "payAmount",
+    /**
+     * Percentage type.
+     */
+    Percentage: "percentage",
+    /**
+     * Product type.
+     */
+    Product: "product",
+    /**
+     * Purpose type.
+     */
+    Purpose: "purpose",
+    /**
+     * Recipient type.
+     */
+    Recipient: "recipient",
+    /**
+     * Relative Position type.
+     */
+    RelativePosition: "relativePosition",
+    /**
+     * Relative Spatial Position type.
+     */
+    RelativeSpatialPosition: "relativeSpatialPosition",
+    /**
+     * Relative Temporal Position type.
+     */
+    RelativeTemporalPosition: "relativeTemporalPosition",
+    /**
+     * Relative Size type.
+     */
+    RelativeSize: "relativeSize",
+    /**
+     * Resolution type.
+     */
+    Resolution: "resolution",
+    /**
+     * Spatial type.
+     */
+    Spatial: "spatial",
+    /**
+     * Spatial Coordinates type.
+     */
+    SpatialCoordinates: "spatialCoordinates",
+    /**
+     * System Device type.
+     */
+    SystemDevice: "systemDevice",
+    /**
+     * Time Interval type.
+     */
+    TimeInterval: "timeInterval",
+    /**
+     * Unit of Count type.
+     */
+    UnitOfCount: "unitOfCount",
+    /**
+     * Version type.
+     */
+    Version: "version",
+    /**
+     * Virtual Location type.
+     */
+    VirtualLocation: "virtualLocation"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types for ODRL Actions.
+ * URI action types (for use with rdf:value/@id)
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const UriActionTypes = {
+    /**
+     * To use the Asset - actions that involve general usage by parties.
+     */
+    OdrlUse: "odrl:use",
+    /**
+     * To transfer the ownership to third parties.
+     */
+    OdrlTransfer: "odrl:transfer",
+    /**
+     * To accept that the use of the Asset may be tracked.
+     */
+    OdrlAcceptTracking: "odrl:acceptTracking",
+    /**
+     * To use the Asset or parts of it as part of a composite collection.
+     */
+    OdrlAggregate: "odrl:aggregate",
+    /**
+     * To add explanatory notations/commentaries to the Asset without modifying the Asset in any other way.
+     */
+    OdrlAnnotate: "odrl:annotate",
+    /**
+     * To anonymize all or parts of the Asset.
+     */
+    OdrlAnonymize: "odrl:anonymize",
+    /**
+     * To store the Asset (in a non-transient form).
+     */
+    OdrlArchive: "odrl:archive",
+    /**
+     * To attribute the use of the Asset.
+     */
+    OdrlAttribute: "odrl:attribute",
+    /**
+     * Credit be given to copyright holder and/or author.
+     */
+    OdrlAttribution: "odrl:attribution",
+    /**
+     * Exercising rights for commercial purposes.
+     */
+    OdrlCommercialUse: "odrl:commercialUse",
+    /**
+     * To compensate by transfer of some amount of value for using or selling the Asset.
+     */
+    OdrlCompensate: "odrl:compensate",
+    /**
+     * To create multiple copies of the Asset that are being concurrently used.
+     */
+    OdrlConcurrentUse: "odrl:concurrentUse",
+    /**
+     * To permanently remove all copies of the Asset after it has been used.
+     */
+    OdrlDelete: "odrl:delete",
+    /**
+     * To create a new derivative Asset from this Asset and to edit or modify the derivative.
+     */
+    OdrlDerive: "odrl:derive",
+    /**
+     * Distribution of derivative works.
+     */
+    OdrlDerivativeWorks: "odrl:derivativeWorks",
+    /**
+     * To produce a digital copy of (or otherwise digitize) the Asset from its analogue form.
+     */
+    OdrlDigitize: "odrl:digitize",
+    /**
+     * To create a static and transient rendition of an Asset.
+     */
+    OdrlDisplay: "odrl:display",
+    /**
+     * To supply the Asset to third-parties.
+     */
+    OdrlDistribute: "odrl:distribute",
+    /**
+     * Distribution, public display, and publicly performance.
+     */
+    OdrlDistribution: "odrl:distribution",
+    /**
+     * To ensure that the Rule on the Asset is exclusive.
+     */
+    OdrlEnsureExclusivity: "odrl:ensureExclusivity",
+    /**
+     * To run the computer program Asset.
+     */
+    OdrlExecute: "odrl:execute",
+    /**
+     * To extract parts of the Asset and to use it as a new Asset.
+     */
+    OdrlExtract: "odrl:extract",
+    /**
+     * To transfer the ownership without compensation and while deleting the original asset.
+     */
+    OdrlGive: "odrl:give",
+    /**
+     * To grant the use of the Asset to third parties.
+     */
+    OdrlGrantUse: "odrl:grantUse",
+    /**
+     * To include other related assets in the Asset.
+     */
+    OdrlInclude: "odrl:include",
+    /**
+     * To record the Asset in an index.
+     */
+    OdrlIndex: "odrl:index",
+    /**
+     * To inform that an action has been performed on or in relation to the Asset.
+     */
+    OdrlInform: "odrl:inform",
+    /**
+     * To load the computer program Asset onto a storage device.
+     */
+    OdrlInstall: "odrl:install",
+    /**
+     * To change existing content of the Asset without creating a new asset.
+     */
+    OdrlModify: "odrl:modify",
+    /**
+     * To move the Asset from one digital location to another including deleting the original copy.
+     */
+    OdrlMove: "odrl:move",
+    /**
+     * To grant the specified Policy to a third party for their use of the Asset.
+     */
+    OdrlNextPolicy: "odrl:nextPolicy",
+    /**
+     * Copyright and license notices be kept intact.
+     */
+    OdrlNotice: "odrl:notice",
+    /**
+     * To obtain verifiable consent to perform the requested action.
+     */
+    OdrlObtainConsent: "odrl:obtainConsent",
+    /**
+     * To create a sequential and transient rendition of an Asset.
+     */
+    OdrlPlay: "odrl:play",
+    /**
+     * To publicly perform the Asset.
+     */
+    OdrlPresent: "odrl:present",
+    /**
+     * To create a tangible and permanent rendition of an Asset.
+     */
+    OdrlPrint: "odrl:print",
+    /**
+     * To obtain data from the Asset.
+     */
+    OdrlRead: "odrl:read",
+    /**
+     * To make duplicate copies of the Asset in any material form.
+     */
+    OdrlReproduce: "odrl:reproduce",
+    /**
+     * Making multiple copies.
+     */
+    OdrlReproduction: "odrl:reproduction",
+    /**
+     * To review the Policy applicable to the Asset.
+     */
+    OdrlReviewPolicy: "odrl:reviewPolicy",
+    /**
+     * To transfer the ownership with compensation and while deleting the original asset.
+     */
+    OdrlSell: "odrl:sell",
+    /**
+     * Derivative works be licensed under the same terms or compatible terms.
+     */
+    OdrlShareAlike: "odrl:shareAlike",
+    /**
+     * Permits commercial derivatives, but only non-commercial distribution.
+     */
+    OdrlSharing: "odrl:sharing",
+    /**
+     * Source code must be provided when exercising some rights.
+     */
+    OdrlSourceCode: "odrl:sourceCode",
+    /**
+     * To deliver the Asset in real-time.
+     */
+    OdrlStream: "odrl:stream",
+    /**
+     * To use the Asset in timed relations with media elements of another Asset.
+     */
+    OdrlSynchronize: "odrl:synchronize",
+    /**
+     * To have a text Asset read out loud.
+     */
+    OdrlTextToSpeech: "odrl:textToSpeech",
+    /**
+     * To convert the Asset into a different format.
+     */
+    OdrlTransform: "odrl:transform",
+    /**
+     * To translate the Asset into another natural language.
+     */
+    OdrlTranslate: "odrl:translate",
+    /**
+     * To unload and delete the computer program Asset.
+     */
+    OdrlUninstall: "odrl:uninstall",
+    /**
+     * To apply a watermark to the Asset.
+     */
+    OdrlWatermark: "odrl:watermark"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Right operand types for ODRL constraints
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RightOperandTypes = {
+    /**
+     * Reference to policy usage events
+     */
+    PolicyUsage: "odrl:policyUsage"
+    // ... other right operand types ...
+};
+
+exports.ActionTypes = ActionTypes;
+exports.ConflictStrategyTypes = ConflictStrategyTypes;
+exports.DataType = DataType;
+exports.LeftOperandType = LeftOperandType;
+exports.LogicalConstraintType = LogicalConstraintType;
+exports.OdrlContexts = OdrlContexts;
+exports.OdrlTypes = OdrlTypes;
+exports.OperatorType = OperatorType;
+exports.PolicyType = PolicyType;
+exports.RightOperandTypes = RightOperandTypes;
+exports.RuleType = RuleType;
+exports.StatusType = StatusType;
+exports.UriActionTypes = UriActionTypes;