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

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

@@ -0,0 +1,215 @@
+/**
+ * The types for ODRL Actions.
+ * URI action types (for use with rdf:value/@id)
+ */
+export declare const UriActionTypes: {
+    /**
+     * To use the Asset - actions that involve general usage by parties.
+     */
+    readonly OdrlUse: "odrl:use";
+    /**
+     * To transfer the ownership to third parties.
+     */
+    readonly OdrlTransfer: "odrl:transfer";
+    /**
+     * To accept that the use of the Asset may be tracked.
+     */
+    readonly OdrlAcceptTracking: "odrl:acceptTracking";
+    /**
+     * To use the Asset or parts of it as part of a composite collection.
+     */
+    readonly OdrlAggregate: "odrl:aggregate";
+    /**
+     * To add explanatory notations/commentaries to the Asset without modifying the Asset in any other way.
+     */
+    readonly OdrlAnnotate: "odrl:annotate";
+    /**
+     * To anonymize all or parts of the Asset.
+     */
+    readonly OdrlAnonymize: "odrl:anonymize";
+    /**
+     * To store the Asset (in a non-transient form).
+     */
+    readonly OdrlArchive: "odrl:archive";
+    /**
+     * To attribute the use of the Asset.
+     */
+    readonly OdrlAttribute: "odrl:attribute";
+    /**
+     * Credit be given to copyright holder and/or author.
+     */
+    readonly OdrlAttribution: "odrl:attribution";
+    /**
+     * Exercising rights for commercial purposes.
+     */
+    readonly OdrlCommercialUse: "odrl:commercialUse";
+    /**
+     * To compensate by transfer of some amount of value for using or selling the Asset.
+     */
+    readonly OdrlCompensate: "odrl:compensate";
+    /**
+     * To create multiple copies of the Asset that are being concurrently used.
+     */
+    readonly OdrlConcurrentUse: "odrl:concurrentUse";
+    /**
+     * To permanently remove all copies of the Asset after it has been used.
+     */
+    readonly OdrlDelete: "odrl:delete";
+    /**
+     * To create a new derivative Asset from this Asset and to edit or modify the derivative.
+     */
+    readonly OdrlDerive: "odrl:derive";
+    /**
+     * Distribution of derivative works.
+     */
+    readonly OdrlDerivativeWorks: "odrl:derivativeWorks";
+    /**
+     * To produce a digital copy of (or otherwise digitize) the Asset from its analogue form.
+     */
+    readonly OdrlDigitize: "odrl:digitize";
+    /**
+     * To create a static and transient rendition of an Asset.
+     */
+    readonly OdrlDisplay: "odrl:display";
+    /**
+     * To supply the Asset to third-parties.
+     */
+    readonly OdrlDistribute: "odrl:distribute";
+    /**
+     * Distribution, public display, and publicly performance.
+     */
+    readonly OdrlDistribution: "odrl:distribution";
+    /**
+     * To ensure that the Rule on the Asset is exclusive.
+     */
+    readonly OdrlEnsureExclusivity: "odrl:ensureExclusivity";
+    /**
+     * To run the computer program Asset.
+     */
+    readonly OdrlExecute: "odrl:execute";
+    /**
+     * To extract parts of the Asset and to use it as a new Asset.
+     */
+    readonly OdrlExtract: "odrl:extract";
+    /**
+     * To transfer the ownership without compensation and while deleting the original asset.
+     */
+    readonly OdrlGive: "odrl:give";
+    /**
+     * To grant the use of the Asset to third parties.
+     */
+    readonly OdrlGrantUse: "odrl:grantUse";
+    /**
+     * To include other related assets in the Asset.
+     */
+    readonly OdrlInclude: "odrl:include";
+    /**
+     * To record the Asset in an index.
+     */
+    readonly OdrlIndex: "odrl:index";
+    /**
+     * To inform that an action has been performed on or in relation to the Asset.
+     */
+    readonly OdrlInform: "odrl:inform";
+    /**
+     * To load the computer program Asset onto a storage device.
+     */
+    readonly OdrlInstall: "odrl:install";
+    /**
+     * To change existing content of the Asset without creating a new asset.
+     */
+    readonly OdrlModify: "odrl:modify";
+    /**
+     * To move the Asset from one digital location to another including deleting the original copy.
+     */
+    readonly OdrlMove: "odrl:move";
+    /**
+     * To grant the specified Policy to a third party for their use of the Asset.
+     */
+    readonly OdrlNextPolicy: "odrl:nextPolicy";
+    /**
+     * Copyright and license notices be kept intact.
+     */
+    readonly OdrlNotice: "odrl:notice";
+    /**
+     * To obtain verifiable consent to perform the requested action.
+     */
+    readonly OdrlObtainConsent: "odrl:obtainConsent";
+    /**
+     * To create a sequential and transient rendition of an Asset.
+     */
+    readonly OdrlPlay: "odrl:play";
+    /**
+     * To publicly perform the Asset.
+     */
+    readonly OdrlPresent: "odrl:present";
+    /**
+     * To create a tangible and permanent rendition of an Asset.
+     */
+    readonly OdrlPrint: "odrl:print";
+    /**
+     * To obtain data from the Asset.
+     */
+    readonly OdrlRead: "odrl:read";
+    /**
+     * To make duplicate copies of the Asset in any material form.
+     */
+    readonly OdrlReproduce: "odrl:reproduce";
+    /**
+     * Making multiple copies.
+     */
+    readonly OdrlReproduction: "odrl:reproduction";
+    /**
+     * To review the Policy applicable to the Asset.
+     */
+    readonly OdrlReviewPolicy: "odrl:reviewPolicy";
+    /**
+     * To transfer the ownership with compensation and while deleting the original asset.
+     */
+    readonly OdrlSell: "odrl:sell";
+    /**
+     * Derivative works be licensed under the same terms or compatible terms.
+     */
+    readonly OdrlShareAlike: "odrl:shareAlike";
+    /**
+     * Permits commercial derivatives, but only non-commercial distribution.
+     */
+    readonly OdrlSharing: "odrl:sharing";
+    /**
+     * Source code must be provided when exercising some rights.
+     */
+    readonly OdrlSourceCode: "odrl:sourceCode";
+    /**
+     * To deliver the Asset in real-time.
+     */
+    readonly OdrlStream: "odrl:stream";
+    /**
+     * To use the Asset in timed relations with media elements of another Asset.
+     */
+    readonly OdrlSynchronize: "odrl:synchronize";
+    /**
+     * To have a text Asset read out loud.
+     */
+    readonly OdrlTextToSpeech: "odrl:textToSpeech";
+    /**
+     * To convert the Asset into a different format.
+     */
+    readonly OdrlTransform: "odrl:transform";
+    /**
+     * To translate the Asset into another natural language.
+     */
+    readonly OdrlTranslate: "odrl:translate";
+    /**
+     * To unload and delete the computer program Asset.
+     */
+    readonly OdrlUninstall: "odrl:uninstall";
+    /**
+     * To apply a watermark to the Asset.
+     */
+    readonly OdrlWatermark: "odrl:watermark";
+};
+/**
+ * The types for ODRL Actions.
+ * Simple action types (for direct string usage)
+ */
+export type UriActionType = (typeof UriActionTypes)[keyof typeof UriActionTypes];

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/standards-w3c-odrl - Changelog
+
+## v0.0.1-next.21
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/standards-w3c-odrl - Examples

