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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Rights Management Plugins
+
+Rights Management plugin implementations.
+
+## Installation
+
+```shell
+npm install @twin.org/rights-management-plugins
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/es/dataAccessHandlers/examplePolicyRequester.js

@@ -0,0 +1,82 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+/**
+ * Example Data Access Handler.
+ */
+export class ExampleDataAccessHandler {
+    /**
+     * The class name of the Example Data Access Handler.
+     */
+    static CLASS_NAME = "ExampleDataAccessHandler";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of ExampleDataAccessHandler.
+     * @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 ExampleDataAccessHandler.CLASS_NAME;
+    }
+    /**
+     * The asset types supported by this handler.
+     * @returns The supported asset types.
+     */
+    supportedAssetTypes() {
+        return [];
+    }
+    /**
+     * Create an item.
+     * @param assetType The type of the item to create.
+     * @param item The item to create.
+     * @returns The id of the item created, for some items this is supplied in the `item`.
+     */
+    async create(assetType, item) {
+        return "";
+    }
+    /**
+     * Get an item.
+     * @param assetType The type of the item to retrieve.
+     * @param id The ID of the item to retrieve.
+     * @returns The item retrieved if the policies allow it.
+     */
+    async get(assetType, id) {
+        return {};
+    }
+    /**
+     * Update an item.
+     * @param assetType The type of the item to update.
+     * @param item The item to update.
+     * @returns Nothing.
+     */
+    async update(assetType, item) { }
+    /**
+     * Remove an item.
+     * @param assetType The type of the item to remove.
+     * @param id The id of the item to remove.
+     * @returns Nothing.
+     */
+    async remove(assetType, id) { }
+    /**
+     * Query for items.
+     * @param assetType The type of the item to query.
+     * @param conditions The conditions to apply to the query.
+     * @param cursor The cursor for pagination.
+     * @param options Additional options which might be supported by the handler.
+     * @returns The items matching the query and cursor if there are more items.
+     */
+    async query(assetType, conditions, cursor, options) {
+        return { items: [] };
+    }
+}
+//# sourceMappingURL=examplePolicyRequester.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"examplePolicyRequester.js","sourceRoot":"","sources":["../../../src/dataAccessHandlers/examplePolicyRequester.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAQlD;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACpC;;OAEG;IACI,MAAM,CAAU,UAAU,8BAA8C;IAE/E;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAAqD;QAChE,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,wBAAwB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAuB;QAC7D,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,SAAiB,EAAE,EAAU;QAC7C,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAuB,IAAkB,CAAC;IAEjF;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,EAAU,IAAkB,CAAC;IAEpE;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CACjB,SAAiB,EACjB,UAA0D,EAC1D,MAA0B,EAC1B,OAA4B;QAK5B,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACtB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { EntityCondition } from \"@twin.org/entity\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IDataAccessHandler } from \"@twin.org/rights-management-models\";\nimport type { IExampleDataAccessHandlerConstructorOptions } from \"../models/IExampleDataAccessHandlerConstructorOptions.js\";\n\n/**\n * Example Data Access Handler.\n */\nexport class ExampleDataAccessHandler implements IDataAccessHandler {\n\t/**\n\t * The class name of the Example Data Access Handler.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ExampleDataAccessHandler>();\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 ExampleDataAccessHandler.\n\t * @param options The options for the example policy Requester.\n\t */\n\tconstructor(options?: IExampleDataAccessHandlerConstructorOptions) {\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 ExampleDataAccessHandler.CLASS_NAME;\n\t}\n\n\t/**\n\t * The asset types supported by this handler.\n\t * @returns The supported asset types.\n\t */\n\tpublic supportedAssetTypes(): string[] {\n\t\treturn [];\n\t}\n\n\t/**\n\t * Create an item.\n\t * @param assetType The type of the item to create.\n\t * @param item The item to create.\n\t * @returns The id of the item created, for some items this is supplied in the `item`.\n\t */\n\tpublic async create(assetType: string, item: IJsonLdNodeObject): Promise<string> {\n\t\treturn \"\";\n\t}\n\n\t/**\n\t * Get an item.\n\t * @param assetType The type of the item to retrieve.\n\t * @param id The ID of the item to retrieve.\n\t * @returns The item retrieved if the policies allow it.\n\t */\n\tpublic async get(assetType: string, id: string): Promise<IJsonLdNodeObject> {\n\t\treturn {};\n\t}\n\n\t/**\n\t * Update an item.\n\t * @param assetType The type of the item to update.\n\t * @param item The item to update.\n\t * @returns Nothing.\n\t */\n\tpublic async update(assetType: string, item: IJsonLdNodeObject): Promise<void> {}\n\n\t/**\n\t * Remove an item.\n\t * @param assetType The type of the item to remove.\n\t * @param id The id of the item to remove.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(assetType: string, id: string): Promise<void> {}\n\n\t/**\n\t * Query for items.\n\t * @param assetType The type of the item to query.\n\t * @param conditions The conditions to apply to the query.\n\t * @param cursor The cursor for pagination.\n\t * @param options Additional options which might be supported by the handler.\n\t * @returns The items matching the query and cursor if there are more items.\n\t */\n\tpublic async query(\n\t\tassetType: string,\n\t\tconditions: EntityCondition<IJsonLdNodeObject> | undefined,\n\t\tcursor: string | undefined,\n\t\toptions: unknown | undefined\n\t): Promise<{\n\t\titems: IJsonLdNodeObject[];\n\t\tcursor?: string;\n\t}> {\n\t\treturn { items: [] };\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,22 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+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/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";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gDAAgD,CAAC;AAC/D,cAAc,yDAAyD,CAAC;AACxE,cAAc,qDAAqD,CAAC;AACpE,cAAc,kEAAkE,CAAC;AACjF,cAAc,wDAAwD,CAAC;AACvE,cAAc,uDAAuD,CAAC;AACtE,cAAc,gEAAgE,CAAC;AAC/E,cAAc,iDAAiD,CAAC;AAChE,cAAc,6DAA6D,CAAC;AAC5E,cAAc,4CAA4C,CAAC;AAC3D,cAAc,kDAAkD,CAAC;AACjE,cAAc,8DAA8D,CAAC;AAC7E,cAAc,0CAA0C,CAAC;AACzD,cAAc,mEAAmE,CAAC;AAClF,cAAc,0DAA0D,CAAC;AACzE,cAAc,+DAA+D,CAAC;AAC9E,cAAc,6DAA6D,CAAC;AAC5E,cAAc,gDAAgD,CAAC;AAC/D,cAAc,8CAA8C,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataAccessHandlers/examplePolicyRequester.js\";\nexport * from \"./models/IExampleDataAccessHandlerConstructorOptions.js\";\nexport * from \"./models/IExamplePolicyArbiterConstructorOptions.js\";\nexport * from \"./models/IExamplePolicyEnforcementProcessorConstructorOptions.js\";\nexport * from \"./models/IExamplePolicyNegotiatorConstructorOptions.js\";\nexport * from \"./models/IExamplePolicyRequesterConstructorOptions.js\";\nexport * from \"./models/IIdentityPolicyInformationSourceConstructorOptions.js\";\nexport * from \"./models/ILoggingPolicyExecutionActionConfig.js\";\nexport * from \"./models/ILoggingPolicyExecutionActionConstructorOptions.js\";\nexport * from \"./models/IStaticPolicyInformationSource.js\";\nexport * from \"./models/IStaticPolicyInformationSourceConfig.js\";\nexport * from \"./models/IStaticPolicyInformationSourceConstructorOptions.js\";\nexport * from \"./policyArbiters/examplePolicyArbiter.js\";\nexport * from \"./policyEnforcementProcessor/examplePolicyEnforcementProcessor.js\";\nexport * from \"./policyExecutionActions/loggingPolicyExecutionAction.js\";\nexport * from \"./policyInformationSources/identityPolicyInformationSource.js\";\nexport * from \"./policyInformationSources/staticPolicyInformationSource.js\";\nexport * from \"./policyNegotiators/examplePolicyNegotiator.js\";\nexport * from \"./policyRequesters/examplePolicyRequester.js\";\n"]}

package/dist/es/models/IExampleDataAccessHandlerConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IExampleDataAccessHandlerConstructorOptions.js.map

package/dist/es/models/IExampleDataAccessHandlerConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IExampleDataAccessHandlerConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IExampleDataAccessHandlerConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the Example Data Access Handler.\n */\nexport interface IExampleDataAccessHandlerConstructorOptions {\n\t/**\n\t * The logging component for data access handler.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/IExamplePolicyArbiterConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IExamplePolicyArbiterConstructorOptions.js.map

package/dist/es/models/IExamplePolicyArbiterConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IExamplePolicyArbiterConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IExamplePolicyArbiterConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the Example Policy Arbiter.\n */\nexport interface IExamplePolicyArbiterConstructorOptions {\n\t/**\n\t * The logging component for policy arbiter.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/IExamplePolicyEnforcementProcessorConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IExamplePolicyEnforcementProcessorConstructorOptions.js.map

package/dist/es/models/IExamplePolicyEnforcementProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IExamplePolicyEnforcementProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IExamplePolicyEnforcementProcessorConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the Example Policy Enforcement Processor.\n */\nexport interface IExamplePolicyEnforcementProcessorConstructorOptions {\n\t/**\n\t * The logging component for policy enforcement processor.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/IExamplePolicyNegotiatorConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IExamplePolicyNegotiatorConstructorOptions.js.map

package/dist/es/models/IExamplePolicyNegotiatorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IExamplePolicyNegotiatorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IExamplePolicyNegotiatorConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the Example Policy Negotiator.\n */\nexport interface IExamplePolicyNegotiatorConstructorOptions {\n\t/**\n\t * The logging component for policy negotiator.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/IExamplePolicyRequesterConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IExamplePolicyRequesterConstructorOptions.js.map

package/dist/es/models/IExamplePolicyRequesterConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IExamplePolicyRequesterConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IExamplePolicyRequesterConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the Example Policy Requester.\n */\nexport interface IExamplePolicyRequesterConstructorOptions {\n\t/**\n\t * The logging component for policy requester.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/IIdentityPolicyInformationSourceConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IIdentityPolicyInformationSourceConstructorOptions.js.map

package/dist/es/models/IIdentityPolicyInformationSourceConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IIdentityPolicyInformationSourceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IIdentityPolicyInformationSourceConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the Identity Policy Information Source Component.\n */\nexport interface IIdentityPolicyInformationSourceConstructorOptions {\n\t/**\n\t * The logging component for logging policy source.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The component for resolving identities.\n\t * @default identity-resolver\n\t */\n\tidentityResolverComponentType?: string;\n}\n"]}

package/dist/es/models/ILoggingPolicyExecutionActionConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ILoggingPolicyExecutionActionConfig.js.map

package/dist/es/models/ILoggingPolicyExecutionActionConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingPolicyExecutionActionConfig.js","sourceRoot":"","sources":["../../../src/models/ILoggingPolicyExecutionActionConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { PolicyDecisionStage } from \"@twin.org/rights-management-models\";\n\n/**\n * Options for the Logging Policy Execution Action Component.\n */\nexport interface ILoggingPolicyExecutionActionConfig {\n\t/**\n\t * The policy decision stages to log, if undefined defaults to all.\n\t */\n\tstages?: PolicyDecisionStage[];\n\n\t/**\n\t * Whether to include the data in the log.\n\t * @default false\n\t */\n\tincludeData?: boolean;\n\n\t/**\n\t * Whether to include the policies in the log.\n\t * @default false\n\t */\n\tincludePolicies?: boolean;\n\n\t/**\n\t * Whether to include the decisions in the log.\n\t * @default false\n\t */\n\tincludeDecisions?: boolean;\n}\n"]}

package/dist/es/models/ILoggingPolicyExecutionActionConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ILoggingPolicyExecutionActionConstructorOptions.js.map

package/dist/es/models/ILoggingPolicyExecutionActionConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingPolicyExecutionActionConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ILoggingPolicyExecutionActionConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ILoggingPolicyExecutionActionConfig } from \"./ILoggingPolicyExecutionActionConfig.js\";\n\n/**\n * Options for the Logging Policy Execution Action.\n */\nexport interface ILoggingPolicyExecutionActionConstructorOptions {\n\t/**\n\t * The logging component for logging policy execution.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration for the logging policy execution.\n\t */\n\tconfig?: ILoggingPolicyExecutionActionConfig;\n}\n"]}

package/dist/es/models/IStaticPolicyInformationSource.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IStaticPolicyInformationSource.js.map

package/dist/es/models/IStaticPolicyInformationSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStaticPolicyInformationSource.js","sourceRoot":"","sources":["../../../src/models/IStaticPolicyInformationSource.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type {\n\tIPolicyLocator,\n\tPolicyInformationAccessMode\n} from \"@twin.org/rights-management-models\";\n\n/**\n * Configuration for the Static Policy Information Source Component.\n */\nexport interface IStaticPolicyInformationSource {\n\t/**\n\t * Is the information public, if so it will be shared with negotiation requests.\n\t */\n\taccessMode: PolicyInformationAccessMode;\n\n\t/**\n\t * Information is only provided for the specified locator combination.\n\t * If undefined is provided matches all resources.\n\t */\n\tmatchLocators?: IPolicyLocator[];\n\n\t/**\n\t * The objects containing the information.\n\t */\n\tobjects: IJsonLdNodeObject[];\n}\n"]}

package/dist/es/models/IStaticPolicyInformationSourceConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IStaticPolicyInformationSourceConfig.js.map

package/dist/es/models/IStaticPolicyInformationSourceConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStaticPolicyInformationSourceConfig.js","sourceRoot":"","sources":["../../../src/models/IStaticPolicyInformationSourceConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IStaticPolicyInformationSource } from \"./IStaticPolicyInformationSource.js\";\n\n/**\n * Configuration for the Static Policy Information Source Component.\n */\nexport interface IStaticPolicyInformationSourceConfig {\n\t/**\n\t * The information to return from the PIP.\n\t */\n\tinformation?: IStaticPolicyInformationSource[];\n}\n"]}

package/dist/es/models/IStaticPolicyInformationSourceConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IStaticPolicyInformationSourceConstructorOptions.js.map

package/dist/es/models/IStaticPolicyInformationSourceConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStaticPolicyInformationSourceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IStaticPolicyInformationSourceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IStaticPolicyInformationSourceConfig } from \"./IStaticPolicyInformationSourceConfig.js\";\n\n/**\n * Options for the Static Policy Information Source Component.\n */\nexport interface IStaticPolicyInformationSourceConstructorOptions {\n\t/**\n\t * The logging component for logging policy source.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration.\n\t */\n\tconfig?: IStaticPolicyInformationSourceConfig;\n}\n"]}

package/dist/es/policyArbiters/examplePolicyArbiter.js

@@ -0,0 +1,50 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+/**
+ * Example Policy Arbiter.
+ */
+export class ExamplePolicyArbiter {
+    /**
+     * The class name of the Example Policy Arbiter.
+     */
+    static CLASS_NAME = "ExamplePolicyArbiter";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of ExamplePolicyArbiter.
+     * @param options The options for the example policy arbiter.
+     */
+    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 ExamplePolicyArbiter.CLASS_NAME;
+    }
+    /**
+     * The policies supported by this arbiter.
+     * @returns The supported policies, if empty can be used for all.
+     */
+    supportedPolicies() {
+        return [];
+    }
+    /**
+     * 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.
+     */
+    async decide(locator, information, policies, data) {
+        return [];
+    }
+}
+//# sourceMappingURL=examplePolicyArbiter.js.map

package/dist/es/policyArbiters/examplePolicyArbiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"examplePolicyArbiter.js","sourceRoot":"","sources":["../../../src/policyArbiters/examplePolicyArbiter.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAYlD;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAAiD;QAC5D,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,iBAAiB;QACvB,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAClB,OAAuB,EACvB,WAAgC,EAChC,QAAwB,EACxB,IAAQ;QAER,OAAO,EAAE,CAAC;IACX,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 {\n\tIPolicyArbiter,\n\tIPolicyDecision,\n\tIPolicyInformation,\n\tIPolicyLocator\n} from \"@twin.org/rights-management-models\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { IExamplePolicyArbiterConstructorOptions } from \"../models/IExamplePolicyArbiterConstructorOptions.js\";\n\n/**\n * Example Policy Arbiter.\n */\nexport class ExamplePolicyArbiter implements IPolicyArbiter {\n\t/**\n\t * The class name of the Example Policy Arbiter.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ExamplePolicyArbiter>();\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 ExamplePolicyArbiter.\n\t * @param options The options for the example policy arbiter.\n\t */\n\tconstructor(options?: IExamplePolicyArbiterConstructorOptions) {\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 ExamplePolicyArbiter.CLASS_NAME;\n\t}\n\n\t/**\n\t * The policies supported by this arbiter.\n\t * @returns The supported policies, if empty can be used for all.\n\t */\n\tpublic supportedPolicies(): IPolicyLocator[] {\n\t\treturn [];\n\t}\n\n\t/**\n\t * Makes decisions regarding policy access to data.\n\t * @param locator The locator to find relevant policies.\n\t * @param information Information provided by the requester to determine if a policy can be created.\n\t * @param policies The policies that apply to the data.\n\t * @param data The data to make a decision on.\n\t * @returns The decisions about access to the data.\n\t */\n\tpublic async decide<D = unknown>(\n\t\tlocator: IPolicyLocator,\n\t\tinformation?: IPolicyInformation,\n\t\tpolicies?: IOdrlPolicy[],\n\t\tdata?: D\n\t): Promise<IPolicyDecision[]> {\n\t\treturn [];\n\t}\n}\n"]}

package/dist/es/policyEnforcementProcessor/examplePolicyEnforcementProcessor.js

@@ -0,0 +1,42 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+/**
+ * Example Policy Enforcement Processor.
+ */
+export class ExamplePolicyEnforcementProcessor {
+    /**
+     * The class name of the Example Policy Enforcement Processor.
+     */
+    static CLASS_NAME = "ExamplePolicyEnforcementProcessor";
+    /**
+     * The logging component.
+     * @internal
+     */
+    _logging;
+    /**
+     * Create a new instance of ExamplePolicyEnforcementProcessor.
+     * @param options The options for the example policy enforcement processor.
+     */
+    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 ExamplePolicyEnforcementProcessor.CLASS_NAME;
+    }
+    /**
+     * 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.
+     */
+    async process(locator, decisions, data) {
+        return data;
+    }
+}
+//# sourceMappingURL=examplePolicyEnforcementProcessor.js.map

package/dist/es/policyEnforcementProcessor/examplePolicyEnforcementProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"examplePolicyEnforcementProcessor.js","sourceRoot":"","sources":["../../../src/policyEnforcementProcessor/examplePolicyEnforcementProcessor.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAUlD;;GAEG;AACH,MAAM,OAAO,iCAAiC;IAC7C;;OAEG;IACI,MAAM,CAAU,UAAU,uCAAuD;IAExF;;;OAGG;IACc,QAAQ,CAAoB;IAE7C;;;OAGG;IACH,YAAY,OAA8D;QACzE,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CACnC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAC1C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,iCAAiC,CAAC,UAAU,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CACnB,OAAuB,EACvB,SAA4B,EAC5B,IAAQ;QAER,OAAO,IAAoB,CAAC;IAC7B,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 {\n\tIPolicyDecision,\n\tIPolicyEnforcementProcessor,\n\tIPolicyLocator\n} from \"@twin.org/rights-management-models\";\nimport type { IExamplePolicyEnforcementProcessorConstructorOptions } from \"../models/IExamplePolicyEnforcementProcessorConstructorOptions.js\";\n\n/**\n * Example Policy Enforcement Processor.\n */\nexport class ExamplePolicyEnforcementProcessor implements IPolicyEnforcementProcessor {\n\t/**\n\t * The class name of the Example Policy Enforcement Processor.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ExamplePolicyEnforcementProcessor>();\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 ExamplePolicyEnforcementProcessor.\n\t * @param options The options for the example policy enforcement processor.\n\t */\n\tconstructor(options?: IExamplePolicyEnforcementProcessorConstructorOptions) {\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 ExamplePolicyEnforcementProcessor.CLASS_NAME;\n\t}\n\n\t/**\n\t * Process the response from the policy decision point.\n\t * @param locator The locator to find relevant policies.\n\t * @param decisions The decisions made by the policy decision point.\n\t * @param data The data to process.\n\t * @returns The data after processing.\n\t */\n\tpublic async process<D = unknown, R = D>(\n\t\tlocator: IPolicyLocator,\n\t\tdecisions: IPolicyDecision[],\n\t\tdata?: D\n\t): Promise<R> {\n\t\treturn data as unknown as R;\n\t}\n}\n"]}