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

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.

package/docs/reference/interfaces/IRightsManagementComponent.md

@@ -0,0 +1,130 @@
+# Interface: IRightsManagementComponent
+
+Interface describing a unified Rights Management Component.
+This serves as a single point of entry for all rights management operations.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### papCreate()
+
+> **papCreate**(`policy`): `Promise`\<`string`\>
+
+Create a new policy with auto-generated UID.
+
+#### Parameters
+
+##### policy
+
+`Omit`\<`IOdrlPolicy`, `"uid"`\>
+
+The policy to create (uid will be auto-generated).
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The UID of the created policy.
+
+***
+
+### papUpdate()
+
+> **papUpdate**(`policy`): `Promise`\<`void`\>
+
+PAP: Update an existing policy.
+
+#### Parameters
+
+##### policy
+
+`IOdrlPolicy`
+
+The policy to update (must include uid).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### papRetrieve()
+
+> **papRetrieve**(`policyId`): `Promise`\<`IOdrlPolicy`\>
+
+PAP: Retrieve a policy.
+
+#### Parameters
+
+##### policyId
+
+`string`
+
+The id of the policy to retrieve.
+
+#### Returns
+
+`Promise`\<`IOdrlPolicy`\>
+
+The policy.
+
+***
+
+### papRemove()
+
+> **papRemove**(`policyId`): `Promise`\<`void`\>
+
+PAP: Remove a policy.
+
+#### Parameters
+
+##### policyId
+
+`string`
+
+The id of the policy to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### papQuery()
+
+> **papQuery**(`conditions?`, `cursor?`, `pageSize?`): `Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+
+PAP: 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.
+
+#### Returns
+
+`Promise`\<\{ `cursor?`: `string`; `policies`: `IOdrlPolicy`[]; \}\>
+
+Cursor for next page of results and the policies matching the query.

package/docs/reference/type-aliases/PolicyActionCallback.md

@@ -0,0 +1,59 @@
+# Type Alias: PolicyActionCallback()\<T\>
+
+> **PolicyActionCallback**\<`T`\> = (`assetType`, `action`, `data`, `userIdentity`, `nodeIdentity`, `policies`) => `Promise`\<`void`\>
+
+Callback function type for policy actions.
+This function is called when a policy action is executed.
+It receives the asset type, action, data, user identity,
+node identity, and the policies that apply to the data.
+The function should return a promise that resolves when the action is complete.
+
+## 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.
+
+`T` | `undefined`
+
+### 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`\>
+
+A promise that resolves when the action is complete.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@twin.org/rights-management-models",
+	"version": "0.0.1-next.10",
+	"description": "Models which define the structure of the rights management connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/rights-management.git",
+		"directory": "packages/rights-management-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-odrl": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}