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

package/docs/reference/classes/IdentityPolicyInformationSource.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 Identity 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 that was evaluated.
+
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`[] \| `undefined`\>
+`Promise`\<`IRightsManagementInformation` \| `undefined`\>
 
 The objects containing relevant information or undefined if nothing relevant is found.
 

package/docs/reference/classes/IdentityProfilePolicyInformationSource.md

@@ -0,0 +1,103 @@
+# Class: IdentityProfilePolicyInformationSource
+
+Policy information source which retrieves identity profile information.
+
+## Implements
+
+- `IPolicyInformationSource`
+
+## Constructors
+
+### Constructor
+
+> **new IdentityProfilePolicyInformationSource**(`options?`): `IdentityProfilePolicyInformationSource`
+
+Create a new instance of IdentityProfilePolicyInformationSource.
+
+#### Parameters
+
+##### options?
+
+[`IIdentityProfilePolicyInformationSourceConstructorOptions`](../interfaces/IIdentityProfilePolicyInformationSourceConstructorOptions.md)
+
+The options for the identity profile policy source.
+
+#### Returns
+
+`IdentityProfilePolicyInformationSource`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Identity Profile Policy Information Source.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyInformationSource.className`
+
+***
+
+### retrieve() {#retrieve}
+
+> **retrieve**\<`D`\>(`policy`, `accessMode`, `data?`, `action?`): `Promise`\<`IRightsManagementInformation` \| `undefined`\>
+
+Retrieve information from the sources.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### policy
+
+`IRightsManagementPolicy` \| `undefined`
+
+The policy to retrieve information for if available.
+
+##### accessMode
+
+`PolicyInformationAccessMode`
+
+The access mode to use for the retrieval.
+
+##### data?
+
+`D`
+
+The data to process.
+
+##### action?
+
+`string`
+
+The action that was evaluated.
+
+#### Returns
+
+`Promise`\<`IRightsManagementInformation` \| `undefined`\>
+
+The objects containing relevant information or undefined if nothing relevant is found.
+
+#### Implementation of
+
+`IPolicyInformationSource.retrieve`

package/docs/reference/classes/LoggingPolicyExecutionAction.md

@@ -28,7 +28,7 @@ The options for the logging policy execution action.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ The class name of the Logging Policy Execution Action.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### supportedStages()
+### supportedStages() {#supportedstages}
 
 > **supportedStages**(): `PolicyDecisionStage`[]
 
@@ -72,9 +72,9 @@ List of stages.
 
 ***
 
-### execute()
+### execute() {#execute}
 
-> **execute**\<`D`\>(`stage`, `locator`, `policies?`, `decisions?`, `data?`): `Promise`\<`void`\>
+> **execute**\<`D`\>(`policy`, `decisions`, `data`, `action`, `stage`): `Promise`\<`void`\>
 
 Execute function type for policy actions.
 
@@ -86,35 +86,35 @@ Execute function type for policy actions.
 
 #### Parameters
 
-##### stage
+##### policy
 
-`PolicyDecisionStage`
+`IRightsManagementPolicy`
 
-The stage of the policy decision.
+The policy that applied to the data.
 
-##### locator
+##### decisions
 
-`IPolicyLocator`
+`IPolicyDecision`[]
 
-The locator to find relevant policies.
+The decisions made by the PDP.
 
-##### policies?
+##### data
 
-`IOdrlPolicy`[]
+`D` \| `undefined`
 
-The policies that apply to the data.
+The data to process.
 
-##### decisions?
+##### action
 
-`IPolicyDecision`[]
+`string` \| `undefined`
 
-The decisions made by the PDP.
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
 
-##### data?
+##### stage
 
-`D`
+`PolicyDecisionStage`
 
-The data to process.
+The stage of the policy decision.
 
 #### Returns
 

package/docs/reference/classes/PassThroughPolicyArbiter.md

@@ -0,0 +1,103 @@
+# Class: PassThroughPolicyArbiter
+
+Pass Through Policy Arbiter.
+
+## Implements
+
+- `IPolicyArbiter`
+
+## Constructors
+
+### Constructor
+
+> **new PassThroughPolicyArbiter**(`options?`): `PassThroughPolicyArbiter`
+
+Create a new instance of PassThroughPolicyArbiter.
+
+#### Parameters
+
+##### options?
+
+[`IPassThroughPolicyArbiterConstructorOptions`](../interfaces/IPassThroughPolicyArbiterConstructorOptions.md)
+
+The options for the pass through policy arbiter.
+
+#### Returns
+
+`PassThroughPolicyArbiter`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Pass Through Policy Arbiter.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyArbiter.className`
+
+***
+
+### decide() {#decide}
+
+> **decide**\<`D`\>(`agreement`, `information?`, `data?`, `action?`): `Promise`\<`IPolicyDecision`[]\>
+
+Makes decisions regarding policy access to data.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### agreement
+
+`IDataspaceProtocolAgreement`
+
+The agreement to evaluate.
+
+##### 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 arbiter will evaluate all actions in the agreement.
+
+#### Returns
+
+`Promise`\<`IPolicyDecision`[]\>
+
+The decisions about access to the data.
+
+#### Implementation of
+
+`IPolicyArbiter.decide`

package/docs/reference/classes/PassThroughPolicyEnforcementProcessor.md

@@ -0,0 +1,107 @@
+# Class: PassThroughPolicyEnforcementProcessor
+
+Pass Through Policy Enforcement Processor.
+
+## Implements
+
+- `IPolicyEnforcementProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new PassThroughPolicyEnforcementProcessor**(`options?`): `PassThroughPolicyEnforcementProcessor`
+
+Create a new instance of PassThroughPolicyEnforcementProcessor.
+
+#### Parameters
+
+##### options?
+
+[`IPassThroughPolicyEnforcementProcessorConstructorOptions`](../interfaces/IPassThroughPolicyEnforcementProcessorConstructorOptions.md)
+
+The options for the pass through policy enforcement processor.
+
+#### Returns
+
+`PassThroughPolicyEnforcementProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Pass Through Policy Enforcement Processor.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyEnforcementProcessor.className`
+
+***
+
+### process() {#process}
+
+> **process**\<`D`, `R`\>(`agreement`, `decisions`, `data?`, `action?`): `Promise`\<`R`\>
+
+Process the response from the policy decision point.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+##### R
+
+`R` = `D`
+
+#### Parameters
+
+##### agreement
+
+`IDataspaceProtocolAgreement`
+
+The agreement to process.
+
+##### decisions
+
+`IPolicyDecision`[]
+
+The decisions made by the policy decision point.
+
+##### data?
+
+`D`
+
+The data to process.
+
+##### action?
+
+`string`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
+#### Returns
+
+`Promise`\<`R`\>
+
+The data after processing.
+
+#### Implementation of
+
+`IPolicyEnforcementProcessor.process`

