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

package/docs/reference/classes/PassThroughPolicyObligationEnforcer.md

@@ -0,0 +1,109 @@
+# Class: PassThroughPolicyObligationEnforcer
+
+Pass Through Policy Obligation Enforcer.
+
+## Implements
+
+- `IPolicyObligationEnforcer`
+
+## Constructors
+
+### Constructor
+
+> **new PassThroughPolicyObligationEnforcer**(`options?`): `PassThroughPolicyObligationEnforcer`
+
+Create a new instance of Pass Through Policy Obligation Enforcer.
+
+#### Parameters
+
+##### options?
+
+[`IPassThroughPolicyObligationEnforcerConstructorOptions`](../interfaces/IPassThroughPolicyObligationEnforcerConstructorOptions.md)
+
+The options for the pass through policy obligation enforcer.
+
+#### Returns
+
+`PassThroughPolicyObligationEnforcer`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Pass Through Policy Obligation Enforcer.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyObligationEnforcer.className`
+
+***
+
+### enforce() {#enforce}
+
+> **enforce**\<`D`\>(`policy`, `duty`, `information?`, `data?`, `action?`): `Promise`\<`boolean`\>
+
+Enforces obligations regarding policy access to data.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### policy
+
+`IRightsManagementPolicy`
+
+The policy to evaluate.
+
+##### duty
+
+`IOdrlDuty`
+
+The duty to enforce.
+
+##### information?
+
+`IRightsManagementInformation`
+
+Information provided by the requester to determine if a policy can be created.
+
+##### data?
+
+`D`
+
+The data to make a decision on.
+
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the enforcer will evaluate all actions in the duty.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Whether the obligations were successfully enforced.
+
+#### Implementation of
+
+`IPolicyObligationEnforcer.enforce`

package/docs/reference/classes/{ExamplePolicyRequester.md → PassThroughPolicyRequester.md}

@@ -1,6 +1,6 @@
-# Class: ExamplePolicyRequester
+# Class: PassThroughPolicyRequester
 
-Example Policy Requester.
+Pass Through Policy Requester.
 
 ## Implements
 
@@ -10,33 +10,33 @@ Example Policy Requester.
 
 ### Constructor
 
-> **new ExamplePolicyRequester**(`options?`): `ExamplePolicyRequester`
+> **new PassThroughPolicyRequester**(`options?`): `PassThroughPolicyRequester`
 
-Create a new instance of ExamplePolicyRequester.
+Create a new instance of PassThroughPolicyRequester.
 
 #### Parameters
 
 ##### options?
 
-[`IExamplePolicyRequesterConstructorOptions`](../interfaces/IExamplePolicyRequesterConstructorOptions.md)
+[`IPassThroughPolicyRequesterConstructorOptions`](../interfaces/IPassThroughPolicyRequesterConstructorOptions.md)
 
-The options for the example policy Requester.
+The options for the pass through policy Requester.
 
 #### Returns
 
-`ExamplePolicyRequester`
+`PassThroughPolicyRequester`
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
-The class name of the Example Policy Requester.
+The class name of the Pass Through Policy Requester.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,29 +54,11 @@ The class name of the component.
 
 ***
 
-### requesterId()
-
-> **requesterId**(): `string`
-
-The unique id of the requester.
-
-#### Returns
-
-`string`
-
-The requester id.
-
-#### Implementation of
-
-`IPolicyRequester.requesterId`
-
-***
-
-### offer()
+### offer() {#offer}
 
 > **offer**(`negotiationId`, `offer`): `Promise`\<`boolean`\>
 
-A policy has been offered by a provider, let the requester know about it.
+A policy has been offered by a provider, let the request handler know about it.
 
 #### Parameters
 
@@ -88,7 +70,7 @@ The id of the negotiation.
 
 ##### offer
 
-`IOdrlOffer`
+`IDataspaceProtocolOffer`
 
 The offer sent by the provider.
 
@@ -104,11 +86,11 @@ True if the offer was accepted, false otherwise.
 
 ***
 
-### agreement()
+### agreement() {#agreement}
 
 > **agreement**(`negotiationId`, `agreement`): `Promise`\<`boolean`\>
 
-A policy agreement has been sent by a provider, let the requester know about it.
+A policy agreement has been sent by a provider, let the request handler know about it.
 
 #### Parameters
 
@@ -120,7 +102,7 @@ The id of the negotiation.
 
 ##### agreement
 
-`IOdrlAgreement`
+`IDataspaceProtocolAgreement`
 
 The agreement sent by the provider.
 
@@ -136,11 +118,11 @@ True if the agreement was accepted, false otherwise.
 
 ***
 
-### finalised()
+### finalised() {#finalised}
 
 > **finalised**(`negotiationId`): `Promise`\<`void`\>
 
-A policy finalisation has been sent by a provider, let the requester know about it.
+A policy finalisation has been sent by a provider, let the request handler know about it.
 
 #### Parameters
 
@@ -154,7 +136,7 @@ The id of the negotiation.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the finalisation has been processed.
 
 #### Implementation of
 
@@ -162,11 +144,11 @@ Nothing.
 
 ***
 
-### terminated()
+### terminated() {#terminated}
 
 > **terminated**(`negotiationId`): `Promise`\<`void`\>
 
-A policy termination has been sent by a provider, let the requester know about it.
+A policy termination has been sent by a provider, let the request handler know about it.
 
 #### Parameters
 
@@ -180,7 +162,7 @@ The id of the negotiation.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the termination has been processed.
 
 #### Implementation of
 

package/docs/reference/classes/StaticPolicyInformationSource.md

@@ -28,7 +28,7 @@ The options for the logging policy source.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ The class name of the Static Policy Information Source.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,9 +54,9 @@ The class name of the component.
 
 ***
 
-### retrieve()
+### retrieve() {#retrieve}
 
-> **retrieve**\<`D`\>(`locator`, `accessMode`, `policies`, `data?`): `Promise`\<`IJsonLdNodeObject`[] \| `undefined`\>
+> **retrieve**\<`D`\>(`policy`, `accessMode`, `data?`, `action?`): `Promise`\<`IRightsManagementInformation` \| `undefined`\>
 
 Retrieve information from the sources.
 
@@ -68,11 +68,11 @@ Retrieve information from the sources.
 
 #### Parameters
 
-##### locator
+##### policy
 
-`IPolicyLocator`
+`IRightsManagementPolicy` \| `undefined`
 
-The locator to find relevant policies.
+The policy to retrieve information for if available.
 
 ##### accessMode
 
@@ -80,21 +80,21 @@ The locator to find relevant policies.
 
 The access mode to use for the retrieval.
 
-##### policies
-
-`IOdrlPolicy`[]
-
-The policies that apply to the data.
-
 ##### data?
 
 `D`
 
 The data to process.
 
+##### action?
+
+`string`
+
+The action to get any additional information for.
+
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`[] \| `undefined`\>
+`Promise`\<`IRightsManagementInformation` \| `undefined`\>
 
 The objects containing relevant information or undefined if nothing relevant is found.
 
