@twin.org/rights-management-plugins 0.0.3-next.4 → 0.0.3-next.41

package/dist/es/policyObligationEnforcers/passThroughPolicyObligationEnforcer.js

@@ -0,0 +1,56 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory, Guards } from "@twin.org/core";
+import { OdrlPolicyHelper } from "@twin.org/rights-management-models";
+/**
+ * Pass Through Policy Obligation Enforcer.
+ */
+export class PassThroughPolicyObligationEnforcer {
+    /**
+     * The class name of the Pass Through Policy Obligation Enforcer.
+     */
+    static CLASS_NAME = "PassThroughPolicyObligationEnforcer";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of Pass Through Policy Obligation Enforcer.
+     * @param options The options for the pass through policy obligation enforcer.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.get(options?.loggingComponentType ?? "logging");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return PassThroughPolicyObligationEnforcer.CLASS_NAME;
+    }
+    /**
+     * Enforces obligations regarding policy access to data.
+     * @param policy The policy to evaluate.
+     * @param duty The duty to enforce.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param data The data to make a decision on.
+     * @param action Optional action to make a decision on, if not provided, the enforcer will evaluate all actions in the duty.
+     * @returns Whether the obligations were successfully enforced.
+     */
+    async enforce(policy, duty, information, data, action) {
+        Guards.object(PassThroughPolicyObligationEnforcer.CLASS_NAME, "policy", policy);
+        Guards.object(PassThroughPolicyObligationEnforcer.CLASS_NAME, "duty", duty);
+        await this._logging.log({
+            level: "info",
+            source: PassThroughPolicyObligationEnforcer.CLASS_NAME,
+            ts: Date.now(),
+            message: "enforcingDuty",
+            data: {
+                policyId: OdrlPolicyHelper.getUid(policy) ?? ""
+            }
+        });
+        return true;
+    }
+}
+//# sourceMappingURL=passThroughPolicyObligationEnforcer.js.map

package/dist/es/policyObligationEnforcers/passThroughPolicyObligationEnforcer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passThroughPolicyObligationEnforcer.js","sourceRoot":"","sources":["../../../src/policyObligationEnforcers/passThroughPolicyObligationEnforcer.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAI1D,OAAO,EACN,gBAAgB,EAGhB,MAAM,oCAAoC,CAAC;AAI5C;;GAEG;AACH,MAAM,OAAO,mCAAmC;IAC/C;;OAEG;IACI,MAAM,CAAU,UAAU,yCAAyD;IAE1F;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAAgE;QAC3E,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,mCAAmC,CAAC,UAAU,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO,CACnB,MAA+B,EAC/B,IAAe,EACf,WAAiD,EACjD,IAAQ,EACR,MAAgC;QAEhC,MAAM,CAAC,MAAM,CACZ,mCAAmC,CAAC,UAAU,YAE9C,MAAM,CACN,CAAC;QACF,MAAM,CAAC,MAAM,CAAY,mCAAmC,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE7F,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,mCAAmC,CAAC,UAAU;YACtD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,eAAe;YACxB,IAAI,EAAE;gBACL,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;aAC/C;SACD,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACb,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, Guards } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tOdrlPolicyHelper,\n\ttype IPolicyObligationEnforcer,\n\ttype IRightsManagementPolicy\n} from \"@twin.org/rights-management-models\";\nimport type { OdrlActionType, IOdrlDuty } from \"@twin.org/standards-w3c-odrl\";\nimport type { IPassThroughPolicyObligationEnforcerConstructorOptions } from \"../models/IPassThroughPolicyObligationEnforcerConstructorOptions.js\";\n\n/**\n * Pass Through Policy Obligation Enforcer.\n */\nexport class PassThroughPolicyObligationEnforcer implements IPolicyObligationEnforcer {\n\t/**\n\t * The class name of the Pass Through Policy Obligation Enforcer.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<PassThroughPolicyObligationEnforcer>();\n\n\t/**\n\t * The logging component.\n\t * @internal\n\t */\n\tprivate readonly _logging: ILoggingComponent;\n\n\t/**\n\t * Create a new instance of Pass Through Policy Obligation Enforcer.\n\t * @param options The options for the pass through policy obligation enforcer.\n\t */\n\tconstructor(options?: IPassThroughPolicyObligationEnforcerConstructorOptions) {\n\t\tthis._logging = ComponentFactory.get<ILoggingComponent>(\n\t\t\toptions?.loggingComponentType ?? \"logging\"\n\t\t);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn PassThroughPolicyObligationEnforcer.CLASS_NAME;\n\t}\n\n\t/**\n\t * Enforces obligations regarding policy access to data.\n\t * @param policy The policy to evaluate.\n\t * @param duty The duty to enforce.\n\t * @param information Information provided by the requester to determine if a policy can be created.\n\t * @param data The data to make a decision on.\n\t * @param action Optional action to make a decision on, if not provided, the enforcer will evaluate all actions in the duty.\n\t * @returns Whether the obligations were successfully enforced.\n\t */\n\tpublic async enforce<D = unknown>(\n\t\tpolicy: IRightsManagementPolicy,\n\t\tduty: IOdrlDuty,\n\t\tinformation?: { [id: string]: IJsonLdNodeObject },\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<boolean> {\n\t\tGuards.object<IRightsManagementPolicy>(\n\t\t\tPassThroughPolicyObligationEnforcer.CLASS_NAME,\n\t\t\tnameof(policy),\n\t\t\tpolicy\n\t\t);\n\t\tGuards.object<IOdrlDuty>(PassThroughPolicyObligationEnforcer.CLASS_NAME, nameof(duty), duty);\n\n\t\tawait this._logging.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: PassThroughPolicyObligationEnforcer.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"enforcingDuty\",\n\t\t\tdata: {\n\t\t\t\tpolicyId: OdrlPolicyHelper.getUid(policy) ?? \"\"\n\t\t\t}\n\t\t});\n\n\t\treturn true;\n\t}\n}\n"]}

