@twin.org/rights-management-models 0.0.1-next.3

package/docs/reference/interfaces/IPapQueryRequest.md

@@ -0,0 +1,29 @@
+# Interface: IPapQueryRequest
+
+The request structure for querying policies.
+
+## Properties
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters of the request.
+
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The condition for the query.
+
+#### pageSize?
+
+> `optional` **pageSize**: `string`
+
+The number of entries to return per page.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get next chunk of data, returned in previous response.

package/docs/reference/interfaces/IPapQueryResponse.md

@@ -0,0 +1,23 @@
+# Interface: IPapQueryResponse
+
+The response structure for querying policies.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body of the response.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor for the next page of results, if there are more results available.
+
+#### policies
+
+> **policies**: `IOdrlPolicy`[]
+
+The policies matching the query.

package/docs/reference/interfaces/IPapRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IPapRemoveRequest
+
+The request structure for removing a policy.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters of the request.
+
+#### id
+
+> **id**: `string`
+
+The ID of the policy to remove.

package/docs/reference/interfaces/IPapRetrieveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IPapRetrieveRequest
+
+The request structure for retrieving a policy.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters of the request.
+
+#### id
+
+> **id**: `string`
+
+The ID of the policy to retrieve.

package/docs/reference/interfaces/IPapRetrieveResponse.md

@@ -0,0 +1,11 @@
+# Interface: IPapRetrieveResponse
+
+The response structure for retrieving a policy.
+
+## Properties
+
+### body
+
+> **body**: `IOdrlPolicy`
+
+The body of the response.

package/docs/reference/interfaces/IPapStoreRequest.md

@@ -0,0 +1,17 @@
+# Interface: IPapStoreRequest
+
+The request structure for storing a policy.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body of the request.
+
+#### policy
+
+> **policy**: `IOdrlPolicy`
+
+The policy to store.

package/docs/reference/interfaces/IPolicyAdministrationPointComponent.md

@@ -0,0 +1,157 @@
+# Interface: IPolicyAdministrationPointComponent
+
+Interface describing a Policy Administration Point (PAP) contract.
+Manages policies for the rights management, policies are also queried by the
+Policy Management Point (PMP) when it handles requests from the Policy Decision Point (PDP).
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### store()
+
+> **store**(`policy`, `userIdentity`, `nodeIdentity`): `Promise`\<`void`\>
+
+Store a policy.
+
+#### Parameters
+
+##### policy
+
+`IOdrlPolicy`
+
+The policy to store.
+
+##### userIdentity
+
+The identity of the user performing the operation.
+
+`undefined` | `string`
+
+##### nodeIdentity
+
+`string`
+
+The identity of the node the operation is performed on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### retrieve()
+
+> **retrieve**(`policyId`, `userIdentity`, `nodeIdentity`): `Promise`\<`IOdrlPolicy`\>
+
+Retrieve a policy.
+
+#### Parameters
+
+##### policyId
+
+`string`
+
+The id of the policy to retrieve.
+
+##### userIdentity
+
+The identity of the user performing the operation.
+
+`undefined` | `string`
+
+##### nodeIdentity
+
+`string`
+
+The identity of the node the operation is performed on.
+
+#### Returns
+
+`Promise`\<`IOdrlPolicy`\>
+
+The policy.
+
+***
+
+### remove()
+
+> **remove**(`policyId`, `userIdentity`, `nodeIdentity`): `Promise`\<`void`\>
+
+Remove a policy.
+
+#### Parameters
+
+##### policyId
+
+`string`
+
+The id of the policy to remove.
+
+##### userIdentity
+
+The identity of the user performing the operation.
+
+`undefined` | `string`
+
+##### nodeIdentity
+
+`string`
+
+The identity of the node the operation is performed on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### query()
+
+> **query**(`conditions?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<\{ `cursor`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+
+Query the policies using the specified conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`IOdrlPolicy`\>
+
+The conditions to use for the query.
+
+##### cursor?
+
+`string`
+
+The cursor to use for pagination.
+
+##### pageSize?
+
+`number`
+
+The number of results to return per page.
+
+##### userIdentity?
+
+`string`
+
+The identity of the user performing the operation.
+
+##### nodeIdentity?
+
+`string`
+
+The identity of the node the operation is performed on.
+
+#### Returns
+
+`Promise`\<\{ `cursor`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+
+Cursor for next page of results and the policies matching the query.

package/docs/reference/interfaces/IPolicyDecisionPointComponent.md

@@ -0,0 +1,67 @@
+# Interface: IPolicyDecisionPointComponent
+
+Interface describing a Policy Decision Point (PDP) contract.
+Decides if a party can be granted access to a resource, will retrieve policies
+from the Policy Management Point (PMP) and any additional information from the
+Policy Information Point (PIP). When a decision is made, the Policy Execution
+Point (PEP) will execute any registered actions.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### evaluate()
+
+> **evaluate**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`): `Promise`\<`IOdrlPolicy`[]\>
+
+Evaluate requests from a Policy Enforcement Point (PEP).
+Uses the Policy Management Point (PMP) to retrieve the policies and the
+Policy Information Point (PIP) to retrieve additional information.
+Executes any actions on the Policy Execution Point (PEP) when the decision is made.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+The data to make a decision on.
+
+`undefined` | `T`
+
+##### userIdentity
+
+`string`
+
+The user identity to use in the decision making.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to use in the decision making.
+
+#### Returns
+
+`Promise`\<`IOdrlPolicy`[]\>
+
+Returns the policy decisions which apply to the data so that the PEP
+can manipulate the data accordingly.

