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

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`[]

package/docs/reference/interfaces/IOdrlRule.md

@@ -8,9 +8,9 @@ Base interface for ODRL Rules.
 
 ## Extended by
 
+- [`IOdrlDuty`](IOdrlDuty.md)
 - [`IOdrlPermission`](IOdrlPermission.md)
 - [`IOdrlProhibition`](IOdrlProhibition.md)
-- [`IOdrlDuty`](IOdrlDuty.md)
 
 ## Indexable
 

package/docs/reference/interfaces/IOdrlSet.md

@@ -0,0 +1,180 @@
+# Interface: IOdrlSet
+
+Interface representing an ODRL Set.
+A Set is a basic policy type with no specific party requirements.
+
+## 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
+
+### @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)
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`assigner`](IOdrlPolicy.md#assigner)
+
+***
+
+### 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)
+
+***
+
+### @type
+
+> **@type**: `"Set"`
+
+The type must be "Set".
+
+#### Overrides
+
+[`IOdrlPolicy`](IOdrlPolicy.md).[`@type`](IOdrlPolicy.md#type)

package/docs/reference/type-aliases/ActionType.md

@@ -1,5 +1,5 @@
 # Type Alias: ActionType
 
-> **ActionType** = *typeof* [`ActionTypes`](../variables/ActionTypes.md)\[keyof *typeof* [`ActionTypes`](../variables/ActionTypes.md)\]
+> **ActionType** = *typeof* [`ActionType`](../variables/ActionType.md)\[keyof *typeof* [`ActionType`](../variables/ActionType.md)\]
 
 The types for ODRL Actions.

package/docs/reference/type-aliases/ConflictStrategyType.md

@@ -1,5 +1,5 @@
 # Type Alias: ConflictStrategyType
 
-> **ConflictStrategyType** = *typeof* [`ConflictStrategyTypes`](../variables/ConflictStrategyTypes.md)\[keyof *typeof* [`ConflictStrategyTypes`](../variables/ConflictStrategyTypes.md)\]
+> **ConflictStrategyType** = *typeof* [`ConflictStrategyType`](../variables/ConflictStrategyType.md)\[keyof *typeof* [`ConflictStrategyType`](../variables/ConflictStrategyType.md)\]
 
 The types for ODRL Conflict Resolution Strategies.

package/docs/reference/type-aliases/OdrlContextType.md

@@ -1,5 +1,5 @@
 # Type Alias: OdrlContextType
 
-> **OdrlContextType** = *typeof* [`Context`](../variables/OdrlContexts.md#context) \| \[*typeof* [`Context`](../variables/OdrlContexts.md#context), `...IJsonLdContextDefinitionElement[]`\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`Context`](../variables/OdrlContexts.md#context), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/OdrlContexts.md#context), `...IJsonLdContextDefinitionElement[]`\]
+> **OdrlContextType** = *typeof* [`ContextRoot`](../variables/OdrlContexts.md#contextroot) \| \[*typeof* [`ContextRoot`](../variables/OdrlContexts.md#contextroot), `...IJsonLdContextDefinitionElement[]`\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/OdrlContexts.md#contextroot), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`ContextRoot`](../variables/OdrlContexts.md#contextroot), `...IJsonLdContextDefinitionElement[]`\]
 
 The ODRL JSON-LD context type.

package/docs/reference/type-aliases/RightOperandType.md

@@ -1,5 +1,5 @@
 # Type Alias: RightOperandType
 
-> **RightOperandType** = *typeof* [`RightOperandTypes`](../variables/RightOperandTypes.md)\[keyof *typeof* [`RightOperandTypes`](../variables/RightOperandTypes.md)\]
+> **RightOperandType** = *typeof* [`RightOperandType`](../variables/RightOperandType.md)\[keyof *typeof* [`RightOperandType`](../variables/RightOperandType.md)\]
 
 The types for ODRL Right Operand Types.

package/docs/reference/type-aliases/UriActionType.md

@@ -1,6 +1,6 @@
 # Type Alias: UriActionType
 
-> **UriActionType** = *typeof* [`UriActionTypes`](../variables/UriActionTypes.md)\[keyof *typeof* [`UriActionTypes`](../variables/UriActionTypes.md)\]
+> **UriActionType** = *typeof* [`UriActionType`](../variables/UriActionType.md)\[keyof *typeof* [`UriActionType`](../variables/UriActionType.md)\]
 
 The types for ODRL Actions.
 Simple action types (for direct string usage)

package/docs/reference/variables/{ActionTypes.md → ActionType.md}

@@ -1,6 +1,6 @@
-# Variable: ActionTypes
+# Variable: ActionType
 
-> `const` **ActionTypes**: `object`
+> `const` **ActionType**: `object`
 
 The types for ODRL Actions.
 Simple action types (for direct string usage)

package/docs/reference/variables/{ConflictStrategyTypes.md → ConflictStrategyType.md}

@@ -1,6 +1,6 @@
-# Variable: ConflictStrategyTypes
+# Variable: ConflictStrategyType
 
-> `const` **ConflictStrategyTypes**: `object`
+> `const` **ConflictStrategyType**: `object`
 
 The types for ODRL Conflict Resolution Strategies.
 

package/docs/reference/variables/OdrlContexts.md

@@ -6,32 +6,14 @@ The contexts for ODRL.
 
 ## Type declaration
 
-### Context
+### ContextRedirect
 
-> `readonly` **Context**: `"https://www.w3.org/ns/odrl.jsonld"` = `"https://www.w3.org/ns/odrl.jsonld"`
+> `readonly` **ContextRedirect**: `"https://www.w3.org/ns/odrl.jsonld"` = `"https://www.w3.org/ns/odrl.jsonld"`
 
 The context root for ODRL.
 
-### ContextVocabulary
+### ContextRoot
 
-> `readonly` **ContextVocabulary**: `"https://www.w3.org/ns/odrl/2/"` = `"https://www.w3.org/ns/odrl/2/"`
+> `readonly` **ContextRoot**: `"https://www.w3.org/ns/odrl/2/"` = `"https://www.w3.org/ns/odrl/2/"`
 
 The context root for ODRL vocabulary.
-
-### ContextDcTerms
-
-> `readonly` **ContextDcTerms**: `"https://purl.org/dc/terms/"` = `"https://purl.org/dc/terms/"`
-
-The context root for Dublin Core Terms.
-
-### ContextRdf
-
-> `readonly` **ContextRdf**: `"https://www.w3.org/1999/02/22-rdf-syntax-ns#"` = `"https://www.w3.org/1999/02/22-rdf-syntax-ns#"`
-
-The context root for RDF.
-
-### ContextXsd
-
-> `readonly` **ContextXsd**: `"https://www.w3.org/2001/XMLSchema#"` = `"https://www.w3.org/2001/XMLSchema#"`
-
-The context root for XSD.

package/docs/reference/variables/OdrlTypes.md

@@ -95,3 +95,15 @@ Constraint type.
 > `readonly` **LogicalConstraint**: `"LogicalConstraint"` = `"LogicalConstraint"`
 
 LogicalConstraint type.
+
+### ContextType
+
+> `readonly` **ContextType**: `"ContextType"` = `"ContextType"`
+
+ContextType.
+
+### PolicyMetadata
+
+> `readonly` **PolicyMetadata**: `"PolicyMetadata"` = `"PolicyMetadata"`
+
+PolicyMetadata type.

package/docs/reference/variables/{RightOperandTypes.md → RightOperandType.md}

@@ -1,6 +1,6 @@
-# Variable: RightOperandTypes
+# Variable: RightOperandType
 
-> `const` **RightOperandTypes**: `object`
+> `const` **RightOperandType**: `object`
 
 Right operand types for ODRL constraints
 

package/docs/reference/variables/{UriActionTypes.md → UriActionType.md}

@@ -1,6 +1,6 @@
-# Variable: UriActionTypes
+# Variable: UriActionType
 
-> `const` **UriActionTypes**: `object`
+> `const` **UriActionType**: `object`
 
 The types for ODRL Actions.
 URI action types (for use with rdf:value/@id)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-w3c-odrl",
-	"version": "0.0.1-next.44",
+	"version": "0.0.1-next.46",
 	"description": "Models which define the structure of W3C ODRL Standard",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/standards-dublin-core": "0.0.1-next.44",
-		"@twin.org/standards-w3c-vcard": "0.0.1-next.44",
+		"@twin.org/standards-dublin-core": "0.0.1-next.46",
+		"@twin.org/standards-w3c-vcard": "0.0.1-next.46",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",

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

@@ -1,37 +0,0 @@
-/**
- * The types for ODRL Data Types.
- */
-export declare const DataType: {
-    /**
-     * String type.
-     */
-    readonly String: "xsd:string";
-    /**
-     * Boolean type.
-     */
-    readonly Boolean: "xsd:boolean";
-    /**
-     * Integer type.
-     */
-    readonly Integer: "xsd:integer";
-    /**
-     * Decimal type.
-     */
-    readonly Decimal: "xsd:decimal";
-    /**
-     * Double type.
-     */
-    readonly Double: "xsd:double";
-    /**
-     * Date type.
-     */
-    readonly Date: "xsd:date";
-    /**
-     * DateTime type.
-     */
-    readonly DateTime: "xsd:dateTime";
-};
-/**
- * The types for ODRL Data Types.
- */
-export type DataType = (typeof DataType)[keyof typeof DataType];

package/docs/reference/type-aliases/DataType.md

@@ -1,5 +0,0 @@
-# Type Alias: DataType
-
-> **DataType** = *typeof* [`DataType`](../variables/DataType.md)\[keyof *typeof* [`DataType`](../variables/DataType.md)\]
-
-The types for ODRL Data Types.

package/docs/reference/variables/DataType.md

@@ -1,49 +0,0 @@
-# Variable: DataType
-
-> `const` **DataType**: `object`
-
-The types for ODRL Data Types.
-
-## Type declaration
-
-### String
-
-> `readonly` **String**: `"xsd:string"` = `"xsd:string"`
-
-String type.
-
-### Boolean
-
-> `readonly` **Boolean**: `"xsd:boolean"` = `"xsd:boolean"`
-
-Boolean type.
-
-### Integer
-
-> `readonly` **Integer**: `"xsd:integer"` = `"xsd:integer"`
-
-Integer type.
-
-### Decimal
-
-> `readonly` **Decimal**: `"xsd:decimal"` = `"xsd:decimal"`
-
-Decimal type.
-
-### Double
-
-> `readonly` **Double**: `"xsd:double"` = `"xsd:double"`
-
-Double type.
-
-### Date
-
-> `readonly` **Date**: `"xsd:date"` = `"xsd:date"`
-
-Date type.
-
-### DateTime
-
-> `readonly` **DateTime**: `"xsd:dateTime"` = `"xsd:dateTime"`
-
-DateTime type.