package/docs/reference/index.md

@@ -0,0 +1,49 @@
+# @twin.org/standards-w3c-odrl
+
+## Interfaces
+
+- [IOdrlAction](interfaces/IOdrlAction.md)
+- [IOdrlAsset](interfaces/IOdrlAsset.md)
+- [IOdrlAssetCollection](interfaces/IOdrlAssetCollection.md)
+- [IOdrlConstraint](interfaces/IOdrlConstraint.md)
+- [IOdrlDuty](interfaces/IOdrlDuty.md)
+- [IOdrlLogicalConstraint](interfaces/IOdrlLogicalConstraint.md)
+- [IOdrlParty](interfaces/IOdrlParty.md)
+- [IOdrlPartyCollection](interfaces/IOdrlPartyCollection.md)
+- [IOdrlPermission](interfaces/IOdrlPermission.md)
+- [IOdrlPolicy](interfaces/IOdrlPolicy.md)
+- [IOdrlPolicyMetadata](interfaces/IOdrlPolicyMetadata.md)
+- [IOdrlProhibition](interfaces/IOdrlProhibition.md)
+- [IOdrlRule](interfaces/IOdrlRule.md)
+
+## Type Aliases
+
+- [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)
+- [OperatorType](type-aliases/OperatorType.md)
+- [PolicyType](type-aliases/PolicyType.md)
+- [RightOperandType](type-aliases/RightOperandType.md)
+- [RuleType](type-aliases/RuleType.md)
+- [StatusType](type-aliases/StatusType.md)
+- [UriActionType](type-aliases/UriActionType.md)
+
+## Variables
+
+- [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)
+- [OperatorType](variables/OperatorType.md)
+- [PolicyType](variables/PolicyType.md)
+- [RightOperandTypes](variables/RightOperandTypes.md)
+- [RuleType](variables/RuleType.md)
+- [StatusType](variables/StatusType.md)
+- [UriActionTypes](variables/UriActionTypes.md)

