@twin.org/rights-management-plugins 0.0.3-next.13 → 0.0.3-next.14

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

@@ -0,0 +1,20 @@
+import type { IDefaultPolicyArbiterConfig } from "./IDefaultPolicyArbiterConfig.js";
+/**
+ * Options for the Default Policy Arbiter.
+ */
+export interface IDefaultPolicyArbiterConstructorOptions {
+    /**
+     * The logging component for policy arbiter.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The policy administration point component for retrieving inherited policies.
+     * @default policy-administration-point
+     */
+    policyAdministrationPointComponentType?: string;
+    /**
+     * The configuration options for the default policy arbiter.
+     */
+    config?: IDefaultPolicyArbiterConfig;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Pass Through Policy Obligation Enforcer.
+ */
+export interface IPassThroughPolicyObligationEnforcerConstructorOptions {
+    /**
+     * The logging component for the policy obligation enforcer.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

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

@@ -0,0 +1,34 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyArbiter, type IPolicyDecision } from "@twin.org/rights-management-models";
+import { type ActionType, type IOdrlAgreement } 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;
+    /**
+     * 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: IOdrlAgreement, information?: {
+        [id: string]: IJsonLdNodeObject;
+    }, data?: D, action?: ActionType | string): Promise<IPolicyDecision[]>;
+}

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

@@ -1,6 +1,6 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IPolicyArbiter, type IPolicyDecision } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ActionType, IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
 import type { IPassThroughPolicyArbiterConstructorOptions } from "../models/IPassThroughPolicyArbiterConstructorOptions.js";
 /**
  * Pass Through Policy Arbiter.
@@ -22,12 +22,13 @@ export declare class PassThroughPolicyArbiter implements IPolicyArbiter {
     className(): string;
     /**
      * Makes decisions regarding policy access to data.
-     * @param policy The policy to evaluate.
+     * @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>(policy: IOdrlPolicy, information?: {
+    decide<D = unknown>(agreement: IOdrlAgreement, information?: {
         [id: string]: IJsonLdNodeObject;
-    }, data?: D): Promise<IPolicyDecision[]>;
+    }, data?: D, action?: ActionType | string): Promise<IPolicyDecision[]>;
 }

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

@@ -1,5 +1,5 @@
 import { type IPolicyDecision, type IPolicyEnforcementProcessor } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ActionType, IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
 import type { IDefaultPolicyEnforcementProcessorConstructorOptions } from "../models/IDefaultPolicyEnforcementProcessorConstructorOptions.js";
 /**
  * Default Policy Enforcement Processor.
@@ -21,12 +21,13 @@ export declare class DefaultPolicyEnforcementProcessor implements IPolicyEnforce
     className(): string;
     /**
      * Process the response from the policy decision point.
-     * @param policy The policy to process.
+     * @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>(policy: IOdrlPolicy, decisions: IPolicyDecision[], data?: D): Promise<R>;
+    process<D = unknown, R = D>(agreement: IOdrlAgreement, decisions: IPolicyDecision[], data?: D, action?: ActionType | string): Promise<R>;
     /**
      * Process a single policy decision.
      * @param sourceObject The data to process.

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

@@ -1,5 +1,5 @@
 import type { IPolicyDecision, IPolicyEnforcementProcessor } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ActionType, IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
 import type { IPassThroughPolicyEnforcementProcessorConstructorOptions } from "../models/IPassThroughPolicyEnforcementProcessorConstructorOptions.js";
 /**
  * Pass Through Policy Enforcement Processor.
@@ -21,10 +21,11 @@ export declare class PassThroughPolicyEnforcementProcessor implements IPolicyEnf
     className(): string;
     /**
      * Process the response from the policy decision point.
-     * @param policy The policy to process.
+     * @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>(policy: IOdrlPolicy, decisions: IPolicyDecision[], data?: D): Promise<R>;
+    process<D = unknown, R = D>(agreement: IOdrlAgreement, decisions: IPolicyDecision[], data?: D, action?: ActionType | string): Promise<R>;
 }

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

@@ -1,5 +1,5 @@
 import { type IPolicyDecision, type IPolicyExecutionAction, PolicyDecisionStage } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ActionType, IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
 import type { ILoggingPolicyExecutionActionConstructorOptions } from "../models/ILoggingPolicyExecutionActionConstructorOptions.js";
 /**
  * Logging Policy Execution Action to send decisions to logging.
@@ -41,8 +41,9 @@ export declare class LoggingPolicyExecutionAction implements IPolicyExecutionAct
      * @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: IOdrlPolicy, decisions: IPolicyDecision[], data: D | undefined, stage: PolicyDecisionStage): Promise<void>;
+    execute<D = unknown>(policy: IOdrlPolicy, decisions: IPolicyDecision[], data: D | undefined, action: ActionType | string, stage: PolicyDecisionStage): Promise<void>;
 }

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

@@ -1,6 +1,6 @@
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IPolicyInformationSource, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ActionType, IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
 import type { IIdentityPolicyInformationSourceConstructorOptions } from "../models/IIdentityPolicyInformationSourceConstructorOptions.js";
 /**
  * Policy information source which retrieves the identity information.
@@ -25,9 +25,10 @@ export declare class IdentityPolicyInformationSource implements IPolicyInformati
      * @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: IOdrlPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D): Promise<{
+    retrieve<D = unknown>(policy: IOdrlPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D, action?: ActionType | 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 } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { ActionType, IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
 import type { IStaticPolicyInformationSource } from "../models/IStaticPolicyInformationSource.js";
 import type { IStaticPolicyInformationSourceConstructorOptions } from "../models/IStaticPolicyInformationSourceConstructorOptions.js";
 /**
@@ -26,9 +26,10 @@ export declare class StaticPolicyInformationSource implements IPolicyInformation
      * @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 to get any additional information for.
      * @returns The objects containing relevant information or undefined if nothing relevant is found.
      */
-    retrieve<D = unknown>(policy: IOdrlPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D): Promise<{
+    retrieve<D = unknown>(policy: IOdrlPolicy | undefined, accessMode: PolicyInformationAccessMode, data?: D, action?: ActionType | string): Promise<{
         [id: string]: IJsonLdNodeObject;
     } | undefined>;
     /**

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

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

package/docs/changelog.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [0.0.3-next.14](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.13...rights-management-plugins-v0.0.3-next.14) (2026-02-12)
+
+
+### Features
+
+* add default policy arbiter ([#76](https://github.com/twinfoundation/rights-management/issues/76)) ([b62ff9c](https://github.com/twinfoundation/rights-management/commit/b62ff9ce1b3400c4a95909da01863af47f430dbf))
+* policy negotiator callback ([#77](https://github.com/twinfoundation/rights-management/issues/77)) ([6566ed0](https://github.com/twinfoundation/rights-management/commit/6566ed0e2186b6445f1669f9b2f88a6ce059ab83))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.3-next.13 to 0.0.3-next.14
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+    * @twin.org/rights-management-pdp-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+    * @twin.org/rights-management-pep-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+    * @twin.org/rights-management-pip-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+    * @twin.org/rights-management-pmp-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+    * @twin.org/rights-management-pnp-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+    * @twin.org/rights-management-pxp-service bumped from 0.0.3-next.13 to 0.0.3-next.14
+
 ## [0.0.3-next.13](https://github.com/twinfoundation/rights-management/compare/rights-management-plugins-v0.0.3-next.12...rights-management-plugins-v0.0.3-next.13) (2026-02-02)
 
 

package/docs/reference/classes/DefaultPolicyArbiter.md

@@ -0,0 +1,101 @@
+# Class: DefaultPolicyArbiter
+
+Default Policy Arbiter.
+
+## Implements
+
+- `IPolicyArbiter`
+
+## Constructors
+
+### Constructor
+
+> **new DefaultPolicyArbiter**(`options?`): `DefaultPolicyArbiter`
+
+Create a new instance of DefaultPolicyArbiter.
+
+#### Parameters
+
+##### options?
+
+[`IDefaultPolicyArbiterConstructorOptions`](../interfaces/IDefaultPolicyArbiterConstructorOptions.md)
+
+The options for the default policy arbiter.
+
+#### Returns
+
+`DefaultPolicyArbiter`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Default 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`
+
+***
+
+### decide()
+
+> **decide**\<`D`\>(`agreement`, `information?`, `data?`, `action?`): `Promise`\<`IPolicyDecision`[]\>
+
+Makes decisions regarding policy access to data.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### agreement
+
+`IOdrlAgreement`
+
+The agreement to evaluate.
+
+##### information?
+
+Information provided by the requester to determine if a policy can be created.
+
+##### data?
+
+`D`
+
+The data to make a decision on.
+
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
+#### Returns
+
+`Promise`\<`IPolicyDecision`[]\>
+
+The decisions about access to the data.
+
+#### Implementation of
+
+`IPolicyArbiter.decide`

package/docs/reference/classes/DefaultPolicyEnforcementProcessor.md

@@ -56,7 +56,7 @@ The class name of the component.
 
 ### process()
 
-> **process**\<`D`, `R`\>(`policy`, `decisions`, `data?`): `Promise`\<`R`\>
+> **process**\<`D`, `R`\>(`agreement`, `decisions`, `data?`, `action?`): `Promise`\<`R`\>
 
 Process the response from the policy decision point.
 
@@ -72,11 +72,11 @@ Process the response from the policy decision point.
 
 #### Parameters
 
-##### policy
+##### agreement
 
-`IOdrlPolicy`
+`IOdrlAgreement`
 
-The policy to process.
+The agreement to process.
 
 ##### decisions
 
@@ -90,6 +90,12 @@ The decisions made by the policy decision point.
 
 The data to process.
 
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
 #### Returns
 
 `Promise`\<`R`\>

package/docs/reference/classes/IdentityPolicyInformationSource.md

@@ -56,7 +56,7 @@ The class name of the component.
 
 ### retrieve()
 
-> **retrieve**\<`D`\>(`policy`, `accessMode`, `data?`): `Promise`\<\{\[`id`: `string`\]: `IJsonLdNodeObject`; \} \| `undefined`\>
+> **retrieve**\<`D`\>(`policy`, `accessMode`, `data?`, `action?`): `Promise`\<\{\[`id`: `string`\]: `IJsonLdNodeObject`; \} \| `undefined`\>
 
 Retrieve information from the sources.
 
@@ -86,6 +86,12 @@ The access mode to use for the retrieval.
 
 The data to process.
 
+##### action?
+
+`string`
+
+The action that was evaluated.
+
 #### Returns
 
 `Promise`\<\{\[`id`: `string`\]: `IJsonLdNodeObject`; \} \| `undefined`\>

package/docs/reference/classes/LoggingPolicyExecutionAction.md

@@ -74,7 +74,7 @@ List of stages.
 
 ### execute()
 
-> **execute**\<`D`\>(`policy`, `decisions`, `data`, `stage`): `Promise`\<`void`\>
+> **execute**\<`D`\>(`policy`, `decisions`, `data`, `action`, `stage`): `Promise`\<`void`\>
 
 Execute function type for policy actions.
 
@@ -104,6 +104,12 @@ The data to process.
 
 `D` | `undefined`
 
+##### action
+
+`string`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
 ##### stage
 
 `PolicyDecisionStage`

package/docs/reference/classes/PassThroughPolicyArbiter.md

@@ -56,7 +56,7 @@ The class name of the component.
 
 ### decide()
 
-> **decide**\<`D`\>(`policy`, `information?`, `data?`): `Promise`\<`IPolicyDecision`[]\>
+> **decide**\<`D`\>(`agreement`, `information?`, `data?`, `action?`): `Promise`\<`IPolicyDecision`[]\>
 
 Makes decisions regarding policy access to data.
 
@@ -68,11 +68,11 @@ Makes decisions regarding policy access to data.
 
 #### Parameters
 
-##### policy
+##### agreement
 
-`IOdrlPolicy`
+`IOdrlAgreement`
 
-The policy to evaluate.
+The agreement to evaluate.
 
 ##### information?
 
@@ -84,6 +84,12 @@ Information provided by the requester to determine if a policy can be created.
 
 The data to make a decision on.
 
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
 #### Returns
 
 `Promise`\<`IPolicyDecision`[]\>

package/docs/reference/classes/PassThroughPolicyEnforcementProcessor.md

@@ -56,7 +56,7 @@ The class name of the component.
 
 ### process()
 
-> **process**\<`D`, `R`\>(`policy`, `decisions`, `data?`): `Promise`\<`R`\>
+> **process**\<`D`, `R`\>(`agreement`, `decisions`, `data?`, `action?`): `Promise`\<`R`\>
 
 Process the response from the policy decision point.
 
@@ -72,11 +72,11 @@ Process the response from the policy decision point.
 
 #### Parameters
 
-##### policy
+##### agreement
 
-`IOdrlPolicy`
+`IOdrlAgreement`
 
-The policy to process.
+The agreement to process.
 
 ##### decisions
 
@@ -90,6 +90,12 @@ The decisions made by the policy decision point.
 
 The data to process.
 
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
 #### Returns
 
 `Promise`\<`R`\>

package/docs/reference/classes/PassThroughPolicyObligationEnforcer.md

@@ -0,0 +1,107 @@
+# Class: PassThroughPolicyObligationEnforcer
+
+Pass Through Policy Obligation Enforcer.
+
+## Implements
+
+- `IPolicyObligationEnforcer`
+
+## Constructors
+
+### Constructor
+
+> **new PassThroughPolicyObligationEnforcer**(`options?`): `PassThroughPolicyObligationEnforcer`
+
+Create a new instance of Pass Through Policy Obligation Enforcer.
+
+#### Parameters
+
+##### options?
+
+[`IPassThroughPolicyObligationEnforcerConstructorOptions`](../interfaces/IPassThroughPolicyObligationEnforcerConstructorOptions.md)
+
+The options for the pass through policy obligation enforcer.
+
+#### Returns
+
+`PassThroughPolicyObligationEnforcer`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Pass Through Policy Obligation Enforcer.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyObligationEnforcer.className`
+
+***
+
+### enforce()
+
+> **enforce**\<`D`\>(`policy`, `duty`, `information?`, `data?`, `action?`): `Promise`\<`boolean`\>
+
+Enforces obligations regarding policy access to data.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### policy
+
+`IOdrlPolicy`
+
+The policy to evaluate.
+
+##### duty
+
+`IOdrlDuty`
+
+The duty to enforce.
+
+##### information?
+
+Information provided by the requester to determine if a policy can be created.
+
+##### data?
+
+`D`
+
+The data to make a decision on.
+
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the enforcer will evaluate all actions in the duty.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Whether the obligations were successfully enforced.
+
+#### Implementation of
+
+`IPolicyObligationEnforcer.enforce`

package/docs/reference/classes/StaticPolicyInformationSource.md

@@ -56,7 +56,7 @@ The class name of the component.
 
 ### retrieve()
 
-> **retrieve**\<`D`\>(`policy`, `accessMode`, `data?`): `Promise`\<\{\[`id`: `string`\]: `IJsonLdNodeObject`; \} \| `undefined`\>
+> **retrieve**\<`D`\>(`policy`, `accessMode`, `data?`, `action?`): `Promise`\<\{\[`id`: `string`\]: `IJsonLdNodeObject`; \} \| `undefined`\>
 
 Retrieve information from the sources.
 
@@ -86,6 +86,12 @@ The access mode to use for the retrieval.
 
 The data to process.
 
+##### action?
+
+`string`
+
+The action to get any additional information for.
+
 #### Returns
 
 `Promise`\<\{\[`id`: `string`\]: `IJsonLdNodeObject`; \} \| `undefined`\>