@twin.org/rights-management-plugins 0.0.3-next.9 → 0.9.0

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

@@ -1,5 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IPolicyLocator, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+import type { IRightsManagementInformation, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
 /**
  * Configuration for the Static Policy Information Source Component.
  */
@@ -10,11 +9,15 @@ export interface IStaticPolicyInformationSource {
     accessMode: PolicyInformationAccessMode;
     /**
      * Information is only provided for the specified locator combination.
-     * If undefined is provided matches all resources.
      */
-    matchLocators?: IPolicyLocator[];
+    matchLocators?: {
+        assignee?: string;
+        assigner?: string;
+        target?: string;
+        action?: string;
+    }[];
     /**
      * The objects containing the information.
      */
-    objects: IJsonLdNodeObject[];
+    objects: IRightsManagementInformation;
 }

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

@@ -5,7 +5,6 @@ import type { IStaticPolicyInformationSourceConfig } from "./IStaticPolicyInform
 export interface IStaticPolicyInformationSourceConstructorOptions {
     /**
      * The logging component for logging policy source.
-     * @default logging
      */
     loggingComponentType?: string;
     /**

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

@@ -0,0 +1,38 @@
+import { type IPolicyArbiter, type IPolicyDecision, type IRightsManagementInformation } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import { type OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IDefaultPolicyArbiterConstructorOptions } from "../models/IDefaultPolicyArbiterConstructorOptions.js";
+/**
+ * Default Policy Arbiter.
+ */
+export declare class DefaultPolicyArbiter implements IPolicyArbiter {
+    /**
+     * The class name of the Default Policy Arbiter.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * ODRL profiles whose custom vocabulary this arbiter understands and supports.
+     * Any policy declaring a profile not in this set will be rejected.
+     * Add a new entry here when support for an additional profile is implemented.
+     */
+    static readonly SUPPORTED_PROFILES: ReadonlySet<string>;
+    /**
+     * Create a new instance of DefaultPolicyArbiter.
+     * @param options The options for the default policy arbiter.
+     */
+    constructor(options?: IDefaultPolicyArbiterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Makes decisions regarding policy access to data.
+     * @param agreement The agreement to evaluate.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param data The data to make a decision on.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The decisions about access to the data.
+     */
+    decide<D = unknown>(agreement: IDataspaceProtocolAgreement, information?: IRightsManagementInformation, data?: D, action?: OdrlActionType | string): Promise<IPolicyDecision[]>;
+}

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

@@ -0,0 +1,32 @@
+import { type IPolicyArbiter, type IPolicyDecision, type IRightsManagementInformation } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IPassThroughPolicyArbiterConstructorOptions } from "../models/IPassThroughPolicyArbiterConstructorOptions.js";
+/**
+ * Pass Through Policy Arbiter.
+ */
+export declare class PassThroughPolicyArbiter implements IPolicyArbiter {
+    /**
+     * The class name of the Pass Through Policy Arbiter.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PassThroughPolicyArbiter.
+     * @param options The options for the pass through policy arbiter.
+     */
+    constructor(options?: IPassThroughPolicyArbiterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Makes decisions regarding policy access to data.
+     * @param agreement The agreement to evaluate.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param data The data to make a decision on.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The decisions about access to the data.
+     */
+    decide<D = unknown>(agreement: IDataspaceProtocolAgreement, information?: IRightsManagementInformation, data?: D, action?: OdrlActionType | string): Promise<IPolicyDecision[]>;
+}

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

@@ -0,0 +1,32 @@
+import { type IPolicyDecision, type IPolicyEnforcementProcessor } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IDefaultPolicyEnforcementProcessorConstructorOptions } from "../models/IDefaultPolicyEnforcementProcessorConstructorOptions.js";
+/**
+ * Default Policy Enforcement Processor.
+ */
+export declare class DefaultPolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
+    /**
+     * The class name of the Default Policy Enforcement Processor.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of DefaultPolicyEnforcementProcessor.
+     * @param options The options for the default policy enforcement processor.
+     */
+    constructor(options?: IDefaultPolicyEnforcementProcessorConstructorOptions);
+    /**
+     * 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 agreement The agreement to process.
+     * @param decisions The decisions made by the policy decision point.
+     * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The data after processing.
+     */
+    process<D = unknown, R = D>(agreement: IDataspaceProtocolAgreement, decisions: IPolicyDecision[], data?: D, action?: OdrlActionType | string): Promise<R>;
+}

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

@@ -0,0 +1,32 @@
+import { type IPolicyDecision, type IPolicyEnforcementProcessor } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IPassThroughPolicyEnforcementProcessorConstructorOptions } from "../models/IPassThroughPolicyEnforcementProcessorConstructorOptions.js";
+/**
+ * Pass Through Policy Enforcement Processor.
+ */
+export declare class PassThroughPolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
+    /**
+     * The class name of the Pass Through Policy Enforcement Processor.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PassThroughPolicyEnforcementProcessor.
+     * @param options The options for the pass through policy enforcement processor.
+     */
+    constructor(options?: IPassThroughPolicyEnforcementProcessorConstructorOptions);
+    /**
+     * 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 agreement The agreement to process.
+     * @param decisions The decisions made by the policy decision point.
+     * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The data after processing.
+     */
+    process<D = unknown, R = D>(agreement: IDataspaceProtocolAgreement, decisions: IPolicyDecision[], data?: D, action?: OdrlActionType | string): Promise<R>;
+}

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