@@ -104,7 +104,7 @@ The objects containing relevant information or undefined if nothing relevant is
 
 ***
 
-### addInformation()
+### addInformation() {#addinformation}
 
 > **addInformation**(`info`): `void`
 

package/docs/reference/index.md

@@ -2,25 +2,35 @@
 
 ## Classes
 
-- [ExampleDataAccessHandler](classes/ExampleDataAccessHandler.md)
-- [ExamplePolicyArbiter](classes/ExamplePolicyArbiter.md)
-- [ExamplePolicyEnforcementProcessor](classes/ExamplePolicyEnforcementProcessor.md)
+- [DefaultPolicyArbiter](classes/DefaultPolicyArbiter.md)
+- [PassThroughPolicyArbiter](classes/PassThroughPolicyArbiter.md)
+- [DefaultPolicyEnforcementProcessor](classes/DefaultPolicyEnforcementProcessor.md)
+- [PassThroughPolicyEnforcementProcessor](classes/PassThroughPolicyEnforcementProcessor.md)
+- [AutomationPolicyExecutionAction](classes/AutomationPolicyExecutionAction.md)
 - [LoggingPolicyExecutionAction](classes/LoggingPolicyExecutionAction.md)
 - [IdentityPolicyInformationSource](classes/IdentityPolicyInformationSource.md)
