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

package/dist/types/index.d.ts

@@ -0,0 +1,26 @@
+export * from "./models/odrlContexts";
+export * from "./models/types/odrlTypes";
+export * from "./models/IOdrlRule";
+export * from "./models/IOdrlPolicy";
+export * from "./models/IOdrlAsset";
+export * from "./models/IOdrlParty";
+export * from "./models/IOdrlAction";
+export * from "./models/IOdrlConstraint";
+export * from "./models/IOdrlPermission";
+export * from "./models/IOdrlProhibition";
+export * from "./models/IOdrlDuty";
+export * from "./models/IOdrlPolicyMetadata";
+export * from "./models/IOdrlAssetCollection";
+export * from "./models/IOdrlLogicalConstraint";
+export * from "./models/IOdrlPartyCollection";
+export * from "./models/types/policyTypes";
+export * from "./models/types/ruleTypes";
+export * from "./models/types/conflictStrategyTypes";
+export * from "./models/types/statusTypes";
+export * from "./models/types/operatorTypes";
+export * from "./models/types/logicalConstraintType";
+export * from "./models/types/actionTypes";
+export * from "./models/types/dataTypes";
+export * from "./models/types/leftOperandTypes";
+export * from "./models/types/uriActionTypes";
+export * from "./models/types/rightOperandTypes";

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

@@ -0,0 +1,33 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlConstraint } from "./IOdrlConstraint";
+import type { IOdrlLogicalConstraint } from "./IOdrlLogicalConstraint";
+import type { ActionType } from "./types/actionTypes";
+/**
+ * Interface for ODRL Actions.
+ */
+export interface IOdrlAction extends IJsonLdNodeObject {
+    /**
+     * The value/identifier of the action.
+     * Used in complex action definitions.
+     */
+    "rdf:value"?: {
+        "@id": string;
+    };
+    /**
+     * Direct action identifier.
+     * Used in simple action references.
+     */
+    "@id"?: string;
+    /**
+     * Refinements applied to the action.
+     */
+    refinement?: IOdrlConstraint | IOdrlLogicalConstraint | (IOdrlConstraint | IOdrlLogicalConstraint)[];
+    /**
+     * Reference to the action this action is included in.
+     */
+    includedIn?: ActionType;
+    /**
+     * References to actions this action implies.
+     */
+    implies?: ActionType[];
+}

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

@@ -0,0 +1,27 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlAssetCollection } from "./IOdrlAssetCollection";
+/**
+ * Interface for ODRL Assets.
+ */
+export interface IOdrlAsset extends IJsonLdNodeObject {
+    /**
+     * The unique identifier for the asset.
+     * Should be an IRI.
+     */
+    uid?: string;
+    /**
+     * The type of the asset.
+     * Can be used to specify additional type information.
+     */
+    "@type"?: string;
+    /**
+     * Reference to the asset collection this asset is part of.
+     * Used to identify an AssetCollection that this Asset is a member of.
+     */
+    partOf?: string | IOdrlAssetCollection;
+    /**
+     * Reference to the policy that governs this asset.
+     * Used to identify the Policy that governs this Asset.
+     */
+    hasPolicy?: string;
+}

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

@@ -0,0 +1,21 @@
+import type { IOdrlAsset } from "./IOdrlAsset";
+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.
+ */
+export interface IOdrlAssetCollection extends IOdrlAsset {
+    /**
+     * Reference to the source of the asset collection.
+     * Must be an IRI that references the AssetCollection.
+     */
+    source: string;
+    /**
+     * Refinements applied to the asset collection.
+     * Used to specify the refinement context under which to identify individual Asset(s)
+     * of the complete collection. The refinement applies to the characteristics of each
+     * member of the collection (not the resource as a whole).
+     */
+    refinement?: IOdrlConstraint[];
+}

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