package/dist/es/policyRequesters/passThroughPolicyRequester.js

@@ -0,0 +1,103 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+import { OdrlPolicyHelper } from "@twin.org/rights-management-models";
+/**
+ * Pass Through Policy Requester.
+ */
+export class PassThroughPolicyRequester {
+    /**
+     * The class name of the Pass Through Policy Requester.
+     */
+    static CLASS_NAME = "PassThroughPolicyRequester";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of PassThroughPolicyRequester.
+     * @param options The options for the pass through policy Requester.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.get(options?.loggingComponentType ?? "logging");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return PassThroughPolicyRequester.CLASS_NAME;
+    }
+    /**
+     * A policy has been offered by a provider, let the request handler know about it.
+     * @param negotiationId The id of the negotiation.
+     * @param offer The offer sent by the provider.
+     * @returns True if the offer was accepted, false otherwise.
+     */
+    async offer(negotiationId, offer) {
+        await this._logging.log({
+            level: "info",
+            source: PassThroughPolicyRequester.CLASS_NAME,
+            ts: Date.now(),
+            message: "offer",
+            data: {
+                negotiationId,
+                offerId: OdrlPolicyHelper.getUid(offer) ?? ""
+            }
+        });
+        return true;
+    }
+    /**
+     * A policy agreement has been sent by a provider, let the request handler know about it.
+     * @param negotiationId The id of the negotiation.
+     * @param agreement The agreement sent by the provider.
+     * @returns True if the agreement was accepted, false otherwise.
+     */
+    async agreement(negotiationId, agreement) {
+        await this._logging.log({
+            level: "info",
+            source: PassThroughPolicyRequester.CLASS_NAME,
+            ts: Date.now(),
+            message: "agreement",
+            data: {
+                negotiationId,
+                agreementId: OdrlPolicyHelper.getUid(agreement) ?? ""
+            }
+        });
+        return true;
+    }
+    /**
+     * A policy finalisation has been sent by a provider, let the request handler know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns Nothing.
+     */
+    async finalised(negotiationId) {
+        await this._logging.log({
+            level: "info",
+            source: PassThroughPolicyRequester.CLASS_NAME,
+            ts: Date.now(),
+            message: "finalised",
+            data: {
+                negotiationId
+            }
+        });
+    }
+    /**
+     * A policy termination has been sent by a provider, let the request handler know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns Nothing.
+     */
+    async terminated(negotiationId) {
+        await this._logging.log({
+            level: "info",
+            source: PassThroughPolicyRequester.CLASS_NAME,
+            ts: Date.now(),
+            message: "terminated",
+            data: {
+                negotiationId
+            }
+        });
+    }
+}
+//# sourceMappingURL=passThroughPolicyRequester.js.map

