@twin.org/rights-management-plugins 0.0.3-next.10

package/dist/es/policyInformationSources/identityPolicyInformationSource.js

@@ -0,0 +1,79 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseError, ComponentFactory, Guards } from "@twin.org/core";
+import { LocatorHelper, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+/**
+ * Policy information source which retrieves the identity information.
+ */
+export class IdentityPolicyInformationSource {
+    /**
+     * The class name of the Identity Policy Information Source.
+     */
+    static CLASS_NAME = "IdentityPolicyInformationSource";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * The identity resolver component.
+     * @internal
+     */
+    _identityResolver;
+    /**
+     * Create a new instance of IdentityPolicyInformationSource.
+     * @param options The options for the logging policy source.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
+        this._identityResolver = ComponentFactory.get(options?.identityResolverComponentType ?? "identity-resolver");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return IdentityPolicyInformationSource.CLASS_NAME;
+    }
+    /**
+     * Retrieve information from the sources.
+     * @param locator The locator to find relevant policies.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param policies The policies that apply to the data.
+     * @param data The data to process.
+     * @returns The objects containing relevant information or undefined if nothing relevant is found.
+     */
+    async retrieve(locator, accessMode, policies, data) {
+        Guards.objectValue(IdentityPolicyInformationSource.CLASS_NAME, "locator", locator);
+        Guards.arrayOneOf(IdentityPolicyInformationSource.CLASS_NAME, "accessMode", accessMode, Object.values(PolicyInformationAccessMode));
+        Guards.stringValue(IdentityPolicyInformationSource.CLASS_NAME, "locator.assignee", locator.assignee);
+        const information = [];
+        try {
+            await this._logging?.log({
+                level: "info",
+                source: IdentityPolicyInformationSource.CLASS_NAME,
+                ts: Date.now(),
+                message: "identityRetrieving",
+                data: {
+                    locator: LocatorHelper.toString(locator)
+                }
+            });
+            const idDoc = await this._identityResolver.identityResolve(locator.assignee);
+            information.push(idDoc);
+        }
+        catch (err) {
+            await this._logging?.log({
+                level: "error",
+                source: IdentityPolicyInformationSource.CLASS_NAME,
+                ts: Date.now(),
+                message: "identityRetrievalFailed",
+                data: {
+                    locator: LocatorHelper.toString(locator)
+                },
+                error: BaseError.fromError(err)
+            });
+        }
+        return information;
+    }
+}
+//# sourceMappingURL=identityPolicyInformationSource.js.map

package/dist/es/policyInformationSources/identityPolicyInformationSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityPolicyInformationSource.js","sourceRoot":"","sources":["../../../src/policyInformationSources/identityPolicyInformationSource.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAKrE,OAAO,EAGN,aAAa,EACb,2BAA2B,EAC3B,MAAM,oCAAoC,CAAC;AAI5C;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAC3C;;OAEG;IACI,MAAM,CAAU,UAAU,qCAAqD;IAEtF;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,iBAAiB,CAA6B;IAE/D;;;OAGG;IACH,YAAY,OAA4D;QACvE,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAC3C,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,CAC5C,OAAO,EAAE,6BAA6B,IAAI,mBAAmB,CAC7D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,+BAA+B,CAAC,UAAU,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CACpB,OAAuB,EACvB,UAAuC,EACvC,QAAuB,EACvB,IAAQ;QAER,MAAM,CAAC,WAAW,CACjB,+BAA+B,CAAC,UAAU,aAE1C,OAAO,CACP,CAAC;QACF,MAAM,CAAC,UAAU,CAChB,+BAA+B,CAAC,UAAU,gBAE1C,UAAU,EACV,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAC1C,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+BAA+B,CAAC,UAAU,sBAE1C,OAAO,CAAC,QAAQ,CAChB,CAAC;QAEF,MAAM,WAAW,GAAwB,EAAE,CAAC;QAE5C,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+BAA+B,CAAC,UAAU;gBAClD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,oBAAoB;gBAC7B,IAAI,EAAE;oBACL,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC;iBACxC;aACD,CAAC,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7E,WAAW,CAAC,IAAI,CAAC,KAAqC,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,OAAO;gBACd,MAAM,EAAE,+BAA+B,CAAC,UAAU;gBAClD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,yBAAyB;gBAClC,IAAI,EAAE;oBACL,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC;iBACxC;gBACD,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC;aAC/B,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACpB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError, ComponentFactory, Guards } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IIdentityResolverComponent } from \"@twin.org/identity-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\ttype IPolicyInformationSource,\n\ttype IPolicyLocator,\n\tLocatorHelper,\n\tPolicyInformationAccessMode\n} from \"@twin.org/rights-management-models\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { IIdentityPolicyInformationSourceConstructorOptions } from \"../models/IIdentityPolicyInformationSourceConstructorOptions.js\";\n\n/**\n * Policy information source which retrieves the identity information.\n */\nexport class IdentityPolicyInformationSource implements IPolicyInformationSource {\n\t/**\n\t * The class name of the Identity Policy Information Source.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityPolicyInformationSource>();\n\n\t/**\n\t * The logging component.\n\t * @internal\n\t */\n\tprivate readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * The identity resolver component.\n\t * @internal\n\t */\n\tprivate readonly _identityResolver: IIdentityResolverComponent;\n\n\t/**\n\t * Create a new instance of IdentityPolicyInformationSource.\n\t * @param options The options for the logging policy source.\n\t */\n\tconstructor(options?: IIdentityPolicyInformationSourceConstructorOptions) {\n\t\tthis._logging = ComponentFactory.getIfExists<ILoggingComponent>(\n\t\t\toptions?.loggingComponentType ?? \"logging\"\n\t\t);\n\t\tthis._identityResolver = ComponentFactory.get(\n\t\t\toptions?.identityResolverComponentType ?? \"identity-resolver\"\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 IdentityPolicyInformationSource.CLASS_NAME;\n\t}\n\n\t/**\n\t * Retrieve information from the sources.\n\t * @param locator The locator to find relevant policies.\n\t * @param accessMode The access mode to use for the retrieval.\n\t * @param policies The policies that apply to the data.\n\t * @param data The data to process.\n\t * @returns The objects containing relevant information or undefined if nothing relevant is found.\n\t */\n\tpublic async retrieve<D = unknown>(\n\t\tlocator: IPolicyLocator,\n\t\taccessMode: PolicyInformationAccessMode,\n\t\tpolicies: IOdrlPolicy[],\n\t\tdata?: D\n\t): Promise<IJsonLdNodeObject[] | undefined> {\n\t\tGuards.objectValue<IPolicyLocator>(\n\t\t\tIdentityPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(locator),\n\t\t\tlocator\n\t\t);\n\t\tGuards.arrayOneOf(\n\t\t\tIdentityPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(accessMode),\n\t\t\taccessMode,\n\t\t\tObject.values(PolicyInformationAccessMode)\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tIdentityPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(locator.assignee),\n\t\t\tlocator.assignee\n\t\t);\n\n\t\tconst information: IJsonLdNodeObject[] = [];\n\n\t\ttry {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: IdentityPolicyInformationSource.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"identityRetrieving\",\n\t\t\t\tdata: {\n\t\t\t\t\tlocator: LocatorHelper.toString(locator)\n\t\t\t\t}\n\t\t\t});\n\t\t\tconst idDoc = await this._identityResolver.identityResolve(locator.assignee);\n\t\t\tinformation.push(idDoc as unknown as IJsonLdNodeObject);\n\t\t} catch (err) {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"error\",\n\t\t\t\tsource: IdentityPolicyInformationSource.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"identityRetrievalFailed\",\n\t\t\t\tdata: {\n\t\t\t\t\tlocator: LocatorHelper.toString(locator)\n\t\t\t\t},\n\t\t\t\terror: BaseError.fromError(err)\n\t\t\t});\n\t\t}\n\n\t\treturn information;\n\t}\n}\n"]}