package/docs/reference/interfaces/IOdrlAction.md

@@ -0,0 +1,61 @@
+# Interface: IOdrlAction
+
+Interface for ODRL Actions.
+
+## 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
+
+### rdf:value?
+
+> `optional` **rdf:value**: `object`
+
+The value/identifier of the action.
+Used in complex action definitions.
+
+#### @id
+
+> **@id**: `string`
+
+***
+
+### @id?
+
+> `optional` **@id**: `string`
+
+Direct action identifier.
+Used in simple action references.
+
+#### Overrides
+
+`IJsonLdNodeObject.@id`
+
+***
+
+### refinement?
+
+> `optional` **refinement**: [`IOdrlConstraint`](IOdrlConstraint.md) \| [`IOdrlLogicalConstraint`](IOdrlLogicalConstraint.md) \| ([`IOdrlConstraint`](IOdrlConstraint.md) \| [`IOdrlLogicalConstraint`](IOdrlLogicalConstraint.md))[]
+
+Refinements applied to the action.
+
+***
+
+### includedIn?
+
+> `optional` **includedIn**: [`ActionType`](../type-aliases/ActionType.md)
+
+Reference to the action this action is included in.
+
+***
+
+### implies?
+
+> `optional` **implies**: [`ActionType`](../type-aliases/ActionType.md)[]
+
+References to actions this action implies.

package/docs/reference/interfaces/IOdrlAsset.md

