@twin.org/rights-management-models 0.0.2-next.3 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -5,36 +5,161 @@ var core = require('@twin.org/core');
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Factory for creating policy execution actions.
+ * The stage at which a PXP is executed in the PDP.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const PolicyExecutionActionFactory = core.Factory.createFactory("policy-execution", true);
+const PolicyDecisionStage = {
+    /**
+     * Before Decision.
+     */
+    Before: "before",
+    /**
+     * After Decision.
+     */
+    After: "after"
+};
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Factory for creating policy information sources.
+ * The mode that can be used to retrieve information from PIP sources.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const PolicyInformationSourceFactory = core.Factory.createFactory("policy-information", true);
+const PolicyInformationAccessMode = {
+    /**
+     * Public.
+     */
+    Public: "public",
+    /**
+     * Private.
+     */
+    Private: "private",
+    /**
+     * Any.
+     */
+    Any: "any"
+};
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The stage at which a PXP is executed in the PDP.
+ * The status of the negotiation in the Policy Negotiation Point (PNP).
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const PolicyDecisionStage = {
+const PolicyNegotiationStatus = {
     /**
-     * Before Decision.
+     * Manual - manual approval is required.
      */
-    Before: "before",
+    Manual: "manual",
     /**
-     * After Decision.
+     * Approved - the negotiation has been approved.
      */
-    After: "after"
+    Approved: "approved",
+    /**
+     * Rejected - the negotiation has been rejected.
+     */
+    Rejected: "rejected"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The namespaces for rights management.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RightsManagementNamespaces = {
+    /**
+     * Policy.
+     */
+    Policy: "policy"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for Odrl Policies.
+ */
+class OdrlPolicyHelper {
+    /**
+     * Find the expiration date of the policy.
+     * @param policy The policy to check.
+     * @param assetType The type of the asset, if undefined will match any asset type.
+     * @param action The action to check, if undefined will match any action.
+     * @returns The expiration date of the policy, or undefined if not found.
+     */
+    static findExpirationDate(policy, assetType, action) {
+        if (core.Is.arrayValue(policy.permission)) {
+            for (const permission of policy.permission) {
+                const matchesPermission = OdrlPolicyHelper.matchTargetAndAction(permission.target, permission.action, assetType, action);
+                if (matchesPermission && core.Is.arrayValue(permission.constraint)) {
+                    for (const constraint of permission.constraint) {
+                        if (constraint.leftOperand === "dateTime" &&
+                            constraint.operator === "lteq" &&
+                            core.Is.dateTimeString(constraint.rightOperand)) {
+                            return constraint.rightOperand;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * Match the target to the requested asset type.
+     * @param target The target to match.
+     * @param matchAssetType The asset type to match.
+     * @returns True if the target is empty, the target matches the requested asset, false otherwise.
+     */
+    static matchAsset(target, matchAssetType) {
+        if (core.Is.empty(target) || core.Is.empty(matchAssetType)) {
+            return true;
+        }
+        if (core.Is.arrayValue(target)) {
+            return target.some(t => OdrlPolicyHelper.matchAsset(t, matchAssetType));
+        }
+        if (core.Is.stringValue(target)) {
+            return target === matchAssetType;
+        }
+        // TODO: This currently only handles the simple case of matching a single asset type.
+        // we need further processing if the target is more complex.
+        return false;
+    }
+    /**
+     * Match the action to the asset type.
+     * @param action The action to match.
+     * @param matchAction The action to match.
+     * @returns True if the action is empty, the action matches the asset type, false otherwise.
+     */
+    static matchAction(action, matchAction) {
+        if (core.Is.empty(action) || core.Is.empty(matchAction)) {
+            return true;
+        }
+        if (core.Is.arrayValue(action)) {
+            return action.some(a => OdrlPolicyHelper.matchAction(a, matchAction));
+        }
+        if (core.Is.stringValue(action)) {
+            return action === matchAction;
+        }
+        // TODO: This currently only handles the simple case of matching a single action type.
+        // we need further processing if the action is more complex.
+        return false;
+    }
+    /**
+     * Match the target and action to the requested asset type and action.
+     * @param target The target to match.
+     * @param action The action to match.
+     * @param matchAssetType The asset type to match.
+     * @param matchAction The action to match.
+     * @returns True if the target and action match the requested asset type and action, false otherwise.
+     */
+    static matchTargetAndAction(target, action, matchAssetType, matchAction) {
+        const assetTypeMatch = OdrlPolicyHelper.matchAsset(target, matchAssetType);
+        const actionMatch = OdrlPolicyHelper.matchAction(action, matchAction);
+        return assetTypeMatch && actionMatch;
+    }
+}
+
+exports.OdrlPolicyHelper = OdrlPolicyHelper;
 exports.PolicyDecisionStage = PolicyDecisionStage;
-exports.PolicyExecutionActionFactory = PolicyExecutionActionFactory;
-exports.PolicyInformationSourceFactory = PolicyInformationSourceFactory;
+exports.PolicyInformationAccessMode = PolicyInformationAccessMode;
+exports.PolicyNegotiationStatus = PolicyNegotiationStatus;
+exports.RightsManagementNamespaces = RightsManagementNamespaces;

package/dist/esm/index.mjs

@@ -1,36 +1,159 @@
-import { Factory } from '@twin.org/core';
+import { Is } from '@twin.org/core';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Factory for creating policy execution actions.
+ * The stage at which a PXP is executed in the PDP.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const PolicyExecutionActionFactory = Factory.createFactory("policy-execution", true);
+const PolicyDecisionStage = {
+    /**
+     * Before Decision.
+     */
+    Before: "before",
+    /**
+     * After Decision.
+     */
+    After: "after"
+};
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Factory for creating policy information sources.
+ * The mode that can be used to retrieve information from PIP sources.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const PolicyInformationSourceFactory = Factory.createFactory("policy-information", true);
+const PolicyInformationAccessMode = {
+    /**
+     * Public.
+     */
+    Public: "public",
+    /**
+     * Private.
+     */
+    Private: "private",
+    /**
+     * Any.
+     */
+    Any: "any"
+};
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The stage at which a PXP is executed in the PDP.
+ * The status of the negotiation in the Policy Negotiation Point (PNP).
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const PolicyDecisionStage = {
+const PolicyNegotiationStatus = {
     /**
-     * Before Decision.
+     * Manual - manual approval is required.
      */
-    Before: "before",
+    Manual: "manual",
     /**
-     * After Decision.
+     * Approved - the negotiation has been approved.
      */
-    After: "after"
+    Approved: "approved",
+    /**
+     * Rejected - the negotiation has been rejected.
+     */
+    Rejected: "rejected"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The namespaces for rights management.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RightsManagementNamespaces = {
+    /**
+     * Policy.
+     */
+    Policy: "policy"
 };
 
-export { PolicyDecisionStage, PolicyExecutionActionFactory, PolicyInformationSourceFactory };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for Odrl Policies.
+ */
+class OdrlPolicyHelper {
+    /**
+     * Find the expiration date of the policy.
+     * @param policy The policy to check.
+     * @param assetType The type of the asset, if undefined will match any asset type.
+     * @param action The action to check, if undefined will match any action.
+     * @returns The expiration date of the policy, or undefined if not found.
+     */
+    static findExpirationDate(policy, assetType, action) {
+        if (Is.arrayValue(policy.permission)) {
+            for (const permission of policy.permission) {
+                const matchesPermission = OdrlPolicyHelper.matchTargetAndAction(permission.target, permission.action, assetType, action);
+                if (matchesPermission && Is.arrayValue(permission.constraint)) {
+                    for (const constraint of permission.constraint) {
+                        if (constraint.leftOperand === "dateTime" &&
+                            constraint.operator === "lteq" &&
+                            Is.dateTimeString(constraint.rightOperand)) {
+                            return constraint.rightOperand;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * Match the target to the requested asset type.
+     * @param target The target to match.
+     * @param matchAssetType The asset type to match.
+     * @returns True if the target is empty, the target matches the requested asset, false otherwise.
+     */
+    static matchAsset(target, matchAssetType) {
+        if (Is.empty(target) || Is.empty(matchAssetType)) {
+            return true;
+        }
+        if (Is.arrayValue(target)) {
+            return target.some(t => OdrlPolicyHelper.matchAsset(t, matchAssetType));
+        }
+        if (Is.stringValue(target)) {
+            return target === matchAssetType;
+        }
+        // TODO: This currently only handles the simple case of matching a single asset type.
+        // we need further processing if the target is more complex.
+        return false;
+    }
+    /**
+     * Match the action to the asset type.
+     * @param action The action to match.
+     * @param matchAction The action to match.
+     * @returns True if the action is empty, the action matches the asset type, false otherwise.
+     */
+    static matchAction(action, matchAction) {
+        if (Is.empty(action) || Is.empty(matchAction)) {
+            return true;
+        }
+        if (Is.arrayValue(action)) {
+            return action.some(a => OdrlPolicyHelper.matchAction(a, matchAction));
+        }
+        if (Is.stringValue(action)) {
+            return action === matchAction;
+        }
+        // TODO: This currently only handles the simple case of matching a single action type.
+        // we need further processing if the action is more complex.
+        return false;
+    }
+    /**
+     * Match the target and action to the requested asset type and action.
+     * @param target The target to match.
+     * @param action The action to match.
+     * @param matchAssetType The asset type to match.
+     * @param matchAction The action to match.
+     * @returns True if the target and action match the requested asset type and action, false otherwise.
+     */
+    static matchTargetAndAction(target, action, matchAssetType, matchAction) {
+        const assetTypeMatch = OdrlPolicyHelper.matchAsset(target, matchAssetType);
+        const actionMatch = OdrlPolicyHelper.matchAction(action, matchAction);
+        return assetTypeMatch && actionMatch;
+    }
+}
+
+export { OdrlPolicyHelper, PolicyDecisionStage, PolicyInformationAccessMode, PolicyNegotiationStatus, RightsManagementNamespaces };

package/dist/types/index.d.ts

@@ -1,21 +1,42 @@
-export * from "./factories/policyExecutionActionFactory";
-export * from "./factories/policyInformationSourceFactory";
-export * from "./models/api/policyAdministrationPoint/IPapCreateRequest";
-export * from "./models/api/policyAdministrationPoint/IPapQueryRequest";
-export * from "./models/api/policyAdministrationPoint/IPapQueryResponse";
-export * from "./models/api/policyAdministrationPoint/IPapRemoveRequest";
-export * from "./models/api/policyAdministrationPoint/IPapRetrieveRequest";
-export * from "./models/api/policyAdministrationPoint/IPapRetrieveResponse";
-export * from "./models/api/policyAdministrationPoint/IPapUpdateRequest";
-export * from "./models/api/policyAdministrationPoint/IPepInterceptRequest";
-export * from "./models/api/policyAdministrationPoint/IPepInterceptResponse";
+export * from "./models/api/policyAdministrationPoint/pap/IPapCreateRequest";
+export * from "./models/api/policyAdministrationPoint/pap/IPapQueryRequest";
+export * from "./models/api/policyAdministrationPoint/pap/IPapQueryResponse";
+export * from "./models/api/policyAdministrationPoint/pap/IPapRemoveRequest";
+export * from "./models/api/policyAdministrationPoint/pap/IPapRetrieveRequest";
+export * from "./models/api/policyAdministrationPoint/pap/IPapRetrieveResponse";
+export * from "./models/api/policyAdministrationPoint/pap/IPapUpdateRequest";
+export * from "./models/api/policyAdministrationPoint/pep/IPepInterceptRequest";
+export * from "./models/api/policyAdministrationPoint/pep/IPepInterceptResponse";
+export * from "./models/api/policyAdministrationPoint/pnap/IPnapGetRequest";
+export * from "./models/api/policyAdministrationPoint/pnap/IPnapGetResponse";
+export * from "./models/api/policyAdministrationPoint/pnap/IPnapQueryRequest";
+export * from "./models/api/policyAdministrationPoint/pnap/IPnapQueryResponse";
+export * from "./models/api/policyAdministrationPoint/pnap/IPnapRemoveRequest";
+export * from "./models/api/policyAdministrationPoint/pnap/IPnapSetRequest";
+export * from "./models/api/policyAdministrationPoint/pnp/IPnpNegotiateRequest";
+export * from "./models/api/policyAdministrationPoint/pnp/IPnpNegotiateResponse";
+export * from "./models/api/policyAdministrationPoint/pnp/IPnpNegotiationCancelRequest";
+export * from "./models/api/policyAdministrationPoint/pnp/IPnpNegotiationStateRequest";
+export * from "./models/api/policyAdministrationPoint/pnp/IPnpNegotiationStateResponse";
 export * from "./models/IPolicyAdministrationPointComponent";
+export * from "./models/IPolicyContext";
 export * from "./models/IPolicyDecisionPointComponent";
 export * from "./models/IPolicyEnforcementPointComponent";
+export * from "./models/IPolicyEnforcementProcessor";
 export * from "./models/IPolicyExecutionAction";
 export * from "./models/IPolicyExecutionPointComponent";
 export * from "./models/IPolicyInformationPointComponent";
 export * from "./models/IPolicyInformationSource";
 export * from "./models/IPolicyManagementPointComponent";
+export * from "./models/IPolicyNegotiation";
+export * from "./models/IPolicyNegotiationAdminPointComponent";
+export * from "./models/IPolicyNegotiationPointComponent";
+export * from "./models/IPolicyNegotiationRequestPointComponent";
+export * from "./models/IPolicyNegotiator";
+export * from "./models/IPolicyState";
 export * from "./models/IRightsManagementComponent";
 export * from "./models/policyDecisionStage";
+export * from "./models/policyInformationAccessMode";
+export * from "./models/policyNegotiationStatus";
+export * from "./models/rightsManagementNamespaces";
+export * from "./utils/odrlPolicyHelper";

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

@@ -10,7 +10,9 @@ export interface IPolicyAdministrationPointComponent extends IComponent {
      * @param policy The policy to create (uid will be auto-generated).
      * @returns The UID of the created policy.
      */
-    create(policy: Omit<IOdrlPolicy, "uid">): Promise<string>;
+    create(policy: Omit<IOdrlPolicy, "uid"> & {
+        uid?: string;
+    }): Promise<string>;
     /**
      * Update an existing policy.
      * @param policy The policy to update (must include uid).

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

@@ -0,0 +1,13 @@
+/**
+ * Context information to be used when making a policy decision.
+ */
+export interface IPolicyContext {
+    /**
+     * The user identity to use in the decision making.
+     */
+    userIdentity?: string;
+    /**
+     * The node identity to use in the decision making.
+     */
+    nodeIdentity?: string;
+}

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

@@ -1,5 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
 /**
  * Interface describing a Policy Decision Point (PDP) contract.
  * Decides if a party can be granted access to a resource, will retrieve policies
@@ -15,11 +16,10 @@ export interface IPolicyDecisionPointComponent extends IComponent {
      * Executes any actions on the Policy Execution Point (PXP) when the decision is made.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param context The context information to use in the decision making.
      * @param data The data to make a decision on.
-     * @param userIdentity The user identity to use in the decision making.
-     * @param nodeIdentity The node identity to use in the decision making.
      * @returns Returns the policy decisions which apply to the data so that the PEP
      * can manipulate the data accordingly.
      */
-    evaluate<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string): Promise<IOdrlPolicy[]>;
+    evaluate<C extends IPolicyContext = IPolicyContext, D = unknown>(assetType: string, action: string, context: C | undefined, data: D | undefined): Promise<IOdrlPolicy[]>;
 }

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

@@ -1,4 +1,6 @@
 import type { IComponent } from "@twin.org/core";
+import type { IPolicyContext } from "./IPolicyContext";
+import type { IPolicyEnforcementProcessor } from "./IPolicyEnforcementProcessor";
 /**
  * Interface describing a Policy Enforcement Point (PEP) contract.
  * Intercepts data and uses the Policy Decision Point (PDP) to make decisions on
@@ -10,10 +12,22 @@ export interface IPolicyEnforcementPointComponent extends IComponent {
      * Process the data using Policy Decision Point (PDP) and return the manipulated data.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param context The context information to use in the decision making.
      * @param data The data to process.
-     * @param userIdentity The user identity to use in the decision making.
-     * @param nodeIdentity The node identity to use in the decision making.
      * @returns The manipulated data with any policies applied.
      */
-    intercept<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string | undefined, nodeIdentity: string | undefined): Promise<T | undefined>;
+    intercept<C extends IPolicyContext = IPolicyContext, D = unknown, R = unknown>(assetType: string, action: string, context: C | undefined, data: D | undefined): Promise<R | undefined>;
+    /**
+     * Register a processor to use for handling data.
+     * @param processorId The id of the processor to register.
+     * @param processor The processor to register.
+     * @returns Nothing.
+     */
+    registerProcessor(processorId: string, processor: IPolicyEnforcementProcessor): Promise<void>;
+    /**
+     * Unregister a processor from the handling.
+     * @param processorId The id of the processor to unregister.
+     * @returns Nothing.
+     */
+    unregisterProcessor(processorId: string): Promise<void>;
 }

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

@@ -0,0 +1,17 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
+/**
+ * Interface for policy enforcement processors.
+ */
+export interface IPolicyEnforcementProcessor {
+    /**
+     * Process the response from the policy decision point.
+     * @param assetType The type of asset being processed.
+     * @param action The action being performed on the asset.
+     * @param context The context information to use in the decision making.
+     * @param data The data to process.
+     * @param policies The policies that apply to the data.
+     * @returns The data after processing.
+     */
+    process<C extends IPolicyContext = IPolicyContext, D = unknown, R = unknown>(assetType: string, action: string, context: C | undefined, data: D | undefined, policies: IOdrlPolicy[]): Promise<R | undefined>;
+}

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

@@ -1,4 +1,5 @@
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
 import type { PolicyDecisionStage } from "./policyDecisionStage";
 /**
  * Interface for policy execution actions.
@@ -6,14 +7,13 @@ import type { PolicyDecisionStage } from "./policyDecisionStage";
 export interface IPolicyExecutionAction {
     /**
      * Execute function type for policy actions.
+     * @param stage The stage of the policy decision.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param context The context information to use in the decision making.
      * @param data The data to process.
-     * @param userIdentity The user identity to use in the decision making.
-     * @param nodeIdentity The node identity to use in the decision making.
      * @param policies The policies that apply to the data.
-     * @param stage The stage of the policy decision.
      * @returns A promise that resolves when the action is complete.
      */
-    execute(assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[], stage: PolicyDecisionStage): Promise<void>;
+    execute<C extends IPolicyContext = IPolicyContext, D = unknown>(stage: PolicyDecisionStage, assetType: string, action: string, context: C | undefined, data: D | undefined, policies: IOdrlPolicy[]): Promise<void>;
 }

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

@@ -1,5 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
 import type { IPolicyExecutionAction } from "./IPolicyExecutionAction";
 import type { PolicyDecisionStage } from "./policyDecisionStage";
 /**
@@ -14,13 +15,12 @@ export interface IPolicyExecutionPointComponent extends IComponent {
      * @param stage The stage at which the PXP is executed in the PDP.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param context The context information to use in the decision making.
      * @param data The data used in the decision by the PDP.
-     * @param userIdentity The user identity to use in the decision making.
-     * @param nodeIdentity The node identity to use in the decision making.
      * @param policies The policies that apply to the data.
      * @returns Nothing.
      */
-    executeActions(stage: PolicyDecisionStage, assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<void>;
+    executeActions<C extends IPolicyContext = IPolicyContext, D = unknown>(stage: PolicyDecisionStage, assetType: string, action: string, context: C | undefined, data: D | undefined, policies: IOdrlPolicy[]): Promise<void>;
     /**
      * Register an action to be executed.
      * @param actionId The id of the action to register.

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

@@ -1,7 +1,9 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
 import type { IPolicyInformationSource } from "./IPolicyInformationSource";
+import type { PolicyInformationAccessMode } from "./policyInformationAccessMode";
 /**
  * Interface describing a Policy Information Point (PEP) contract.
  * Provides additional information to the Policy Decision Point (PDP) when
@@ -12,13 +14,13 @@ export interface IPolicyInformationPointComponent extends IComponent {
      * Retrieve additional information which is relevant in the PDP decision making.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param context The context information to use in the decision making.
      * @param data The data to get any additional information for.
-     * @param userIdentity The user identity to get additional information for.
-     * @param nodeIdentity The node identity to get additional information for.
      * @param policies The policies that apply to the data.
      * @returns Returns additional information based on the data and identities.
      */
-    retrieve(assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<{
+    retrieve<C extends IPolicyContext = IPolicyContext, D = unknown>(assetType: string, action: string, accessMode: PolicyInformationAccessMode, context: C | undefined, data: D | undefined, policies: IOdrlPolicy[]): Promise<{
         [source: string]: IJsonLdNodeObject[];
     }>;
     /**

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

@@ -1,5 +1,7 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
+import type { PolicyInformationAccessMode } from "./policyInformationAccessMode";
 /**
  * Interface for policy information sources.
  */
@@ -8,11 +10,11 @@ export interface IPolicyInformationSource {
      * Retrieve information from the sources.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param context The context information to use in the decision making.
      * @param data The data to process.
-     * @param userIdentity The user identity to use in the decision making.
-     * @param nodeIdentity The node identity to use in the decision making.
      * @param policies The policies that apply to the data.
      * @returns The objects containing relevant information or undefined if nothing relevant is found.
      */
-    retrieve(assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<IJsonLdNodeObject[] | undefined>;
+    retrieve<C extends IPolicyContext = IPolicyContext, D = unknown>(assetType: string, action: string, accessMode: PolicyInformationAccessMode, context: C | undefined, data: D | undefined, policies: IOdrlPolicy[]): Promise<IJsonLdNodeObject[] | undefined>;
 }

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

@@ -1,5 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyContext } from "./IPolicyContext";
 /**
  * Interface describing a Policy Management Point (PMP) contract.
  * Provide the policies to the Policy Decision Point (PDP) based on the data and identities.
@@ -9,10 +10,9 @@ export interface IPolicyManagementPointComponent extends IComponent {
      * Get the policies from a PAP based on the data and identities.
      * @param assetType The type of asset being processed.
      * @param action The action being performed on the asset.
+     * @param context The context information to use in the decision making.
      * @param data The data to retrieve the policies for.
-     * @param userIdentity The user identity to retrieve the policies for.
-     * @param nodeIdentity The node identity to retrieve the policies for.
      * @returns Returns the policies which apply to the data and identities so that the PDP can make a decision.
      */
-    retrieve<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string): Promise<IOdrlPolicy[]>;
+    retrieve<C extends IPolicyContext = IPolicyContext, D = unknown>(assetType: string, action: string, context: C | undefined, data: D | undefined): Promise<IOdrlPolicy[]>;
 }