@@ -0,0 +1,49 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { DataType } from "./types/dataTypes";
+import type { LeftOperandType } from "./types/leftOperandTypes";
+import type { OperatorType } from "./types/operatorTypes";
+import type { StatusType } from "./types/statusTypes";
+/**
+ * Interface for ODRL Constraints.
+ */
+export interface IOdrlConstraint extends IJsonLdNodeObject {
+    /**
+     * Optional unique identifier for the constraint.
+     */
+    uid?: string;
+    /**
+     * The left operand of the constraint.
+     */
+    leftOperand: string | LeftOperandType;
+    /**
+     * The operator of the constraint.
+     */
+    operator: OperatorType;
+    /**
+     * The right operand of the constraint.
+     * value with optional @type is used for literal values (like "5.00" with type "xsd:decimal")
+     * id is used when referencing a URI/identifier (like odrl:policyUsage)
+     */
+    rightOperand?: string | {
+        "@value": string;
+        "@type"?: DataType;
+    } | {
+        "@id": string;
+    };
+    /**
+     * Reference to the right operand.
+     */
+    rightOperandReference?: string;
+    /**
+     * The data type of the right operand.
+     */
+    dataType?: DataType;
+    /**
+     * The unit for the right operand value.
+     */
+    unit?: string;
+    /**
+     * The status value for comparison.
+     */
+    status?: StatusType;
+}

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

@@ -0,0 +1,33 @@
+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.
+ */
+export interface IOdrlDuty extends IOdrlRule {
+    /**
+     * The party to be attributed
+     * Used when the duty involves attribution
+     */
+    attributedParty?: string;
+    /**
+     * The party performing the tracking
+     * Used when the duty involves tracking
+     */
+    trackingParty?: string;
+    /**
+     * The consequences if the duty is not fulfilled.
+     * Only applicable when the Duty is referenced by a Rule with duty or obligation
+     * properties.
+     */
+    consequence?: IOdrlDuty[];
+    /**
+     * The remedies that may be fulfilled to cure the violation.
+     */
+    remedy?: IOdrlDuty[];
+    /**
+     * The party to be compensated
+     * Used when the duty involves compensation
+     */
+    compensatedParty?: string;
+}

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

@@ -0,0 +1,45 @@
+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.
+ */
+export interface IOdrlLogicalConstraint extends IJsonLdNodeObject {
+    /**
+     * Optional unique identifier for the logical constraint.
+     * Must be an IRI.
+     */
+    uid?: string;
+    /**
+     * AND operator - all constraints must be satisfied.
+     */
+    and?: {
+        "@list": {
+            "@id": string;
+        }[];
+    };
+    /**
+     * OR operator - at least one constraint must be satisfied.
+     */
+    or?: {
+        "@list": {
+            "@id": string;
+        }[];
+    };
+    /**
+     * XOR operator - exactly one constraint must be satisfied.
+     */
+    xone?: {
+        "@list": {
+            "@id": string;
+        }[];
+    };
+    /**
+     * AND Sequence operator - all constraints must be satisfied in order.
+     */
+    andSequence?: {
+        "@list": {
+            "@id": string;
+        }[];
+    };
+}

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

@@ -0,0 +1,35 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlPartyCollection } from "./IOdrlPartyCollection";
+/**
+ * Interface for ODRL Parties.
+ */
+export interface IOdrlParty extends IJsonLdNodeObject {
+    /**
+     * The unique identifier for the party.
+     * Must be an IRI.
+     */
+    uid?: string;
+    /**
+     * The type of the party.
+     * Can be used to specify additional type information (e.g., "Party",
+     * "vcard:Organization", "vcard:Individual").
+     */
+    "@type"?: string | string[];
+    /**
+     * Reference to the party collection this party is part of.
+     * Used to identify a PartyCollection that a Party entity is a member of.
+     */
+    partOf?: string | IOdrlPartyCollection;
+    /**
+     * Reference to a policy where this party is an assignee.
+     * When assigneeOf is asserted, the Party MUST be inferred to undertake
+     * the assignee functional role of all the Rules of that Policy.
+     */
+    assigneeOf?: string;
+    /**
+     * Reference to a policy where this party is an assigner.
+     * When assignerOf is asserted, the Party MUST be inferred to undertake
+     * the assigner functional role of all the Rules of that Policy.
+     */
+    assignerOf?: string;
+}

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

@@ -0,0 +1,18 @@
+import type { IOdrlConstraint } from "./IOdrlConstraint";
+import type { IOdrlParty } from "./IOdrlParty";
+/**
+ * Interface for ODRL Party Collections.
+ * A PartyCollection identifies a collection of entities and is a subclass of Party.
+ */
+export interface IOdrlPartyCollection extends IOdrlParty {
+    /**
+     * Reference to the source of the party collection.
+     * Used to identify the origin or location of the collection.
+     */
+    source: string;
+    /**
+     * Refinements applied to the party collection.
+     * Used to specify constraints that apply to all members of the collection.
+     */
+    refinement?: IOdrlConstraint[];
+}

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