+- [IdentityProfilePolicyInformationSource](classes/IdentityProfilePolicyInformationSource.md)
 - [StaticPolicyInformationSource](classes/StaticPolicyInformationSource.md)
-- [ExamplePolicyNegotiator](classes/ExamplePolicyNegotiator.md)
-- [ExamplePolicyRequester](classes/ExamplePolicyRequester.md)
+- [PassThroughPolicyNegotiator](classes/PassThroughPolicyNegotiator.md)
+- [PassThroughPolicyObligationEnforcer](classes/PassThroughPolicyObligationEnforcer.md)
+- [PassThroughPolicyRequester](classes/PassThroughPolicyRequester.md)
 
 ## Interfaces
 
-- [IExampleDataAccessHandlerConstructorOptions](interfaces/IExampleDataAccessHandlerConstructorOptions.md)
-- [IExamplePolicyArbiterConstructorOptions](interfaces/IExamplePolicyArbiterConstructorOptions.md)
-- [IExamplePolicyEnforcementProcessorConstructorOptions](interfaces/IExamplePolicyEnforcementProcessorConstructorOptions.md)
-- [IExamplePolicyNegotiatorConstructorOptions](interfaces/IExamplePolicyNegotiatorConstructorOptions.md)
-- [IExamplePolicyRequesterConstructorOptions](interfaces/IExamplePolicyRequesterConstructorOptions.md)
+- [IAutomationPolicyExecutionActionConfig](interfaces/IAutomationPolicyExecutionActionConfig.md)
+- [IAutomationPolicyExecutionActionConstructorOptions](interfaces/IAutomationPolicyExecutionActionConstructorOptions.md)
+- [IDefaultPolicyArbiterConfig](interfaces/IDefaultPolicyArbiterConfig.md)
+- [IDefaultPolicyArbiterConstructorOptions](interfaces/IDefaultPolicyArbiterConstructorOptions.md)
+- [IDefaultPolicyEnforcementProcessorConstructorOptions](interfaces/IDefaultPolicyEnforcementProcessorConstructorOptions.md)
 - [IIdentityPolicyInformationSourceConstructorOptions](interfaces/IIdentityPolicyInformationSourceConstructorOptions.md)
+- [IIdentityProfilePolicyInformationSourceConstructorOptions](interfaces/IIdentityProfilePolicyInformationSourceConstructorOptions.md)
 - [ILoggingPolicyExecutionActionConfig](interfaces/ILoggingPolicyExecutionActionConfig.md)
 - [ILoggingPolicyExecutionActionConstructorOptions](interfaces/ILoggingPolicyExecutionActionConstructorOptions.md)
+- [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)
 - [IStaticPolicyInformationSourceConstructorOptions](interfaces/IStaticPolicyInformationSourceConstructorOptions.md)

package/docs/reference/interfaces/IAutomationPolicyExecutionActionConfig.md

@@ -0,0 +1,11 @@
+# Interface: IAutomationPolicyExecutionActionConfig
+
+Options for the Automation Policy Execution Action Component.
+
+## Properties
+
+### triggerActions? {#triggeractions}
+
+> `optional` **triggerActions?**: `string`[]
+
+The policy decision stages to trigger the automation actions, if undefined defaults to "inform".

package/docs/reference/interfaces/IAutomationPolicyExecutionActionConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IAutomationPolicyExecutionActionConstructorOptions
+
+Options for the Automation Policy Execution Action.
+
+## Properties
+
+### automationComponentType? {#automationcomponenttype}
+
+> `optional` **automationComponentType?**: `string`
+
+The automation component for executing automation policies.
+
+#### Default
+
+```ts
+automation
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IAutomationPolicyExecutionActionConfig`](IAutomationPolicyExecutionActionConfig.md)
+
+The configuration for the automation policy execution.

package/docs/reference/interfaces/IDefaultPolicyArbiterConfig.md