package/docs/reference/interfaces/IPolicyEnforcementPointComponent.md

@@ -0,0 +1,62 @@
+# Interface: IPolicyEnforcementPointComponent
+
+Interface describing a Policy Enforcement Point (PEP) contract.
+Intercepts data and uses the Policy Decision Point (PDP) to make decisions on
+access to a resource, based on the decision a manipulated data object can
+be returned.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### intercept()
+
+> **intercept**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`): `Promise`\<`undefined` \| `T`\>
+
+Process the data using Policy Decision Point (PDP) and return the manipulated data.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+The data to process.
+
+`undefined` | `T`
+
+##### userIdentity
+
+`string`
+
+The user identity to use in the decision making.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to use in the decision making.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The manipulated data with any policies applied.

package/docs/reference/interfaces/IPolicyExecutionPointComponent.md

@@ -0,0 +1,124 @@
+# Interface: IPolicyExecutionPointComponent
+
+Interface describing a Policy Execution Point (PXP) contract.
+When a decision is made by the Policy Decision Point (PDP),
+the Policy Execution Point (PEP) will execute any
+registered actions based on the decision.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### executeActions()
+
+> **executeActions**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`): `Promise`\<`void`\>
+
+Execute actions based on the PDP's decisions.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+The data used in the decision by the PDP.
+
+`undefined` | `T`
+
+##### userIdentity
+
+`string`
+
+The user identity to use in the decision making.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to use in the decision making.
+
+##### policies
+
+`IOdrlPolicy`[]
+
+The policies that apply to the data.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### registerAction()
+
+> **registerAction**\<`T`\>(`actionId`, `action`): `Promise`\<`void`\>
+
+Register an action to be executed.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### actionId
+
+`string`
+
+The id of the action to register.
+
+##### action
+
+[`PolicyActionCallback`](../type-aliases/PolicyActionCallback.md)\<`T`\>
+
+The action to execute.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### unregisterAction()
+
+> **unregisterAction**(`actionId`): `Promise`\<`void`\>
+
+Unregister an action from the execution point.
+
+#### Parameters
+
+##### actionId
+
+`string`
+
+The id of the action to unregister.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IPolicyInformationPointComponent.md

@@ -0,0 +1,61 @@
+# Interface: IPolicyInformationPointComponent
+
+Interface describing a Policy Information Point (PEP) contract.
+Provides additional information to the Policy Decision Point (PDP) when
+it is making decisions.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### retrieve()
+
+> **retrieve**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`): `Promise`\<`IJsonLdNodeObject`[]\>
+
+Retrieve additional information which is relevant in the PDP decision making.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+The data to get any additional information for.
+
+`undefined` | `T`
+
+##### userIdentity
+
+`string`
+
+The user identity to get additional information for.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to get additional information for.
+
+#### Returns
+
+`Promise`\<`IJsonLdNodeObject`[]\>
+
+Returns additional information based on the data and identities.

package/docs/reference/interfaces/IPolicyManagementPointComponent.md

@@ -0,0 +1,60 @@
+# Interface: IPolicyManagementPointComponent
+
+Interface describing a Policy Management Point (PMP) contract.
+Provide the policies to the Policy Decision Point (PDP) based on the data and identities.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### retrieve()
+
+> **retrieve**\<`T`\>(`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`): `Promise`\<`IOdrlPolicy`[]\>
+
+Get the policies from a PAP based on the data and identities.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### assetType
+
+`string`
+
+The type of asset being processed.
+
+##### action
+
+`string`
+
+The action being performed on the asset.
+
+##### data
+
+The data to retrieve the policies for.
+
+`undefined` | `T`
+
+##### userIdentity
+
+`string`
+
+The user identity to retrieve the policies for.
+
+##### nodeIdentity
+
+`string`
+
+The node identity to retrieve the policies for.
+
+#### Returns
+
+`Promise`\<`IOdrlPolicy`[]\>
+
+Returns the policies which apply to the data and identities so that the PDP can make a decision.