package/dist/es/policyInformationSources/staticPolicyInformationSource.js

@@ -0,0 +1,94 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory, Guards, Is } from "@twin.org/core";
+import { LocatorHelper, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+/**
+ * Policy information source which retrieves static information.
+ */
+export class StaticPolicyInformationSource {
+    /**
+     * The class name of the Static Policy Information Source.
+     */
+    static CLASS_NAME = "StaticPolicyInformationSource";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * The information sources.
+     * @internal
+     */
+    _information;
+    /**
+     * Create a new instance of StaticPolicyInformationSource.
+     * @param options The options for the logging policy source.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
+        this._information = options?.config?.information ?? [];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return StaticPolicyInformationSource.CLASS_NAME;
+    }
+    /**
+     * Retrieve information from the sources.
+     * @param locator The locator to find relevant policies.
+     * @param accessMode The access mode to use for the retrieval.
+     * @param policies The policies that apply to the data.
+     * @param data The data to process.
+     * @returns The objects containing relevant information or undefined if nothing relevant is found.
+     */
+    async retrieve(locator, accessMode, policies, data) {
+        Guards.objectValue(StaticPolicyInformationSource.CLASS_NAME, "locator", locator);
+        Guards.arrayOneOf(StaticPolicyInformationSource.CLASS_NAME, "accessMode", accessMode, Object.values(PolicyInformationAccessMode));
+        Guards.stringValue(StaticPolicyInformationSource.CLASS_NAME, "locator.assignee", locator.assignee);
+        const information = [];
+        await this._logging?.log({
+            level: "info",
+            source: StaticPolicyInformationSource.CLASS_NAME,
+            ts: Date.now(),
+            message: "staticRetrieving",
+            data: {
+                locator: LocatorHelper.toString(locator),
+                accessMode
+            }
+        });
+        for (const info of this._information) {
+            if (info.accessMode === accessMode ||
+                accessMode === PolicyInformationAccessMode.Any ||
+                info.accessMode === PolicyInformationAccessMode.Any) {
+                if (!Is.arrayValue(info.matchLocators) ||
+                    !Is.empty(LocatorHelper.findMatchingLocator(info.matchLocators, locator))) {
+                    information.push(...info.objects);
+                }
+            }
+        }
+        await this._logging?.log({
+            level: "info",
+            source: StaticPolicyInformationSource.CLASS_NAME,
+            ts: Date.now(),
+            message: "staticRetrieved",
+            data: {
+                locator: LocatorHelper.toString(locator),
+                accessMode,
+                itemCount: information.length
+            }
+        });
+        return information.length > 0 ? information : undefined;
+    }
+    /**
+     * Add static policy information.
+     * @param info The static policy information to add.
+     */
+    addInformation(info) {
+        Guards.arrayOneOf(StaticPolicyInformationSource.CLASS_NAME, "info.accessMode", info.accessMode, Object.values(PolicyInformationAccessMode));
+        Guards.arrayValue(StaticPolicyInformationSource.CLASS_NAME, "info.objects", info.objects);
+        this._information.push(info);
+    }
+}
+//# sourceMappingURL=staticPolicyInformationSource.js.map

package/dist/es/policyInformationSources/staticPolicyInformationSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticPolicyInformationSource.js","sourceRoot":"","sources":["../../../src/policyInformationSources/staticPolicyInformationSource.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAI9D,OAAO,EACN,aAAa,EACb,2BAA2B,EAG3B,MAAM,oCAAoC,CAAC;AAK5C;;GAEG;AACH,MAAM,OAAO,6BAA6B;IACzC;;OAEG;IACI,MAAM,CAAU,UAAU,mCAAmD;IAEpF;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,YAAY,CAAmC;IAEhE;;;OAGG;IACH,YAAY,OAA0D;QACrE,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAC3C,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,6BAA6B,CAAC,UAAU,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CACpB,OAAuB,EACvB,UAAuC,EACvC,QAAuB,EACvB,IAAQ;QAER,MAAM,CAAC,WAAW,CACjB,6BAA6B,CAAC,UAAU,aAExC,OAAO,CACP,CAAC;QACF,MAAM,CAAC,UAAU,CAChB,6BAA6B,CAAC,UAAU,gBAExC,UAAU,EACV,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAC1C,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,6BAA6B,CAAC,UAAU,sBAExC,OAAO,CAAC,QAAQ,CAChB,CAAC;QAEF,MAAM,WAAW,GAAwB,EAAE,CAAC;QAE5C,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;YACxB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,6BAA6B,CAAC,UAAU;YAChD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE;gBACL,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACxC,UAAU;aACV;SACD,CAAC,CAAC;QAEH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,IACC,IAAI,CAAC,UAAU,KAAK,UAAU;gBAC9B,UAAU,KAAK,2BAA2B,CAAC,GAAG;gBAC9C,IAAI,CAAC,UAAU,KAAK,2BAA2B,CAAC,GAAG,EAClD,CAAC;gBACF,IACC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;oBAClC,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,EACxE,CAAC;oBACF,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnC,CAAC;YACF,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;YACxB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,6BAA6B,CAAC,UAAU;YAChD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,iBAAiB;YAC1B,IAAI,EAAE;gBACL,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACxC,UAAU;gBACV,SAAS,EAAE,WAAW,CAAC,MAAM;aAC7B;SACD,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,IAAoC;QACzD,MAAM,CAAC,UAAU,CAChB,6BAA6B,CAAC,UAAU,qBAExC,IAAI,CAAC,UAAU,EACf,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAC1C,CAAC;QACF,MAAM,CAAC,UAAU,CAChB,6BAA6B,CAAC,UAAU,kBAExC,IAAI,CAAC,OAAO,CACZ,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, Guards, Is } 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\tLocatorHelper,\n\tPolicyInformationAccessMode,\n\ttype IPolicyInformationSource,\n\ttype IPolicyLocator\n} from \"@twin.org/rights-management-models\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { IStaticPolicyInformationSource } from \"../models/IStaticPolicyInformationSource.js\";\nimport type { IStaticPolicyInformationSourceConstructorOptions } from \"../models/IStaticPolicyInformationSourceConstructorOptions.js\";\n\n/**\n * Policy information source which retrieves static information.\n */\nexport class StaticPolicyInformationSource implements IPolicyInformationSource {\n\t/**\n\t * The class name of the Static Policy Information Source.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<StaticPolicyInformationSource>();\n\n\t/**\n\t * The logging component.\n\t * @internal\n\t */\n\tprivate readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * The information sources.\n\t * @internal\n\t */\n\tprivate readonly _information: IStaticPolicyInformationSource[];\n\n\t/**\n\t * Create a new instance of StaticPolicyInformationSource.\n\t * @param options The options for the logging policy source.\n\t */\n\tconstructor(options?: IStaticPolicyInformationSourceConstructorOptions) {\n\t\tthis._logging = ComponentFactory.getIfExists<ILoggingComponent>(\n\t\t\toptions?.loggingComponentType ?? \"logging\"\n\t\t);\n\t\tthis._information = options?.config?.information ?? [];\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 StaticPolicyInformationSource.CLASS_NAME;\n\t}\n\n\t/**\n\t * Retrieve information from the sources.\n\t * @param locator The locator to find relevant policies.\n\t * @param accessMode The access mode to use for the retrieval.\n\t * @param policies The policies that apply to the data.\n\t * @param data The data to process.\n\t * @returns The objects containing relevant information or undefined if nothing relevant is found.\n\t */\n\tpublic async retrieve<D = unknown>(\n\t\tlocator: IPolicyLocator,\n\t\taccessMode: PolicyInformationAccessMode,\n\t\tpolicies: IOdrlPolicy[],\n\t\tdata?: D\n\t): Promise<IJsonLdNodeObject[] | undefined> {\n\t\tGuards.objectValue<IPolicyLocator>(\n\t\t\tStaticPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(locator),\n\t\t\tlocator\n\t\t);\n\t\tGuards.arrayOneOf(\n\t\t\tStaticPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(accessMode),\n\t\t\taccessMode,\n\t\t\tObject.values(PolicyInformationAccessMode)\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tStaticPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(locator.assignee),\n\t\t\tlocator.assignee\n\t\t);\n\n\t\tconst information: IJsonLdNodeObject[] = [];\n\n\t\tawait this._logging?.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: StaticPolicyInformationSource.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"staticRetrieving\",\n\t\t\tdata: {\n\t\t\t\tlocator: LocatorHelper.toString(locator),\n\t\t\t\taccessMode\n\t\t\t}\n\t\t});\n\n\t\tfor (const info of this._information) {\n\t\t\tif (\n\t\t\t\tinfo.accessMode === accessMode ||\n\t\t\t\taccessMode === PolicyInformationAccessMode.Any ||\n\t\t\t\tinfo.accessMode === PolicyInformationAccessMode.Any\n\t\t\t) {\n\t\t\t\tif (\n\t\t\t\t\t!Is.arrayValue(info.matchLocators) ||\n\t\t\t\t\t!Is.empty(LocatorHelper.findMatchingLocator(info.matchLocators, locator))\n\t\t\t\t) {\n\t\t\t\t\tinformation.push(...info.objects);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tawait this._logging?.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: StaticPolicyInformationSource.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"staticRetrieved\",\n\t\t\tdata: {\n\t\t\t\tlocator: LocatorHelper.toString(locator),\n\t\t\t\taccessMode,\n\t\t\t\titemCount: information.length\n\t\t\t}\n\t\t});\n\n\t\treturn information.length > 0 ? information : undefined;\n\t}\n\n\t/**\n\t * Add static policy information.\n\t * @param info The static policy information to add.\n\t */\n\tpublic addInformation(info: IStaticPolicyInformationSource): void {\n\t\tGuards.arrayOneOf<string>(\n\t\t\tStaticPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(info.accessMode),\n\t\t\tinfo.accessMode,\n\t\t\tObject.values(PolicyInformationAccessMode)\n\t\t);\n\t\tGuards.arrayValue<IJsonLdNodeObject>(\n\t\t\tStaticPolicyInformationSource.CLASS_NAME,\n\t\t\tnameof(info.objects),\n\t\t\tinfo.objects\n\t\t);\n\t\tthis._information.push(info);\n\t}\n}\n"]}

