@twin.org/rights-management-plugins 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IPassThroughPolicyRequesterConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IPassThroughPolicyRequesterConstructorOptions
+
+Options for the Pass Through Policy Requester.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for policy requester.

package/docs/reference/interfaces/IStaticPolicyInformationSource.md

@@ -4,7 +4,7 @@ Configuration for the Static Policy Information Source Component.
 
 ## Properties
 
-### accessMode
+### accessMode {#accessmode}
 
 > **accessMode**: `PolicyInformationAccessMode`
 
@@ -12,17 +12,32 @@ Is the information public, if so it will be shared with negotiation requests.
 
 ***
 
-### matchLocators?
+### matchLocators? {#matchlocators}
 
-> `optional` **matchLocators**: `IPolicyLocator`[]
+> `optional` **matchLocators?**: `object`[]
 
 Information is only provided for the specified locator combination.
-If undefined is provided matches all resources.
+
+#### assignee?
+
+> `optional` **assignee?**: `string`
+
+#### assigner?
+
+> `optional` **assigner?**: `string`
+
+#### target?
+
+> `optional` **target?**: `string`
+
+#### action?
+
+> `optional` **action?**: `string`
 
 ***
 
-### objects
+### objects {#objects}
 
-> **objects**: `IJsonLdNodeObject`[]
+> **objects**: `IRightsManagementInformation`
 
 The objects containing the information.

package/docs/reference/interfaces/IStaticPolicyInformationSourceConfig.md

@@ -4,8 +4,8 @@ Configuration for the Static Policy Information Source Component.
 
 ## Properties
 
-### information?
+### information? {#information}
 
-> `optional` **information**: [`IStaticPolicyInformationSource`](IStaticPolicyInformationSource.md)[]
+> `optional` **information?**: [`IStaticPolicyInformationSource`](IStaticPolicyInformationSource.md)[]
 
 The information to return from the PIP.

package/docs/reference/interfaces/IStaticPolicyInformationSourceConstructorOptions.md

@@ -4,22 +4,16 @@ Options for the Static Policy Information Source Component.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The logging component for logging policy source.
 
-#### Default
-
-```ts
-logging
-```
-
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`IStaticPolicyInformationSourceConfig`](IStaticPolicyInformationSourceConfig.md)
+> `optional` **config?**: [`IStaticPolicyInformationSourceConfig`](IStaticPolicyInformationSourceConfig.md)
 
 The configuration.

package/locales/en.json