package/docs/reference/classes/{ExamplePolicyNegotiator.md → PassThroughPolicyNegotiator.md}

@@ -1,6 +1,6 @@
-# Class: ExamplePolicyNegotiator
+# Class: PassThroughPolicyNegotiator
 
-Example Policy Negotiator.
+Pass Through Policy Negotiator.
 
 ## Implements
 
@@ -10,33 +10,33 @@ Example Policy Negotiator.
 
 ### Constructor
 
-> **new ExamplePolicyNegotiator**(`options?`): `ExamplePolicyNegotiator`
+> **new PassThroughPolicyNegotiator**(`options?`): `PassThroughPolicyNegotiator`
 
-Create a new instance of ExamplePolicyNegotiator.
+Create a new instance of PassThroughPolicyNegotiator.
 
 #### Parameters
 
 ##### options?
 
-[`IExamplePolicyNegotiatorConstructorOptions`](../interfaces/IExamplePolicyNegotiatorConstructorOptions.md)
+[`IPassThroughPolicyNegotiatorConstructorOptions`](../interfaces/IPassThroughPolicyNegotiatorConstructorOptions.md)
 
-The options for the example policy negotiator.
+The options for the pass through policy negotiator.
 
 #### Returns
 
-`ExamplePolicyNegotiator`
+`PassThroughPolicyNegotiator`
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
-The class name of the Example Policy Negotiator.
+The class name of the Pass Through Policy Negotiator.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### supportsOffer()
+### supportsOffer() {#supportsoffer}
 
 > **supportsOffer**(`offer`): `boolean`
 
@@ -64,7 +64,7 @@ Determines if the negotiator supports the given offer.
 
 ##### offer
 
-`IOdrlOffer`
+`IDataspaceProtocolOffer`
 
 The offer to check.
 
@@ -72,7 +72,7 @@ The offer to check.
 
 `boolean`
 
-Sets the supports flag if it can be offered, and the interventionRequired flag if manual agreement is needed.
+True if the negotiator supports the given offer.
 
 #### Implementation of
 
@@ -80,7 +80,7 @@ Sets the supports flag if it can be offered, and the interventionRequired flag i
 
 ***
 
-### handleOffer()
+### handleOffer() {#handleoffer}
 
 > **handleOffer**(`offer`, `information?`): `Promise`\<\{ `accepted`: `boolean`; `interventionRequired`: `boolean`; \}\>
 
@@ -90,13 +90,13 @@ Handle the offer.
 
 ##### offer
 
-`IOdrlOffer`
+`IDataspaceProtocolOffer`
 
 The offer to check.
 
 ##### information?
 
-`IPolicyInformation`
+`IRightsManagementInformation`
 
 Information provided by the requester to determine if a policy can be created.
 
@@ -112,9 +112,9 @@ Sets the accepted flag if it can be offered, and the interventionRequired flag i
 
 ***
 
-### createAgreement()
+### createAgreement() {#createagreement}
 
-> **createAgreement**(`offer`, `information?`): `Promise`\<`IOdrlAgreement` \| `undefined`\>
+> **createAgreement**(`offer`, `assignee`, `information?`): `Promise`\<`IDataspaceProtocolAgreement` \| `undefined`\>
 
 Create an agreement based on the offer.
 
@@ -122,19 +122,25 @@ Create an agreement based on the offer.
 
 ##### offer
 
-`IOdrlOffer`
+`IDataspaceProtocolOffer`
 
 The offer to create the agreement from.
 
+##### assignee
+
+`string` \| `IOdrlParty`
+
+The assignee of the agreement.
+
 ##### information?
 
-`IPolicyInformation`
+`IRightsManagementInformation`
 
 Information provided by the requester to aid in the creation of the agreement.
 
 #### Returns
 
-`Promise`\<`IOdrlAgreement` \| `undefined`\>
+`Promise`\<`IDataspaceProtocolAgreement` \| `undefined`\>
 
 The agreement created from the offer or undefined if an agreement could not be created.