package/dist/es/policyNegotiators/examplePolicyNegotiator.js

@@ -0,0 +1,61 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+/**
+ * Example Policy Negotiator.
+ */
+export class ExamplePolicyNegotiator {
+    /**
+     * The class name of the Example Policy Negotiator.
+     */
+    static CLASS_NAME = "ExamplePolicyNegotiator";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of ExamplePolicyNegotiator.
+     * @param options The options for the example policy negotiator.
+     */
+    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 ExamplePolicyNegotiator.CLASS_NAME;
+    }
+    /**
+     * Determines if the negotiator supports the given offer.
+     * @param offer The offer to check.
+     * @returns Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+     */
+    supportsOffer(offer) {
+        return true;
+    }
+    /**
+     * Handle the offer.
+     * @param offer The offer to check.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @returns Sets the accepted flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+     */
+    async handleOffer(offer, information) {
+        return {
+            accepted: true,
+            interventionRequired: false
+        };
+    }
+    /**
+     * Create an agreement based on the offer.
+     * @param offer The offer to create the agreement from.
+     * @param information Information provided by the requester to aid in the creation of the agreement.
+     * @returns The agreement created from the offer or undefined if an agreement could not be created.
+     */
+    async createAgreement(offer, information) {
+        return undefined;
+    }
+}
+//# sourceMappingURL=examplePolicyNegotiator.js.map

