@3sixty/rights-management-plugins 0.0.0-stage → 0.20.0-next.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/PassThroughPolicyRequester.md

@@ -0,0 +1,169 @@
+# Class: PassThroughPolicyRequester
+
+Pass Through Policy Requester.
+
+## Implements
+
+- `IPolicyRequester`
+
+## Constructors
+
+### Constructor
+
+> **new PassThroughPolicyRequester**(`options?`): `PassThroughPolicyRequester`
+
+Create a new instance of PassThroughPolicyRequester.
+
+#### Parameters
+
+##### options?
+
+[`IPassThroughPolicyRequesterConstructorOptions`](../interfaces/IPassThroughPolicyRequesterConstructorOptions.md)
+
+The options for the pass through policy Requester.
+
+#### Returns
+
+`PassThroughPolicyRequester`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Pass Through Policy Requester.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyRequester.className`
+
+***
+
+### offer() {#offer}
+
+> **offer**(`negotiationId`, `offer`): `Promise`\<`boolean`\>
+
+A policy has been offered by a provider, let the request handler know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+##### offer
+
+`IDataspaceProtocolOffer`
+
+The offer sent by the provider.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the offer was accepted, false otherwise.
+
+#### Implementation of
+
+`IPolicyRequester.offer`
+
+***
+
+### agreement() {#agreement}
+
+> **agreement**(`negotiationId`, `agreement`): `Promise`\<`boolean`\>
+
+A policy agreement has been sent by a provider, let the request handler know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+##### agreement
+
+`IDataspaceProtocolAgreement`
+
+The agreement sent by the provider.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the agreement was accepted, false otherwise.
+
+#### Implementation of
+
+`IPolicyRequester.agreement`
+
+***
+
+### finalised() {#finalised}
+
+> **finalised**(`negotiationId`): `Promise`\<`void`\>
+
+A policy finalisation has been sent by a provider, let the request handler know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the finalisation has been processed.
+
+#### Implementation of
+
+`IPolicyRequester.finalised`
+
+***
+
+### terminated() {#terminated}
+
+> **terminated**(`negotiationId`): `Promise`\<`void`\>
+
+A policy termination has been sent by a provider, let the request handler know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the termination has been processed.
+
+#### Implementation of
+
+`IPolicyRequester.terminated`

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 {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Static 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 to get any additional information for.
+
+#### Returns
+
+`Promise`\<`IRightsManagementInformation` \| `undefined`\>
+
+The objects containing relevant information or undefined if nothing relevant is found.
+
+#### Implementation of
+
+`IPolicyInformationSource.retrieve`
+
+***
+
+### addInformation() {#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,38 @@
+# @3sixty/rights-management-plugins
+
+## Classes
+
+- [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)
+- [PassThroughPolicyNegotiator](classes/PassThroughPolicyNegotiator.md)
+- [PassThroughPolicyObligationEnforcer](classes/PassThroughPolicyObligationEnforcer.md)
+- [PassThroughPolicyRequester](classes/PassThroughPolicyRequester.md)
+
+## Interfaces
+
+- [IAutomationPolicyExecutionActionConfig](interfaces/IAutomationPolicyExecutionActionConfig.md)
+- [IAutomationPolicyExecutionActionConstructorOptions](interfaces/IAutomationPolicyExecutionActionConstructorOptions.md)
+- [IDefaultPolicyArbiterConfig](interfaces/IDefaultPolicyArbiterConfig.md)
+- [IDefaultPolicyArbiterConstructorOptions](interfaces/IDefaultPolicyArbiterConstructorOptions.md)
+- [IDefaultPolicyEnforcementProcessorConfig](interfaces/IDefaultPolicyEnforcementProcessorConfig.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)
+- [IPassThroughPolicyNegotiatorConfig](interfaces/IPassThroughPolicyNegotiatorConfig.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/IDefaultPolicyEnforcementProcessorConfig.md

@@ -0,0 +1,13 @@
+# Interface: IDefaultPolicyEnforcementProcessorConfig
+
+Configuration for the Default Policy Enforcement Processor.
+
+## Properties
+
+### structuralKeys? {#structuralkeys}
+
+> `optional` **structuralKeys?**: `string`[]
+
+Top-level keys that are treated as document-structural fields and are
+passed through unconditionally, regardless of policy decisions.
+Defaults to the standard JSON-LD envelope keys: @context, @type, @id, type, id.

package/docs/reference/interfaces/IDefaultPolicyEnforcementProcessorConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IDefaultPolicyEnforcementProcessorConstructorOptions
+
+Options for the Default Policy Enforcement Processor.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for policy enforcement processor.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IDefaultPolicyEnforcementProcessorConfig`](IDefaultPolicyEnforcementProcessorConfig.md)
+
+The configuration options for the default policy enforcement processor.

package/docs/reference/interfaces/IIdentityPolicyInformationSourceConstructorOptions.md

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

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

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

package/docs/reference/interfaces/ILoggingPolicyExecutionActionConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: ILoggingPolicyExecutionActionConstructorOptions
+
+Options for the Logging Policy Execution Action.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component for logging policy execution.
+
+***
+
+### config? {#config}
+
+> `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.