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

package/docs/reference/classes/LoggingPolicyExecutionAction.md

@@ -0,0 +1,127 @@
+# Class: LoggingPolicyExecutionAction
+
+Logging Policy Execution Action to send decisions to logging.
+
+## Implements
+
+- `IPolicyExecutionAction`
+
+## Constructors
+
+### Constructor
+
+> **new LoggingPolicyExecutionAction**(`options?`): `LoggingPolicyExecutionAction`
+
+Create a new instance of LoggingPolicyExecutionAction.
+
+#### Parameters
+
+##### options?
+
+[`ILoggingPolicyExecutionActionConstructorOptions`](../interfaces/ILoggingPolicyExecutionActionConstructorOptions.md)
+
+The options for the logging policy execution action.
+
+#### Returns
+
+`LoggingPolicyExecutionAction`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Logging Policy Execution Action.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyExecutionAction.className`
+
+***
+
+### supportedStages()
+
+> **supportedStages**(): `PolicyDecisionStage`[]
+
+Which stages should the action be executed at.
+
+#### Returns
+
+`PolicyDecisionStage`[]
+
+List of stages.
+
+#### Implementation of
+
+`IPolicyExecutionAction.supportedStages`
+
+***
+
+### execute()
+
+> **execute**\<`D`\>(`stage`, `locator`, `policies?`, `decisions?`, `data?`): `Promise`\<`void`\>
+
+Execute function type for policy actions.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### stage
+
+`PolicyDecisionStage`
+
+The stage of the policy decision.
+
+##### locator
+
+`IPolicyLocator`
+
+The locator to find relevant policies.
+
+##### policies?
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
+##### decisions?
+
+`IPolicyDecision`[]
+
+The decisions made by the PDP.
+
+##### data?
+
+`D`
+
+The data to process.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action is complete.
+
+#### Implementation of
+
+`IPolicyExecutionAction.execute`

package/docs/reference/classes/StaticPolicyInformationSource.md

@@ -0,0 +1,123 @@
+# Class: StaticPolicyInformationSource
+
+Policy information source which retrieves static information.
+
+## Implements
+
+- `IPolicyInformationSource`
+
+## Constructors
+
+### Constructor
+
+> **new StaticPolicyInformationSource**(`options?`): `StaticPolicyInformationSource`
+
+Create a new instance of StaticPolicyInformationSource.
+
+#### Parameters
+
+##### options?
+
+[`IStaticPolicyInformationSourceConstructorOptions`](../interfaces/IStaticPolicyInformationSourceConstructorOptions.md)
+
+The options for the logging policy source.
+
+#### Returns
+
+`StaticPolicyInformationSource`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Static Policy Information Source.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyInformationSource.className`
+
+***
+
+### retrieve()
+
+> **retrieve**\<`D`\>(`locator`, `accessMode`, `policies`, `data?`): `Promise`\<`IJsonLdNodeObject`[] \| `undefined`\>
+
+Retrieve information from the sources.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### locator
+
+`IPolicyLocator`
+
+The locator to find relevant policies.
+
+##### accessMode
+
+`PolicyInformationAccessMode`
+
+The access mode to use for the retrieval.
+
+##### policies
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
+##### data?
+
+`D`
+
+The data to process.
+
+#### Returns
+
+`Promise`\<`IJsonLdNodeObject`[] \| `undefined`\>
+
+The objects containing relevant information or undefined if nothing relevant is found.
+
+#### Implementation of
+
+`IPolicyInformationSource.retrieve`
+
+***
+
+### addInformation()
+
+> **addInformation**(`info`): `void`
+
+Add static policy information.
+
+#### Parameters
+
+##### info
+
+[`IStaticPolicyInformationSource`](../interfaces/IStaticPolicyInformationSource.md)
+
+The static policy information to add.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,26 @@
+# @twin.org/rights-management-plugins
+
+## Classes
+
+- [ExampleDataAccessHandler](classes/ExampleDataAccessHandler.md)
+- [ExamplePolicyArbiter](classes/ExamplePolicyArbiter.md)
+- [ExamplePolicyEnforcementProcessor](classes/ExamplePolicyEnforcementProcessor.md)
+- [LoggingPolicyExecutionAction](classes/LoggingPolicyExecutionAction.md)
+- [IdentityPolicyInformationSource](classes/IdentityPolicyInformationSource.md)
+- [StaticPolicyInformationSource](classes/StaticPolicyInformationSource.md)
+- [ExamplePolicyNegotiator](classes/ExamplePolicyNegotiator.md)
+- [ExamplePolicyRequester](classes/ExamplePolicyRequester.md)
+
+## Interfaces
+
+- [IExampleDataAccessHandlerConstructorOptions](interfaces/IExampleDataAccessHandlerConstructorOptions.md)
+- [IExamplePolicyArbiterConstructorOptions](interfaces/IExamplePolicyArbiterConstructorOptions.md)
+- [IExamplePolicyEnforcementProcessorConstructorOptions](interfaces/IExamplePolicyEnforcementProcessorConstructorOptions.md)
+- [IExamplePolicyNegotiatorConstructorOptions](interfaces/IExamplePolicyNegotiatorConstructorOptions.md)
+- [IExamplePolicyRequesterConstructorOptions](interfaces/IExamplePolicyRequesterConstructorOptions.md)
+- [IIdentityPolicyInformationSourceConstructorOptions](interfaces/IIdentityPolicyInformationSourceConstructorOptions.md)
+- [ILoggingPolicyExecutionActionConfig](interfaces/ILoggingPolicyExecutionActionConfig.md)
+- [ILoggingPolicyExecutionActionConstructorOptions](interfaces/ILoggingPolicyExecutionActionConstructorOptions.md)
+- [IStaticPolicyInformationSource](interfaces/IStaticPolicyInformationSource.md)
+- [IStaticPolicyInformationSourceConfig](interfaces/IStaticPolicyInformationSourceConfig.md)
+- [IStaticPolicyInformationSourceConstructorOptions](interfaces/IStaticPolicyInformationSourceConstructorOptions.md)