package/dist/es/policyNegotiators/examplePolicyNegotiator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"examplePolicyNegotiator.js","sourceRoot":"","sources":["../../../src/policyNegotiators/examplePolicyNegotiator.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAOlD;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACnC;;OAEG;IACI,MAAM,CAAU,UAAU,6BAA6C;IAE9E;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAAoD;QAC/D,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,uBAAuB,CAAC,UAAU,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,KAAiB;QACrC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CACvB,KAAiB,EACjB,WAAgC;QAKhC,OAAO;YACN,QAAQ,EAAE,IAAI;YACd,oBAAoB,EAAE,KAAK;SAC3B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAC3B,KAAiB,EACjB,WAAgC;QAEhC,OAAO,SAAS,CAAC;IAClB,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 type { IPolicyInformation, IPolicyNegotiator } from \"@twin.org/rights-management-models\";\nimport type { IOdrlAgreement, IOdrlOffer } from \"@twin.org/standards-w3c-odrl\";\nimport type { IExamplePolicyNegotiatorConstructorOptions } from \"../models/IExamplePolicyNegotiatorConstructorOptions.js\";\n\n/**\n * Example Policy Negotiator.\n */\nexport class ExamplePolicyNegotiator implements IPolicyNegotiator {\n\t/**\n\t * The class name of the Example Policy Negotiator.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ExamplePolicyNegotiator>();\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 ExamplePolicyNegotiator.\n\t * @param options The options for the example policy negotiator.\n\t */\n\tconstructor(options?: IExamplePolicyNegotiatorConstructorOptions) {\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 ExamplePolicyNegotiator.CLASS_NAME;\n\t}\n\n\t/**\n\t * Determines if the negotiator supports the given offer.\n\t * @param offer The offer to check.\n\t * @returns Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.\n\t */\n\tpublic supportsOffer(offer: IOdrlOffer): boolean {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Handle the offer.\n\t * @param offer The offer to check.\n\t * @param information Information provided by the requester to determine if a policy can be created.\n\t * @returns Sets the accepted flag if it can be offered, and the interventionRequired flag if manual agreement is needed.\n\t */\n\tpublic async handleOffer(\n\t\toffer: IOdrlOffer,\n\t\tinformation?: IPolicyInformation\n\t): Promise<{\n\t\taccepted: boolean;\n\t\tinterventionRequired: boolean;\n\t}> {\n\t\treturn {\n\t\t\taccepted: true,\n\t\t\tinterventionRequired: false\n\t\t};\n\t}\n\n\t/**\n\t * Create an agreement based on the offer.\n\t * @param offer The offer to create the agreement from.\n\t * @param information Information provided by the requester to aid in the creation of the agreement.\n\t * @returns The agreement created from the offer or undefined if an agreement could not be created.\n\t */\n\tpublic async createAgreement(\n\t\toffer: IOdrlOffer,\n\t\tinformation?: IPolicyInformation\n\t): Promise<IOdrlAgreement | undefined> {\n\t\treturn undefined;\n\t}\n}\n"]}

