@twin.org/rights-management-plugins 0.0.3-next.10

package/dist/types/policyExecutionActions/loggingPolicyExecutionAction.d.ts

@@ -0,0 +1,49 @@
+import { type IPolicyDecision, type IPolicyExecutionAction, type IPolicyLocator, PolicyDecisionStage } from "@twin.org/rights-management-models";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ILoggingPolicyExecutionActionConstructorOptions } from "../models/ILoggingPolicyExecutionActionConstructorOptions.js";
+/**
+ * Logging Policy Execution Action to send decisions to logging.
+ */
+export declare class LoggingPolicyExecutionAction implements IPolicyExecutionAction {
+    /**
+     * The class name of the Logging Policy Execution Action.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Whether to include the data in the log.
+     */
+    private readonly _includeData;
+    /**
+     * Whether to include the policies in the log.
+     */
+    private readonly _includePolicies;
+    /**
+     * Whether to include the decisions in the log.
+     */
+    private readonly _includeDecisions;
+    /**
+     * Create a new instance of LoggingPolicyExecutionAction.
+     * @param options The options for the logging policy execution action.
+     */
+    constructor(options?: ILoggingPolicyExecutionActionConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Which stages should the action be executed at.
+     * @returns List of stages.
+     */
+    supportedStages(): PolicyDecisionStage[];
+    /**
+     * Execute function type for policy actions.
+     * @param stage The stage of the policy decision.
+     * @param locator The locator to find relevant policies.
+     * @param policies The policies that apply to the data.
+     * @param decisions The decisions made by the PDP.
+     * @param data The data to process.
+     * @returns A promise that resolves when the action is complete.
+     */
+    execute<D = unknown>(stage: PolicyDecisionStage, locator: IPolicyLocator, policies?: IOdrlPolicy[], decisions?: IPolicyDecision[], data?: D): Promise<void>;
+}

package/dist/types/policyInformationSources/identityPolicyInformationSource.d.ts

@@ -0,0 +1,32 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyInformationSource, type IPolicyLocator, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IIdentityPolicyInformationSourceConstructorOptions } from "../models/IIdentityPolicyInformationSourceConstructorOptions.js";
+/**
+ * Policy information source which retrieves the identity information.
+ */
+export declare class IdentityPolicyInformationSource implements IPolicyInformationSource {
+    /**
+     * The class name of the Identity Policy Information Source.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IdentityPolicyInformationSource.
+     * @param options The options for the logging policy source.
+     */
+    constructor(options?: IIdentityPolicyInformationSourceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Retrieve information from the sources.
+     * @param locator The locator to find relevant policies.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param policies The policies that apply to the data.
+     * @param data The data to process.
+     * @returns The objects containing relevant information or undefined if nothing relevant is found.
+     */
+    retrieve<D = unknown>(locator: IPolicyLocator, accessMode: PolicyInformationAccessMode, policies: IOdrlPolicy[], data?: D): Promise<IJsonLdNodeObject[] | undefined>;
+}

package/dist/types/policyInformationSources/staticPolicyInformationSource.d.ts

@@ -0,0 +1,38 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { PolicyInformationAccessMode, type IPolicyInformationSource, type IPolicyLocator } from "@twin.org/rights-management-models";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IStaticPolicyInformationSource } from "../models/IStaticPolicyInformationSource.js";
+import type { IStaticPolicyInformationSourceConstructorOptions } from "../models/IStaticPolicyInformationSourceConstructorOptions.js";
+/**
+ * Policy information source which retrieves static information.
+ */
+export declare class StaticPolicyInformationSource implements IPolicyInformationSource {
+    /**
+     * The class name of the Static Policy Information Source.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of StaticPolicyInformationSource.
+     * @param options The options for the logging policy source.
+     */
+    constructor(options?: IStaticPolicyInformationSourceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Retrieve information from the sources.
+     * @param locator The locator to find relevant policies.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param policies The policies that apply to the data.
+     * @param data The data to process.
+     * @returns The objects containing relevant information or undefined if nothing relevant is found.
+     */
+    retrieve<D = unknown>(locator: IPolicyLocator, accessMode: PolicyInformationAccessMode, policies: IOdrlPolicy[], data?: D): Promise<IJsonLdNodeObject[] | undefined>;
+    /**
+     * Add static policy information.
+     * @param info The static policy information to add.
+     */
+    addInformation(info: IStaticPolicyInformationSource): void;
+}

package/dist/types/policyNegotiators/examplePolicyNegotiator.d.ts

@@ -0,0 +1,45 @@
+import type { IPolicyInformation, IPolicyNegotiator } from "@twin.org/rights-management-models";
+import type { IOdrlAgreement, IOdrlOffer } from "@twin.org/standards-w3c-odrl";
+import type { IExamplePolicyNegotiatorConstructorOptions } from "../models/IExamplePolicyNegotiatorConstructorOptions.js";
+/**
+ * Example Policy Negotiator.
+ */
+export declare class ExamplePolicyNegotiator implements IPolicyNegotiator {
+    /**
+     * The class name of the Example Policy Negotiator.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ExamplePolicyNegotiator.
+     * @param options The options for the example policy negotiator.
+     */
+    constructor(options?: IExamplePolicyNegotiatorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Determines if the negotiator supports the given offer.
+     * @param offer The offer to check.
+     * @returns Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+     */
+    supportsOffer(offer: IOdrlOffer): boolean;
+    /**
+     * Handle the offer.
+     * @param offer The offer to check.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @returns Sets the accepted flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+     */
+    handleOffer(offer: IOdrlOffer, information?: IPolicyInformation): Promise<{
+        accepted: boolean;
+        interventionRequired: boolean;
+    }>;
+    /**
+     * Create an agreement based on the offer.
+     * @param offer The offer to create the agreement from.
+     * @param information Information provided by the requester to aid in the creation of the agreement.
+     * @returns The agreement created from the offer or undefined if an agreement could not be created.
+     */
+    createAgreement(offer: IOdrlOffer, information?: IPolicyInformation): Promise<IOdrlAgreement | undefined>;
+}

package/dist/types/policyRequesters/examplePolicyRequester.d.ts

@@ -0,0 +1,53 @@
+import type { IPolicyRequester } from "@twin.org/rights-management-models";
+import type { IOdrlAgreement, IOdrlOffer } from "@twin.org/standards-w3c-odrl";
+import type { IExamplePolicyRequesterConstructorOptions } from "../models/IExamplePolicyRequesterConstructorOptions.js";
+/**
+ * Example Policy Requester.
+ */
+export declare class ExamplePolicyRequester implements IPolicyRequester {
+    /**
+     * The class name of the Example Policy Requester.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ExamplePolicyRequester.
+     * @param options The options for the example policy Requester.
+     */
+    constructor(options?: IExamplePolicyRequesterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * The unique id of the requester.
+     * @returns The requester id.
+     */
+    requesterId(): string;
+    /**
+     * A policy has been offered by a provider, let the requester know about it.
+     * @param negotiationId The id of the negotiation.
+     * @param offer The offer sent by the provider.
+     * @returns True if the offer was accepted, false otherwise.
+     */
+    offer(negotiationId: string, offer: IOdrlOffer): Promise<boolean>;
+    /**
+     * A policy agreement has been sent by a provider, let the requester know about it.
+     * @param negotiationId The id of the negotiation.
+     * @param agreement The agreement sent by the provider.
+     * @returns True if the agreement was accepted, false otherwise.
+     */
+    agreement(negotiationId: string, agreement: IOdrlAgreement): Promise<boolean>;
+    /**
+     * A policy finalisation has been sent by a provider, let the requester know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns Nothing.
+     */
+    finalised(negotiationId: string): Promise<void>;
+    /**
+     * A policy termination has been sent by a provider, let the requester know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns Nothing.
+     */
+    terminated(negotiationId: string): Promise<void>;
+}

package/docs/changelog.md

@@ -0,0 +1,102 @@
+# Changelog
+
+## [0.0.3-next.10](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.9...rights-management-plugins-v0.0.3-next.10) (2026-01-28)
+
+
+### Features
+
+* remove data access point ([#67](https://github.com/twinfoundation/rights-management/issues/67)) ([8573676](https://github.com/twinfoundation/rights-management/commit/8573676862c9f1634a66a0677b225b4de16a89cd))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.8...rights-management-plugins-v0.0.3-next.9) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **rights-management-plugins:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.7...rights-management-plugins-v0.0.3-next.8) (2026-01-21)
+
+
+### Miscellaneous Chores
+
+* **rights-management-plugins:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.6...rights-management-plugins-v0.0.3-next.7) (2026-01-14)
+
+
+### Miscellaneous Chores
+
+* **rights-management-plugins:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.5...rights-management-plugins-v0.0.3-next.6) (2026-01-12)
+
+
+### Miscellaneous Chores
+
+* **rights-management-plugins:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.4...rights-management-plugins-v0.0.3-next.5) (2026-01-06)
+
+
+### Features
+
+* add missing dependency ([f7c8e0e](https://github.com/twinfoundation/rights-management/commit/f7c8e0e4819c945ef823b853139440ad7999b9b9))
+* add missing dependency ([c62a098](https://github.com/twinfoundation/rights-management/commit/c62a0983e912c252ab0c27261c9bb92a63c06f96))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.3...rights-management-plugins-v0.0.3-next.4) (2025-12-04)
+
+
+### Features
+
+* add factory pattern ([d26b4c0](https://github.com/twinfoundation/rights-management/commit/d26b4c08a2f3ba5758df66a1c48203b8d8e3638e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## @twin.org/rights-management-plugins - Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/rights-management-plugins - Examples

package/docs/reference/classes/ExamplePolicyArbiter.md

@@ -0,0 +1,121 @@
+# Class: ExamplePolicyArbiter
+
+Example Policy Arbiter.
+
+## Implements
+
+- `IPolicyArbiter`
+
+## Constructors
+
+### Constructor
+
+> **new ExamplePolicyArbiter**(`options?`): `ExamplePolicyArbiter`
+
+Create a new instance of ExamplePolicyArbiter.
+
+#### Parameters
+
+##### options?
+
+[`IExamplePolicyArbiterConstructorOptions`](../interfaces/IExamplePolicyArbiterConstructorOptions.md)
+
+The options for the example policy arbiter.
+
+#### Returns
+
+`ExamplePolicyArbiter`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Example Policy Arbiter.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyArbiter.className`
+
+***
+
+### supportedPolicies()
+
+> **supportedPolicies**(): `IPolicyLocator`[]
+
+The policies supported by this arbiter.
+
+#### Returns
+
+`IPolicyLocator`[]
+
+The supported policies, if empty can be used for all.
+
+#### Implementation of
+
+`IPolicyArbiter.supportedPolicies`
+
+***
+
+### decide()
+
+> **decide**\<`D`\>(`locator`, `information?`, `policies?`, `data?`): `Promise`\<`IPolicyDecision`[]\>
+
+Makes decisions regarding policy access to data.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### locator
+
+`IPolicyLocator`
+
+The locator to find relevant policies.
+
+##### information?
+
+`IPolicyInformation`
+
+Information provided by the requester to determine if a policy can be created.
+
+##### policies?
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
+##### data?
+
+`D`
+
+The data to make a decision on.
+
+#### Returns
+
+`Promise`\<`IPolicyDecision`[]\>
+
+The decisions about access to the data.
+
+#### Implementation of
+
+`IPolicyArbiter.decide`

package/docs/reference/classes/ExamplePolicyEnforcementProcessor.md

@@ -0,0 +1,101 @@
+# Class: ExamplePolicyEnforcementProcessor
+
+Example Policy Enforcement Processor.
+
+## Implements
+
+- `IPolicyEnforcementProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new ExamplePolicyEnforcementProcessor**(`options?`): `ExamplePolicyEnforcementProcessor`
+
+Create a new instance of ExamplePolicyEnforcementProcessor.
+
+#### Parameters
+
+##### options?
+
+[`IExamplePolicyEnforcementProcessorConstructorOptions`](../interfaces/IExamplePolicyEnforcementProcessorConstructorOptions.md)
+
+The options for the example policy enforcement processor.
+
+#### Returns
+
+`ExamplePolicyEnforcementProcessor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Example Policy Enforcement Processor.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyEnforcementProcessor.className`
+
+***
+
+### process()
+
+> **process**\<`D`, `R`\>(`locator`, `decisions`, `data?`): `Promise`\<`R`\>
+
+Process the response from the policy decision point.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+##### R
+
+`R` = `D`
+
+#### Parameters
+
+##### locator
+
+`IPolicyLocator`
+
+The locator to find relevant policies.
+
+##### decisions
+
+`IPolicyDecision`[]
+
+The decisions made by the policy decision point.
+
+##### data?
+
+`D`
+
+The data to process.
+
+#### Returns
+
+`Promise`\<`R`\>
+
+The data after processing.
+
+#### Implementation of
+
+`IPolicyEnforcementProcessor.process`

package/docs/reference/classes/ExamplePolicyNegotiator.md

@@ -0,0 +1,143 @@
+# Class: ExamplePolicyNegotiator
+
+Example Policy Negotiator.
+
+## Implements
+
+- `IPolicyNegotiator`
+
+## Constructors
+
+### Constructor
+
+> **new ExamplePolicyNegotiator**(`options?`): `ExamplePolicyNegotiator`
+
+Create a new instance of ExamplePolicyNegotiator.
+
+#### Parameters
+
+##### options?
+
+[`IExamplePolicyNegotiatorConstructorOptions`](../interfaces/IExamplePolicyNegotiatorConstructorOptions.md)
+
+The options for the example policy negotiator.
+
+#### Returns
+
+`ExamplePolicyNegotiator`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Example Policy Negotiator.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyNegotiator.className`
+
+***
+
+### supportsOffer()
+
+> **supportsOffer**(`offer`): `boolean`
+
+Determines if the negotiator supports the given offer.
+
+#### Parameters
+
+##### offer
+
+`IOdrlOffer`
+
+The offer to check.
+
+#### Returns
+
+`boolean`
+
+Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+
+#### Implementation of
+
+`IPolicyNegotiator.supportsOffer`
+
+***
+
+### handleOffer()
+
+> **handleOffer**(`offer`, `information?`): `Promise`\<\{ `accepted`: `boolean`; `interventionRequired`: `boolean`; \}\>
+
+Handle the offer.
+
+#### Parameters
+
+##### offer
+
+`IOdrlOffer`
+
+The offer to check.
+
+##### information?
+
+`IPolicyInformation`
+
+Information provided by the requester to determine if a policy can be created.
+
+#### Returns
+
+`Promise`\<\{ `accepted`: `boolean`; `interventionRequired`: `boolean`; \}\>
+
+Sets the accepted flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+
+#### Implementation of
+
+`IPolicyNegotiator.handleOffer`
+
+***
+
+### createAgreement()
+
+> **createAgreement**(`offer`, `information?`): `Promise`\<`IOdrlAgreement` \| `undefined`\>
+
+Create an agreement based on the offer.
+
+#### Parameters
+
+##### offer
+
+`IOdrlOffer`
+
+The offer to create the agreement from.
+
+##### information?
+
+`IPolicyInformation`
+
+Information provided by the requester to aid in the creation of the agreement.
+
+#### Returns
+
+`Promise`\<`IOdrlAgreement` \| `undefined`\>
+
+The agreement created from the offer or undefined if an agreement could not be created.
+
+#### Implementation of
+
+`IPolicyNegotiator.createAgreement`