@twin.org/rights-management-models 0.0.1-next.3

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 Models
+
+Models which define the structure of the rights management contracts and connectors.
+
+## Installation
+
+```shell
+npm install @twin.org/rights-management-models
+```
+
+## 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,2 @@
+'use strict';
+

package/dist/esm/index.mjs

@@ -0,0 +1 @@
+

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./models/IPolicyAdministrationPointComponent";
+export * from "./models/IPolicyDecisionPointComponent";
+export * from "./models/IPolicyEnforcementPointComponent";
+export * from "./models/IPolicyExecutionPointComponent";
+export * from "./models/IPolicyInformationPointComponent";
+export * from "./models/IPolicyManagementPointComponent";
+export * from "./models/policyActionCallback";
+export * from "./models/api/policyAdministrationPoint/IPapStoreRequest";
+export * from "./models/api/policyAdministrationPoint/IPapRetrieveRequest";
+export * from "./models/api/policyAdministrationPoint/IPapRetrieveResponse";
+export * from "./models/api/policyAdministrationPoint/IPapRemoveRequest";
+export * from "./models/api/policyAdministrationPoint/IPapQueryRequest";
+export * from "./models/api/policyAdministrationPoint/IPapQueryResponse";
+export * from "./models/IRightsManagementComponent";

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

@@ -0,0 +1,53 @@
+import type { IComponent } from "@twin.org/core";
+import type { EntityCondition } from "@twin.org/entity";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Interface describing a Policy Administration Point (PAP) contract.
+ * Manages policies for the rights management, policies are also queried by the
+ * Policy Management Point (PMP) when it handles requests from the Policy Decision Point (PDP).
+ */
+export interface IPolicyAdministrationPointComponent extends IComponent {
+    /**
+     * Store a policy.
+     * @param policy The policy to store.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns Nothing.
+     */
+    store(policy: IOdrlPolicy, userIdentity: string | undefined, nodeIdentity: string): Promise<void>;
+    /**
+     * Retrieve a policy.
+     * @param policyId The id of the policy to retrieve.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns The policy.
+     */
+    retrieve(policyId: string, userIdentity: string | undefined, nodeIdentity: string): Promise<IOdrlPolicy>;
+    /**
+     * Remove a policy.
+     * @param policyId The id of the policy to remove.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns Nothing.
+     */
+    remove(policyId: string, userIdentity: string | undefined, nodeIdentity: string): Promise<void>;
+    /**
+     * Query the policies using the specified conditions.
+     * @param conditions The conditions to use for the query.
+     * @param cursor The cursor to use for pagination.
+     * @param pageSize The number of results to return per page.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns Cursor for next page of results and the policies matching the query.
+     */
+    query(conditions?: EntityCondition<IOdrlPolicy>, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<{
+        /**
+         * The cursor for the next page of results.
+         */
+        cursor?: string;
+        /**
+         * The policies that match the query.
+         */
+        policies: IOdrlPolicy[];
+    }>;
+}

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

@@ -0,0 +1,25 @@
+import type { IComponent } from "@twin.org/core";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Interface describing a Policy Decision Point (PDP) contract.
+ * Decides if a party can be granted access to a resource, will retrieve policies
+ * from the Policy Management Point (PMP) and any additional information from the
+ * Policy Information Point (PIP). When a decision is made, the Policy Execution
+ * Point (PEP) will execute any registered actions.
+ */
+export interface IPolicyDecisionPointComponent extends IComponent {
+    /**
+     * 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 (PEP) when the decision is made.
+     * @param assetType The type of asset being processed.
+     * @param action The action being performed on the asset.
+     * @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[]>;
+}

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

@@ -0,0 +1,19 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * Interface describing a Policy Enforcement Point (PEP) contract.
+ * Intercepts data and uses the Policy Decision Point (PDP) to make decisions on
+ * access to a resource, based on the decision a manipulated data object can
+ * be returned.
+ */
+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 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, nodeIdentity: string): Promise<T | undefined>;
+}

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

