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

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

@@ -1,6 +1,6 @@
-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 IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyInformationSource, 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 +22,13 @@ 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<{
+        [id: string]: IJsonLdNodeObject;
+    } | undefined>;
 }

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

@@ -1,6 +1,6 @@
 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 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 +23,15 @@ 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<{
+        [id: string]: IJsonLdNodeObject;
+    } | undefined>;
     /**
      * Add static policy information.
      * @param info The static policy information to add.

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

@@ -0,0 +1,52 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyNegotiator } 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 Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+     */
+    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?: {
+        [id: string]: IJsonLdNodeObject;
+    }): 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?: {
+        [id: string]: IJsonLdNodeObject;
+    }): Promise<IDataspaceProtocolAgreement | undefined>;
+}

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

@@ -0,0 +1,35 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyObligationEnforcer, 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?: {
+        [id: string]: IJsonLdNodeObject;
+    }, data?: D, action?: OdrlActionType | string): Promise<boolean>;
+}

package/dist/types/policyRequesters/{examplePolicyRequester.d.ts → passThroughPolicyRequester.d.ts}

@@ -1,51 +1,46 @@
-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";
+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";
 /**
- * Example Policy Requester.
+ * Pass Through Policy Requester.
  */
-export declare class ExamplePolicyRequester implements IPolicyRequester {
+export declare class PassThroughPolicyRequester implements IPolicyRequester {
     /**
-     * The class name of the Example Policy Requester.
+     * The class name of the Pass Through Policy Requester.
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of ExamplePolicyRequester.
-     * @param options The options for the example policy Requester.
+     * Create a new instance of PassThroughPolicyRequester.
+     * @param options The options for the pass through policy Requester.
      */
-    constructor(options?: IExamplePolicyRequesterConstructorOptions);
+    constructor(options?: IPassThroughPolicyRequesterConstructorOptions);
     /**
      * 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.
+     * 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: IOdrlOffer): Promise<boolean>;
+    offer(negotiationId: string, offer: IDataspaceProtocolOffer): Promise<boolean>;
     /**
-     * A policy agreement has been sent by a provider, let the requester know about it.
+     * 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: IOdrlAgreement): Promise<boolean>;
+    agreement(negotiationId: string, agreement: IDataspaceProtocolAgreement): Promise<boolean>;
     /**
-     * A policy finalisation has been sent by a provider, let the requester know about it.
+     * A policy finalisation has been sent by a provider, let the request handler 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.
+     * A policy termination has been sent by a provider, let the request handler know about it.
      * @param negotiationId The id of the negotiation.
      * @returns Nothing.
      */