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

package/dist/cjs/index.cjs

@@ -1,5 +1,23 @@
 'use strict';
 
+var core = require('@twin.org/core');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating policy execution actions.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyExecutionActionFactory = core.Factory.createFactory("policy-execution", true);
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating policy information sources.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyInformationSourceFactory = core.Factory.createFactory("policy-information", true);
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -18,3 +36,5 @@ const PolicyDecisionStage = {
 };
 
 exports.PolicyDecisionStage = PolicyDecisionStage;
+exports.PolicyExecutionActionFactory = PolicyExecutionActionFactory;
+exports.PolicyInformationSourceFactory = PolicyInformationSourceFactory;

package/dist/esm/index.mjs

@@ -1,3 +1,21 @@
+import { Factory } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating policy execution actions.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyExecutionActionFactory = Factory.createFactory("policy-execution", true);
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating policy information sources.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const PolicyInformationSourceFactory = Factory.createFactory("policy-information", true);
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -15,4 +33,4 @@ const PolicyDecisionStage = {
     After: "after"
 };
 
-export { PolicyDecisionStage };
+export { PolicyDecisionStage, PolicyExecutionActionFactory, PolicyInformationSourceFactory };

package/dist/types/factories/policyExecutionActionFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IPolicyExecutionAction } from "../models/IPolicyExecutionAction";
+/**
+ * Factory for creating policy execution actions.
+ */
+export declare const PolicyExecutionActionFactory: Factory<IPolicyExecutionAction>;

package/dist/types/factories/policyInformationSourceFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IPolicyInformationSource } from "../models/IPolicyInformationSource";
+/**
+ * Factory for creating policy information sources.
+ */
+export declare const PolicyInformationSourceFactory: Factory<IPolicyInformationSource>;

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
+export * from "./factories/policyExecutionActionFactory";
+export * from "./factories/policyInformationSourceFactory";
 export * from "./models/api/policyAdministrationPoint/IPapCreateRequest";
 export * from "./models/api/policyAdministrationPoint/IPapQueryRequest";
 export * from "./models/api/policyAdministrationPoint/IPapQueryResponse";
@@ -10,9 +12,10 @@ export * from "./models/api/policyAdministrationPoint/IPepInterceptResponse";
 export * from "./models/IPolicyAdministrationPointComponent";
 export * from "./models/IPolicyDecisionPointComponent";
 export * from "./models/IPolicyEnforcementPointComponent";
+export * from "./models/IPolicyExecutionAction";
 export * from "./models/IPolicyExecutionPointComponent";
 export * from "./models/IPolicyInformationPointComponent";
+export * from "./models/IPolicyInformationSource";
 export * from "./models/IPolicyManagementPointComponent";
 export * from "./models/IRightsManagementComponent";
-export * from "./models/policyActionCallback";
 export * from "./models/policyDecisionStage";

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

@@ -0,0 +1,19 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { PolicyDecisionStage } from "./policyDecisionStage";
+/**
+ * Interface for policy execution actions.
+ */
+export interface IPolicyExecutionAction {
+    /**
+     * Execute function type for policy actions.
+     * @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.
+     * @param stage The stage of the policy decision.
+     * @returns A promise that resolves when the action is complete.
+     */
+    execute(assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[], stage: PolicyDecisionStage): Promise<void>;
+}

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
-import type { PolicyActionCallback } from "./policyActionCallback";
+import type { IPolicyExecutionAction } from "./IPolicyExecutionAction";
 import type { PolicyDecisionStage } from "./policyDecisionStage";
 /**
  * Interface describing a Policy Execution Point (PXP) contract.
@@ -20,7 +20,7 @@ export interface IPolicyExecutionPointComponent extends IComponent {
      * @param policies The policies that apply to the data.
      * @returns Nothing.
      */
