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

package/docs/reference/interfaces/IOdrlRule.md

@@ -0,0 +1,75 @@
+# Interface: IOdrlRule
+
+Base interface for ODRL Rules.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Extended by
+
+- [`IOdrlPermission`](IOdrlPermission.md)
+- [`IOdrlProhibition`](IOdrlProhibition.md)
+- [`IOdrlDuty`](IOdrlDuty.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`
+
+Optional unique identifier for the rule.
+
+***
+
+### action?
+
+> `optional` **action**: [`ActionType`](../type-aliases/ActionType.md) \| [`IOdrlAction`](IOdrlAction.md) \| ActionType \| IOdrlAction[]
+
+The action associated with the rule.
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| [`IOdrlAsset`](IOdrlAsset.md) \| (`string` \| [`IOdrlAsset`](IOdrlAsset.md))[]
+
+The target asset for the rule.
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assigner of the rule.
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| [`IOdrlParty`](IOdrlParty.md)
+
+The assignee of the rule.
+
+***
+
+### constraint?
+
+> `optional` **constraint**: [`IOdrlConstraint`](IOdrlConstraint.md)[]
+
+Constraints applied to the rule.
+
+***
+
+### 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/docs/reference/variables/ActionTypes.md

@@ -0,0 +1,314 @@
+# Variable: ActionTypes
+
+> `const` **ActionTypes**: `object`
+
+The types for ODRL Actions.
+Simple action types (for direct string usage)
+
+## Type declaration
+
+### Use
+
+> `readonly` **Use**: `"use"` = `"use"`
+
+To use the Asset - actions that involve general usage by parties.
+
+### Transfer
+
+> `readonly` **Transfer**: `"transfer"` = `"transfer"`
+
+To transfer the ownership to third parties.
+
+### AcceptTracking
+
+> `readonly` **AcceptTracking**: `"acceptTracking"` = `"acceptTracking"`
+
+To accept that the use of the Asset may be tracked.
+
+### Aggregate
+
+> `readonly` **Aggregate**: `"aggregate"` = `"aggregate"`
+
+To use the Asset or parts of it as part of a composite collection.
+
+### Annotate
+
+> `readonly` **Annotate**: `"annotate"` = `"annotate"`
+
+To add explanatory notations/commentaries to the Asset without modifying the Asset in any other way.
+
+### Anonymize
+
+> `readonly` **Anonymize**: `"anonymize"` = `"anonymize"`
+
+To anonymize all or parts of the Asset.
+
+### Archive
+
+> `readonly` **Archive**: `"archive"` = `"archive"`
+
+To store the Asset (in a non-transient form).
+
+### Attribute
+
+> `readonly` **Attribute**: `"attribute"` = `"attribute"`
+
+To attribute the use of the Asset.
+
+### Attribution
+
+> `readonly` **Attribution**: `"attribution"` = `"attribution"`
+
+Credit be given to copyright holder and/or author.
+
+### CommercialUse
+
+> `readonly` **CommercialUse**: `"commercialUse"` = `"commercialUse"`
+
+Exercising rights for commercial purposes.
+
+### Compensate
+
+> `readonly` **Compensate**: `"compensate"` = `"compensate"`
+
+To compensate by transfer of some amount of value for using or selling the Asset.
+
+### ConcurrentUse
+
+> `readonly` **ConcurrentUse**: `"concurrentUse"` = `"concurrentUse"`
+
+To create multiple copies of the Asset that are being concurrently used.
+
+### Delete
+
+> `readonly` **Delete**: `"delete"` = `"delete"`
+
+To permanently remove all copies of the Asset after it has been used.
+
+### Derive
+
+> `readonly` **Derive**: `"derive"` = `"derive"`
+
+To create a new derivative Asset from this Asset and to edit or modify the derivative.
+
+### DerivativeWorks
+
+> `readonly` **DerivativeWorks**: `"derivativeWorks"` = `"derivativeWorks"`
+
+Distribution of derivative works.
+
+### Digitize
+
+> `readonly` **Digitize**: `"digitize"` = `"digitize"`
+
+To produce a digital copy of (or otherwise digitize) the Asset from its analogue form.
+
+### Display
+
+> `readonly` **Display**: `"display"` = `"display"`
+
+To create a static and transient rendition of an Asset.
+
+### Distribute
+
+> `readonly` **Distribute**: `"distribute"` = `"distribute"`
+
+To supply the Asset to third-parties.
+
+### Distribution
+
+> `readonly` **Distribution**: `"distribution"` = `"distribution"`
+
+Distribution, public display, and publicly performance.
+
+### EnsureExclusivity
+
+> `readonly` **EnsureExclusivity**: `"ensureExclusivity"` = `"ensureExclusivity"`
+
+To ensure that the Rule on the Asset is exclusive.
+
+### Execute
+
+> `readonly` **Execute**: `"execute"` = `"execute"`
+
+To run the computer program Asset.
+
+### Extract
+
+> `readonly` **Extract**: `"extract"` = `"extract"`
+
+To extract parts of the Asset and to use it as a new Asset.
+
+### Give
+
+> `readonly` **Give**: `"give"` = `"give"`
+
+To transfer the ownership without compensation and while deleting the original asset.
+
+### GrantUse
+
+> `readonly` **GrantUse**: `"grantUse"` = `"grantUse"`
+
+To grant the use of the Asset to third parties.
+
+### Include
+
+> `readonly` **Include**: `"include"` = `"include"`
+
+To include other related assets in the Asset.
+
+### Index
+
+> `readonly` **Index**: `"index"` = `"index"`
+
+To record the Asset in an index.
+
+### Inform
+
+> `readonly` **Inform**: `"inform"` = `"inform"`
+
+To inform that an action has been performed on or in relation to the Asset.
+
+### Install
+
+> `readonly` **Install**: `"install"` = `"install"`
+
+To load the computer program Asset onto a storage device.
+
+### Modify
+
+> `readonly` **Modify**: `"modify"` = `"modify"`
+
+To change existing content of the Asset without creating a new asset.
+
+### Move
+
+> `readonly` **Move**: `"move"` = `"move"`
+
+To move the Asset from one digital location to another including deleting the original copy.
+
+### NextPolicy
+
+> `readonly` **NextPolicy**: `"nextPolicy"` = `"nextPolicy"`
+
+To grant the specified Policy to a third party for their use of the Asset.
+
+### Notice
+
+> `readonly` **Notice**: `"notice"` = `"notice"`
+
+Copyright and license notices be kept intact.
+
+### ObtainConsent
+
+> `readonly` **ObtainConsent**: `"obtainConsent"` = `"obtainConsent"`
+
+To obtain verifiable consent to perform the requested action.
+
+### Play
+
+> `readonly` **Play**: `"play"` = `"play"`
+
+To create a sequential and transient rendition of an Asset.
+
+### Present
+
+> `readonly` **Present**: `"present"` = `"present"`
+
+To publicly perform the Asset.
+
+### Print
+
+> `readonly` **Print**: `"print"` = `"print"`
+
+To create a tangible and permanent rendition of an Asset.
+
+### Read
+
+> `readonly` **Read**: `"read"` = `"read"`
+
+To obtain data from the Asset.
+
+### Reproduce
+
+> `readonly` **Reproduce**: `"reproduce"` = `"reproduce"`
+
+To make duplicate copies of the Asset in any material form.
+
+### Reproduction
+
+> `readonly` **Reproduction**: `"reproduction"` = `"reproduction"`
+
+Making multiple copies.
+
+### ReviewPolicy
+
+> `readonly` **ReviewPolicy**: `"reviewPolicy"` = `"reviewPolicy"`
+
+To review the Policy applicable to the Asset.
+
+### Sell
+
+> `readonly` **Sell**: `"sell"` = `"sell"`
+
+To transfer the ownership with compensation and while deleting the original asset.
+
+### ShareAlike
+
+> `readonly` **ShareAlike**: `"shareAlike"` = `"shareAlike"`
+
+Derivative works be licensed under the same terms or compatible terms.
+
+### Sharing
+
+> `readonly` **Sharing**: `"sharing"` = `"sharing"`
+
+Permits commercial derivatives, but only non-commercial distribution.
+
+### SourceCode
+
+> `readonly` **SourceCode**: `"sourceCode"` = `"sourceCode"`
+
+Source code must be provided when exercising some rights.
+
+### Stream
+
+> `readonly` **Stream**: `"stream"` = `"stream"`
+
+To deliver the Asset in real-time.
+
+### Synchronize
+
+> `readonly` **Synchronize**: `"synchronize"` = `"synchronize"`
+
+To use the Asset in timed relations with media elements of another Asset.
+
+### TextToSpeech
+
+> `readonly` **TextToSpeech**: `"textToSpeech"` = `"textToSpeech"`
+
+To have a text Asset read out loud.
+
+### Transform
+
+> `readonly` **Transform**: `"transform"` = `"transform"`
+
+To convert the Asset into a different format.
+
+### Translate
+
+> `readonly` **Translate**: `"translate"` = `"translate"`
+
+To translate the Asset into another natural language.
+
+### Uninstall
+
+> `readonly` **Uninstall**: `"uninstall"` = `"uninstall"`
+
+To unload and delete the computer program Asset.
+
+### Watermark
+
+> `readonly` **Watermark**: `"watermark"` = `"watermark"`
+
+To apply a watermark to the Asset.

package/docs/reference/variables/ConflictStrategyTypes.md

@@ -0,0 +1,25 @@
+# Variable: ConflictStrategyTypes
+
+> `const` **ConflictStrategyTypes**: `object`
+
+The types for ODRL Conflict Resolution Strategies.
+
+## Type declaration
+
+### Perm
+
+> `readonly` **Perm**: `"perm"` = `"perm"`
+
+Permission type.
+
+### Prohibit
+
+> `readonly` **Prohibit**: `"prohibit"` = `"prohibit"`
+
+Prohibition type.
+
+### Invalid
+
+> `readonly` **Invalid**: `"invalid"` = `"invalid"`
+
+Invalid type.

package/docs/reference/variables/DataType.md

@@ -0,0 +1,49 @@
+# 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.