package/docs/reference/interfaces/IExampleDataAccessHandlerConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IExampleDataAccessHandlerConstructorOptions
+
+Options for the Example Data Access Handler.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for data access handler.
+
+#### Default
+
+```ts
+logging
+```

package/docs/reference/interfaces/IExamplePolicyArbiterConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IExamplePolicyArbiterConstructorOptions
+
+Options for the Example Policy Arbiter.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for policy arbiter.
+
+#### Default
+
+```ts
+logging
+```

package/docs/reference/interfaces/IExamplePolicyEnforcementProcessorConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IExamplePolicyEnforcementProcessorConstructorOptions
+
+Options for the Example Policy Enforcement Processor.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for policy enforcement processor.
+
+#### Default
+
+```ts
+logging
+```

package/docs/reference/interfaces/IExamplePolicyNegotiatorConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IExamplePolicyNegotiatorConstructorOptions
+
+Options for the Example Policy Negotiator.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for policy negotiator.
+
+#### Default
+
+```ts
+logging
+```

package/docs/reference/interfaces/IExamplePolicyRequesterConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IExamplePolicyRequesterConstructorOptions
+
+Options for the Example Policy Requester.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for policy requester.
+
+#### Default
+
+```ts
+logging
+```

package/docs/reference/interfaces/IIdentityPolicyInformationSourceConstructorOptions.md

@@ -0,0 +1,31 @@
+# Interface: IIdentityPolicyInformationSourceConstructorOptions
+
+Options for the Identity Policy Information Source Component.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for logging policy source.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### identityResolverComponentType?
+
+> `optional` **identityResolverComponentType**: `string`
+
+The component for resolving identities.
+
+#### Default
+
+```ts
+identity-resolver
+```

package/docs/reference/interfaces/ILoggingPolicyExecutionActionConfig.md

@@ -0,0 +1,53 @@
+# Interface: ILoggingPolicyExecutionActionConfig
+
+Options for the Logging Policy Execution Action Component.
+
+## Properties
+
+### stages?
+
+> `optional` **stages**: `PolicyDecisionStage`[]
+
+The policy decision stages to log, if undefined defaults to all.
+
+***
+
+### includeData?
+
+> `optional` **includeData**: `boolean`
+
+Whether to include the data in the log.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### includePolicies?
+
+> `optional` **includePolicies**: `boolean`
+
+Whether to include the policies in the log.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### includeDecisions?
+
+> `optional` **includeDecisions**: `boolean`
+
+Whether to include the decisions in the log.
+
+#### Default
+
+```ts
+false
+```

package/docs/reference/interfaces/ILoggingPolicyExecutionActionConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: ILoggingPolicyExecutionActionConstructorOptions
+
+Options for the Logging Policy Execution Action.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component for logging policy execution.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`ILoggingPolicyExecutionActionConfig`](ILoggingPolicyExecutionActionConfig.md)
+
+The configuration for the logging policy execution.

package/docs/reference/interfaces/IStaticPolicyInformationSource.md

@@ -0,0 +1,28 @@
+# Interface: IStaticPolicyInformationSource
+
+Configuration for the Static Policy Information Source Component.
+
+## Properties
+
+### accessMode
+
+> **accessMode**: `PolicyInformationAccessMode`
+
+Is the information public, if so it will be shared with negotiation requests.
+
+***
+
+### matchLocators?
+
+> `optional` **matchLocators**: `IPolicyLocator`[]
+
+Information is only provided for the specified locator combination.
+If undefined is provided matches all resources.
+
+***
+
+### objects
+
+> **objects**: `IJsonLdNodeObject`[]
+
+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?
+
+> `optional` **information**: [`IStaticPolicyInformationSource`](IStaticPolicyInformationSource.md)[]
+
+The information to return from the PIP.

package/docs/reference/interfaces/IStaticPolicyInformationSourceConstructorOptions.md

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

package/locales/en.json

@@ -0,0 +1,20 @@
+{
+	"error": {
+		"identityPolicyInformationSource": {
+			"identityRetrievalFailed": "Failed to retrieve identity information for locator: \"{locator}\""
+		}
+	},
+	"info": {
+		"identityPolicyInformationSource": {
+			"identityRetrieving": "Retrieving identity information for locator: \"{locator}\""
+		},
+		"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}"
+		},
+		"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}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+	"name": "@twin.org/rights-management-plugins",
+	"version": "0.0.3-next.4",
+	"description": "Rights management plugin implementations",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/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": ">=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.4",
+		"@twin.org/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/twinfoundation/rights-management/issues"
+	},
+	"homepage": "https://twindev.org"
+}