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

package/docs/reference/classes/IdentityPolicyInformationSource.md

@@ -0,0 +1,103 @@
+# Class: IdentityPolicyInformationSource
+
+Policy information source which retrieves the identity information.
+
+## Implements
+
+- `IPolicyInformationSource`
+
+## Constructors
+
+### Constructor
+
+> **new IdentityPolicyInformationSource**(`options?`): `IdentityPolicyInformationSource`
+
+Create a new instance of IdentityPolicyInformationSource.
+
+#### Parameters
+
+##### options?
+
+[`IIdentityPolicyInformationSourceConstructorOptions`](../interfaces/IIdentityPolicyInformationSourceConstructorOptions.md)
+
+The options for the logging policy source.
+
+#### Returns
+
+`IdentityPolicyInformationSource`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Identity 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/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

@@ -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 {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Logging Policy Execution Action.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyExecutionAction.className`
+
+***
+
+### supportedStages() {#supportedstages}
+
+> **supportedStages**(): `PolicyDecisionStage`[]
+
+Which stages should the action be executed at.
+
+#### Returns
+
+`PolicyDecisionStage`[]
+
+List of stages.
+
+#### Implementation of
+
+`IPolicyExecutionAction.supportedStages`
+
+***
+
+### execute() {#execute}
+
+> **execute**\<`D`\>(`policy`, `decisions`, `data`, `action`, `stage`): `Promise`\<`void`\>
+
+Execute function type for policy actions.
+
+#### Type Parameters
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### policy
+
+`IRightsManagementPolicy`
+
+The policy that applied to the data.
+
+##### decisions
+
+`IPolicyDecision`[]
+
+The decisions made by the PDP.
+
+##### data
+
+`D` \| `undefined`
+
+The data to process.
+
+##### action
+
+`string` \| `undefined`
+
+Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
+
+##### stage
+
+`PolicyDecisionStage`
+
+The stage of the policy decision.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the action is complete.
+
+#### Implementation of
+
+`IPolicyExecutionAction.execute`

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

@@ -0,0 +1,149 @@
+# Class: PassThroughPolicyNegotiator
+
+Pass Through Policy Negotiator.
+
+## Implements
+
+- `IPolicyNegotiator`
+
+## Constructors
+
+### Constructor
+
+> **new PassThroughPolicyNegotiator**(`options?`): `PassThroughPolicyNegotiator`
+
+Create a new instance of PassThroughPolicyNegotiator.
+
+#### Parameters
+
+##### options?
+
+[`IPassThroughPolicyNegotiatorConstructorOptions`](../interfaces/IPassThroughPolicyNegotiatorConstructorOptions.md)
+
+The options for the pass through policy negotiator.
+
+#### Returns
+
+`PassThroughPolicyNegotiator`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Pass Through Policy Negotiator.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyNegotiator.className`
+
+***
+
+### supportsOffer() {#supportsoffer}
+
+> **supportsOffer**(`offer`): `boolean`
+
+Determines if the negotiator supports the given offer.
+
+#### Parameters
+
+##### offer
+
+`IDataspaceProtocolOffer`
+
+The offer to check.
+
+#### Returns
+
+`boolean`
+
+True if the negotiator supports the given offer.
+
+#### Implementation of
+
+`IPolicyNegotiator.supportsOffer`
+
+***
+
+### handleOffer() {#handleoffer}
+
+> **handleOffer**(`offer`, `information?`): `Promise`\<\{ `accepted`: `boolean`; `interventionRequired`: `boolean`; `directAgreement?`: `boolean`; \}\>
+
+Handle the offer.
+
+#### Parameters
+
+##### offer
+
+`IDataspaceProtocolOffer`
+
+The offer to check.
+
+##### information?
+
+`IRightsManagementInformation`
+
+Information provided by the requester to determine if a policy can be created.
+
+#### Returns
+
+`Promise`\<\{ `accepted`: `boolean`; `interventionRequired`: `boolean`; `directAgreement?`: `boolean`; \}\>
+
+Sets the accepted flag if it can be offered, the interventionRequired flag if manual agreement is needed, and directAgreement per the constructor's directAgreement option (default true).
+
+#### Implementation of
+
+`IPolicyNegotiator.handleOffer`
+
+***
+
+### createAgreement() {#createagreement}
+
+> **createAgreement**(`offer`, `assignee`, `information?`): `Promise`\<`IDataspaceProtocolAgreement` \| `undefined`\>
+
+Create an agreement based on the offer.
+
+#### Parameters
+
+##### offer
+
+`IDataspaceProtocolOffer`
+
+The offer to create the agreement from.
+
+##### assignee
+
+`string` \| `IOdrlParty`
+
+The assignee of the agreement.
+
+##### information?
+
+`IRightsManagementInformation`
+
+Information provided by the requester to aid in the creation of the agreement.
+
+#### Returns
+
+`Promise`\<`IDataspaceProtocolAgreement` \| `undefined`\>
+
+The agreement created from the offer or undefined if an agreement could not be created.
+
+#### Implementation of
+
+`IPolicyNegotiator.createAgreement`