package/dist/es/policyRequesters/passThroughPolicyRequester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passThroughPolicyRequester.js","sourceRoot":"","sources":["../../../src/policyRequesters/passThroughPolicyRequester.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAGlD,OAAO,EAAE,gBAAgB,EAAyB,MAAM,oCAAoC,CAAC;AAO7F;;GAEG;AACH,MAAM,OAAO,0BAA0B;IACtC;;OAEG;IACI,MAAM,CAAU,UAAU,gCAAgD;IAEjF;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAAuD;QAClE,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,0BAA0B,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,aAAqB,EAAE,KAA8B;QACvE,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,0BAA0B,CAAC,UAAU;YAC7C,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE;gBACL,aAAa;gBACb,OAAO,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;aAC7C;SACD,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACrB,aAAqB,EACrB,SAAsC;QAEtC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,0BAA0B,CAAC,UAAU;YAC7C,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE;gBACL,aAAa;gBACb,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE;aACrD;SACD,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,aAAqB;QAC3C,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,0BAA0B,CAAC,UAAU;YAC7C,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE;gBACL,aAAa;aACb;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,aAAqB;QAC5C,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,0BAA0B,CAAC,UAAU;YAC7C,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,YAAY;YACrB,IAAI,EAAE;gBACL,aAAa;aACb;SACD,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory } from \"@twin.org/core\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { OdrlPolicyHelper, type IPolicyRequester } from \"@twin.org/rights-management-models\";\nimport type {\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolOffer\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { IPassThroughPolicyRequesterConstructorOptions } from \"../models/IPassThroughPolicyRequesterConstructorOptions.js\";\n\n/**\n * Pass Through Policy Requester.\n */\nexport class PassThroughPolicyRequester implements IPolicyRequester {\n\t/**\n\t * The class name of the Pass Through Policy Requester.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<PassThroughPolicyRequester>();\n\n\t/**\n\t * The logging component.\n\t * @internal\n\t */\n\tprivate readonly _logging: ILoggingComponent;\n\n\t/**\n\t * Create a new instance of PassThroughPolicyRequester.\n\t * @param options The options for the pass through policy Requester.\n\t */\n\tconstructor(options?: IPassThroughPolicyRequesterConstructorOptions) {\n\t\tthis._logging = ComponentFactory.get<ILoggingComponent>(\n\t\t\toptions?.loggingComponentType ?? \"logging\"\n\t\t);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn PassThroughPolicyRequester.CLASS_NAME;\n\t}\n\n\t/**\n\t * A policy has been offered by a provider, let the request handler know about it.\n\t * @param negotiationId The id of the negotiation.\n\t * @param offer The offer sent by the provider.\n\t * @returns True if the offer was accepted, false otherwise.\n\t */\n\tpublic async offer(negotiationId: string, offer: IDataspaceProtocolOffer): Promise<boolean> {\n\t\tawait this._logging.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: PassThroughPolicyRequester.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"offer\",\n\t\t\tdata: {\n\t\t\t\tnegotiationId,\n\t\t\t\tofferId: OdrlPolicyHelper.getUid(offer) ?? \"\"\n\t\t\t}\n\t\t});\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * A policy agreement has been sent by a provider, let the request handler know about it.\n\t * @param negotiationId The id of the negotiation.\n\t * @param agreement The agreement sent by the provider.\n\t * @returns True if the agreement was accepted, false otherwise.\n\t */\n\tpublic async agreement(\n\t\tnegotiationId: string,\n\t\tagreement: IDataspaceProtocolAgreement\n\t): Promise<boolean> {\n\t\tawait this._logging.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: PassThroughPolicyRequester.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"agreement\",\n\t\t\tdata: {\n\t\t\t\tnegotiationId,\n\t\t\t\tagreementId: OdrlPolicyHelper.getUid(agreement) ?? \"\"\n\t\t\t}\n\t\t});\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * A policy finalisation has been sent by a provider, let the request handler know about it.\n\t * @param negotiationId The id of the negotiation.\n\t * @returns Nothing.\n\t */\n\tpublic async finalised(negotiationId: string): Promise<void> {\n\t\tawait this._logging.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: PassThroughPolicyRequester.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"finalised\",\n\t\t\tdata: {\n\t\t\t\tnegotiationId\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * A policy termination has been sent by a provider, let the request handler know about it.\n\t * @param negotiationId The id of the negotiation.\n\t * @returns Nothing.\n\t */\n\tpublic async terminated(negotiationId: string): Promise<void> {\n\t\tawait this._logging.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: PassThroughPolicyRequester.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"terminated\",\n\t\t\tdata: {\n\t\t\t\tnegotiationId\n\t\t\t}\n\t\t});\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -1,19 +1,27 @@
-export * from "./dataAccessHandlers/examplePolicyRequester.js";
-export * from "./models/IExampleDataAccessHandlerConstructorOptions.js";
-export * from "./models/IExamplePolicyArbiterConstructorOptions.js";
-export * from "./models/IExamplePolicyEnforcementProcessorConstructorOptions.js";
-export * from "./models/IExamplePolicyNegotiatorConstructorOptions.js";
-export * from "./models/IExamplePolicyRequesterConstructorOptions.js";
+export * from "./models/IAutomationPolicyExecutionActionConfig.js";
+export * from "./models/IAutomationPolicyExecutionActionConstructorOptions.js";
+export * from "./models/IDefaultPolicyArbiterConfig.js";
+export * from "./models/IDefaultPolicyArbiterConstructorOptions.js";
+export * from "./models/IDefaultPolicyEnforcementProcessorConstructorOptions.js";
 export * from "./models/IIdentityPolicyInformationSourceConstructorOptions.js";
 export * from "./models/ILoggingPolicyExecutionActionConfig.js";
 export * from "./models/ILoggingPolicyExecutionActionConstructorOptions.js";
