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

package/docs/reference/interfaces/IOdrlLogicalConstraint.md

@@ -0,0 +1,70 @@
+# Interface: IOdrlLogicalConstraint
+
+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.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdNodeObject`[] \| `IJsonLdGraphObject` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\}
+
+## Properties
+
+### uid?
+
+> `optional` **uid**: `string`
+
+Optional unique identifier for the logical constraint.
+Must be an IRI.
+
+***
+
+### and?
+
+> `optional` **and**: `object`
+
+AND operator - all constraints must be satisfied.
+
+#### @list
+
+> **@list**: `object`[]
+
+***
+
+### or?
+
+> `optional` **or**: `object`
+
+OR operator - at least one constraint must be satisfied.
+
+#### @list
+
+> **@list**: `object`[]
+
+***
+
+### xone?
+
+> `optional` **xone**: `object`
+
+XOR operator - exactly one constraint must be satisfied.
+
+#### @list
+
+> **@list**: `object`[]
+
+***
+
+### andSequence?
+
+> `optional` **andSequence**: `object`
+
+AND Sequence operator - all constraints must be satisfied in order.
+
+#### @list
+
+> **@list**: `object`[]

package/docs/reference/interfaces/IOdrlParty.md

@@ -0,0 +1,67 @@
+# Interface: IOdrlParty
+
+Interface for ODRL Parties.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Extended by
+
+- [`IOdrlPartyCollection`](IOdrlPartyCollection.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdNodeObject`[] \| `IJsonLdGraphObject` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\}
+
+## Properties
+
+### uid?
+
+> `optional` **uid**: `string`
+
+The unique identifier for the party.
+Must be an IRI.
+
+***
+
+### @type?
+
+> `optional` **@type**: `string` \| `string`[]
+
+The type of the party.
+Can be used to specify additional type information (e.g., "Party",
+"vcard:Organization", "vcard:Individual").
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### partOf?
+
+> `optional` **partOf**: `string` \| [`IOdrlPartyCollection`](IOdrlPartyCollection.md)
+
+Reference to the party collection this party is part of.
+Used to identify a PartyCollection that a Party entity is a member of.
+
+***
+
+### assigneeOf?
+
+> `optional` **assigneeOf**: `string`
+
+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.
+
+***
+
+### assignerOf?
+
+> `optional` **assignerOf**: `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.

package/docs/reference/interfaces/IOdrlPartyCollection.md

@@ -0,0 +1,98 @@
+# Interface: IOdrlPartyCollection
+
+Interface for ODRL Party Collections.
+A PartyCollection identifies a collection of entities and is a subclass of Party.
+
+## Extends
+
+- [`IOdrlParty`](IOdrlParty.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdNodeObject`[] \| `IJsonLdGraphObject` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\}
+
+## Properties
+
+### uid?
+
+> `optional` **uid**: `string`
+
+The unique identifier for the party.
+Must be an IRI.
+
+#### Inherited from
+
+[`IOdrlParty`](IOdrlParty.md).[`uid`](IOdrlParty.md#uid)
+
+***
+
+### @type?
+
+> `optional` **@type**: `string` \| `string`[]
+
+The type of the party.
+Can be used to specify additional type information (e.g., "Party",
+"vcard:Organization", "vcard:Individual").
+
+#### Inherited from
+
+[`IOdrlParty`](IOdrlParty.md).[`@type`](IOdrlParty.md#@type)
+
+***
+
+### partOf?
+
+> `optional` **partOf**: `string` \| [`IOdrlPartyCollection`](IOdrlPartyCollection.md)
+
+Reference to the party collection this party is part of.
+Used to identify a PartyCollection that a Party entity is a member of.
+
+#### Inherited from
+
+[`IOdrlParty`](IOdrlParty.md).[`partOf`](IOdrlParty.md#partof)
+
+***
+
+### assigneeOf?
+
+> `optional` **assigneeOf**: `string`
+
+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.
+
+#### Inherited from
+
+[`IOdrlParty`](IOdrlParty.md).[`assigneeOf`](IOdrlParty.md#assigneeof)
+
+***
+
+### assignerOf?
+
+> `optional` **assignerOf**: `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.
+
+#### Inherited from
+
+[`IOdrlParty`](IOdrlParty.md).[`assignerOf`](IOdrlParty.md#assignerof)
+
+***
+
+### source
+
+> **source**: `string`
+
+Reference to the source of the party collection.
+Used to identify the origin or location of the collection.
+
+***
+
+### refinement?
+
+> `optional` **refinement**: [`IOdrlConstraint`](IOdrlConstraint.md)[]
+
+Refinements applied to the party collection.
+Used to specify constraints that apply to all members of the collection.

package/docs/reference/interfaces/IOdrlPermission.md

@@ -0,0 +1,108 @@
+# Interface: IOdrlPermission
+
+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.
+
+## Extends
+
+- [`IOdrlRule`](IOdrlRule.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdNodeObject`[] \| `IJsonLdGraphObject` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\}
+
+## Properties
+
+### duty?
+
+> `optional` **duty**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The duties that must be fulfilled before the permission can be exercised.
+A Permission MAY have none, one, or more duty property values.
+
+***
+
+### uid?
+
+> `optional` **uid**: `string`
+
+Optional unique identifier for the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`uid`](IOdrlRule.md#uid)
+
+***
+
+### action?
+
+> `optional` **action**: [`ActionType`](../type-aliases/ActionType.md) \| [`IOdrlAction`](IOdrlAction.md) \| ActionType \| IOdrlAction[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`action`](IOdrlRule.md#action)
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| [`IOdrlAsset`](IOdrlAsset.md) \| (`string` \| [`IOdrlAsset`](IOdrlAsset.md))[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`target`](IOdrlRule.md#target)
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`assigner`](IOdrlRule.md#assigner)
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assignee of the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`assignee`](IOdrlRule.md#assignee)
+
+***
+
+### constraint?
+
+> `optional` **constraint**: [`IOdrlConstraint`](IOdrlConstraint.md)[]
+
+Constraints applied to the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`constraint`](IOdrlRule.md#constraint)
+
+***
+
+### summary?
+
+> `optional` **summary**: `string`
+
+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.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`summary`](IOdrlRule.md#summary)

package/docs/reference/interfaces/IOdrlPolicy.md

@@ -0,0 +1,136 @@
+# Interface: IOdrlPolicy
+
+Interface representing an ODRL Policy.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdNodeObject`[] \| `IJsonLdGraphObject` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\}
+
+## Properties
+
+### @context
+
+> **@context**: `"https://www.w3.org/ns/odrl.jsonld"` \| `IJsonLdContextDefinition` \| \[`"https://www.w3.org/ns/odrl.jsonld"`, `IJsonLdContextDefinition`\]
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### @type
+
+> **@type**: [`PolicyType`](../type-aliases/PolicyType.md)
+
+The type of policy.
+Must be one of: "Set", "Offer", "Agreement"
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### uid
+
+> **uid**: `string`
+
+The unique identifier for the policy.
+Must be an IRI.
+
+***
+
+### profile?
+
+> `optional` **profile**: `string` \| `string`[]
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the policy.
+Applies to all rules unless overridden at rule level.
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assignee of the policy.
+Applies to all rules unless overridden at rule level.
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| [`IOdrlAsset`](IOdrlAsset.md) \| (`string` \| [`IOdrlAsset`](IOdrlAsset.md))[]
+
+The target asset for the rule.
+
+***
+
+### action?
+
+> `optional` **action**: [`ActionType`](../type-aliases/ActionType.md) \| [`IOdrlAction`](IOdrlAction.md) \| ActionType \| IOdrlAction[]
+
+The action associated with the rule.
+
+***
+
+### inheritFrom?
+
+> `optional` **inheritFrom**: `string` \| `string`[]
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+***
+
+### 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)
+
+***
+
+### permission?
+
+> `optional` **permission**: [`IOdrlPermission`](IOdrlPermission.md)[]
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+***
+
+### prohibition?
+
+> `optional` **prohibition**: [`IOdrlProhibition`](IOdrlProhibition.md)[]
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+***
+
+### obligation?
+
+> `optional` **obligation**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.

package/docs/reference/interfaces/IOdrlPolicyMetadata.md

@@ -0,0 +1,86 @@
+# Interface: IOdrlPolicyMetadata
+
+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.
+
+## Properties
+
+### dc:creator?
+
+> `optional` **dc:creator**: `string` \| `string`[]
+
+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:description?
+
+> `optional` **dc:description**: `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:issued?
+
+> `optional` **dc:issued**: `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:modified?
+
+> `optional` **dc:modified**: `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:publisher?
+
+> `optional` **dc:publisher**: `string`
+
+The publisher of the Policy.
+Note: String values may not be normalized and should not be used for direct comparison.
+
+***
+
+### dc:subject?
+
+> `optional` **dc:subject**: `string` \| `string`[]
+
+The subject of the Policy.
+Note: String values may not be normalized and should not be used for direct comparison.
+
+***
+
+### dc:coverage?
+
+> `optional` **dc:coverage**: `string` \| \{ `@id`: `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:replaces?
+
+> `optional` **dc:replaces**: `string` \| \{ `@id`: `string`; \}
+
+The identifier of a Policy that this Policy supersedes.
+Using "@id" references is preferred for comparison purposes.
+
+***
+
+### dc:isReplacedBy?
+
+> `optional` **dc:isReplacedBy**: `string` \| \{ `@id`: `string`; \}
+
+The identifier of a Policy that supersedes this Policy.
+Using "@id" references is preferred for comparison purposes.

package/docs/reference/interfaces/IOdrlProhibition.md

@@ -0,0 +1,105 @@
+# Interface: IOdrlProhibition
+
+Interface for Prohibition Rules.
+
+## Extends
+
+- [`IOdrlRule`](IOdrlRule.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdNodeObject`[] \| `IJsonLdGraphObject` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\}
+
+## Properties
+
+### remedy?
+
+> `optional` **remedy**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The remedies that must be fulfilled if prohibition is violated.
+
+***
+
+### uid?
+
+> `optional` **uid**: `string`
+
+Optional unique identifier for the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`uid`](IOdrlRule.md#uid)
+
+***
+
+### action?
+
+> `optional` **action**: [`ActionType`](../type-aliases/ActionType.md) \| [`IOdrlAction`](IOdrlAction.md) \| ActionType \| IOdrlAction[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`action`](IOdrlRule.md#action)
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| [`IOdrlAsset`](IOdrlAsset.md) \| (`string` \| [`IOdrlAsset`](IOdrlAsset.md))[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`target`](IOdrlRule.md#target)
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`assigner`](IOdrlRule.md#assigner)
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assignee of the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`assignee`](IOdrlRule.md#assignee)
+
+***
+
+### constraint?
+
+> `optional` **constraint**: [`IOdrlConstraint`](IOdrlConstraint.md)[]
+
+Constraints applied to the rule.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`constraint`](IOdrlRule.md#constraint)
+
+***
+
+### summary?
+
+> `optional` **summary**: `string`
+
+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.
+
+#### Inherited from
+
+[`IOdrlRule`](IOdrlRule.md).[`summary`](IOdrlRule.md#summary)