@@ -0,0 +1,35 @@
+import type { IComponent } from "@twin.org/core";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { PolicyActionCallback } from "./policyActionCallback";
+/**
+ * Interface describing a Policy Execution Point (PXP) contract.
+ * When a decision is made by the Policy Decision Point (PDP),
+ * the Policy Execution Point (PEP) will execute any
+ * registered actions based on the decision.
+ */
+export interface IPolicyExecutionPointComponent extends IComponent {
+    /**
+     * Execute actions based on the PDP's decisions.
+     * @param assetType The type of asset being processed.
+     * @param action The action being performed on the asset.
+     * @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<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<void>;
+    /**
+     * Register an action to be executed.
+     * @param actionId The id of the action to register.
+     * @param action The action to execute.
+     * @returns Nothing.
+     */
+    registerAction<T = unknown>(actionId: string, action: PolicyActionCallback<T>): Promise<void>;
+    /**
+     * Unregister an action from the execution point.
+     * @param actionId The id of the action to unregister.
+     * @returns Nothing.
+     */
+    unregisterAction(actionId: string): Promise<void>;
+}

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

@@ -0,0 +1,19 @@
+import type { IComponent } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Interface describing a Policy Information Point (PEP) contract.
+ * Provides additional information to the Policy Decision Point (PDP) when
+ * it is making decisions.
+ */
+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 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.
+     * @returns Returns additional information based on the data and identities.
+     */
+    retrieve<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string): Promise<IJsonLdNodeObject[]>;
+}

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

@@ -0,0 +1,18 @@
+import type { IComponent } from "@twin.org/core";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Interface describing a Policy Management Point (PMP) contract.
+ * Provide the policies to the Policy Decision Point (PDP) based on the data and identities.
+ */
+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 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[]>;
+}

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