+export * from "./models/IPassThroughPolicyArbiterConstructorOptions.js";
+export * from "./models/IPassThroughPolicyEnforcementProcessorConstructorOptions.js";
+export * from "./models/IPassThroughPolicyNegotiatorConstructorOptions.js";
+export * from "./models/IPassThroughPolicyObligationEnforcerConstructorOptions.js";
+export * from "./models/IPassThroughPolicyRequesterConstructorOptions.js";
 export * from "./models/IStaticPolicyInformationSource.js";
 export * from "./models/IStaticPolicyInformationSourceConfig.js";
 export * from "./models/IStaticPolicyInformationSourceConstructorOptions.js";
-export * from "./policyArbiters/examplePolicyArbiter.js";
-export * from "./policyEnforcementProcessor/examplePolicyEnforcementProcessor.js";
+export * from "./policyArbiters/defaultPolicyArbiter.js";
+export * from "./policyArbiters/passThroughPolicyArbiter.js";
+export * from "./policyEnforcementProcessor/defaultPolicyEnforcementProcessor.js";
+export * from "./policyEnforcementProcessor/passThroughPolicyEnforcementProcessor.js";
+export * from "./policyExecutionActions/automationPolicyExecutionAction.js";
 export * from "./policyExecutionActions/loggingPolicyExecutionAction.js";
 export * from "./policyInformationSources/identityPolicyInformationSource.js";
 export * from "./policyInformationSources/staticPolicyInformationSource.js";
-export * from "./policyNegotiators/examplePolicyNegotiator.js";
-export * from "./policyRequesters/examplePolicyRequester.js";
+export * from "./policyNegotiators/passThroughPolicyNegotiator.js";
+export * from "./policyObligationEnforcers/passThroughPolicyObligationEnforcer.js";
+export * from "./policyRequesters/passThroughPolicyRequester.js";

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

@@ -0,0 +1,9 @@
+/**
+ * Options for the Automation Policy Execution Action Component.
+ */
+export interface IAutomationPolicyExecutionActionConfig {
+    /**
+     * The policy decision stages to trigger the automation actions, if undefined defaults to "inform".
+     */
+    triggerActions?: string[];
+}

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

