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

package/dist/types/index.d.ts

@@ -5,6 +5,8 @@ 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/IPolicyAdministrationPointComponent";
 export * from "./models/IPolicyDecisionPointComponent";
 export * from "./models/IPolicyEnforcementPointComponent";

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

@@ -15,5 +15,5 @@ export interface IPolicyEnforcementPointComponent extends IComponent {
      * @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>;
+    intercept<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string | undefined, nodeIdentity: string | undefined): Promise<T | undefined>;
 }

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

@@ -41,4 +41,14 @@ export interface IRightsManagementComponent extends IComponent {
         cursor?: string;
         policies: IOdrlPolicy[];
     }>;
+    /**
+     * PEP: 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.
+     */
+    pepIntercept<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string | undefined, nodeIdentity: string | undefined): Promise<T | undefined>;
 }

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

@@ -0,0 +1,22 @@
+/**
+ * The request structure for intercepting a request and enforcing a policy.
+ */
+export interface IPepInterceptRequest {
+    /**
+     * The body parameters of the request.
+     */
+    body: {
+        /**
+         * The type of the asset to enforce the policy on.
+         */
+        assetType: string;
+        /**
+         * The action to perform on the asset.
+         */
+        action: string;
+        /**
+         * The data to include in the request.
+         */
+        data: unknown;
+    };
+}

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

@@ -0,0 +1,9 @@
+/**
+ * The response structure for intercepting a request and enforcing a policy.
+ */
+export interface IPepInterceptResponse {
+    /**
+     * The manipulated data with any policies applied.
+     */
+    body: unknown;
+}

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/rights-management-models - Changelog
 
+## [0.0.2-next.2](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.2-next.1...rights-management-models-v0.0.2-next.2) (2025-08-22)
+
+
+### Features
+
+* add scaffold for other services ([de25f34](https://github.com/twinfoundation/rights-management/commit/de25f34c40fb65b6d73df98965ea4e368019da84))
+
+## [0.0.2-next.1](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.2-next.0...rights-management-models-v0.0.2-next.1) (2025-08-20)
+
+
+### Features
+
+* add policy decision stage ([b3eb5a9](https://github.com/twinfoundation/rights-management/commit/b3eb5a96f6270247d198b57c07deca4eeb5cc0bb))
+* 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 dependencies ([dd0a553](https://github.com/twinfoundation/rights-management/commit/dd0a553020b0dc5c41fb6865a2e36bd26045b0b9))
+* update framework core ([d0ffcba](https://github.com/twinfoundation/rights-management/commit/d0ffcba9cf1dc2b562193ee298f099612d100ce8))
+* 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))
+
+
+### Bug Fixes
+
+* correct PXP naming in comments ([1cd9053](https://github.com/twinfoundation/rights-management/commit/1cd9053eaa1c56a53d3cc52e75ea4d242bbe2654))
+* query params force coercion ([8590a0d](https://github.com/twinfoundation/rights-management/commit/8590a0da92584c04b67e73c448319f96f70c34a5))
+
 ## 0.0.1 (2025-07-08)
 
 

package/docs/reference/index.md

@@ -16,6 +16,8 @@
 - [IPapRetrieveRequest](interfaces/IPapRetrieveRequest.md)
 - [IPapRetrieveResponse](interfaces/IPapRetrieveResponse.md)
 - [IPapUpdateRequest](interfaces/IPapUpdateRequest.md)
+- [IPepInterceptRequest](interfaces/IPepInterceptRequest.md)
+- [IPepInterceptResponse](interfaces/IPepInterceptResponse.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/IPepInterceptRequest.md

@@ -0,0 +1,29 @@
+# Interface: IPepInterceptRequest
+
+The request structure for intercepting a request and enforcing a policy.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body parameters of the request.
+
+#### assetType
+
+> **assetType**: `string`
+
+The type of the asset to enforce the policy on.
+
+#### action
+
+> **action**: `string`
+
+The action to perform on the asset.
+
+#### data
+
+> **data**: `unknown`
+
+The data to include in the request.

package/docs/reference/interfaces/IPepInterceptResponse.md

@@ -0,0 +1,11 @@
+# Interface: IPepInterceptResponse
+
+The response structure for intercepting a request and enforcing a policy.
+
+## Properties
+
+### body
+
+> **body**: `unknown`
+
+The manipulated data with any policies applied.

package/docs/reference/interfaces/IPolicyEnforcementPointComponent.md

@@ -45,16 +45,16 @@ The data to process.
 
 ##### userIdentity
 
-`string`
-
 The user identity to use in the decision making.
 
-##### nodeIdentity
+`undefined` | `string`
 
-`string`
+##### nodeIdentity
 
 The node identity to use in the decision making.
 
+`undefined` | `string`
+
 #### Returns
 
 `Promise`\<`undefined` \| `T`\>

package/docs/reference/interfaces/IRightsManagementComponent.md

@@ -128,3 +128,55 @@ The number of results to return per page.
 `Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
 
 Cursor for next page of results and the policies matching the query.
+
+***
+
+### pepIntercept()
+
+> **pepIntercept**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`): `Promise`\<`undefined` \| `T`\>
+
+PEP: Process the data using Policy Decision Point (PDP) and return the manipulated data.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+The data to process.
+
+`undefined` | `T`
+
+##### userIdentity
+
+The user identity to use in the decision making.
+
+`undefined` | `string`
+
+##### nodeIdentity
+
+The node identity to use in the decision making.
+
+`undefined` | `string`
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The manipulated data with any policies applied.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/rights-management-models",
-	"version": "0.0.1",
+	"version": "0.0.2-next.2",
 	"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": "^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"
+		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-odrl": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",