@@ -0,0 +1,14 @@
+import type { IOdrlDuty } from "./IOdrlDuty";
+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.
+ */
+export interface IOdrlPermission extends IOdrlRule {
+    /**
+     * The duties that must be fulfilled before the permission can be exercised.
+     * A Permission MAY have none, one, or more duty property values.
+     */
+    duty?: IOdrlDuty[];
+}

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

@@ -0,0 +1,81 @@
+import type { IJsonLdContextDefinition, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlAction } from "./IOdrlAction";
+import type { IOdrlAsset } from "./IOdrlAsset";
+import type { IOdrlDuty } from "./IOdrlDuty";
+import type { IOdrlParty } from "./IOdrlParty";
+import type { IOdrlPermission } from "./IOdrlPermission";
+import type { IOdrlProhibition } from "./IOdrlProhibition";
+import type { OdrlContexts } from "./odrlContexts";
+import type { ActionType } from "./types/actionTypes";
+import type { ConflictStrategyType } from "./types/conflictStrategyTypes";
+import type { PolicyType } from "./types/policyTypes";
+/**
+ * Interface representing an ODRL Policy.
+ */
+export interface IOdrlPolicy extends IJsonLdNodeObject {
+    /**
+     * The context for the policy.
+     * Must include "https://www.w3.org/ns/odrl.jsonld"
+     */
+    "@context": typeof OdrlContexts.Context | [typeof OdrlContexts.Context, IJsonLdContextDefinition] | IJsonLdContextDefinition;
+    /**
+     * The type of policy.
+     * Must be one of: "Set", "Offer", "Agreement"
+     */
+    "@type": PolicyType;
+    /**
+     * The unique identifier for the policy.
+     * Must be an IRI.
+     */
+    uid: string;
+    /**
+     * The profile(s) this policy conforms to.
+     * IRIs identifying the ODRL Profile(s).
+     */
+    profile?: string | string[];
+    /**
+     * The assigner of the policy.
+     * Applies to all rules unless overridden at rule level.
+     */
+    assigner?: string | IOdrlParty;
+    /**
+     * The assignee of the policy.
+     * Applies to all rules unless overridden at rule level.
+     */
+    assignee?: string | IOdrlParty;
+    /**
+     * The target asset for the rule.
+     */
+    target?: string | IOdrlAsset | (string | IOdrlAsset)[];
+    /**
+     * The action associated with the rule.
+     */
+    action?: ActionType | IOdrlAction | (ActionType | IOdrlAction)[];
+    /**
+     * The parent policy(ies) this policy inherits from.
+     * IRIs identifying the parent Policy(ies).
+     */
+    inheritFrom?: string | string[];
+    /**
+     * The conflict resolution strategy.
+     * - perm: Permissions override Prohibitions
+     * - prohibit: Prohibitions override Permissions
+     * - invalid: Policy is void if conflicts exist (default)
+     */
+    conflict?: ConflictStrategyType;
+    /**
+     * The permissions in the policy.
+     * At least one of permission, prohibition, or obligation must be present.
+     */
+    permission?: IOdrlPermission[];
+    /**
+     * The prohibitions in the policy.
+     * At least one of permission, prohibition, or obligation must be present.
+     */
+    prohibition?: IOdrlProhibition[];
+    /**
+     * The obligations in the policy.
+     * At least one of permission, prohibition, or obligation must be present.
+     */
+    obligation?: IOdrlDuty[];
+}

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

