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

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

@@ -0,0 +1,15 @@
+/**
+ * Options for the Identity Policy Information Source Component.
+ */
+export interface IIdentityPolicyInformationSourceConstructorOptions {
+    /**
+     * The logging component for logging policy source.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The component for resolving identities.
+     * @default identity-resolver
+     */
+    identityResolverComponentType?: string;
+}

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

@@ -0,0 +1,25 @@
+import type { PolicyDecisionStage } from "@twin.org/rights-management-models";
+/**
+ * Options for the Logging Policy Execution Action Component.
+ */
+export interface ILoggingPolicyExecutionActionConfig {
+    /**
+     * The policy decision stages to log, if undefined defaults to all.
+     */
+    stages?: PolicyDecisionStage[];
+    /**
+     * Whether to include the data in the log.
+     * @default false
+     */
+    includeData?: boolean;
+    /**
+     * Whether to include the policies in the log.
+     * @default false
+     */
+    includePolicies?: boolean;
+    /**
+     * Whether to include the decisions in the log.
+     * @default false
+     */
+    includeDecisions?: boolean;
+}

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

@@ -0,0 +1,15 @@
+import type { ILoggingPolicyExecutionActionConfig } from "./ILoggingPolicyExecutionActionConfig.js";
+/**
+ * Options for the Logging Policy Execution Action.
+ */
+export interface ILoggingPolicyExecutionActionConstructorOptions {
+    /**
+     * The logging component for logging policy execution.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration for the logging policy execution.
+     */
+    config?: ILoggingPolicyExecutionActionConfig;
+}

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

@@ -0,0 +1,20 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IPolicyLocator, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+/**
+ * Configuration for the Static Policy Information Source Component.
+ */
+export interface IStaticPolicyInformationSource {
+    /**
+     * Is the information public, if so it will be shared with negotiation requests.
+     */
+    accessMode: PolicyInformationAccessMode;
+    /**
+     * Information is only provided for the specified locator combination.
+     * If undefined is provided matches all resources.
+     */
+    matchLocators?: IPolicyLocator[];
+    /**
+     * The objects containing the information.
+     */
+    objects: IJsonLdNodeObject[];
+}

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

@@ -0,0 +1,10 @@
+import type { IStaticPolicyInformationSource } from "./IStaticPolicyInformationSource.js";
+/**
+ * Configuration for the Static Policy Information Source Component.
+ */
+export interface IStaticPolicyInformationSourceConfig {
+    /**
+     * The information to return from the PIP.
+     */
+    information?: IStaticPolicyInformationSource[];
+}

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

@@ -0,0 +1,15 @@
+import type { IStaticPolicyInformationSourceConfig } from "./IStaticPolicyInformationSourceConfig.js";
+/**
+ * Options for the Static Policy Information Source Component.
+ */
+export interface IStaticPolicyInformationSourceConstructorOptions {
+    /**
+     * The logging component for logging policy source.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration.
+     */
+    config?: IStaticPolicyInformationSourceConfig;
+}

package/dist/types/policyArbiters/examplePolicyArbiter.d.ts

