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

package/docs/reference/classes/ExamplePolicyRequester.md

@@ -0,0 +1,187 @@
+# Class: ExamplePolicyRequester
+
+Example Policy Requester.
+
+## Implements
+
+- `IPolicyRequester`
+
+## Constructors
+
+### Constructor
+
+> **new ExamplePolicyRequester**(`options?`): `ExamplePolicyRequester`
+
+Create a new instance of ExamplePolicyRequester.
+
+#### Parameters
+
+##### options?
+
+[`IExamplePolicyRequesterConstructorOptions`](../interfaces/IExamplePolicyRequesterConstructorOptions.md)
+
+The options for the example policy Requester.
+
+#### Returns
+
+`ExamplePolicyRequester`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Example Policy Requester.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IPolicyRequester.className`
+
+***
+
+### requesterId()
+
+> **requesterId**(): `string`
+
+The unique id of the requester.
+
+#### Returns
+
+`string`
+
+The requester id.
+
+#### Implementation of
+
+`IPolicyRequester.requesterId`
+
+***
+
+### offer()
+
+> **offer**(`negotiationId`, `offer`): `Promise`\<`boolean`\>
+
+A policy has been offered by a provider, let the requester know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+##### offer
+
+`IOdrlOffer`
+
+The offer sent by the provider.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the offer was accepted, false otherwise.
+
+#### Implementation of
+
+`IPolicyRequester.offer`
+
+***
+
+### agreement()
+
+> **agreement**(`negotiationId`, `agreement`): `Promise`\<`boolean`\>
+
+A policy agreement has been sent by a provider, let the requester know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+##### agreement
+
+`IOdrlAgreement`
+
+The agreement sent by the provider.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the agreement was accepted, false otherwise.
+
+#### Implementation of
+
+`IPolicyRequester.agreement`
+
+***
+
+### finalised()
+
+> **finalised**(`negotiationId`): `Promise`\<`void`\>
+
+A policy finalisation has been sent by a provider, let the requester know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IPolicyRequester.finalised`
+
+***
+
+### terminated()
+
+> **terminated**(`negotiationId`): `Promise`\<`void`\>
+
+A policy termination has been sent by a provider, let the requester know about it.
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The id of the negotiation.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IPolicyRequester.terminated`

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
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+The class name of the Identity 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`

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,25 @@
+# @twin.org/rights-management-plugins
+
+## Classes
+
+- [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
+```