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

package/docs/reference/classes/RightsManagementService.md

@@ -0,0 +1,212 @@
+# Class: RightsManagementService
+
+Service for performing Rights Management operations.
+This is a unified service that provides access to all Rights Management components.
+
+## Implements
+
+- `IRightsManagementComponent`
+
+## Constructors
+
+### Constructor
+
+> **new RightsManagementService**(`options?`): `RightsManagementService`
+
+Create a new instance of RightsManagementService.
+
+#### Parameters
+
+##### options?
+
+[`IRightsManagementServiceConstructorOptions`](../interfaces/IRightsManagementServiceConstructorOptions.md)
+
+The options for the service.
+
+#### Returns
+
+`RightsManagementService`
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"rights-management"`
+
+The namespace supported by the Rights Management service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IRightsManagementComponent.CLASS_NAME`
+
+## Methods
+
+### papStore()
+
+> **papStore**(`policy`, `userIdentity`, `nodeIdentity`): `Promise`\<`void`\>
+
+PAP: 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.
+
+#### Implementation of
+
+`IRightsManagementComponent.papStore`
+
+***
+
+### papRetrieve()
+
+> **papRetrieve**(`policyId`, `userIdentity`, `nodeIdentity`): `Promise`\<`IOdrlPolicy`\>
+
+PAP: 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.
+
+#### Implementation of
+
+`IRightsManagementComponent.papRetrieve`
+
+***
+
+### papRemove()
+
+> **papRemove**(`policyId`, `userIdentity`, `nodeIdentity`): `Promise`\<`void`\>
+
+PAP: 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.
+
+#### Implementation of
+
+`IRightsManagementComponent.papRemove`
+
+***
+
+### papQuery()
+
+> **papQuery**(`conditions?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `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.
+
+##### 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.
+
+#### Implementation of
+
+`IRightsManagementComponent.papQuery`

package/docs/reference/functions/generateRestRoutes.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutes()
+
+> **generateRestRoutes**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for the Rights Management.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/papQuery.md

@@ -0,0 +1,31 @@
+# Function: papQuery()
+
+> **papQuery**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IPapQueryResponse`\>
+
+PAP: Query policies.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IPapQueryRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IPapQueryResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/papRemove.md

@@ -0,0 +1,31 @@
+# Function: papRemove()
+
+> **papRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+PAP: Remove a policy.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IPapRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/papRetrieve.md

@@ -0,0 +1,31 @@
+# Function: papRetrieve()
+
+> **papRetrieve**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IPapRetrieveResponse`\>
+
+PAP: Retrieve a policy.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IPapRetrieveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IPapRetrieveResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/papStore.md

@@ -0,0 +1,31 @@
+# Function: papStore()
+
+> **papStore**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+PAP: Store a policy.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IPapStoreRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @twin.org/rights-management-service
+
+## Classes
+
+- [RightsManagementService](classes/RightsManagementService.md)
+
+## Interfaces
+
+- [IRightsManagementServiceConfig](interfaces/IRightsManagementServiceConfig.md)
+- [IRightsManagementServiceConstructorOptions](interfaces/IRightsManagementServiceConstructorOptions.md)
+
+## Variables
+
+- [restEntryPoints](variables/restEntryPoints.md)
+- [tags](variables/tags.md)
+
+## Functions
+
+- [generateRestRoutes](functions/generateRestRoutes.md)
+- [papStore](functions/papStore.md)
+- [papRetrieve](functions/papRetrieve.md)
+- [papRemove](functions/papRemove.md)
+- [papQuery](functions/papQuery.md)

package/docs/reference/interfaces/IRightsManagementServiceConfig.md

@@ -0,0 +1,43 @@
+# Interface: IRightsManagementServiceConfig
+
+The configuration for the RightsManagementService.
+
+## Properties
+
+### papNamespace?
+
+> `optional` **papNamespace**: `string`
+
+The namespace for the PAP component.
+
+***
+
+### defaultEntityStorageType?
+
+> `optional` **defaultEntityStorageType**: `string`
+
+The default entity storage type.
+
+***
+
+### includeUserIdentity?
+
+> `optional` **includeUserIdentity**: `boolean`
+
+Should the user identity be included in entity storage operations.
+
+***
+
+### includeNodeIdentity?
+
+> `optional` **includeNodeIdentity**: `boolean`
+
+Should the node identity be included in entity storage operations.
+
+***
+
+### maxQueryResults?
+
+> `optional` **maxQueryResults**: `number`
+
+The maximum number of results to return in a query.

package/docs/reference/interfaces/IRightsManagementServiceConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IRightsManagementServiceConstructorOptions
+
+The constructor options for the RightsManagementService.
+
+## Properties
+
+### config?
+
+> `optional` **config**: [`IRightsManagementServiceConfig`](IRightsManagementServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,5 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+Entry points for the REST API.

package/docs/reference/variables/tags.md

@@ -0,0 +1,5 @@
+# Variable: tags
+
+> `const` **tags**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,10 @@
+{
+	"error": {
+		"rightsManagementService": {
+			"storeFailed": "Failed to store policy",
+			"retrieveFailed": "Failed to retrieve policy",
+			"removeFailed": "Failed to remove policy",
+			"queryFailed": "Failed to query policies"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+	"name": "@twin.org/rights-management-service",
+	"version": "0.0.1-next.3",
+	"description": "Rights Management service implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/rights-management.git",
+		"directory": "packages/rights-management-service"
+	},
+	"author": "cornel.filip@iota.org; adrian.sanchez.sequeira@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-service": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/rights-management-models": "0.0.1-next.3",
+		"@twin.org/rights-management-pap-entity-storage": "0.0.1-next.3",
+		"@twin.org/standards-w3c-odrl": "next",
+		"@twin.org/web": "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"
+	]
+}