-    executeActions<T = unknown>(stage: PolicyDecisionStage, assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<void>;
+    executeActions(stage: PolicyDecisionStage, assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<void>;
     /**
      * Register an action to be executed.
      * @param actionId The id of the action to register.
@@ -28,11 +28,12 @@ export interface IPolicyExecutionPointComponent extends IComponent {
      * @param action The action to execute.
      * @returns Nothing.
      */
-    registerAction<T = unknown>(actionId: string, stage: PolicyDecisionStage, action: PolicyActionCallback<T>): Promise<void>;
+    registerAction(actionId: string, stage: PolicyDecisionStage, action: IPolicyExecutionAction): Promise<void>;
     /**
      * Unregister an action from the execution point.
      * @param actionId The id of the action to unregister.
+     * @param stage The stage at which the action was executed.
      * @returns Nothing.
      */
-    unregisterAction(actionId: string): Promise<void>;
+    unregisterAction(actionId: string, stage: PolicyDecisionStage): Promise<void>;
 }

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

@@ -1,5 +1,7 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IPolicyInformationSource } from "./IPolicyInformationSource";
 /**
  * Interface describing a Policy Information Point (PEP) contract.
  * Provides additional information to the Policy Decision Point (PDP) when
@@ -13,7 +15,23 @@ export interface IPolicyInformationPointComponent extends IComponent {
      * @param data The data to get any additional information for.
      * @param userIdentity The user identity to get additional information for.
      * @param nodeIdentity The node identity to get additional information for.
+     * @param policies The policies that apply to the data.
      * @returns Returns additional information based on the data and identities.
      */
-    retrieve<T = unknown>(assetType: string, action: string, data: T | undefined, userIdentity: string, nodeIdentity: string): Promise<IJsonLdNodeObject[]>;
+    retrieve(assetType: string, action: string, data: unknown, userIdentity: string, nodeIdentity: string, policies: IOdrlPolicy[]): Promise<{
+        [source: string]: IJsonLdNodeObject[];
+    }>;
+    /**
+     * Register a source to use for retrieval.
+     * @param sourceId The id of the source to register.
+     * @param source The source to register.
+     * @returns Nothing.
+     */
+    registerSource(sourceId: string, source: IPolicyInformationSource): Promise<void>;
+    /**
+     * Unregister a source from the retrieval.
+     * @param sourceId The id of the source to unregister.
+     * @returns Nothing.
+     */
+    unregisterSource(sourceId: string): Promise<void>;
 }

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

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

package/docs/changelog.md

@@ -1,5 +1,17 @@
 # @twin.org/rights-management-models - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.2-next.2...rights-management-models-v0.0.2-next.3) (2025-08-29)
