@twin.org/rights-management-plugins 0.0.3-next.13 → 0.0.3-next.14

package/docs/reference/index.md

@@ -2,6 +2,7 @@
 
 ## Classes
 
+- [DefaultPolicyArbiter](classes/DefaultPolicyArbiter.md)
 - [PassThroughPolicyArbiter](classes/PassThroughPolicyArbiter.md)
 - [DefaultPolicyEnforcementProcessor](classes/DefaultPolicyEnforcementProcessor.md)
 - [PassThroughPolicyEnforcementProcessor](classes/PassThroughPolicyEnforcementProcessor.md)
@@ -9,10 +10,13 @@
 - [IdentityPolicyInformationSource](classes/IdentityPolicyInformationSource.md)
 - [StaticPolicyInformationSource](classes/StaticPolicyInformationSource.md)
 - [PassThroughPolicyNegotiator](classes/PassThroughPolicyNegotiator.md)
+- [PassThroughPolicyObligationEnforcer](classes/PassThroughPolicyObligationEnforcer.md)
 - [PassThroughPolicyRequester](classes/PassThroughPolicyRequester.md)
 
 ## Interfaces
 
+- [IDefaultPolicyArbiterConfig](interfaces/IDefaultPolicyArbiterConfig.md)
+- [IDefaultPolicyArbiterConstructorOptions](interfaces/IDefaultPolicyArbiterConstructorOptions.md)
 - [IDefaultPolicyEnforcementProcessorConstructorOptions](interfaces/IDefaultPolicyEnforcementProcessorConstructorOptions.md)
 - [IIdentityPolicyInformationSourceConstructorOptions](interfaces/IIdentityPolicyInformationSourceConstructorOptions.md)
 - [ILoggingPolicyExecutionActionConfig](interfaces/ILoggingPolicyExecutionActionConfig.md)
@@ -20,6 +24,7 @@
 - [IPassThroughPolicyArbiterConstructorOptions](interfaces/IPassThroughPolicyArbiterConstructorOptions.md)
 - [IPassThroughPolicyEnforcementProcessorConstructorOptions](interfaces/IPassThroughPolicyEnforcementProcessorConstructorOptions.md)
 - [IPassThroughPolicyNegotiatorConstructorOptions](interfaces/IPassThroughPolicyNegotiatorConstructorOptions.md)
+- [IPassThroughPolicyObligationEnforcerConstructorOptions](interfaces/IPassThroughPolicyObligationEnforcerConstructorOptions.md)
 - [IPassThroughPolicyRequesterConstructorOptions](interfaces/IPassThroughPolicyRequesterConstructorOptions.md)
 - [IStaticPolicyInformationSource](interfaces/IStaticPolicyInformationSource.md)
 - [IStaticPolicyInformationSourceConfig](interfaces/IStaticPolicyInformationSourceConfig.md)

package/docs/reference/interfaces/IDefaultPolicyArbiterConfig.md

@@ -0,0 +1,17 @@
+# Interface: IDefaultPolicyArbiterConfig
+
+Configuration for the Default Policy Arbiter.
+
+## Properties
+
+### maxInheritanceDepth?
+
+> `optional` **maxInheritanceDepth**: `number`
+
+The maximum depth to traverse when resolving inherited policies.
+
+#### Default
+
+```ts
+10
+```

package/docs/reference/interfaces/IDefaultPolicyArbiterConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: IDefaultPolicyArbiterConstructorOptions
+
+Options for the Default Policy Arbiter.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for policy arbiter.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### policyAdministrationPointComponentType?
+
+> `optional` **policyAdministrationPointComponentType**: `string`
+
+The policy administration point component for retrieving inherited policies.
+
+#### Default
+
+```ts
+policy-administration-point
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IDefaultPolicyArbiterConfig`](IDefaultPolicyArbiterConfig.md)
+
+The configuration options for the default policy arbiter.

package/docs/reference/interfaces/IPassThroughPolicyObligationEnforcerConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IPassThroughPolicyObligationEnforcerConstructorOptions
+
+Options for the Pass Through Policy Obligation Enforcer.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for the policy obligation enforcer.
+
+#### Default
+
+```ts
+logging
+```

package/locales/en.json

@@ -3,6 +3,16 @@
 		"identityPolicyInformationSource": {
 			"identityRetrievalFailed": "Failed to retrieve identity \"{id}\" information for policy id: \"{policyId}\""
 		},
+		"defaultPolicyArbiter": {
+			"jsonPathOperandMissingTarget": "The operand \"{operand}\" is missing a JSONPath target after the twin:jsonpath: prefix.",
+			"informationTargetMissing": "The permission target references information key \"{key}\" but it does not exist.",
+			"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.",
+			"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}\"."
+		},
 		"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}\"."
@@ -29,6 +39,9 @@
 		"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}\""
@@ -38,6 +51,9 @@
 			"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,6 +1,6 @@
 {
 	"name": "@twin.org/rights-management-plugins",
-	"version": "0.0.3-next.13",
+	"version": "0.0.3-next.14",
 	"description": "Rights management plugin implementations",
 	"repository": {
 		"type": "git",
@@ -24,7 +24,7 @@
 		"@twin.org/data-json-path": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/rights-management-models": "0.0.3-next.13",
+		"@twin.org/rights-management-models": "0.0.3-next.14",
 		"@twin.org/standards-w3c-odrl": "next"
 	},
 	"main": "./dist/es/index.js",