@twin.org/standards-w3c-odrl 0.0.1 → 0.0.2-next.10

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

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

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

@@ -1,215 +0,0 @@
-/**
- * The types for ODRL Actions.
- * URI action types (for use with rdf:value/@id)
- */
-export declare const UriActionType: {
-    /**
-     * 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 UriActionType)[keyof typeof UriActionType];

package/docs/reference/interfaces/IOdrlPolicyMetadata.md

@@ -1,86 +0,0 @@
-# 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/type-aliases/UriActionType.md

@@ -1,6 +0,0 @@
-# Type Alias: UriActionType
-
-> **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/UriActionType.md

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