@@ -1,20 +1,79 @@
 {
 	"error": {
 		"identityPolicyInformationSource": {
-			"identityRetrievalFailed": "Failed to retrieve identity information for locator: \"{locator}\""
+			"identityRetrievalFailed": "Failed to retrieve identity \"{id}\" information for policy id: \"{policyId}\""
+		},
+		"identityProfilePolicyInformationSource": {
+			"profileRetrievalFailed": "Failed to retrieve identity profile \"{id}\" information for policy id: \"{policyId}\""
+		},
+		"defaultPolicyArbiter": {
+			"ruleTargetNotSupported": "Rule target \"{target}\" is not supported. Only twin:<object>:<jsonPath> targets are currently supported.",
+			"multipleTargetsNotSupported": "Multiple targets in a single permission are not supported.",
+			"circularInheritanceDetected": "Circular inheritance detected: policy \"{policyId}\" inherits from \"{inheritFromId}\" which creates a cycle.",
+			"logicalConstraintOperandNotUnique": "Logical constraint operand is not unique within the policy, each operand must be unique.",
+			"inheritedPolicyNotFound": "The inherited policy with id \"{inheritFromId}\" could not be found in the Policy Administration Point.",
+			"assetCollectionSourceNotSupported": "AssetCollection source \"{source}\" is not supported. It must be a twin:jsonPath target.",
+			"partyCollectionSourceNotSupported": "PartyCollection source \"{source}\" is not supported.",
+			"assetHasPolicyNotSupported": "Asset hasPolicy is not supported. Policies must be referenced through the agreement directly.",
+			"assetPartOfNotSupported": "Asset partOf is not supported. AssetCollection membership is resolved through the agreement directly.",
+			"partyAssignerOfNotSupported": "Party assignerOf is not supported. Assigner roles must be specified directly on individual rules or the agreement.",
+			"partyAssigneeOfNotSupported": "Party assigneeOf is not supported. Assignee roles must be specified directly on individual rules or the agreement.",
+			"partyPartOfNotSupported": "Party partOf is not supported. PartyCollection membership is resolved through the agreement directly.",
+			"noObligationEnforcersRegistered": "No Policy Obligation Enforcers are registered and they are required to enforce duties.",
+			"maxInheritanceDepthExceeded": "The maximum inheritance depth of {maxInheritanceDepth} has been exceeded when processing policy \"{policyId}\".",
+			"rightOperandReferenceNotSupported": "Constraint rightOperandReference is not supported. Use rightOperand with a typed JSONPath value instead.",
+			"constraintDataTypeNotSupported": "Constraint dataType is not supported. Value coercion based on dataType is not implemented.",
+			"constraintUnitNotSupported": "Constraint unit is not supported. Unit-aware comparison is not implemented.",
+			"constraintStatusNotSupported": "Constraint status is not supported. State-based evaluation is not implemented.",
+			"jsonPathExpressionMissing": "Canonical JSONPath expression is missing for \"{operand}\". Provide twin:jsonPathExpression.",
+			"policyProfileNotSupported": "Policy \"{policyId}\" declares unsupported profile \"{unsupportedProfile}\". Only known profiles are supported.",
+			"inheritedPolicyProfileNotSupported": "Inherited policy \"{policyId}\" declares an unsupported profile. All policies in the inheritFrom chain must declare only supported profiles.",
+			"leftOperandNotSupported": "Constraint leftOperand \"{leftOperand}\" is a recognised ODRL built-in but is not yet supported by this arbiter."
+		},
+		"defaultPolicyEnforcementProcessor": {
+			"targetNotJsonPath": "The policy decision target \"{target}\" is not a valid JSON-path string, it should be a minimum of $.",
+			"replaceValueMissing": "The policy decision replaceValue was not provided for target \"{target}\"."
 		}
 	},
 	"info": {
 		"identityPolicyInformationSource": {
-			"identityRetrieving": "Retrieving identity information for locator: \"{locator}\""
+			"identityRetrieving": "Retrieving identity \"{id}\" information for policy id: \"{policyId}\""
+		},
+		"identityProfilePolicyInformationSource": {
+			"profileRetrieving": "Retrieving identity profile \"{id}\" information for policy id: \"{policyId}\""
 		},
 		"staticPolicyInformationSource": {
-			"staticRetrieving": "Retrieving static policy information for locator \"{locator}\" with access mode: \"{accessMode}\"",
-			"staticRetrieved": "Retrieved static policy information for locator: \"{locator}\" with access mode: \"{accessMode}\", item count: {itemCount}"
+			"staticRetrieving": "Retrieving static policy information for policy id: \"{policyId}\" with access mode: \"{accessMode}\"",
+			"staticRetrieved": "Retrieved static policy information for policy id: \"{policyId}\" with access mode: \"{accessMode}\", item count: {itemCount}"
 		},
 		"loggingPolicyExecutionAction": {
-			"policyActionExecutedBefore": "Policy executed for locator: \"{locator}\", stage: \"{stage}\", data: \"{data}\", policies: \"{policies}\"",
-			"policyActionExecutedAfter": "Policy executed for locator: \"{locator}\", stage: \"{stage}\", data: \"{data}\", policies: \"{policies}\", decisions: \"{decisions}\""
+			"policyActionExecutedBefore": "Policy executed for policyId: \"{policyId}\", stage: \"{stage}\", data: \"{data}\", policy: \"{policy}\", decisions: \"{decisions}\"",
+			"policyActionExecutedAfter": "Policy executed for policyId: \"{policyId}\", stage: \"{stage}\", data: \"{data}\", policy: \"{policy}\", decisions: \"{decisions}\""
+		},
+		"passThroughPolicyEnforcementProcessor": {
+			"processingPolicy": "Processing policy enforcement for policy id: \"{policyId}\""
+		},
+		"defaultPolicyEnforcementProcessor": {
+			"processingPolicy": "Processing policy enforcement for policy id: \"{policyId}\""
+		},
+		"passThroughPolicyArbiter": {
+			"decidingPolicy": "Deciding policy for policy id: \"{policyId}\""
+		},
+		"defaultPolicyArbiter": {
+			"decidingPolicy": "Deciding policy for policy id: \"{policyId}\""
+		},
+		"passThroughPolicyNegotiator": {
+			"handlingOffer": "Handling offer negotiation for offer id: \"{offerId}\"",
+			"createAgreement": "Creating agreement for policy id: \"{offerId}\""
+		},
+		"passThroughPolicyRequester": {
+			"offer": "Logging offer request for offer id: \"{offerId}\", negotiation id: \"{negotiationId}\"",
+			"agreement": "Logging agreement request for agreement id: \"{agreementId}\", negotiation id: \"{negotiationId}\"",
+			"finalised": "Logging finalised request for negotiation id: \"{negotiationId}\"",
+			"terminated": "Logging terminated request for negotiation id: \"{negotiationId}\""
+		},
+		"passThroughPolicyObligationEnforcer": {
+			"enforcingDuty": "Enforcing duty for policy id: \"{policyId}\""
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/rights-management-plugins",
-	"version": "0.0.3-next.9",
-	"description": "Rights management plugin implementations",
+	"version": "0.9.0",
+	"description": "Plugin implementations for extending rights management behaviour across components.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/rights-management.git",
+		"url": "git+https://github.com/iotaledger/twin-rights-management.git",
 		"directory": "packages/rights-management-plugins"
 	},
 	"contributors": [
@@ -18,13 +18,16 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/context": "next",
-		"@twin.org/core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/logging-models": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/rights-management-models": "0.0.3-next.9",
-		"@twin.org/standards-w3c-odrl": "next"
+		"@twin.org/automation-models": "^0.9.0",
+		"@twin.org/context": "^0.9.0",
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/data-json-ld": "^0.9.0",
+		"@twin.org/data-json-path": "^0.9.0",
+		"@twin.org/identity-models": "^0.9.0-next.1",
+		"@twin.org/logging-models": "^0.9.0",
+		"@twin.org/nameof": "^0.9.0",
+		"@twin.org/rights-management-models": "^0.9.0",
+		"@twin.org/standards-w3c-odrl": "^0.9.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -51,7 +54,7 @@
 		"rights-management"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/rights-management/issues"
+		"url": "git+https://github.com/iotaledger/twin-rights-management/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/es/dataAccessHandlers/examplePolicyRequester.js

@@ -1,82 +0,0 @@
-// 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

@@ -1 +0,0 @@
-{"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/models/IExampleDataAccessHandlerConstructorOptions.js.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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/policyArbiters/examplePolicyArbiter.js

@@ -1,50 +0,0 @@
-// 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

@@ -1 +0,0 @@
-{"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

@@ -1,42 +0,0 @@
-// 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

@@ -1 +0,0 @@
-{"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"]}

package/dist/es/policyNegotiators/examplePolicyNegotiator.js

@@ -1,61 +0,0 @@
-// 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

@@ -1 +0,0 @@
-{"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

@@ -1,69 +0,0 @@
-// 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

@@ -1 +0,0 @@
-{"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"]}