@twin.org/rights-management-pdp-service 0.0.2-next.10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Rights Management Policy Decision Point Service
+
+Policy decision point implementation.
+
+## Installation
+
+```shell
+npm install @twin.org/rights-management-pdp-service
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,156 @@
+'use strict';
+
+var core = require('@twin.org/core');
+var rightsManagementModels = require('@twin.org/rights-management-models');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class implementation of Policy Decision Point Component.
+ */
+class PolicyDecisionPointService {
+    /**
+     * The class name of the Policy Decision Point Service.
+     */
+    CLASS_NAME = "PolicyDecisionPointService";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * The policy management point component.
+     * @internal
+     */
+    _policyManagementPointComponent;
+    /**
+     * The policy information point component.
+     * @internal
+     */
+    _policyInformationPointComponent;
+    /**
+     * The policy execution point component.
+     * @internal
+     */
+    _policyExecutionPointComponent;
+    /**
+     * These arbiters can be registered to make decision on specific types.
+     * @internal
+     */
+    _arbiters;
+    /**
+     * Create a new instance of PolicyDecisionPointService (PDP).
+     * @param options The options for the component.
+     */
+    constructor(options) {
+        this._logging = core.ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
+        this._policyManagementPointComponent = core.ComponentFactory.get(options?.policyManagementPointComponentType ?? "policy-management-point");
+        this._policyInformationPointComponent = core.ComponentFactory.get(options?.policyInformationPointComponentType ?? "policy-information-point");
+        this._policyExecutionPointComponent = core.ComponentFactory.get(options?.policyExecutionPointComponentType ?? "policy-execution-point");
+        this._arbiters = options?.config?.arbiters ?? [];
+    }
+    /**
+     * Evaluate requests from a Policy Enforcement Point (PEP).
+     * Uses the Policy Management Point (PMP) to retrieve the policies and the
+     * Policy Information Point (PIP) to retrieve additional information.
+     * Executes any actions on the Policy Execution Point (PXP) before and after decision is made.
+     * @param locator The locator to find relevant policies.
+     * @param data The data to make a decision on.
+     * @returns Returns the policy decisions which apply to the data so that the PEP
+     * can manipulate the data accordingly.
+     */
+    async evaluate(locator, data) {
+        core.Guards.objectValue(this.CLASS_NAME, "locator", locator);
+        const supportedArbiters = this._arbiters.filter(({ arbiter }) => {
+            const supportedPolicies = arbiter.supportedPolicies();
+            return (supportedPolicies.length === 0 ||
+                rightsManagementModels.LocatorHelper.findMatchingLocator(supportedPolicies, locator));
+        });
+        if (supportedArbiters.length === 0) {
+            throw new core.GeneralError(this.CLASS_NAME, "noSupportedArbiters", {
+                locator: rightsManagementModels.LocatorHelper.toString(locator)
+            });
+        }
+        const policies = [];
+        let cursor;
+        do {
+            const retrieveResult = await this._policyManagementPointComponent.retrieve(locator, data);
+            cursor = retrieveResult.cursor;
+            policies.push(...retrieveResult.policies);
+        } while (core.Is.stringValue(cursor));
+        const decisions = [];
+        await this._policyExecutionPointComponent.executeActions(rightsManagementModels.PolicyDecisionStage.Before, locator, policies, decisions, data);
+        const information = await this._policyInformationPointComponent.retrieve(locator, rightsManagementModels.PolicyInformationAccessMode.Any, policies, data);
+        for (const { arbiterId, arbiter } of supportedArbiters) {
+            try {
+                const arbiterDecisions = await arbiter.decide(locator, information, policies, data);
+                decisions.push(...arbiterDecisions);
+            }
+            catch (error) {
+                this._logging?.log({
+                    level: "error",
+                    source: this.CLASS_NAME,
+                    ts: Date.now(),
+                    message: "decidingFailed",
+                    data: {
+                        arbiterId,
+                        locator: rightsManagementModels.LocatorHelper.toString(locator)
+                    },
+                    error: core.BaseError.fromError(error)
+                });
+                throw new core.GeneralError(this.CLASS_NAME, "decidingFailed", { arbiterId, locator: rightsManagementModels.LocatorHelper.toString(locator) }, error);
+            }
+        }
+        await this._policyExecutionPointComponent.executeActions(rightsManagementModels.PolicyDecisionStage.After, locator, policies, decisions, data);
+        return decisions;
+    }
+    /**
+     * Register an arbiter to use for making decisions.
+     * @param arbiterId The id of the arbiter to register.
+     * @param arbiter The arbiter to register.
+     * @returns Nothing.
+     */
+    async registerArbiter(arbiterId, arbiter) {
+        core.Guards.stringValue(this.CLASS_NAME, "arbiterId", arbiterId);
+        core.Guards.object(this.CLASS_NAME, "arbiter", arbiter);
+        const currentIndex = this._arbiters.findIndex(a => a.arbiterId === arbiterId);
+        if (currentIndex !== -1) {
+            this._arbiters[currentIndex].arbiter = arbiter;
+        }
+        else {
+            this._arbiters.push({ arbiterId, arbiter });
+        }
+        this._logging?.log({
+            level: "info",
+            source: this.CLASS_NAME,
+            ts: Date.now(),
+            message: "registeredArbiter",
+            data: {
+                arbiterId
+            }
+        });
+    }
+    /**
+     * Unregister an arbiter from making decisions.
+     * @param arbiterId The id of the arbiter to unregister.
+     * @returns Nothing.
+     */
+    async unregisterArbiter(arbiterId) {
+        core.Guards.stringValue(this.CLASS_NAME, "arbiterId", arbiterId);
+        const currentIndex = this._arbiters.findIndex(a => a.arbiterId === arbiterId);
+        if (currentIndex !== -1) {
+            this._arbiters.splice(currentIndex, 1);
+        }
+        this._logging?.log({
+            level: "info",
+            source: this.CLASS_NAME,
+            ts: Date.now(),
+            message: "unregisteredArbiter",
+            data: {
+                arbiterId
+            }
+        });
+    }
+}
+
+exports.PolicyDecisionPointService = PolicyDecisionPointService;

package/dist/esm/index.mjs

@@ -0,0 +1,154 @@
+import { ComponentFactory, Guards, GeneralError, Is, BaseError } from '@twin.org/core';
+import { LocatorHelper, PolicyDecisionStage, PolicyInformationAccessMode } from '@twin.org/rights-management-models';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class implementation of Policy Decision Point Component.
+ */
+class PolicyDecisionPointService {
+    /**
+     * The class name of the Policy Decision Point Service.
+     */
+    CLASS_NAME = "PolicyDecisionPointService";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * The policy management point component.
+     * @internal
+     */
+    _policyManagementPointComponent;
+    /**
+     * The policy information point component.
+     * @internal
+     */
+    _policyInformationPointComponent;
+    /**
+     * The policy execution point component.
+     * @internal
+     */
+    _policyExecutionPointComponent;
+    /**
+     * These arbiters can be registered to make decision on specific types.
+     * @internal
+     */
+    _arbiters;
+    /**
+     * Create a new instance of PolicyDecisionPointService (PDP).
+     * @param options The options for the component.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
+        this._policyManagementPointComponent = ComponentFactory.get(options?.policyManagementPointComponentType ?? "policy-management-point");
+        this._policyInformationPointComponent = ComponentFactory.get(options?.policyInformationPointComponentType ?? "policy-information-point");
+        this._policyExecutionPointComponent = ComponentFactory.get(options?.policyExecutionPointComponentType ?? "policy-execution-point");
+        this._arbiters = options?.config?.arbiters ?? [];
+    }
+    /**
+     * Evaluate requests from a Policy Enforcement Point (PEP).
+     * Uses the Policy Management Point (PMP) to retrieve the policies and the
+     * Policy Information Point (PIP) to retrieve additional information.
+     * Executes any actions on the Policy Execution Point (PXP) before and after decision is made.
+     * @param locator The locator to find relevant policies.
+     * @param data The data to make a decision on.
+     * @returns Returns the policy decisions which apply to the data so that the PEP
+     * can manipulate the data accordingly.
+     */
+    async evaluate(locator, data) {
+        Guards.objectValue(this.CLASS_NAME, "locator", locator);
+        const supportedArbiters = this._arbiters.filter(({ arbiter }) => {
+            const supportedPolicies = arbiter.supportedPolicies();
+            return (supportedPolicies.length === 0 ||
+                LocatorHelper.findMatchingLocator(supportedPolicies, locator));
+        });
+        if (supportedArbiters.length === 0) {
+            throw new GeneralError(this.CLASS_NAME, "noSupportedArbiters", {
+                locator: LocatorHelper.toString(locator)
+            });
+        }
+        const policies = [];
+        let cursor;
+        do {
+            const retrieveResult = await this._policyManagementPointComponent.retrieve(locator, data);
+            cursor = retrieveResult.cursor;
+            policies.push(...retrieveResult.policies);
+        } while (Is.stringValue(cursor));
+        const decisions = [];
+        await this._policyExecutionPointComponent.executeActions(PolicyDecisionStage.Before, locator, policies, decisions, data);
+        const information = await this._policyInformationPointComponent.retrieve(locator, PolicyInformationAccessMode.Any, policies, data);
+        for (const { arbiterId, arbiter } of supportedArbiters) {
+            try {
+                const arbiterDecisions = await arbiter.decide(locator, information, policies, data);
+                decisions.push(...arbiterDecisions);
+            }
+            catch (error) {
+                this._logging?.log({
+                    level: "error",
+                    source: this.CLASS_NAME,
+                    ts: Date.now(),
+                    message: "decidingFailed",
+                    data: {
+                        arbiterId,
+                        locator: LocatorHelper.toString(locator)
+                    },
+                    error: BaseError.fromError(error)
+                });
+                throw new GeneralError(this.CLASS_NAME, "decidingFailed", { arbiterId, locator: LocatorHelper.toString(locator) }, error);
+            }
+        }
+        await this._policyExecutionPointComponent.executeActions(PolicyDecisionStage.After, locator, policies, decisions, data);
+        return decisions;
+    }
+    /**
+     * Register an arbiter to use for making decisions.
+     * @param arbiterId The id of the arbiter to register.
+     * @param arbiter The arbiter to register.
+     * @returns Nothing.
+     */
+    async registerArbiter(arbiterId, arbiter) {
+        Guards.stringValue(this.CLASS_NAME, "arbiterId", arbiterId);
+        Guards.object(this.CLASS_NAME, "arbiter", arbiter);
+        const currentIndex = this._arbiters.findIndex(a => a.arbiterId === arbiterId);
+        if (currentIndex !== -1) {
+            this._arbiters[currentIndex].arbiter = arbiter;
+        }
+        else {
+            this._arbiters.push({ arbiterId, arbiter });
+        }
+        this._logging?.log({
+            level: "info",
+            source: this.CLASS_NAME,
+            ts: Date.now(),
+            message: "registeredArbiter",
+            data: {
+                arbiterId
+            }
+        });
+    }
+    /**
+     * Unregister an arbiter from making decisions.
+     * @param arbiterId The id of the arbiter to unregister.
+     * @returns Nothing.
+     */
+    async unregisterArbiter(arbiterId) {
+        Guards.stringValue(this.CLASS_NAME, "arbiterId", arbiterId);
+        const currentIndex = this._arbiters.findIndex(a => a.arbiterId === arbiterId);
+        if (currentIndex !== -1) {
+            this._arbiters.splice(currentIndex, 1);
+        }
+        this._logging?.log({
+            level: "info",
+            source: this.CLASS_NAME,
+            ts: Date.now(),
+            message: "unregisteredArbiter",
+            data: {
+                arbiterId
+            }
+        });
+    }
+}
+
+export { PolicyDecisionPointService };

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./models/IPolicyDecisionPointServiceConfig";
+export * from "./models/IPolicyDecisionPointServiceConstructorOptions";
+export * from "./policyDecisionPointService";

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

@@ -0,0 +1,13 @@
+import type { IPolicyArbiter } from "@twin.org/rights-management-models";
+/**
+ * Options for the Policy Decision Point Component.
+ */
+export interface IPolicyDecisionPointServiceConfig {
+    /**
+     * Initial arbiters to register with the PDP.
+     */
+    arbiters?: {
+        arbiterId: string;
+        arbiter: IPolicyArbiter;
+    }[];
+}

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

@@ -0,0 +1,30 @@
+import type { IPolicyDecisionPointServiceConfig } from "./IPolicyDecisionPointServiceConfig";
+/**
+ * Options for the Policy Decision Point Component.
+ */
+export interface IPolicyDecisionPointServiceConstructorOptions {
+    /**
+     * The logging component for logging policy decisions.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The type of the policy information point component.
+     * @default policy-information-point
+     */
+    policyInformationPointComponentType?: string;
+    /**
+     * The type of the policy management point component.
+     * @default policy-management-point
+     */
+    policyManagementPointComponentType?: string;
+    /**
+     * The type of the policy execution point component.
+     * @default policy-execution-point
+     */
+    policyExecutionPointComponentType?: string;
+    /**
+     * The configuration for the Policy Decision Point Service.
+     */
+    config?: IPolicyDecisionPointServiceConfig;
+}

package/dist/types/policyDecisionPointService.d.ts

@@ -0,0 +1,40 @@
+import { type IPolicyLocator, type IPolicyArbiter, type IPolicyDecision, type IPolicyDecisionPointComponent } from "@twin.org/rights-management-models";
+import type { IPolicyDecisionPointServiceConstructorOptions } from "./models/IPolicyDecisionPointServiceConstructorOptions";
+/**
+ * Class implementation of Policy Decision Point Component.
+ */
+export declare class PolicyDecisionPointService implements IPolicyDecisionPointComponent {
+    /**
+     * The class name of the Policy Decision Point Service.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PolicyDecisionPointService (PDP).
+     * @param options The options for the component.
+     */
+    constructor(options?: IPolicyDecisionPointServiceConstructorOptions);
+    /**
+     * Evaluate requests from a Policy Enforcement Point (PEP).
+     * Uses the Policy Management Point (PMP) to retrieve the policies and the
+     * Policy Information Point (PIP) to retrieve additional information.
+     * Executes any actions on the Policy Execution Point (PXP) before and after decision is made.
+     * @param locator The locator to find relevant policies.
+     * @param data The data to make a decision on.
+     * @returns Returns the policy decisions which apply to the data so that the PEP
+     * can manipulate the data accordingly.
+     */
+    evaluate<D = unknown>(locator: IPolicyLocator, data?: D): Promise<IPolicyDecision[]>;
+    /**
+     * Register an arbiter to use for making decisions.
+     * @param arbiterId The id of the arbiter to register.
+     * @param arbiter The arbiter to register.
+     * @returns Nothing.
+     */
+    registerArbiter(arbiterId: string, arbiter: IPolicyArbiter): Promise<void>;
+    /**
+     * Unregister an arbiter from making decisions.
+     * @param arbiterId The id of the arbiter to unregister.
+     * @returns Nothing.
+     */
+    unregisterArbiter(arbiterId: string): Promise<void>;
+}

package/docs/changelog.md

@@ -0,0 +1,178 @@
+# Changelog
+
+## [0.0.2-next.10](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.9...rights-management-pdp-service-v0.0.2-next.10) (2025-09-19)
+
+
+### Features
+
+* add pdp tests ([87a0c29](https://github.com/twinfoundation/rights-management/commit/87a0c29674ac5b97c3b2a1723d14f56a582f36c4))
+* pdp add ([#39](https://github.com/twinfoundation/rights-management/issues/39)) ([68b9a8a](https://github.com/twinfoundation/rights-management/commit/68b9a8a7a3cf2902f9eecb590ca3316c6b1671f0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.8...rights-management-pdp-service-v0.0.2-next.9) (2025-09-08)
+
+
+### Features
+
+* add JSON-LD types for negotiation ([6be61f8](https://github.com/twinfoundation/rights-management/commit/6be61f890537cb9d22d4fad90092b858de2c9c2d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.7...rights-management-pdp-service-v0.0.2-next.8) (2025-09-05)
+
+
+### Miscellaneous Chores
+
+* **rights-management-pdp-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.6...rights-management-pdp-service-v0.0.2-next.7) (2025-09-05)
+
+
+### Miscellaneous Chores
+
+* **rights-management-pdp-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.5...rights-management-pdp-service-v0.0.2-next.6) (2025-09-05)
+
+
+### Miscellaneous Chores
+
+* **rights-management-pdp-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.4...rights-management-pdp-service-v0.0.2-next.5) (2025-09-05)
+
+
+### Features
+
+* add policy negotiation point PNP, PNAP and PNRP ([#32](https://github.com/twinfoundation/rights-management/issues/32)) ([90f0659](https://github.com/twinfoundation/rights-management/commit/90f06593a1126df3c2f4ca23cf95a08260fd6415))
+* introduce context for additional environment input ([e1d0392](https://github.com/twinfoundation/rights-management/commit/e1d0392622e5a018b695644f423c5b23cc40d3b7))
+* remove optional for components ([a354232](https://github.com/twinfoundation/rights-management/commit/a354232ff97fe49cbcdc18c73c4e17cf9346ccfd))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.3...rights-management-pdp-service-v0.0.2-next.4) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([5698a8c](https://github.com/twinfoundation/rights-management/commit/5698a8c399a020a13be0bcdff5a7c5050272cfcc))
+* improve constructor option naming ([c89a7e8](https://github.com/twinfoundation/rights-management/commit/c89a7e8df43a5017ac5cf84b549f5a26cc41e089))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.2...rights-management-pdp-service-v0.0.2-next.3) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([23a0c08](https://github.com/twinfoundation/rights-management/commit/23a0c085e7fc2e522c8d85d325dc5844b9c3fd8e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/rights-management/compare/rights-management-pdp-service-v0.0.2-next.1...rights-management-pdp-service-v0.0.2-next.2) (2025-08-22)
+
+
+### Features
+
+* add scaffold for other services ([de25f34](https://github.com/twinfoundation/rights-management/commit/de25f34c40fb65b6d73df98965ea4e368019da84))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/rights-management-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+  * devDependencies
+    * @twin.org/rights-management-pap-service bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/rights-management-pip-service bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/rights-management-pmp-service bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/rights-management-pxp-service bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## @twin.org/rights-management-pdp-service - Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/rights-management-pdp-service - Examples

package/docs/reference/classes/PolicyDecisionPointService.md

@@ -0,0 +1,139 @@
+# Class: PolicyDecisionPointService
+
+Class implementation of Policy Decision Point Component.
+
+## Implements
+
+- `IPolicyDecisionPointComponent`
+
+## Constructors
+
+### Constructor
+
+> **new PolicyDecisionPointService**(`options?`): `PolicyDecisionPointService`
+
+Create a new instance of PolicyDecisionPointService (PDP).
+
+#### Parameters
+
+##### options?
+
+[`IPolicyDecisionPointServiceConstructorOptions`](../interfaces/IPolicyDecisionPointServiceConstructorOptions.md)
+
+The options for the component.
+
+#### Returns
+
+`PolicyDecisionPointService`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+The class name of the Policy Decision Point Service.
+
+#### Implementation of
+
+`IPolicyDecisionPointComponent.CLASS_NAME`
+
+## Methods
+
+### evaluate()
+
+> **evaluate**\<`D`\>(`locator`, `data?`): `Promise`\<`IPolicyDecision`[]\>
+
+Evaluate requests from a Policy Enforcement Point (PEP).
+Uses the Policy Management Point (PMP) to retrieve the policies and the
+Policy Information Point (PIP) to retrieve additional information.
+Executes any actions on the Policy Execution Point (PXP) before and after decision is made.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### locator
+
+`IPolicyLocator`
+
+The locator to find relevant policies.
+
+##### data?
+
+`D`
+
+The data to make a decision on.
+
+#### Returns
+
+`Promise`\<`IPolicyDecision`[]\>
+
+Returns the policy decisions which apply to the data so that the PEP
+can manipulate the data accordingly.
+
+#### Implementation of
+
+`IPolicyDecisionPointComponent.evaluate`
+
+***
+
+### registerArbiter()
+
+> **registerArbiter**(`arbiterId`, `arbiter`): `Promise`\<`void`\>
+
+Register an arbiter to use for making decisions.
+
+#### Parameters
+
+##### arbiterId
+
+`string`
+
+The id of the arbiter to register.
+
+##### arbiter
+
+`IPolicyArbiter`
+
+The arbiter to register.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IPolicyDecisionPointComponent.registerArbiter`
+
+***
+
+### unregisterArbiter()
+
+> **unregisterArbiter**(`arbiterId`): `Promise`\<`void`\>
+
+Unregister an arbiter from making decisions.
+
+#### Parameters
+
+##### arbiterId
+
+`string`
+
+The id of the arbiter to unregister.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IPolicyDecisionPointComponent.unregisterArbiter`

package/docs/reference/index.md

@@ -0,0 +1,10 @@
+# @twin.org/rights-management-pdp-service
+
+## Classes
+
+- [PolicyDecisionPointService](classes/PolicyDecisionPointService.md)
+
+## Interfaces
+
+- [IPolicyDecisionPointServiceConfig](interfaces/IPolicyDecisionPointServiceConfig.md)
+- [IPolicyDecisionPointServiceConstructorOptions](interfaces/IPolicyDecisionPointServiceConstructorOptions.md)

package/docs/reference/interfaces/IPolicyDecisionPointServiceConfig.md

@@ -0,0 +1,19 @@
+# Interface: IPolicyDecisionPointServiceConfig
+
+Options for the Policy Decision Point Component.
+
+## Properties
+
+### arbiters?
+
+> `optional` **arbiters**: `object`[]
+
+Initial arbiters to register with the PDP.
+
+#### arbiterId
+
+> **arbiterId**: `string`
+
+#### arbiter
+
+> **arbiter**: `IPolicyArbiter`

package/docs/reference/interfaces/IPolicyDecisionPointServiceConstructorOptions.md

@@ -0,0 +1,67 @@
+# Interface: IPolicyDecisionPointServiceConstructorOptions
+
+Options for the Policy Decision Point Component.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for logging policy decisions.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### policyInformationPointComponentType?
+
+> `optional` **policyInformationPointComponentType**: `string`
+
+The type of the policy information point component.
+
+#### Default
+
+```ts
+policy-information-point
+```
+
+***
+
+### policyManagementPointComponentType?
+
+> `optional` **policyManagementPointComponentType**: `string`
+
+The type of the policy management point component.
+
+#### Default
+
+```ts
+policy-management-point
+```
+
+***
+
+### policyExecutionPointComponentType?
+
+> `optional` **policyExecutionPointComponentType**: `string`
+
+The type of the policy execution point component.
+
+#### Default
+
+```ts
+policy-execution-point
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IPolicyDecisionPointServiceConfig`](IPolicyDecisionPointServiceConfig.md)
+
+The configuration for the Policy Decision Point Service.

package/locales/en.json

@@ -0,0 +1,14 @@
+{
+	"error": {
+		"policyDecisionPointService": {
+			"decidingFailed": "Deciding on policies for locator \"{locator}\" failed in arbiter with id: \"{arbiterId}\"",
+			"noSupportedArbiters": "No arbiters found that support the given locator: \"{locator}\""
+		}
+	},
+	"info": {
+		"policyDecisionPointService": {
+			"registeredArbiter": "Arbiter registered with id: \"{arbiterId}\"",
+			"unregisteredArbiter": "Arbiter unregistered with id: \"{arbiterId}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@twin.org/rights-management-pdp-service",
+	"version": "0.0.2-next.10",
+	"description": "Policy decision point implementation",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/rights-management.git",
+		"directory": "packages/rights-management-pdp-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/rights-management-models": "0.0.2-next.10",
+		"@twin.org/standards-w3c-odrl": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}