@@ -0,0 +1,45 @@
+import { type IPolicyDecision, type IPolicyExecutionAction, type IRightsManagementPolicy, PolicyDecisionStage } from "@twin.org/rights-management-models";
+import { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IAutomationPolicyExecutionActionConstructorOptions } from "../models/IAutomationPolicyExecutionActionConstructorOptions.js";
+/**
+ * Automation Policy Execution Action to execute automation policies.
+ */
+export declare class AutomationPolicyExecutionAction implements IPolicyExecutionAction {
+    /**
+     * The class name of the Automation Policy Execution Action.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * The before automation trigger name.
+     */
+    static readonly BEFORE_TRIGGER_NAME: string;
+    /**
+     * The after automation trigger name.
+     */
+    static readonly AFTER_TRIGGER_NAME: string;
+    /**
+     * Create a new instance of AutomationPolicyExecutionAction.
+     * @param options The options for the automation policy execution action.
+     */
+    constructor(options?: IAutomationPolicyExecutionActionConstructorOptions);
+    /**
+     * 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 policy The policy that applied to the data.
+     * @param decisions The decisions made by the PDP.
+     * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @param stage The stage of the policy decision.
+     * @returns A promise that resolves when the action is complete.
+     */
+    execute<D = unknown>(policy: IRightsManagementPolicy, decisions: IPolicyDecision[], data: D | undefined, action: OdrlActionType | string | undefined, stage: PolicyDecisionStage): Promise<void>;
+}

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