+
+
+### Features
+
+* add policy information point ([#27](https://github.com/twinfoundation/rights-management/issues/27)) ([61a1cd1](https://github.com/twinfoundation/rights-management/commit/61a1cd18f0c2c4a847c0a30da70de6814c777e29))
+* eslint migration to flat config ([23a0c08](https://github.com/twinfoundation/rights-management/commit/23a0c085e7fc2e522c8d85d325dc5844b9c3fd8e))
+* policy execution point ([#26](https://github.com/twinfoundation/rights-management/issues/26)) ([d930f10](https://github.com/twinfoundation/rights-management/commit/d930f104006a0d815cdf222b87d11d749351fb84))
+* switch execution callback to class/factory pattern ([60db8cf](https://github.com/twinfoundation/rights-management/commit/60db8cfa213d7d4432396b196442d592a5dab6a6))
+* switch execution callback to class/factory pattern ([a6b5660](https://github.com/twinfoundation/rights-management/commit/a6b56602aad98652de06961c436c76d52bf42665))
+* switch execution callback to class/factory pattern ([8294daf](https://github.com/twinfoundation/rights-management/commit/8294daf933b74a1f90f1a34f206b215e59d76810))
+
 ## [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)
 
 

package/docs/reference/index.md

@@ -5,8 +5,10 @@
 - [IPolicyAdministrationPointComponent](interfaces/IPolicyAdministrationPointComponent.md)
 - [IPolicyDecisionPointComponent](interfaces/IPolicyDecisionPointComponent.md)
 - [IPolicyEnforcementPointComponent](interfaces/IPolicyEnforcementPointComponent.md)
+- [IPolicyExecutionAction](interfaces/IPolicyExecutionAction.md)
 - [IPolicyExecutionPointComponent](interfaces/IPolicyExecutionPointComponent.md)
 - [IPolicyInformationPointComponent](interfaces/IPolicyInformationPointComponent.md)
+- [IPolicyInformationSource](interfaces/IPolicyInformationSource.md)
 - [IPolicyManagementPointComponent](interfaces/IPolicyManagementPointComponent.md)
 - [IRightsManagementComponent](interfaces/IRightsManagementComponent.md)
 - [IPapCreateRequest](interfaces/IPapCreateRequest.md)
@@ -21,9 +23,10 @@
 
 ## Type Aliases
 
-- [PolicyActionCallback](type-aliases/PolicyActionCallback.md)
 - [PolicyDecisionStage](type-aliases/PolicyDecisionStage.md)
 
 ## Variables
 
+- [PolicyExecutionActionFactory](variables/PolicyExecutionActionFactory.md)
+- [PolicyInformationSourceFactory](variables/PolicyInformationSourceFactory.md)
 - [PolicyDecisionStage](variables/PolicyDecisionStage.md)

package/docs/reference/interfaces/IPolicyExecutionAction.md

@@ -0,0 +1,61 @@
+# Interface: IPolicyExecutionAction
+
+Interface for policy execution actions.
+
+## Methods
+
+### execute()
+
+> **execute**(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`, `stage`): `Promise`\<`void`\>
+
+Execute function type for policy actions.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+`unknown`
+
+The data to process.
+
+##### userIdentity
+
+`string`
+
+The user identity to use in the decision making.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to use in the decision making.
+
+##### policies
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
+##### stage
+
+[`PolicyDecisionStage`](../type-aliases/PolicyDecisionStage.md)
+
+The stage of the policy decision.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action is complete.

package/docs/reference/interfaces/IPolicyExecutionPointComponent.md

@@ -13,16 +13,10 @@ registered actions based on the decision.
 
 ### executeActions()
 
-> **executeActions**\<`T`\>(`stage`, `assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<`void`\>
+> **executeActions**(`stage`, `assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<`void`\>
 
 Execute actions based on the PDP's decisions.
 
-#### Type Parameters
-
-##### T
-
-`T` = `unknown`
-
 #### Parameters
 
 ##### stage
@@ -45,9 +39,9 @@ The action being performed on the asset.
 
 ##### data
 
-The data used in the decision by the PDP.
+`unknown`
 
-`undefined` | `T`
+The data used in the decision by the PDP.
 
 ##### userIdentity
 
@@ -77,16 +71,10 @@ Nothing.
 
 ### registerAction()
 
-> **registerAction**\<`T`\>(`actionId`, `stage`, `action`): `Promise`\<`void`\>
+> **registerAction**(`actionId`, `stage`, `action`): `Promise`\<`void`\>
 
 Register an action to be executed.
 
-#### Type Parameters
-
-##### T
-
-`T` = `unknown`
-
 #### Parameters
 
 ##### actionId
@@ -103,7 +91,7 @@ The stage at which the action should be executed.
 
 ##### action
 
-[`PolicyActionCallback`](../type-aliases/PolicyActionCallback.md)\<`T`\>
+[`IPolicyExecutionAction`](IPolicyExecutionAction.md)
 
 The action to execute.
 
@@ -117,7 +105,7 @@ Nothing.
 
 ### unregisterAction()
 
-> **unregisterAction**(`actionId`): `Promise`\<`void`\>
+> **unregisterAction**(`actionId`, `stage`): `Promise`\<`void`\>
 
 Unregister an action from the execution point.
 
@@ -129,6 +117,12 @@ Unregister an action from the execution point.
 
 The id of the action to unregister.
 
+##### stage
+
+[`PolicyDecisionStage`](../type-aliases/PolicyDecisionStage.md)
+
+The stage at which the action was executed.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IPolicyInformationPointComponent.md

@@ -12,16 +12,10 @@ it is making decisions.
 
 ### retrieve()
 
-> **retrieve**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`): `Promise`\<`IJsonLdNodeObject`[]\>
+> **retrieve**(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<\{\[`source`: `string`\]: `IJsonLdNodeObject`[]; \}\>
 
 Retrieve additional information which is relevant in the PDP decision making.
 
-#### Type Parameters
-
-##### T
-
-`T` = `unknown`
-
 #### Parameters
 
 ##### assetType
@@ -38,9 +32,9 @@ The action being performed on the asset.
 
 ##### data
 
-The data to get any additional information for.
+`unknown`
 
-`undefined` | `T`
+The data to get any additional information for.
 
 ##### userIdentity
 
@@ -54,8 +48,64 @@ The user identity to get additional information for.
 
 The node identity to get additional information for.
 
+##### policies
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`[]\>
+`Promise`\<\{\[`source`: `string`\]: `IJsonLdNodeObject`[]; \}\>
 
 Returns additional information based on the data and identities.
+
+***
+
+### registerSource()
+
+> **registerSource**(`sourceId`, `source`): `Promise`\<`void`\>
+
+Register a source to use for retrieval.
+
+#### Parameters
+
+##### sourceId
+
+`string`
+
+The id of the source to register.
+
+##### source
+
+[`IPolicyInformationSource`](IPolicyInformationSource.md)
+
+The source to register.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### unregisterSource()
+
+> **unregisterSource**(`sourceId`): `Promise`\<`void`\>
+
+Unregister a source from the retrieval.
+
+#### Parameters
+
+##### sourceId
+
+`string`
+
+The id of the source to unregister.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IPolicyInformationSource.md

@@ -0,0 +1,55 @@
+# Interface: IPolicyInformationSource
+
+Interface for policy information sources.
+
+## Methods
+
+### retrieve()
+
+> **retrieve**(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<`undefined` \| `IJsonLdNodeObject`[]\>
+
+Retrieve information from the sources.
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+`unknown`
+
+The data to process.
+
+##### userIdentity
+
+`string`
+
+The user identity to use in the decision making.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to use in the decision making.
+
+##### policies
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
+#### Returns
+
+`Promise`\<`undefined` \| `IJsonLdNodeObject`[]\>
+
+The objects containing relevant information or undefined if nothing relevant is found.

package/docs/reference/variables/PolicyDecisionStage.md

@@ -4,7 +4,7 @@
 
 The stage at which a PXP is executed in the PDP.
 
-## Type declaration
+## Type Declaration
 
 ### Before
 

package/docs/reference/variables/PolicyExecutionActionFactory.md

@@ -0,0 +1,5 @@
+# Variable: PolicyExecutionActionFactory
+
+> `const` **PolicyExecutionActionFactory**: `Factory`\<[`IPolicyExecutionAction`](../interfaces/IPolicyExecutionAction.md)\>
+
+Factory for creating policy execution actions.

package/docs/reference/variables/PolicyInformationSourceFactory.md

@@ -0,0 +1,5 @@
+# Variable: PolicyInformationSourceFactory
+
+> `const` **PolicyInformationSourceFactory**: `Factory`\<[`IPolicyInformationSource`](../interfaces/IPolicyInformationSource.md)\>
+
+Factory for creating policy information sources.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/rights-management-models",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.3",
 	"description": "Models which define the structure of the rights management connectors and services",
 	"repository": {
 		"type": "git",

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

@@ -1,16 +0,0 @@
-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/reference/type-aliases/PolicyActionCallback.md

@@ -1,59 +0,0 @@
-# Type Alias: PolicyActionCallback()\<T\>
-
-> **PolicyActionCallback**\<`T`\> = (`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`) => `Promise`\<`void`\>
-
-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.
-
-## 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.
-
-`T` | `undefined`
-
-### userIdentity
-
-`string`
-
-The user identity to use in the decision making.
-
-### nodeIdentity
-
-`string`
-
-The node identity to use in the decision making.
-
-### policies
-
-`IOdrlPolicy`[]
-
-The policies that apply to the data.
-
-## Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the action is complete.