@@ -0,0 +1,46 @@
+import type { IComponent } from "@twin.org/core";
+import type { EntityCondition } from "@twin.org/entity";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Interface describing a unified Rights Management Component.
+ * This serves as a single point of entry for all rights management operations.
+ */
+export interface IRightsManagementComponent extends IComponent {
+    /**
+     * PAP: Store a policy.
+     * @param policy The policy to store.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns Nothing.
+     */
+    papStore(policy: IOdrlPolicy, userIdentity: string | undefined, nodeIdentity: string): Promise<void>;
+    /**
+     * PAP: Retrieve a policy.
+     * @param policyId The id of the policy to retrieve.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns The policy.
+     */
+    papRetrieve(policyId: string, userIdentity: string | undefined, nodeIdentity: string): Promise<IOdrlPolicy>;
+    /**
+     * PAP: Remove a policy.
+     * @param policyId The id of the policy to remove.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns Nothing.
+     */
+    papRemove(policyId: string, userIdentity: string | undefined, nodeIdentity: string): Promise<void>;
+    /**
+     * PAP: Query the policies using the specified conditions.
+     * @param conditions The conditions to use for the query.
+     * @param cursor The cursor to use for pagination.
+     * @param pageSize The number of results to return per page.
+     * @param userIdentity The identity of the user performing the operation.
+     * @param nodeIdentity The identity of the node the operation is performed on.
+     * @returns Cursor for next page of results and the policies matching the query.
+     */
+    papQuery(conditions?: EntityCondition<IOdrlPolicy>, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<{
+        cursor?: string;
+        policies: IOdrlPolicy[];
+    }>;
+}

package/dist/types/models/api/policyAdministrationPoint/IPapQueryRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The request structure for querying policies.
+ */
+export interface IPapQueryRequest {
+    /**
+     * The query parameters of the request.
+     */
+    query?: {
+        /**
+         * The condition for the query.
+         */
+        conditions?: string;
+        /**
+         * The number of entries to return per page.
+         */
+        pageSize?: string;
+        /**
+         * The cursor to get next chunk of data, returned in previous response.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/policyAdministrationPoint/IPapQueryResponse.d.ts

@@ -0,0 +1,19 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * The response structure for querying policies.
+ */
+export interface IPapQueryResponse {
+    /**
+     * The body of the response.
+     */
+    body: {
+        /**
+         * The cursor for the next page of results, if there are more results available.
+         */
+        cursor?: string;
+        /**
+         * The policies matching the query.
+         */
+        policies: IOdrlPolicy[];
+    };
+}

package/dist/types/models/api/policyAdministrationPoint/IPapRemoveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The request structure for removing a policy.
+ */
+export interface IPapRemoveRequest {
+    /**
+     * The path parameters of the request.
+     */
+    pathParams: {
+        /**
+         * The ID of the policy to remove.
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/policyAdministrationPoint/IPapRetrieveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The request structure for retrieving a policy.
+ */
+export interface IPapRetrieveRequest {
+    /**
+     * The path parameters of the request.
+     */
+    pathParams: {
+        /**
+         * The ID of the policy to retrieve.
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/policyAdministrationPoint/IPapRetrieveResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * The response structure for retrieving a policy.
+ */
+export interface IPapRetrieveResponse {
+    /**
+     * The body of the response.
+     */
+    body: IOdrlPolicy;
+}

package/dist/types/models/api/policyAdministrationPoint/IPapStoreRequest.d.ts

@@ -0,0 +1,15 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * The request structure for storing a policy.
+ */
+export interface IPapStoreRequest {
+    /**
+     * The body of the request.
+     */
+    body: {
+        /**
+         * The policy to store.
+         */
+        policy: IOdrlPolicy;
+    };
+}

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

@@ -0,0 +1,16 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Callback function type for policy actions.
+ * This function is called when a policy action is executed.
+ * It receives the asset type, action, data, user identity,
+ * node identity, and the policies that apply to the data.
+ * The function should return a promise that resolves when the action is complete.
+ * @param assetType The type of asset being processed.
+ * @param action The action being performed on the asset.
+ * @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 A promise that resolves when the action is complete.
+ */
+export type PolicyActionCallback<T = unknown> = (assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]) => Promise<void>;

package/docs/changelog.md

@@ -0,0 +1,31 @@
+# @twin.org/rights-management-models - Changelog
+
+## [0.0.1-next.3](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.2...rights-management-models-v0.0.1-next.3) (2025-05-28)
+
+
+### Features
+
+* add publish workflows ([9f4db27](https://github.com/twinfoundation/rights-management/commit/9f4db27cccc724a5061f944b29ed7ed5317c9bbf))
+* rights management pap ([#4](https://github.com/twinfoundation/rights-management/issues/4)) ([d1165a9](https://github.com/twinfoundation/rights-management/commit/d1165a92f57128731cfb308d977832e28cf33493))
+* update models based on feedback ([1f11df3](https://github.com/twinfoundation/rights-management/commit/1f11df32bdae5e0a9119e3eee9346b970c5fd345))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/rights-management/issues/2)) ([21c086d](https://github.com/twinfoundation/rights-management/commit/21c086d7be3989858ee28bedb7a1e7b97d65b752))
+
+## [0.0.1-next.2](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.1...rights-management-models-v0.0.1-next.2) (2025-04-17)
+
+
+### Features
+
+* add publish workflows ([9f4db27](https://github.com/twinfoundation/rights-management/commit/9f4db27cccc724a5061f944b29ed7ed5317c9bbf))
+* update models based on feedback ([1f11df3](https://github.com/twinfoundation/rights-management/commit/1f11df32bdae5e0a9119e3eee9346b970c5fd345))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/rights-management/issues/2)) ([21c086d](https://github.com/twinfoundation/rights-management/commit/21c086d7be3989858ee28bedb7a1e7b97d65b752))
+
+## [0.0.1-next.2](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.1...rights-management-models-v0.0.1-next.2) (2025-03-28)
+
+
+### Features
+
+* add publish workflows ([9f4db27](https://github.com/twinfoundation/rights-management/commit/9f4db27cccc724a5061f944b29ed7ed5317c9bbf))
+
+## v0.0.1-next.1
+
+- Initial Release

package/docs/examples.md

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

package/docs/reference/index.md

@@ -0,0 +1,21 @@
+# @twin.org/rights-management-models
+
+## Interfaces
+
+- [IPolicyAdministrationPointComponent](interfaces/IPolicyAdministrationPointComponent.md)
+- [IPolicyDecisionPointComponent](interfaces/IPolicyDecisionPointComponent.md)
+- [IPolicyEnforcementPointComponent](interfaces/IPolicyEnforcementPointComponent.md)
+- [IPolicyExecutionPointComponent](interfaces/IPolicyExecutionPointComponent.md)
+- [IPolicyInformationPointComponent](interfaces/IPolicyInformationPointComponent.md)
+- [IPolicyManagementPointComponent](interfaces/IPolicyManagementPointComponent.md)
+- [IRightsManagementComponent](interfaces/IRightsManagementComponent.md)
+- [IPapQueryRequest](interfaces/IPapQueryRequest.md)
+- [IPapQueryResponse](interfaces/IPapQueryResponse.md)
+- [IPapRemoveRequest](interfaces/IPapRemoveRequest.md)
+- [IPapRetrieveRequest](interfaces/IPapRetrieveRequest.md)
+- [IPapRetrieveResponse](interfaces/IPapRetrieveResponse.md)
+- [IPapStoreRequest](interfaces/IPapStoreRequest.md)
+
+## Type Aliases
+
+- [PolicyActionCallback](type-aliases/PolicyActionCallback.md)