@@ -0,0 +1,58 @@
+/**
+ * Interface for ODRL Policy Metadata using Dublin Core terms.
+ * While these aren't explicitly defined in the ODRL spec, they are valid and useful metadata properties that follow Dublin Core standards.
+ */
+export interface IOdrlPolicyMetadata {
+    /**
+     * The individual, agent, or organisation that authored the Policy.
+     * Note: String values may not be normalized and should not be used for direct comparison.
+     */
+    "dc:creator"?: string | string[];
+    /**
+     * A human-readable representation or summary of the Policy.
+     * Note: String values may not be normalized and should not be used for direct comparison.
+     */
+    "dc:description"?: string | string[];
+    /**
+     * The date (and time) the Policy was first issued.
+     * Note: String values may not be normalized and should not be used for direct comparison.
+     */
+    "dc:issued"?: string;
+    /**
+     * The date (and time) the Policy was updated.
+     * Note: String values may not be normalized and should not be used for direct comparison.
+     */
+    "dc:modified"?: string;
+    /**
+     * The publisher of the Policy.
+     * Note: String values may not be normalized and should not be used for direct comparison.
+     */
+    "dc:publisher"?: string;
+    /**
+     * The subject of the Policy.
+     * Note: String values may not be normalized and should not be used for direct comparison.
+     */
+    "dc:subject"?: string | string[];
+    /**
+     * The jurisdiction under which the Policy is relevant.
+     * Note: When using string values, they may not be normalized and should not be used for direct comparison.
+     * Using "@id" references is preferred for comparison purposes.
+     */
+    "dc:coverage"?: string | {
+        "@id": string;
+    };
+    /**
+     * The identifier of a Policy that this Policy supersedes.
+     * Using "@id" references is preferred for comparison purposes.
+     */
+    "dc:replaces"?: string | {
+        "@id": string;
+    };
+    /**
+     * The identifier of a Policy that supersedes this Policy.
+     * Using "@id" references is preferred for comparison purposes.
+     */
+    "dc:isReplacedBy"?: string | {
+        "@id": string;
+    };
+}

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

@@ -0,0 +1,11 @@
+import type { IOdrlDuty } from "./IOdrlDuty";
+import type { IOdrlRule } from "./IOdrlRule";
+/**
+ * Interface for Prohibition Rules.
+ */
+export interface IOdrlProhibition extends IOdrlRule {
+    /**
+     * The remedies that must be fulfilled if prohibition is violated.
+     */
+    remedy?: IOdrlDuty[];
+}

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

@@ -0,0 +1,41 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlAction } from "./IOdrlAction";
+import type { IOdrlAsset } from "./IOdrlAsset";
+import type { IOdrlConstraint } from "./IOdrlConstraint";
+import type { IOdrlParty } from "./IOdrlParty";
+import type { ActionType } from "./types/actionTypes";
+/**
+ * Base interface for ODRL Rules.
+ */
+export interface IOdrlRule extends IJsonLdNodeObject {
+    /**
+     * Optional unique identifier for the rule.
+     */
+    uid?: string;
+    /**
+     * The action associated with the rule.
+     */
+    action?: ActionType | IOdrlAction | (ActionType | IOdrlAction)[];
+    /**
+     * The target asset for the rule.
+     */
+    target?: string | IOdrlAsset | (string | IOdrlAsset)[];
+    /**
+     * The assigner of the rule.
+     */
+    assigner?: string | IOdrlParty;
+    /**
+     * The assignee of the rule.
+     */
+    assignee?: string | IOdrlParty;
+    /**
+     * Constraints applied to the rule.
+     */
+    constraint?: IOdrlConstraint[];
+    /**
+     * Additional relation sub-properties as defined in ODRL profiles.
+     * For example, 'summary' in profile "http://example.com/odrl:profile:03"
+     * indicates where the output should be stored.
+     */
+    summary?: string;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * The contexts for ODRL.
+ */
+export declare const OdrlContexts: {
+    /**
+     * The context root for ODRL.
+     */
+    readonly Context: "https://www.w3.org/ns/odrl.jsonld";
+    /**
+     * The context root for ODRL vocabulary.
+     */
+    readonly ContextVocabulary: "https://www.w3.org/ns/odrl/2/";
+    /**
+     * The context root for Dublin Core Terms.
+     */
+    readonly ContextDcTerms: "https://purl.org/dc/terms/";
+    /**
+     * The context root for RDF.
+     */
+    readonly ContextRdf: "https://www.w3.org/1999/02/22-rdf-syntax-ns#";
+    /**
+     * The context root for XSD.
+     */
+    readonly ContextXsd: "https://www.w3.org/2001/XMLSchema#";
+};
+/**
+ * The contexts for ODRL.
+ */
+export type OdrlContexts = (typeof OdrlContexts)[keyof typeof OdrlContexts];