@twin.org/rights-management-models 0.0.1-next.8 → 0.0.1

package/dist/cjs/index.cjs

@@ -1,2 +1,20 @@
 'use strict';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The stage at which a PXP is executed in the PDP.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyDecisionStage = {
+    /**
+     * Before Decision.
+     */
+    Before: "before",
+    /**
+     * After Decision.
+     */
+    After: "after"
+};
+
+exports.PolicyDecisionStage = PolicyDecisionStage;

package/dist/esm/index.mjs

@@ -1 +1,18 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The stage at which a PXP is executed in the PDP.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyDecisionStage = {
+    /**
+     * Before Decision.
+     */
+    Before: "before",
+    /**
+     * After Decision.
+     */
+    After: "after"
+};
 
+export { PolicyDecisionStage };

package/dist/types/index.d.ts

@@ -1,15 +1,16 @@
+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/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/IPapCreateRequest";
-export * from "./models/api/policyAdministrationPoint/IPapUpdateRequest";
-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";
+export * from "./models/policyActionCallback";
+export * from "./models/policyDecisionStage";

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

@@ -12,7 +12,7 @@ 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.
+     * 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 data The data to make a decision on.

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

@@ -1,15 +1,17 @@
 import type { IComponent } from "@twin.org/core";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
 import type { PolicyActionCallback } from "./policyActionCallback";