@@ -1,5 +1,5 @@
-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 IPolicyDecision, type IPolicyExecutionAction, type IRightsManagementPolicy, PolicyDecisionStage } from "@twin.org/rights-management-models";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
 import type { ILoggingPolicyExecutionActionConstructorOptions } from "../models/ILoggingPolicyExecutionActionConstructorOptions.js";
 /**
  * Logging Policy Execution Action to send decisions to logging.
@@ -9,18 +9,6 @@ export declare class LoggingPolicyExecutionAction implements IPolicyExecutionAct
      * 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.
@@ -38,12 +26,12 @@ export declare class LoggingPolicyExecutionAction implements IPolicyExecutionAct
     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 policy The policy that applied to the data.
      * @param decisions The decisions made by the PDP.
      * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @param stage The stage of the policy decision.
      * @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>;
+    execute<D = unknown>(policy: IRightsManagementPolicy, decisions: IPolicyDecision[], data: D | undefined, action: OdrlActionType | string | undefined, stage: PolicyDecisionStage): Promise<void>;
 }

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

@@ -1,6 +1,5 @@
-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 IPolicyInformationSource, type IRightsManagementInformation, type IRightsManagementPolicy, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
 import type { IIdentityPolicyInformationSourceConstructorOptions } from "../models/IIdentityPolicyInformationSourceConstructorOptions.js";
 /**
  * Policy information source which retrieves the identity information.
@@ -22,11 +21,11 @@ export declare class IdentityPolicyInformationSource implements IPolicyInformati
     className(): string;
     /**
      * Retrieve information from the sources.
-     * @param locator The locator to find relevant policies.
+     * @param policy The policy to retrieve information for if available.
      * @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.
+     * @param action The action that was evaluated.
      * @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>;
+    retrieve<D = unknown>(policy: IRightsManagementPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D, action?: OdrlActionType | string): Promise<IRightsManagementInformation | undefined>;
 }

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

@@ -0,0 +1,31 @@
+import { PolicyInformationAccessMode, type IPolicyInformationSource, type IRightsManagementInformation, type IRightsManagementPolicy } from "@twin.org/rights-management-models";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IIdentityProfilePolicyInformationSourceConstructorOptions } from "../models/IIdentityProfilePolicyInformationSourceConstructorOptions.js";
+/**
+ * Policy information source which retrieves identity profile information.
+ */
+export declare class IdentityProfilePolicyInformationSource implements IPolicyInformationSource {
+    /**
+     * The class name of the Identity Profile Policy Information Source.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IdentityProfilePolicyInformationSource.
+     * @param options The options for the identity profile policy source.
+     */
+    constructor(options?: IIdentityProfilePolicyInformationSourceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Retrieve information from the sources.
+     * @param policy The policy to retrieve information for if available.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param data The data to process.
+     * @param action The action that was evaluated.
+     * @returns The objects containing relevant information or undefined if nothing relevant is found.
+     */
+    retrieve<D = unknown>(policy: IRightsManagementPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D, action?: OdrlActionType | string): Promise<IRightsManagementInformation | undefined>;
+}

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

@@ -1,6 +1,5 @@
-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 { PolicyInformationAccessMode, type IPolicyInformationSource, type IRightsManagementInformation, type IRightsManagementPolicy } from "@twin.org/rights-management-models";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
 import type { IStaticPolicyInformationSource } from "../models/IStaticPolicyInformationSource.js";
 import type { IStaticPolicyInformationSourceConstructorOptions } from "../models/IStaticPolicyInformationSourceConstructorOptions.js";
 /**
@@ -23,13 +22,13 @@ export declare class StaticPolicyInformationSource implements IPolicyInformation
     className(): string;
     /**
      * Retrieve information from the sources.
-     * @param locator The locator to find relevant policies.
+     * @param policy The policy to retrieve information for if available.
      * @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.
+     * @param action The action to get any additional information for.
      * @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>;
+    retrieve<D = unknown>(policy: IRightsManagementPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D, action?: OdrlActionType | string): Promise<IRightsManagementInformation | undefined>;
     /**
      * Add static policy information.
      * @param info The static policy information to add.

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

@@ -0,0 +1,47 @@
+import { type IPolicyNegotiator, type IRightsManagementInformation } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement, IDataspaceProtocolOffer } from "@twin.org/standards-dataspace-protocol";
+import { type IOdrlParty } from "@twin.org/standards-w3c-odrl";
+import type { IPassThroughPolicyNegotiatorConstructorOptions } from "../models/IPassThroughPolicyNegotiatorConstructorOptions.js";
+/**
+ * Pass Through Policy Negotiator.
+ */
+export declare class PassThroughPolicyNegotiator implements IPolicyNegotiator {
+    /**
+     * The class name of the Pass Through Policy Negotiator.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PassThroughPolicyNegotiator.
+     * @param options The options for the pass through policy negotiator.
+     */
+    constructor(options?: IPassThroughPolicyNegotiatorConstructorOptions);
+    /**
+     * 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 True if the negotiator supports the given offer.
+     */
+    supportsOffer(offer: IDataspaceProtocolOffer): 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: IDataspaceProtocolOffer, information?: IRightsManagementInformation): Promise<{
+        accepted: boolean;
+        interventionRequired: boolean;
+    }>;
+    /**
+     * Create an agreement based on the offer.
+     * @param offer The offer to create the agreement from.
+     * @param assignee The assignee of the agreement.
+     * @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: IDataspaceProtocolOffer, assignee: string | IOdrlParty, information?: IRightsManagementInformation): Promise<IDataspaceProtocolAgreement | undefined>;
+}

package/dist/types/policyObligationEnforcers/passThroughPolicyObligationEnforcer.d.ts

@@ -0,0 +1,32 @@
+import { type IPolicyObligationEnforcer, type IRightsManagementInformation, type IRightsManagementPolicy } from "@twin.org/rights-management-models";
+import type { OdrlActionType, IOdrlDuty } from "@twin.org/standards-w3c-odrl";
+import type { IPassThroughPolicyObligationEnforcerConstructorOptions } from "../models/IPassThroughPolicyObligationEnforcerConstructorOptions.js";
+/**
+ * Pass Through Policy Obligation Enforcer.
+ */
+export declare class PassThroughPolicyObligationEnforcer implements IPolicyObligationEnforcer {
+    /**
+     * The class name of the Pass Through Policy Obligation Enforcer.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of Pass Through Policy Obligation Enforcer.
+     * @param options The options for the pass through policy obligation enforcer.
+     */
+    constructor(options?: IPassThroughPolicyObligationEnforcerConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Enforces obligations regarding policy access to data.
+     * @param policy The policy to evaluate.
+     * @param duty The duty to enforce.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param data The data to make a decision on.
+     * @param action Optional action to make a decision on, if not provided, the enforcer will evaluate all actions in the duty.
+     * @returns Whether the obligations were successfully enforced.
+     */
+    enforce<D = unknown>(policy: IRightsManagementPolicy, duty: IOdrlDuty, information?: IRightsManagementInformation, data?: D, action?: OdrlActionType | string): Promise<boolean>;
+}

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

@@ -0,0 +1,48 @@
+import { type IPolicyRequester } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement, IDataspaceProtocolOffer } from "@twin.org/standards-dataspace-protocol";
+import type { IPassThroughPolicyRequesterConstructorOptions } from "../models/IPassThroughPolicyRequesterConstructorOptions.js";
+/**
+ * Pass Through Policy Requester.
+ */
+export declare class PassThroughPolicyRequester implements IPolicyRequester {
+    /**
+     * The class name of the Pass Through Policy Requester.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PassThroughPolicyRequester.
+     * @param options The options for the pass through policy Requester.
+     */
+    constructor(options?: IPassThroughPolicyRequesterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * A policy has been offered by a provider, let the request handler 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: IDataspaceProtocolOffer): Promise<boolean>;
+    /**
+     * A policy agreement has been sent by a provider, let the request handler 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: IDataspaceProtocolAgreement): Promise<boolean>;
+    /**
+     * A policy finalisation has been sent by a provider, let the request handler know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns A promise that resolves when the finalisation has been processed.
+     */
+    finalised(negotiationId: string): Promise<void>;
+    /**
+     * A policy termination has been sent by a provider, let the request handler know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns A promise that resolves when the termination has been processed.
+     */
+    terminated(negotiationId: string): Promise<void>;
+}