@@ -0,0 +1,15 @@
+import type { IAutomationPolicyExecutionActionConfig } from "./IAutomationPolicyExecutionActionConfig.js";
+/**
+ * Options for the Automation Policy Execution Action.
+ */
+export interface IAutomationPolicyExecutionActionConstructorOptions {
+    /**
+     * The automation component for executing automation policies.
+     * @default automation
+     */
+    automationComponentType?: string;
+    /**
+     * The configuration for the automation policy execution.
+     */
+    config?: IAutomationPolicyExecutionActionConfig;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Configuration for the Default Policy Arbiter.
+ */
+export interface IDefaultPolicyArbiterConfig {
+    /**
+     * The maximum depth to traverse when resolving inherited policies.
+     * @default 10
+     */
+    maxInheritanceDepth?: number;
+}

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

@@ -0,0 +1,20 @@
+import type { IDefaultPolicyArbiterConfig } from "./IDefaultPolicyArbiterConfig.js";
+/**
+ * Options for the Default Policy Arbiter.
+ */
+export interface IDefaultPolicyArbiterConstructorOptions {
+    /**
+     * The logging component for policy arbiter.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The policy administration point component for retrieving inherited policies.
+     * @default policy-administration-point
+     */
+    policyAdministrationPointComponentType?: string;
+    /**
+     * The configuration options for the default policy arbiter.
+     */
+    config?: IDefaultPolicyArbiterConfig;
+}

package/dist/types/models/{IExamplePolicyEnforcementProcessorConstructorOptions.d.ts → IDefaultPolicyEnforcementProcessorConstructorOptions.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Options for the Example Policy Enforcement Processor.
+ * Options for the Default Policy Enforcement Processor.
  */
-export interface IExamplePolicyEnforcementProcessorConstructorOptions {
+export interface IDefaultPolicyEnforcementProcessorConstructorOptions {
     /**
      * The logging component for policy enforcement processor.
      * @default logging

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

@@ -13,10 +13,10 @@ export interface ILoggingPolicyExecutionActionConfig {
      */
     includeData?: boolean;
     /**
-     * Whether to include the policies in the log.
+     * Whether to include the policy in the log.
      * @default false
      */
-    includePolicies?: boolean;
+    includePolicy?: boolean;
     /**
      * Whether to include the decisions in the log.
      * @default false

package/dist/types/models/{IExamplePolicyArbiterConstructorOptions.d.ts → IPassThroughPolicyArbiterConstructorOptions.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Options for the Example Policy Arbiter.
+ * Options for the Pass Through Policy Arbiter.
  */
-export interface IExamplePolicyArbiterConstructorOptions {
+export interface IPassThroughPolicyArbiterConstructorOptions {
     /**
      * The logging component for policy arbiter.
      * @default logging

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Pass Through Policy Enforcement Processor.
+ */
+export interface IPassThroughPolicyEnforcementProcessorConstructorOptions {
+    /**
+     * The logging component for policy enforcement processor.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

package/dist/types/models/{IExamplePolicyNegotiatorConstructorOptions.d.ts → IPassThroughPolicyNegotiatorConstructorOptions.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Options for the Example Policy Negotiator.
+ * Options for the Pass Through Policy Negotiator.
  */
-export interface IExamplePolicyNegotiatorConstructorOptions {
+export interface IPassThroughPolicyNegotiatorConstructorOptions {
     /**
      * The logging component for policy negotiator.
      * @default logging

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Pass Through Policy Obligation Enforcer.
+ */
+export interface IPassThroughPolicyObligationEnforcerConstructorOptions {
+    /**
+     * The logging component for the policy obligation enforcer.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

package/dist/types/models/{IExamplePolicyRequesterConstructorOptions.d.ts → IPassThroughPolicyRequesterConstructorOptions.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Options for the Example Policy Requester.
+ * Options for the Pass Through Policy Requester.
  */
-export interface IExamplePolicyRequesterConstructorOptions {
+export interface IPassThroughPolicyRequesterConstructorOptions {
     /**
      * The logging component for policy requester.
      * @default logging

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

@@ -1,5 +1,5 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IPolicyLocator, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+import type { PolicyInformationAccessMode } from "@twin.org/rights-management-models";
 /**
  * Configuration for the Static Policy Information Source Component.
  */
@@ -10,11 +10,17 @@ export interface IStaticPolicyInformationSource {
     accessMode: PolicyInformationAccessMode;
     /**
      * Information is only provided for the specified locator combination.
-     * If undefined is provided matches all resources.
      */
-    matchLocators?: IPolicyLocator[];
+    matchLocators?: {
+        assignee?: string;
+        assigner?: string;
+        target?: string;
+        action?: string;
+    }[];
     /**
      * The objects containing the information.
      */
-    objects: IJsonLdNodeObject[];
+    objects: {
+        [id: string]: IJsonLdNodeObject;
+    };
 }

package/dist/types/policyArbiters/defaultPolicyArbiter.d.ts

@@ -0,0 +1,41 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyArbiter, type IPolicyDecision } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import { type OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IDefaultPolicyArbiterConstructorOptions } from "../models/IDefaultPolicyArbiterConstructorOptions.js";
+/**
+ * Default Policy Arbiter.
+ */
+export declare class DefaultPolicyArbiter implements IPolicyArbiter {
+    /**
+     * The class name of the Default Policy Arbiter.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * ODRL profiles whose custom vocabulary this arbiter understands and supports.
+     * Any policy declaring a profile not in this set will be rejected.
+     * Add a new entry here when support for an additional profile is implemented.
+     */
+    static readonly SUPPORTED_PROFILES: ReadonlySet<string>;
+    /**
+     * Create a new instance of DefaultPolicyArbiter.
+     * @param options The options for the default policy arbiter.
+     */
+    constructor(options?: IDefaultPolicyArbiterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Makes decisions regarding policy access to data.
+     * @param agreement The agreement to evaluate.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param data The data to make a decision on.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The decisions about access to the data.
+     */
+    decide<D = unknown>(agreement: IDataspaceProtocolAgreement, information?: {
+        [id: string]: IJsonLdNodeObject;
+    }, data?: D, action?: OdrlActionType | string): Promise<IPolicyDecision[]>;
+}

package/dist/types/policyArbiters/passThroughPolicyArbiter.d.ts

@@ -0,0 +1,35 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IPolicyArbiter, type IPolicyDecision } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IPassThroughPolicyArbiterConstructorOptions } from "../models/IPassThroughPolicyArbiterConstructorOptions.js";
+/**
+ * Pass Through Policy Arbiter.
+ */
+export declare class PassThroughPolicyArbiter implements IPolicyArbiter {
+    /**
+     * The class name of the Pass Through Policy Arbiter.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PassThroughPolicyArbiter.
+     * @param options The options for the pass through policy arbiter.
+     */
+    constructor(options?: IPassThroughPolicyArbiterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Makes decisions regarding policy access to data.
+     * @param agreement The agreement to evaluate.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param data The data to make a decision on.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The decisions about access to the data.
+     */
+    decide<D = unknown>(agreement: IDataspaceProtocolAgreement, information?: {
+        [id: string]: IJsonLdNodeObject;
+    }, data?: D, action?: OdrlActionType | string): Promise<IPolicyDecision[]>;
+}

package/dist/types/policyEnforcementProcessor/defaultPolicyEnforcementProcessor.d.ts

@@ -0,0 +1,40 @@
+import { type IPolicyDecision, type IPolicyEnforcementProcessor } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IDefaultPolicyEnforcementProcessorConstructorOptions } from "../models/IDefaultPolicyEnforcementProcessorConstructorOptions.js";
+/**
+ * Default Policy Enforcement Processor.
+ */
+export declare class DefaultPolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
+    /**
+     * The class name of the Default Policy Enforcement Processor.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of DefaultPolicyEnforcementProcessor.
+     * @param options The options for the default policy enforcement processor.
+     */
+    constructor(options?: IDefaultPolicyEnforcementProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Process the response from the policy decision point.
+     * @param agreement The agreement to process.
+     * @param decisions The decisions made by the policy decision point.
+     * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The data after processing.
+     */
+    process<D = unknown, R = D>(agreement: IDataspaceProtocolAgreement, decisions: IPolicyDecision[], data?: D, action?: OdrlActionType | string): Promise<R>;
+    /**
+     * Process a single policy decision.
+     * @param sourceObject The data to process.
+     * @param outputObject The currently processed object.
+     * @param policyDecision The policy decision to process.
+     * @throws GeneralError When replaceValue is missing or invalid.
+     */
+    private processDecision;
+}

package/dist/types/policyEnforcementProcessor/passThroughPolicyEnforcementProcessor.d.ts

@@ -0,0 +1,32 @@
+import { type IPolicyDecision, type IPolicyEnforcementProcessor } from "@twin.org/rights-management-models";
+import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IPassThroughPolicyEnforcementProcessorConstructorOptions } from "../models/IPassThroughPolicyEnforcementProcessorConstructorOptions.js";
+/**
+ * Pass Through Policy Enforcement Processor.
+ */
+export declare class PassThroughPolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
+    /**
+     * The class name of the Pass Through Policy Enforcement Processor.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PassThroughPolicyEnforcementProcessor.
+     * @param options The options for the pass through policy enforcement processor.
+     */
+    constructor(options?: IPassThroughPolicyEnforcementProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Process the response from the policy decision point.
+     * @param agreement The agreement to process.
+     * @param decisions The decisions made by the policy decision point.
+     * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @returns The data after processing.
+     */
+    process<D = unknown, R = D>(agreement: IDataspaceProtocolAgreement, decisions: IPolicyDecision[], data?: D, action?: OdrlActionType | string): Promise<R>;
+}

package/dist/types/policyExecutionActions/automationPolicyExecutionAction.d.ts

@@ -0,0 +1,49 @@
+import { type IPolicyDecision, type IPolicyExecutionAction, type IRightsManagementPolicy, PolicyDecisionStage } from "@twin.org/rights-management-models";
+import { OdrlActionType } from "@twin.org/standards-w3c-odrl";
+import type { IAutomationPolicyExecutionActionConstructorOptions } from "../models/IAutomationPolicyExecutionActionConstructorOptions.js";
+/**
+ * Automation Policy Execution Action to execute automation policies.
+ */
+export declare class AutomationPolicyExecutionAction implements IPolicyExecutionAction {
+    /**
+     * The class name of the Automation Policy Execution Action.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * The before automation trigger name.
+     */
+    static readonly BEFORE_TRIGGER_NAME: string;
+    /**
+     * The after automation trigger name.
+     */
+    static readonly AFTER_TRIGGER_NAME: string;
+    /**
+     * The policy decision stages to trigger the automation actions, if undefined defaults to "inform".
+     */
+    private readonly _triggerActions;
+    /**
+     * Create a new instance of AutomationPolicyExecutionAction.
+     * @param options The options for the automation policy execution action.
+     */
+    constructor(options?: IAutomationPolicyExecutionActionConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Which stages should the action be executed at.
+     * @returns List of stages.
+     */
+    supportedStages(): PolicyDecisionStage[];
+    /**
+     * Execute function type for policy actions.
+     * @param policy The policy that applied to the data.
+     * @param decisions The decisions made by the PDP.
+     * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @param stage The stage of the policy decision.
+     * @returns A promise that resolves when the action is complete.
+     */
+    execute<D = unknown>(policy: IRightsManagementPolicy, decisions: IPolicyDecision[], data: D | undefined, action: OdrlActionType | string | undefined, stage: PolicyDecisionStage): Promise<void>;
+}

package/dist/types/policyExecutionActions/loggingPolicyExecutionAction.d.ts

@@ -1,5 +1,5 @@
-import { type IPolicyDecision, type IPolicyExecutionAction, type IPolicyLocator, PolicyDecisionStage } from "@twin.org/rights-management-models";
-import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import { type IPolicyDecision, type IPolicyExecutionAction, type IRightsManagementPolicy, PolicyDecisionStage } from "@twin.org/rights-management-models";
+import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
 import type { ILoggingPolicyExecutionActionConstructorOptions } from "../models/ILoggingPolicyExecutionActionConstructorOptions.js";
 /**
  * Logging Policy Execution Action to send decisions to logging.
@@ -14,9 +14,9 @@ export declare class LoggingPolicyExecutionAction implements IPolicyExecutionAct
      */
     private readonly _includeData;
     /**
-     * Whether to include the policies in the log.
+     * Whether to include the policy in the log.
      */
-    private readonly _includePolicies;
+    private readonly _includePolicy;
     /**
      * Whether to include the decisions in the log.
      */
@@ -38,12 +38,12 @@ export declare class LoggingPolicyExecutionAction implements IPolicyExecutionAct
     supportedStages(): PolicyDecisionStage[];
     /**
      * Execute function type for policy actions.
-     * @param stage The stage of the policy decision.
-     * @param locator The locator to find relevant policies.
-     * @param policies The policies that apply to the data.
+     * @param policy The policy that applied to the data.
      * @param decisions The decisions made by the PDP.
      * @param data The data to process.
+     * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+     * @param stage The stage of the policy decision.
      * @returns A promise that resolves when the action is complete.
      */
-    execute<D = unknown>(stage: PolicyDecisionStage, locator: IPolicyLocator, policies?: IOdrlPolicy[], decisions?: IPolicyDecision[], data?: D): Promise<void>;
+    execute<D = unknown>(policy: IRightsManagementPolicy, decisions: IPolicyDecision[], data: D | undefined, action: OdrlActionType | string | undefined, stage: PolicyDecisionStage): Promise<void>;
 }