@twin.org/standards-w3c-odrl 0.0.1-next.44 → 0.0.1-next.45

package/dist/types/dataTypes/odrlDataTypes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Handle all the data types for ODRL.
+ */
+export declare class OdrlDataTypes {
+    /**
+     * Register the JSON-LD Redirects.
+     */
+    static registerRedirects(): void;
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -13,6 +13,9 @@ export * from "./models/IOdrlPolicyMetadata";
 export * from "./models/IOdrlAssetCollection";
 export * from "./models/IOdrlLogicalConstraint";
 export * from "./models/IOdrlPartyCollection";
+export * from "./models/IOdrlAgreement";
+export * from "./models/IOdrlOffer";
+export * from "./models/IOdrlSet";
 export * from "./models/types/policyTypes";
 export * from "./models/types/ruleTypes";
 export * from "./models/types/conflictStrategyTypes";
@@ -20,8 +23,8 @@ 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";
 export * from "./models/odrlContextType";
+export * from "./dataTypes/odrlDataTypes";

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

@@ -0,0 +1,23 @@
+import type { IOdrlParty } from "./IOdrlParty";
+import type { IOdrlPolicy } from "./IOdrlPolicy";
+import type { OdrlTypes } from "./types/odrlTypes";
+/**
+ * Interface representing an ODRL Agreement.
+ * An Agreement requires both an assigner and assignee (both agreeing parties).
+ */
+export interface IOdrlAgreement extends IOdrlPolicy {
+    /**
+     * The type must be "Agreement".
+     */
+    "@type": typeof OdrlTypes.Agreement;
+    /**
+     * The assigner of the agreement.
+     * Required for Agreement policies.
+     */
+    assigner: string | IOdrlParty;
+    /**
+     * The assignee of the agreement.
+     * Required for Agreement policies.
+     */
+    assignee: string | IOdrlParty;
+}

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

@@ -1,5 +1,4 @@
 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";
@@ -26,7 +25,7 @@ export interface IOdrlConstraint extends IJsonLdNodeObject {
      */
     rightOperand?: string | {
         "@value": string;
-        "@type"?: DataType;
+        "@type"?: string;
     } | {
         "@id": string;
     };
@@ -37,7 +36,7 @@ export interface IOdrlConstraint extends IJsonLdNodeObject {
     /**
      * The data type of the right operand.
      */
-    dataType?: DataType;
+    dataType?: string;
     /**
      * The unit for the right operand value.
      */

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

@@ -0,0 +1,18 @@
+import type { IOdrlParty } from "./IOdrlParty";
+import type { IOdrlPolicy } from "./IOdrlPolicy";
+import type { OdrlTypes } from "./types/odrlTypes";
+/**
+ * Interface representing an ODRL Offer.
+ * An Offer requires an assigner (the party making the offer).
+ */
+export interface IOdrlOffer extends IOdrlPolicy {
+    /**
+     * The type must be "Offer".
+     */
+    "@type": typeof OdrlTypes.Offer;
+    /**
+     * The assigner of the offer.
+     * Required for Offer policies.
+     */
+    assigner: string | IOdrlParty;
+}

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

@@ -0,0 +1,12 @@
+import type { IOdrlPolicy } from "./IOdrlPolicy";
+import type { OdrlTypes } from "./types/odrlTypes";
+/**
+ * Interface representing an ODRL Set.
+ * A Set is a basic policy type with no specific party requirements.
+ */
+export interface IOdrlSet extends IOdrlPolicy {
+    /**
+     * The type must be "Set".
+     */
+    "@type": typeof OdrlTypes.Set;
+}

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

@@ -3,12 +3,12 @@ import type { OdrlContexts } from "./odrlContexts";
 /**
  * The ODRL JSON-LD context type.
  */
-export type OdrlContextType = typeof OdrlContexts.Context | [typeof OdrlContexts.Context, ...IJsonLdContextDefinitionElement[]] | [
+export type OdrlContextType = typeof OdrlContexts.ContextRoot | [typeof OdrlContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]] | [
     ...IJsonLdContextDefinitionElement[],
-    typeof OdrlContexts.Context,
+    typeof OdrlContexts.ContextRoot,
     IJsonLdContextDefinitionElement
 ] | [
     IJsonLdContextDefinitionElement,
-    typeof OdrlContexts.Context,
+    typeof OdrlContexts.ContextRoot,
     ...IJsonLdContextDefinitionElement[]
 ];

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

@@ -5,23 +5,11 @@ export declare const OdrlContexts: {
     /**
      * The context root for ODRL.
      */
-    readonly Context: "https://www.w3.org/ns/odrl.jsonld";
+    readonly ContextRedirect: "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#";
+    readonly ContextRoot: "https://www.w3.org/ns/odrl/2/";
 };
 /**
  * The contexts for ODRL.

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

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

package/docs/changelog.md

@@ -1,5 +1,20 @@
 # @twin.org/standards-w3c-odrl - Changelog
 
+## [0.0.1-next.45](https://github.com/twinfoundation/standards/compare/standards-w3c-odrl-v0.0.1-next.44...standards-w3c-odrl-v0.0.1-next.45) (2025-06-02)
+
+
+### Features
+
+* update ODRL data types and context definitions ([#31](https://github.com/twinfoundation/standards/issues/31)) ([ade0169](https://github.com/twinfoundation/standards/commit/ade0169d1049e7812bfc128ce5c16512548714fa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/standards-w3c-vcard bumped from 0.0.1-next.44 to 0.0.1-next.45
+    * @twin.org/standards-dublin-core bumped from 0.0.1-next.44 to 0.0.1-next.45
+
 ## [0.0.1-next.44](https://github.com/twinfoundation/standards/compare/standards-w3c-odrl-v0.0.1-next.43...standards-w3c-odrl-v0.0.1-next.44) (2025-05-28)
 
 

package/docs/reference/classes/OdrlDataTypes.md

@@ -0,0 +1,37 @@
+# Class: OdrlDataTypes
+
+Handle all the data types for ODRL.
+
+## Constructors
+
+### Constructor
+
+> **new OdrlDataTypes**(): `OdrlDataTypes`
+
+#### Returns
+
+`OdrlDataTypes`
+
+## Methods
+
+### registerRedirects()
+
+> `static` **registerRedirects**(): `void`
+
+Register the JSON-LD Redirects.
+
+#### Returns
+
+`void`
+
+***
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -1,13 +1,19 @@
 # @twin.org/standards-w3c-odrl
 
+## Classes
+
+- [OdrlDataTypes](classes/OdrlDataTypes.md)
+
 ## Interfaces
 
 - [IOdrlAction](interfaces/IOdrlAction.md)
+- [IOdrlAgreement](interfaces/IOdrlAgreement.md)
 - [IOdrlAsset](interfaces/IOdrlAsset.md)
 - [IOdrlAssetCollection](interfaces/IOdrlAssetCollection.md)
 - [IOdrlConstraint](interfaces/IOdrlConstraint.md)
 - [IOdrlDuty](interfaces/IOdrlDuty.md)
 - [IOdrlLogicalConstraint](interfaces/IOdrlLogicalConstraint.md)
+- [IOdrlOffer](interfaces/IOdrlOffer.md)
 - [IOdrlParty](interfaces/IOdrlParty.md)
 - [IOdrlPartyCollection](interfaces/IOdrlPartyCollection.md)
 - [IOdrlPermission](interfaces/IOdrlPermission.md)
@@ -15,6 +21,7 @@
 - [IOdrlPolicyMetadata](interfaces/IOdrlPolicyMetadata.md)
 - [IOdrlProhibition](interfaces/IOdrlProhibition.md)
 - [IOdrlRule](interfaces/IOdrlRule.md)
+- [IOdrlSet](interfaces/IOdrlSet.md)
 
 ## Type Aliases
 
@@ -22,7 +29,6 @@
 - [OdrlContexts](type-aliases/OdrlContexts.md)
 - [ActionType](type-aliases/ActionType.md)
 - [ConflictStrategyType](type-aliases/ConflictStrategyType.md)
-- [DataType](type-aliases/DataType.md)
 - [LeftOperandType](type-aliases/LeftOperandType.md)
 - [LogicalConstraintType](type-aliases/LogicalConstraintType.md)
 - [OdrlTypes](type-aliases/OdrlTypes.md)
@@ -38,7 +44,6 @@
 - [OdrlContexts](variables/OdrlContexts.md)
 - [ActionTypes](variables/ActionTypes.md)
 - [ConflictStrategyTypes](variables/ConflictStrategyTypes.md)
-- [DataType](variables/DataType.md)
 - [LeftOperandType](variables/LeftOperandType.md)
 - [LogicalConstraintType](variables/LogicalConstraintType.md)
 - [OdrlTypes](variables/OdrlTypes.md)

package/docs/reference/interfaces/IOdrlAgreement.md

@@ -0,0 +1,180 @@
+# Interface: IOdrlAgreement
+
+Interface representing an ODRL Agreement.
+An Agreement requires both an assigner and assignee (both agreeing parties).
+
+## Extends
+
+- [`IOdrlPolicy`](IOdrlPolicy.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### @type
+
+> **@type**: `"Agreement"`
+
+The type must be "Agreement".
+
+#### Overrides
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`@type`](IOdrlPolicy.md#type)
+
+***
+
+### assigner
+
+> **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the agreement.
+Required for Agreement policies.
+
+#### Overrides
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`assigner`](IOdrlPolicy.md#assigner)
+
+***
+
+### assignee
+
+> **assignee**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assignee of the agreement.
+Required for Agreement policies.
+
+#### Overrides
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`assignee`](IOdrlPolicy.md#assignee)
+
+***
+
+### @context
+
+> **@context**: [`OdrlContextType`](../type-aliases/OdrlContextType.md)
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`@context`](IOdrlPolicy.md#context)
+
+***
+
+### uid
+
+> **uid**: `string`
+
+The unique identifier for the policy.
+Must be an IRI.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`uid`](IOdrlPolicy.md#uid)
+
+***
+
+### profile?
+
+> `optional` **profile**: `string` \| `string`[]
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`profile`](IOdrlPolicy.md#profile)
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| [`IOdrlAsset`](IOdrlAsset.md) \| (`string` \| [`IOdrlAsset`](IOdrlAsset.md))[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`target`](IOdrlPolicy.md#target)
+
+***
+
+### action?
+
+> `optional` **action**: [`ActionType`](../type-aliases/ActionType.md) \| [`IOdrlAction`](IOdrlAction.md) \| ActionType \| IOdrlAction[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`action`](IOdrlPolicy.md#action)
+
+***
+
+### inheritFrom?
+
+> `optional` **inheritFrom**: `string` \| `string`[]
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`inheritFrom`](IOdrlPolicy.md#inheritfrom)
+
+***
+
+### conflict?
+
+> `optional` **conflict**: [`ConflictStrategyType`](../type-aliases/ConflictStrategyType.md)
+
+The conflict resolution strategy.
+- perm: Permissions override Prohibitions
+- prohibit: Prohibitions override Permissions
+- invalid: Policy is void if conflicts exist (default)
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`conflict`](IOdrlPolicy.md#conflict)
+
+***
+
+### permission?
+
+> `optional` **permission**: [`IOdrlPermission`](IOdrlPermission.md)[]
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`permission`](IOdrlPolicy.md#permission)
+
+***
+
+### prohibition?
+
+> `optional` **prohibition**: [`IOdrlProhibition`](IOdrlProhibition.md)[]
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`prohibition`](IOdrlPolicy.md#prohibition)
+
+***
+
+### obligation?
+
+> `optional` **obligation**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`obligation`](IOdrlPolicy.md#obligation)

package/docs/reference/interfaces/IOdrlConstraint.md

@@ -38,7 +38,7 @@ The operator of the constraint.
 
 ### rightOperand?
 
-> `optional` **rightOperand**: `string` \| \{ `@value`: `string`; `@type`: [`DataType`](../type-aliases/DataType.md); \} \| \{ `@id`: `string`; \}
+> `optional` **rightOperand**: `string` \| \{ `@value`: `string`; `@type`: `string`; \} \| \{ `@id`: `string`; \}
 
 The right operand of the constraint.
 value with optional
@@ -55,7 +55,7 @@ Reference to the right operand.
 
 ### dataType?
 
-> `optional` **dataType**: [`DataType`](../type-aliases/DataType.md)
+> `optional` **dataType**: `string`
 
 The data type of the right operand.
 

package/docs/reference/interfaces/IOdrlOffer.md

@@ -0,0 +1,180 @@
+# Interface: IOdrlOffer
+
+Interface representing an ODRL Offer.
+An Offer requires an assigner (the party making the offer).
+
+## Extends
+
+- [`IOdrlPolicy`](IOdrlPolicy.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### @type
+
+> **@type**: `"Offer"`
+
+The type must be "Offer".
+
+#### Overrides
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`@type`](IOdrlPolicy.md#type)
+
+***
+
+### assigner
+
+> **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the offer.
+Required for Offer policies.
+
+#### Overrides
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`assigner`](IOdrlPolicy.md#assigner)
+
+***
+
+### @context
+
+> **@context**: [`OdrlContextType`](../type-aliases/OdrlContextType.md)
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`@context`](IOdrlPolicy.md#context)
+
+***
+
+### uid
+
+> **uid**: `string`
+
+The unique identifier for the policy.
+Must be an IRI.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`uid`](IOdrlPolicy.md#uid)
+
+***
+
+### profile?
+
+> `optional` **profile**: `string` \| `string`[]
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`profile`](IOdrlPolicy.md#profile)
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assignee of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`assignee`](IOdrlPolicy.md#assignee)
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| [`IOdrlAsset`](IOdrlAsset.md) \| (`string` \| [`IOdrlAsset`](IOdrlAsset.md))[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`target`](IOdrlPolicy.md#target)
+
+***
+
+### action?
+
+> `optional` **action**: [`ActionType`](../type-aliases/ActionType.md) \| [`IOdrlAction`](IOdrlAction.md) \| ActionType \| IOdrlAction[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`action`](IOdrlPolicy.md#action)
+
+***
+
+### inheritFrom?
+
+> `optional` **inheritFrom**: `string` \| `string`[]
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`inheritFrom`](IOdrlPolicy.md#inheritfrom)
+
+***
+
+### conflict?
+
+> `optional` **conflict**: [`ConflictStrategyType`](../type-aliases/ConflictStrategyType.md)
+
+The conflict resolution strategy.
+- perm: Permissions override Prohibitions
+- prohibit: Prohibitions override Permissions
+- invalid: Policy is void if conflicts exist (default)
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`conflict`](IOdrlPolicy.md#conflict)
+
+***
+
+### permission?
+
+> `optional` **permission**: [`IOdrlPermission`](IOdrlPermission.md)[]
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`permission`](IOdrlPolicy.md#permission)
+
+***
+
+### prohibition?
+
+> `optional` **prohibition**: [`IOdrlProhibition`](IOdrlProhibition.md)[]
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`prohibition`](IOdrlPolicy.md#prohibition)
+
+***
+
+### obligation?
+
+> `optional` **obligation**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`obligation`](IOdrlPolicy.md#obligation)

package/docs/reference/interfaces/IOdrlPolicy.md

@@ -6,6 +6,12 @@ Interface representing an ODRL Policy.
 
 - `IJsonLdNodeObject`
 
+## Extended by
+
+- [`IOdrlAgreement`](IOdrlAgreement.md)
+- [`IOdrlOffer`](IOdrlOffer.md)
+- [`IOdrlSet`](IOdrlSet.md)
+
 ## Indexable
 
 \[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]