@@ -0,0 +1,36 @@
+import type { IPolicyArbiter, IPolicyDecision, IPolicyInformation, IPolicyLocator } from "@twin.org/rights-management-models";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IExamplePolicyArbiterConstructorOptions } from "../models/IExamplePolicyArbiterConstructorOptions.js";
+/**
+ * Example Policy Arbiter.
+ */
+export declare class ExamplePolicyArbiter implements IPolicyArbiter {
+    /**
+     * The class name of the Example Policy Arbiter.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ExamplePolicyArbiter.
+     * @param options The options for the example policy arbiter.
+     */
+    constructor(options?: IExamplePolicyArbiterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * The policies supported by this arbiter.
+     * @returns The supported policies, if empty can be used for all.
+     */
+    supportedPolicies(): IPolicyLocator[];
+    /**
+     * Makes decisions regarding policy access to data.
+     * @param locator The locator to find relevant policies.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param policies The policies that apply to the data.
+     * @param data The data to make a decision on.
+     * @returns The decisions about access to the data.
+     */
+    decide<D = unknown>(locator: IPolicyLocator, information?: IPolicyInformation, policies?: IOdrlPolicy[], data?: D): Promise<IPolicyDecision[]>;
+}

package/dist/types/policyEnforcementProcessor/examplePolicyEnforcementProcessor.d.ts

@@ -0,0 +1,29 @@
+import type { IPolicyDecision, IPolicyEnforcementProcessor, IPolicyLocator } from "@twin.org/rights-management-models";
+import type { IExamplePolicyEnforcementProcessorConstructorOptions } from "../models/IExamplePolicyEnforcementProcessorConstructorOptions.js";
+/**
+ * Example Policy Enforcement Processor.
+ */
+export declare class ExamplePolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
+    /**
+     * The class name of the Example Policy Enforcement Processor.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ExamplePolicyEnforcementProcessor.
+     * @param options The options for the example policy enforcement processor.
+     */
+    constructor(options?: IExamplePolicyEnforcementProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Process the response from the policy decision point.
+     * @param locator The locator to find relevant policies.
+     * @param decisions The decisions made by the policy decision point.
+     * @param data The data to process.
+     * @returns The data after processing.
+     */
+    process<D = unknown, R = D>(locator: IPolicyLocator, decisions: IPolicyDecision[], data?: D): Promise<R>;
+}

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,17 @@
+# Changelog
+
+## [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/ExampleDataAccessHandler.md

@@ -0,0 +1,243 @@
+# Class: ExampleDataAccessHandler
+
+Example Data Access Handler.
+
+## Implements
+
+- `IDataAccessHandler`
+
+## Constructors
+
+### Constructor
+
+> **new ExampleDataAccessHandler**(`options?`): `ExampleDataAccessHandler`
+
+Create a new instance of ExampleDataAccessHandler.
+
+#### Parameters
+
+##### options?
+
+[`IExampleDataAccessHandlerConstructorOptions`](../interfaces/IExampleDataAccessHandlerConstructorOptions.md)
+
+The options for the example policy Requester.
+
+#### Returns
+
+`ExampleDataAccessHandler`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Example Data Access Handler.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDataAccessHandler.className`
+
+***
+
+### supportedAssetTypes()
+
+> **supportedAssetTypes**(): `string`[]
+
+The asset types supported by this handler.
+
+#### Returns
+
+`string`[]
+
+The supported asset types.
+
+#### Implementation of
+
+`IDataAccessHandler.supportedAssetTypes`
+
+***
+
+### create()
+
+> **create**(`assetType`, `item`): `Promise`\<`string`\>
+
+Create an item.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of the item to create.
+
+##### item
+
+`IJsonLdNodeObject`
+
+The item to create.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the item created, for some items this is supplied in the `item`.
+
+#### Implementation of
+
+`IDataAccessHandler.create`
+
+***
+
+### get()
+
+> **get**(`assetType`, `id`): `Promise`\<`IJsonLdNodeObject`\>
+
+Get an item.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of the item to retrieve.
+
+##### id
+
+`string`
+
+The ID of the item to retrieve.
+
+#### Returns
+
+`Promise`\<`IJsonLdNodeObject`\>
+
+The item retrieved if the policies allow it.
+
+#### Implementation of
+
+`IDataAccessHandler.get`
+
+***
+
+### update()
+
+> **update**(`assetType`, `item`): `Promise`\<`void`\>
+
+Update an item.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of the item to update.
+
+##### item
+
+`IJsonLdNodeObject`
+
+The item to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IDataAccessHandler.update`
+
+***
+
+### remove()
+
+> **remove**(`assetType`, `id`): `Promise`\<`void`\>
+
+Remove an item.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of the item to remove.
+
+##### id
+
+`string`
+
+The id of the item to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IDataAccessHandler.remove`
+
+***
+
+### query()
+
+> **query**(`assetType`, `conditions`, `cursor`, `options`): `Promise`\<\{ `items`: `IJsonLdNodeObject`[]; `cursor?`: `string`; \}\>
+
+Query for items.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of the item to query.
+
+##### conditions
+
+The conditions to apply to the query.
+
+`EntityCondition`\<`IJsonLdNodeObject`\> | `undefined`
+
+##### cursor
+
+The cursor for pagination.
+
+`string` | `undefined`
+
+##### options
+
+`unknown`
+
+Additional options which might be supported by the handler.
+
+#### Returns
+
+`Promise`\<\{ `items`: `IJsonLdNodeObject`[]; `cursor?`: `string`; \}\>
+
+The items matching the query and cursor if there are more items.
+
+#### Implementation of
+
+`IDataAccessHandler.query`