+import type { PolicyDecisionStage } from "./policyDecisionStage";
 /**
  * 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
+ * the Policy Execution Point (PXP) will execute any
  * registered actions based on the decision.
  */
 export interface IPolicyExecutionPointComponent extends IComponent {
     /**
      * Execute actions based on the PDP's decisions.
+     * @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 data The data used in the decision by the PDP.
@@ -18,14 +20,15 @@ export interface IPolicyExecutionPointComponent extends IComponent {
      * @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>;
+    executeActions<T = unknown>(stage: PolicyDecisionStage, 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 stage The stage at which the action should be executed.
      * @param action The action to execute.
      * @returns Nothing.
      */
-    registerAction<T = unknown>(actionId: string, action: PolicyActionCallback<T>): Promise<void>;
+    registerAction<T = unknown>(actionId: string, stage: PolicyDecisionStage, action: PolicyActionCallback<T>): Promise<void>;
     /**
      * Unregister an action from the execution point.
      * @param actionId The id of the action to unregister.

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

@@ -13,7 +13,7 @@ export interface IPapQueryRequest {
         /**
          * The number of entries to return per page.
          */
-        pageSize?: string;
+        pageSize?: number | string;
         /**
          * The cursor to get next chunk of data, returned in previous response.
          */

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

@@ -0,0 +1,17 @@
+/**
+ * The stage at which a PXP is executed in the PDP.
+ */
+export declare const PolicyDecisionStage: {
+    /**
+     * Before Decision.
+     */
+    readonly Before: "before";
+    /**
+     * After Decision.
+     */
+    readonly After: "after";
+};
+/**
+ * The stage at which a PXP is executed in the PDP.
+ */
+export type PolicyDecisionStage = (typeof PolicyDecisionStage)[keyof typeof PolicyDecisionStage];

package/docs/changelog.md

@@ -1,5 +1,50 @@
 # @twin.org/rights-management-models - Changelog
 
+## 0.0.1 (2025-07-08)
+
+
+### Features
+
+* release to production ([947f85a](https://github.com/twinfoundation/rights-management/commit/947f85ab9e23c117135dba7008a75c2d85435259))
+
+## [0.0.1-next.12](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.11...rights-management-models-v0.0.1-next.12) (2025-06-26)
+
+
+### Features
+
+* add policy decision stage ([b3eb5a9](https://github.com/twinfoundation/rights-management/commit/b3eb5a96f6270247d198b57c07deca4eeb5cc0bb))
+
+
+### Bug Fixes
+
+* correct PXP naming in comments ([1cd9053](https://github.com/twinfoundation/rights-management/commit/1cd9053eaa1c56a53d3cc52e75ea4d242bbe2654))
+
+## [0.0.1-next.11](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.10...rights-management-models-v0.0.1-next.11) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([8590a0d](https://github.com/twinfoundation/rights-management/commit/8590a0da92584c04b67e73c448319f96f70c34a5))
+
+## [0.0.1-next.10](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.9...rights-management-models-v0.0.1-next.10) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([dd0a553](https://github.com/twinfoundation/rights-management/commit/dd0a553020b0dc5c41fb6865a2e36bd26045b0b9))
+
+## [0.0.1-next.9](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.8...rights-management-models-v0.0.1-next.9) (2025-06-06)
+
+
+### Features
+
+* add publish workflows ([9f4db27](https://github.com/twinfoundation/rights-management/commit/9f4db27cccc724a5061f944b29ed7ed5317c9bbf))
+* pap create, update methods ([#13](https://github.com/twinfoundation/rights-management/issues/13)) ([edb6c9e](https://github.com/twinfoundation/rights-management/commit/edb6c9efcfda55ac96f7594253bf831b4f0e5993))
+* rename pap entity storage to pap service ([38a2c14](https://github.com/twinfoundation/rights-management/commit/38a2c14d8f63a86e398820166c83437be5aca1b8))
+* 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.8](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.1-next.7...rights-management-models-v0.0.1-next.8) (2025-06-05)
 
 

package/docs/reference/index.md

@@ -20,3 +20,8 @@
 ## Type Aliases
 
 - [PolicyActionCallback](type-aliases/PolicyActionCallback.md)
+- [PolicyDecisionStage](type-aliases/PolicyDecisionStage.md)
+
+## Variables
+
+- [PolicyDecisionStage](variables/PolicyDecisionStage.md)

package/docs/reference/interfaces/IPapQueryRequest.md

@@ -18,7 +18,7 @@ The condition for the query.
 
 #### pageSize?
 
-> `optional` **pageSize**: `string`
+> `optional` **pageSize**: `string` \| `number`
 
 The number of entries to return per page.
 

package/docs/reference/interfaces/IPolicyAdministrationPointComponent.md

@@ -98,7 +98,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `cursor?`, `pageSize?`): `Promise`\<\{ `cursor`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+> **query**(`conditions?`, `cursor?`, `pageSize?`): `Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
 
 Query the policies using the specified conditions.
 
@@ -124,6 +124,6 @@ The number of results to return per page.
 
 #### Returns
 
-`Promise`\<\{ `cursor`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+`Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
 
 Cursor for next page of results and the policies matching the query.

package/docs/reference/interfaces/IPolicyDecisionPointComponent.md

@@ -19,7 +19,7 @@ Point (PEP) will execute any registered actions.
 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.
+Executes any actions on the Policy Execution Point (PXP) when the decision is made.
 
 #### Type Parameters
 

package/docs/reference/interfaces/IPolicyExecutionPointComponent.md

@@ -2,7 +2,7 @@
 
 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
+the Policy Execution Point (PXP) will execute any
 registered actions based on the decision.
 
 ## Extends
@@ -13,7 +13,7 @@ registered actions based on the decision.
 
 ### executeActions()
 
-> **executeActions**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<`void`\>
+> **executeActions**\<`T`\>(`stage`, `assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<`void`\>
 
 Execute actions based on the PDP's decisions.
 
@@ -25,6 +25,12 @@ Execute actions based on the PDP's decisions.
 
 #### Parameters
 
+##### stage
+
+[`PolicyDecisionStage`](../type-aliases/PolicyDecisionStage.md)
+
+The stage at which the PXP is executed in the PDP.
+
 ##### assetType
 
 `string`
@@ -71,7 +77,7 @@ Nothing.
 
 ### registerAction()
 
-> **registerAction**\<`T`\>(`actionId`, `action`): `Promise`\<`void`\>
+> **registerAction**\<`T`\>(`actionId`, `stage`, `action`): `Promise`\<`void`\>
 
 Register an action to be executed.
 
@@ -89,6 +95,12 @@ Register an action to be executed.
 
 The id of the action to register.
 
+##### stage
+
+[`PolicyDecisionStage`](../type-aliases/PolicyDecisionStage.md)
+
+The stage at which the action should be executed.
+
 ##### action
 
 [`PolicyActionCallback`](../type-aliases/PolicyActionCallback.md)\<`T`\>

package/docs/reference/interfaces/IRightsManagementComponent.md

@@ -99,7 +99,7 @@ Nothing.
 
 ### papQuery()
 
-> **papQuery**(`conditions?`, `cursor?`, `pageSize?`): `Promise`\<\{ `cursor`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+> **papQuery**(`conditions?`, `cursor?`, `pageSize?`): `Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
 
 PAP: Query the policies using the specified conditions.
 
@@ -125,6 +125,6 @@ The number of results to return per page.
 
 #### Returns
 
-`Promise`\<\{ `cursor`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+`Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
 
 Cursor for next page of results and the policies matching the query.

package/docs/reference/type-aliases/PolicyDecisionStage.md

@@ -0,0 +1,5 @@
+# Type Alias: PolicyDecisionStage
+
+> **PolicyDecisionStage** = *typeof* [`PolicyDecisionStage`](../variables/PolicyDecisionStage.md)\[keyof *typeof* [`PolicyDecisionStage`](../variables/PolicyDecisionStage.md)\]
+
+The stage at which a PXP is executed in the PDP.

package/docs/reference/variables/PolicyDecisionStage.md

@@ -0,0 +1,19 @@
+# Variable: PolicyDecisionStage
+
+> `const` **PolicyDecisionStage**: `object`
+
+The stage at which a PXP is executed in the PDP.
+
+## Type declaration
+
+### Before
+
+> `readonly` **Before**: `"before"` = `"before"`
+
+Before Decision.
+
+### After
+
+> `readonly` **After**: `"after"` = `"after"`
+
+After Decision.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/rights-management-models",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Models which define the structure of the rights management connectors and services",
 	"repository": {
 		"type": "git",
@@ -14,11 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-odrl": "next"
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/standards-w3c-odrl": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",