@3sixty/rights-management-plugins 0.0.0-stage → 0.20.0-next.1

package/docs/reference/interfaces/IPassThroughPolicyEnforcementProcessorConstructorOptions.md

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

package/docs/reference/interfaces/IPassThroughPolicyNegotiatorConfig.md

@@ -0,0 +1,11 @@
+# Interface: IPassThroughPolicyNegotiatorConfig
+
+Configuration for the Pass Through Policy Negotiator.
+
+## Properties
+
+### directAgreement? {#directagreement}
+
+> `optional` **directAgreement?**: `boolean`
+
+Signal directAgreement (skip OFFERED/ACCEPTED) on handleOffer(); default true. Set false to keep the full negotiation cycle, e.g. during a staged rollout where counterparties may not yet accept a direct REQUESTED -> AGREED transition.

package/docs/reference/interfaces/IPassThroughPolicyNegotiatorConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IPassThroughPolicyNegotiatorConstructorOptions
+
+Options for the Pass Through Policy Negotiator.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for policy negotiator.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IPassThroughPolicyNegotiatorConfig`](IPassThroughPolicyNegotiatorConfig.md)
+
+The configuration options for the pass through policy negotiator.

package/docs/reference/interfaces/IPassThroughPolicyObligationEnforcerConstructorOptions.md

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

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

@@ -0,0 +1,43 @@
+# Interface: IStaticPolicyInformationSource
+
+Configuration for the Static Policy Information Source Component.
+
+## Properties
+
+### accessMode {#accessmode}
+
+> **accessMode**: `PolicyInformationAccessMode`
+
+Is the information public, if so it will be shared with negotiation requests.
+
+***
+
+### matchLocators? {#matchlocators}
+
+> `optional` **matchLocators?**: `object`[]
+
+Information is only provided for the specified locator combination.
+
+#### assignee?
+
+> `optional` **assignee?**: `string`
+
+#### assigner?
+
+> `optional` **assigner?**: `string`
+
+#### target?
+
+> `optional` **target?**: `string`
+
+#### action?
+
+> `optional` **action?**: `string`
+
+***
+
+### objects {#objects}
+
+> **objects**: `IRightsManagementInformation`
+
+The objects containing the information.

package/docs/reference/interfaces/IStaticPolicyInformationSourceConfig.md

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

package/docs/reference/interfaces/IStaticPolicyInformationSourceConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IStaticPolicyInformationSourceConstructorOptions
+
+Options for the Static Policy Information Source Component.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for logging policy source.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IStaticPolicyInformationSourceConfig`](IStaticPolicyInformationSourceConfig.md)
+
+The configuration.

package/locales/en.json

@@ -0,0 +1,79 @@
+{
+	"error": {
+		"identityPolicyInformationSource": {
+			"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 \"{id}\" information for policy id: \"{policyId}\""
+		},
+		"identityProfilePolicyInformationSource": {
+			"profileRetrieving": "Retrieving identity profile \"{id}\" information for policy id: \"{policyId}\""
+		},
+		"staticPolicyInformationSource": {
+			"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 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,6 +1,61 @@
 {
-  "name": "@3sixty/rights-management-plugins",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/rights-management-plugins",
+	"version": "0.20.0-next.1",
+	"description": "Plugin implementations for extending rights management behaviour across components.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/rights-management.git",
+		"directory": "packages/rights-management-plugins"
+	},
+	"contributors": [
+		"cornel.filip@iota.org",
+		"adrian.sanchez.sequeira@iota.org",
+		"martyn.janes@iota.org"
+	],
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/automation-models": "next",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/data-json-ld": "next",
+		"@3sixty/data-json-path": "next",
+		"@3sixty/identity-models": "next",
+		"@3sixty/logging-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/rights-management-models": "0.20.0-next.1",
+		"@3sixty/standards-dataspace-protocol": "next",
+		"@3sixty/standards-w3c-odrl": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"rights-management"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/rights-management/issues"
+	},
+	"homepage": "https://3sixty.global"
+}