@@ -0,0 +1,55 @@
+# Interface: IOdrlAsset
+
+Interface for ODRL Assets.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Extended by
+
+- [`IOdrlAssetCollection`](IOdrlAssetCollection.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 asset.
+Should be an IRI.
+
+***
+
+### @type?
+
+> `optional` **@type**: `string`
+
+The type of the asset.
+Can be used to specify additional type information.
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### partOf?
+
+> `optional` **partOf**: `string` \| [`IOdrlAssetCollection`](IOdrlAssetCollection.md)
+
+Reference to the asset collection this asset is part of.
+Used to identify an AssetCollection that this Asset is a member of.
+
+***
+
+### hasPolicy?
+
+> `optional` **hasPolicy**: `string`
+
+Reference to the policy that governs this asset.
+Used to identify the Policy that governs this Asset.

package/docs/reference/interfaces/IOdrlAssetCollection.md

@@ -0,0 +1,85 @@
+# Interface: IOdrlAssetCollection
+
+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.
+
+## Extends
+
+- [`IOdrlAsset`](IOdrlAsset.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 asset.
+Should be an IRI.
+
+#### Inherited from
+
+[`IOdrlAsset`](IOdrlAsset.md).[`uid`](IOdrlAsset.md#uid)
+
+***
+
+### @type?
+
+> `optional` **@type**: `string`
+
+The type of the asset.
+Can be used to specify additional type information.
+
+#### Inherited from
+
+[`IOdrlAsset`](IOdrlAsset.md).[`@type`](IOdrlAsset.md#@type)
+
+***
+
+### partOf?
+
+> `optional` **partOf**: `string` \| [`IOdrlAssetCollection`](IOdrlAssetCollection.md)
+
+Reference to the asset collection this asset is part of.
+Used to identify an AssetCollection that this Asset is a member of.
+
+#### Inherited from
+
+[`IOdrlAsset`](IOdrlAsset.md).[`partOf`](IOdrlAsset.md#partof)
+
+***
+
+### hasPolicy?
+
+> `optional` **hasPolicy**: `string`
+
+Reference to the policy that governs this asset.
+Used to identify the Policy that governs this Asset.
+
+#### Inherited from
+
+[`IOdrlAsset`](IOdrlAsset.md).[`hasPolicy`](IOdrlAsset.md#haspolicy)
+
+***
+
+### source
+
+> **source**: `string`
+
+Reference to the source of the asset collection.
+Must be an IRI that references the AssetCollection.
+
+***
+
+### refinement?
+
+> `optional` **refinement**: [`IOdrlConstraint`](IOdrlConstraint.md)[]
+
+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).

package/docs/reference/interfaces/IOdrlConstraint.md

@@ -0,0 +1,76 @@
+# Interface: IOdrlConstraint
+
+Interface for ODRL Constraints.
+
+## 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 constraint.
+
+***
+
+### leftOperand
+
+> **leftOperand**: `string`
+
+The left operand of the constraint.
+
+***
+
+### operator
+
+> **operator**: [`OperatorType`](../type-aliases/OperatorType.md)
+
+The operator of the constraint.
+
+***
+
+### rightOperand?
+
+> `optional` **rightOperand**: `string` \| \{ `@value`: `string`; `@type`: [`DataType`](../type-aliases/DataType.md); \} \| \{ `@id`: `string`; \}
+
+The right operand of the constraint.
+value with optional
+
+***
+
+### rightOperandReference?
+
+> `optional` **rightOperandReference**: `string`
+
+Reference to the right operand.
+
+***
+
+### dataType?
+
+> `optional` **dataType**: [`DataType`](../type-aliases/DataType.md)
+
+The data type of the right operand.
+
+***
+
+### unit?
+
+> `optional` **unit**: `string`
+
+The unit for the right operand value.
+
+***
+
+### status?
+
+> `optional` **status**: [`StatusType`](../type-aliases/StatusType.md)
+
+The status value for comparison.

package/docs/reference/interfaces/IOdrlDuty.md

@@ -0,0 +1,144 @@
+# Interface: IOdrlDuty
+
+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.
+
+## 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
+
+### attributedParty?
+
+> `optional` **attributedParty**: `string`
+
+The party to be attributed
+Used when the duty involves attribution
+
+***
+
+### trackingParty?
+
+> `optional` **trackingParty**: `string`
+
+The party performing the tracking
+Used when the duty involves tracking
+
+***
+
+### consequence?
+
+> `optional` **consequence**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The consequences if the duty is not fulfilled.
+Only applicable when the Duty is referenced by a Rule with duty or obligation
+properties.
+
+***
+
+### remedy?
+
+> `optional` **remedy**: [`IOdrlDuty`](IOdrlDuty.md)[]
+
+The remedies that may be fulfilled to cure the violation.
+
+***
+
+### compensatedParty?
+
+> `optional` **compensatedParty**: `string`
+
+The party to be compensated
+Used when the duty involves compensation
+
+***
+
+### 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)