package/dist/es/policyRequesters/examplePolicyRequester.js

@@ -0,0 +1,69 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+/**
+ * Example Policy Requester.
+ */
+export class ExamplePolicyRequester {
+    /**
+     * The class name of the Example Policy Requester.
+     */
+    static CLASS_NAME = "ExamplePolicyRequester";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of ExamplePolicyRequester.
+     * @param options The options for the example 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 ExamplePolicyRequester.CLASS_NAME;
+    }
+    /**
+     * The unique id of the requester.
+     * @returns The requester id.
+     */
+    requesterId() {
+        return "";
+    }
+    /**
+     * A policy has been offered by a provider, let the requester 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) {
+        return true;
+    }
+    /**
+     * A policy agreement has been sent by a provider, let the requester 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) {
+        return true;
+    }
+    /**
+     * A policy finalisation has been sent by a provider, let the requester know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns Nothing.
+     */
+    async finalised(negotiationId) { }
+    /**
+     * A policy termination has been sent by a provider, let the requester know about it.
+     * @param negotiationId The id of the negotiation.
+     * @returns Nothing.
+     */
+    async terminated(negotiationId) { }
+}
+//# sourceMappingURL=examplePolicyRequester.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"examplePolicyRequester.js","sourceRoot":"","sources":["../../../src/policyRequesters/examplePolicyRequester.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAOlD;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAClC;;OAEG;IACI,MAAM,CAAU,UAAU,4BAA4C;IAE7E;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAAmD;QAC9D,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,sBAAsB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,WAAW;QACjB,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,aAAqB,EAAE,KAAiB;QAC1D,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,aAAqB,EAAE,SAAyB;QACtE,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,aAAqB,IAAkB,CAAC;IAE/D;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,aAAqB,IAAkB,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 type { IPolicyRequester } from \"@twin.org/rights-management-models\";\nimport type { IOdrlAgreement, IOdrlOffer } from \"@twin.org/standards-w3c-odrl\";\nimport type { IExamplePolicyRequesterConstructorOptions } from \"../models/IExamplePolicyRequesterConstructorOptions.js\";\n\n/**\n * Example Policy Requester.\n */\nexport class ExamplePolicyRequester implements IPolicyRequester {\n\t/**\n\t * The class name of the Example Policy Requester.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ExamplePolicyRequester>();\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 ExamplePolicyRequester.\n\t * @param options The options for the example policy Requester.\n\t */\n\tconstructor(options?: IExamplePolicyRequesterConstructorOptions) {\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 ExamplePolicyRequester.CLASS_NAME;\n\t}\n\n\t/**\n\t * The unique id of the requester.\n\t * @returns The requester id.\n\t */\n\tpublic requesterId(): string {\n\t\treturn \"\";\n\t}\n\n\t/**\n\t * A policy has been offered by a provider, let the requester 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: IOdrlOffer): Promise<boolean> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * A policy agreement has been sent by a provider, let the requester 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(negotiationId: string, agreement: IOdrlAgreement): Promise<boolean> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * A policy finalisation has been sent by a provider, let the requester 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\n\t/**\n\t * A policy termination has been sent by a provider, let the requester 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}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+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/IIdentityPolicyInformationSourceConstructorOptions.js";
+export * from "./models/ILoggingPolicyExecutionActionConfig.js";
+export * from "./models/ILoggingPolicyExecutionActionConstructorOptions.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 "./policyExecutionActions/loggingPolicyExecutionAction.js";
+export * from "./policyInformationSources/identityPolicyInformationSource.js";
+export * from "./policyInformationSources/staticPolicyInformationSource.js";
+export * from "./policyNegotiators/examplePolicyNegotiator.js";
+export * from "./policyRequesters/examplePolicyRequester.js";

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Example Data Access Handler.
+ */
+export interface IExampleDataAccessHandlerConstructorOptions {
+    /**
+     * The logging component for data access handler.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Example Policy Arbiter.
+ */
+export interface IExamplePolicyArbiterConstructorOptions {
+    /**
+     * The logging component for policy arbiter.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Example Policy Negotiator.
+ */
+export interface IExamplePolicyNegotiatorConstructorOptions {
+    /**
+     * The logging component for policy negotiator.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the Example Policy Requester.
+ */
+export interface IExamplePolicyRequesterConstructorOptions {
+    /**
+     * The logging component for policy requester.
+     * @default logging
+     */
+    loggingComponentType?: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * Options for the Identity Policy Information Source Component.
+ */
+export interface IIdentityPolicyInformationSourceConstructorOptions {
+    /**
+     * The logging component for logging policy source.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The component for resolving identities.
+     * @default identity-resolver
+     */
+    identityResolverComponentType?: string;
+}

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

@@ -0,0 +1,25 @@
+import type { PolicyDecisionStage } from "@twin.org/rights-management-models";
+/**
+ * Options for the Logging Policy Execution Action Component.
+ */
+export interface ILoggingPolicyExecutionActionConfig {
+    /**
+     * The policy decision stages to log, if undefined defaults to all.
+     */
+    stages?: PolicyDecisionStage[];
+    /**
+     * Whether to include the data in the log.
+     * @default false
+     */
+    includeData?: boolean;
+    /**
+     * Whether to include the policies in the log.
+     * @default false
+     */
+    includePolicies?: boolean;
+    /**
+     * Whether to include the decisions in the log.
+     * @default false
+     */
+    includeDecisions?: boolean;
+}

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

@@ -0,0 +1,15 @@
+import type { ILoggingPolicyExecutionActionConfig } from "./ILoggingPolicyExecutionActionConfig.js";
+/**
+ * Options for the Logging Policy Execution Action.
+ */
+export interface ILoggingPolicyExecutionActionConstructorOptions {
+    /**
+     * The logging component for logging policy execution.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration for the logging policy execution.
+     */
+    config?: ILoggingPolicyExecutionActionConfig;
+}

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

@@ -0,0 +1,20 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IPolicyLocator, PolicyInformationAccessMode } from "@twin.org/rights-management-models";
+/**
+ * Configuration for the Static Policy Information Source Component.
+ */
+export interface IStaticPolicyInformationSource {
+    /**
+     * Is the information public, if so it will be shared with negotiation requests.
+     */
+    accessMode: PolicyInformationAccessMode;
+    /**
+     * Information is only provided for the specified locator combination.
+     * If undefined is provided matches all resources.
+     */
+    matchLocators?: IPolicyLocator[];
+    /**
+     * The objects containing the information.
+     */
+    objects: IJsonLdNodeObject[];
+}

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

@@ -0,0 +1,10 @@
+import type { IStaticPolicyInformationSource } from "./IStaticPolicyInformationSource.js";
+/**
+ * Configuration for the Static Policy Information Source Component.
+ */
+export interface IStaticPolicyInformationSourceConfig {
+    /**
+     * The information to return from the PIP.
+     */
+    information?: IStaticPolicyInformationSource[];
+}

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

@@ -0,0 +1,15 @@
+import type { IStaticPolicyInformationSourceConfig } from "./IStaticPolicyInformationSourceConfig.js";
+/**
+ * Options for the Static Policy Information Source Component.
+ */
+export interface IStaticPolicyInformationSourceConstructorOptions {
+    /**
+     * The logging component for logging policy source.
+     * @default logging
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration.
+     */
+    config?: IStaticPolicyInformationSourceConfig;
+}

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

@@ -0,0 +1,36 @@
+import type { IPolicyArbiter, IPolicyDecision, IPolicyInformation, IPolicyLocator } from "@twin.org/rights-management-models";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { IExamplePolicyArbiterConstructorOptions } from "../models/IExamplePolicyArbiterConstructorOptions.js";
+/**
+ * Example Policy Arbiter.
+ */
+export declare class ExamplePolicyArbiter implements IPolicyArbiter {
+    /**
+     * The class name of the Example Policy Arbiter.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ExamplePolicyArbiter.
+     * @param options The options for the example policy arbiter.
+     */
+    constructor(options?: IExamplePolicyArbiterConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * The policies supported by this arbiter.
+     * @returns The supported policies, if empty can be used for all.
+     */
+    supportedPolicies(): IPolicyLocator[];
+    /**
+     * Makes decisions regarding policy access to data.
+     * @param locator The locator to find relevant policies.
+     * @param information Information provided by the requester to determine if a policy can be created.
+     * @param policies The policies that apply to the data.
+     * @param data The data to make a decision on.
+     * @returns The decisions about access to the data.
+     */
+    decide<D = unknown>(locator: IPolicyLocator, information?: IPolicyInformation, policies?: IOdrlPolicy[], data?: D): Promise<IPolicyDecision[]>;
+}

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

@@ -0,0 +1,29 @@
+import type { IPolicyDecision, IPolicyEnforcementProcessor, IPolicyLocator } from "@twin.org/rights-management-models";
+import type { IExamplePolicyEnforcementProcessorConstructorOptions } from "../models/IExamplePolicyEnforcementProcessorConstructorOptions.js";
+/**
+ * Example Policy Enforcement Processor.
+ */
+export declare class ExamplePolicyEnforcementProcessor implements IPolicyEnforcementProcessor {
+    /**
+     * The class name of the Example Policy Enforcement Processor.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ExamplePolicyEnforcementProcessor.
+     * @param options The options for the example policy enforcement processor.
+     */
+    constructor(options?: IExamplePolicyEnforcementProcessorConstructorOptions);
+    /**
+     * 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 locator The locator to find relevant policies.
+     * @param decisions The decisions made by the policy decision point.
+     * @param data The data to process.
+     * @returns The data after processing.
+     */
+    process<D = unknown, R = D>(locator: IPolicyLocator, decisions: IPolicyDecision[], data?: D): Promise<R>;
+}