@@ -0,0 +1,17 @@
+# Interface: IDefaultPolicyArbiterConfig
+
+Configuration for the Default Policy Arbiter.
+
+## Properties
+
+### maxInheritanceDepth? {#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,33 @@
+# Interface: IDefaultPolicyArbiterConstructorOptions
+
+Options for the Default Policy Arbiter.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for policy arbiter.
+
+***
+
+### policyAdministrationPointComponentType? {#policyadministrationpointcomponenttype}
+
+> `optional` **policyAdministrationPointComponentType?**: `string`
+
+The policy administration point component for retrieving inherited policies.
+
+#### Default
+
+```ts
+policy-administration-point
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IDefaultPolicyArbiterConfig`](IDefaultPolicyArbiterConfig.md)
+
+The configuration options for the default policy arbiter.

package/docs/reference/interfaces/IDefaultPolicyEnforcementProcessorConstructorOptions.md

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

package/docs/reference/interfaces/IIdentityPolicyInformationSourceConstructorOptions.md

@@ -4,23 +4,17 @@ Options for the Identity Policy Information Source Component.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The logging component for logging policy source.
 
-#### Default
-
-```ts
-logging
-```
-
 ***
 
-### identityResolverComponentType?
+### identityResolverComponentType? {#identityresolvercomponenttype}
 
-> `optional` **identityResolverComponentType**: `string`
+> `optional` **identityResolverComponentType?**: `string`
 
 The component for resolving identities.
 

package/docs/reference/interfaces/IIdentityProfilePolicyInformationSourceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IIdentityProfilePolicyInformationSourceConstructorOptions
+
+Options for the Identity Profile Policy Information Source Component.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for logging policy source.
+
+***
+
+### identityProfileComponentType? {#identityprofilecomponenttype}
+
+> `optional` **identityProfileComponentType?**: `string`
+
+The component for retrieving identity profiles.
+
+#### Default
+
+```ts
+identity-profile
+```

package/docs/reference/interfaces/ILoggingPolicyExecutionActionConfig.md

@@ -4,17 +4,17 @@ Options for the Logging Policy Execution Action Component.
 
 ## Properties
 
-### stages?
+### stages? {#stages}
 
-> `optional` **stages**: `PolicyDecisionStage`[]
+> `optional` **stages?**: `PolicyDecisionStage`[]
 
 The policy decision stages to log, if undefined defaults to all.
 
 ***
 
-### includeData?
+### includeData? {#includedata}
 
-> `optional` **includeData**: `boolean`
+> `optional` **includeData?**: `boolean`
 
 Whether to include the data in the log.
 
@@ -26,11 +26,11 @@ false
 
 ***
 
-### includePolicies?
+### includePolicy? {#includepolicy}
 
-> `optional` **includePolicies**: `boolean`
+> `optional` **includePolicy?**: `boolean`
 
-Whether to include the policies in the log.
+Whether to include the policy in the log.
 
 #### Default
 
@@ -40,9 +40,9 @@ false
 
 ***
 
-### includeDecisions?
+### includeDecisions? {#includedecisions}
 
-> `optional` **includeDecisions**: `boolean`
+> `optional` **includeDecisions?**: `boolean`
 
 Whether to include the decisions in the log.
 

package/docs/reference/interfaces/ILoggingPolicyExecutionActionConstructorOptions.md

@@ -4,22 +4,16 @@ Options for the Logging Policy Execution Action.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The logging component for logging policy execution.
 
-#### Default
-
-```ts
-logging
-```
-
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`ILoggingPolicyExecutionActionConfig`](ILoggingPolicyExecutionActionConfig.md)
+> `optional` **config?**: [`ILoggingPolicyExecutionActionConfig`](ILoggingPolicyExecutionActionConfig.md)
 
 The configuration for the logging policy execution.

package/docs/reference/interfaces/IPassThroughPolicyArbiterConstructorOptions.md

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

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/IPassThroughPolicyNegotiatorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IPassThroughPolicyNegotiatorConstructorOptions
+
+Options for the Pass Through Policy Negotiator.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for 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.