@twin.org/engine-types 0.0.2-next.13 → 0.0.2-next.14

package/docs/reference/functions/initialiseRightsManagementDapComponent.md

@@ -0,0 +1,41 @@
+# Function: initialiseRightsManagementDapComponent()
+
+> **initialiseRightsManagementDapComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+
+Initialise the rights management DAP component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`RightsManagementDapComponentConfig`](../type-aliases/RightsManagementDapComponentConfig.md)
+
+The instance config.
+
+### overrideInstanceType?
+
+`string`
+
+The instance type to override the default.
+
+## Returns
+
+`Promise`\<`undefined` \| `string`\>
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/{initialiseRightsManagementPnrpComponent.md → initialiseRightsManagementDarpComponent.md}

@@ -1,8 +1,8 @@
-# Function: initialiseRightsManagementPnrpComponent()
+# Function: initialiseRightsManagementDarpComponent()
 
-> **initialiseRightsManagementPnrpComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseRightsManagementDarpComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
 
-Initialise the rights management PNRP component.
+Initialise the rights management DARP component.
 
 ## Parameters
 
@@ -20,7 +20,7 @@ The context for the engine.
 
 ### instanceConfig
 
-[`RightsManagementPnrpComponentConfig`](../type-aliases/RightsManagementPnrpComponentConfig.md)
+[`RightsManagementDarpComponentConfig`](../type-aliases/RightsManagementDarpComponentConfig.md)
 
 The instance config.
 

package/docs/reference/index.md

@@ -40,6 +40,8 @@
 - [MessagingSmsConnectorConfig](type-aliases/MessagingSmsConnectorConfig.md)
 - [NftComponentConfig](type-aliases/NftComponentConfig.md)
 - [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
+- [RightsManagementDapComponentConfig](type-aliases/RightsManagementDapComponentConfig.md)
+- [RightsManagementDarpComponentConfig](type-aliases/RightsManagementDarpComponentConfig.md)
 - [RightsManagementPapComponentConfig](type-aliases/RightsManagementPapComponentConfig.md)
 - [RightsManagementPdpComponentConfig](type-aliases/RightsManagementPdpComponentConfig.md)
 - [RightsManagementPepComponentConfig](type-aliases/RightsManagementPepComponentConfig.md)
@@ -47,7 +49,6 @@
 - [RightsManagementPmpComponentConfig](type-aliases/RightsManagementPmpComponentConfig.md)
 - [RightsManagementPnapComponentConfig](type-aliases/RightsManagementPnapComponentConfig.md)
 - [RightsManagementPnpComponentConfig](type-aliases/RightsManagementPnpComponentConfig.md)
-- [RightsManagementPnrpComponentConfig](type-aliases/RightsManagementPnrpComponentConfig.md)
 - [RightsManagementPxpComponentConfig](type-aliases/RightsManagementPxpComponentConfig.md)
 - [SynchronisedStorageComponentConfig](type-aliases/SynchronisedStorageComponentConfig.md)
 - [TaskSchedulerComponentConfig](type-aliases/TaskSchedulerComponentConfig.md)
@@ -91,6 +92,8 @@
 - [MessagingSmsConnectorType](type-aliases/MessagingSmsConnectorType.md)
 - [NftComponentType](type-aliases/NftComponentType.md)
 - [NftConnectorType](type-aliases/NftConnectorType.md)
+- [RightsManagementDapComponentType](type-aliases/RightsManagementDapComponentType.md)
+- [RightsManagementDarpComponentType](type-aliases/RightsManagementDarpComponentType.md)
 - [RightsManagementPapComponentType](type-aliases/RightsManagementPapComponentType.md)
 - [RightsManagementPdpComponentType](type-aliases/RightsManagementPdpComponentType.md)
 - [RightsManagementPepComponentType](type-aliases/RightsManagementPepComponentType.md)
@@ -98,7 +101,6 @@
 - [RightsManagementPmpComponentType](type-aliases/RightsManagementPmpComponentType.md)
 - [RightsManagementPnapComponentType](type-aliases/RightsManagementPnapComponentType.md)
 - [RightsManagementPnpComponentType](type-aliases/RightsManagementPnpComponentType.md)
-- [RightsManagementPnrpComponentType](type-aliases/RightsManagementPnrpComponentType.md)
 - [RightsManagementPxpComponentType](type-aliases/RightsManagementPxpComponentType.md)
 - [SynchronisedStorageComponentType](type-aliases/SynchronisedStorageComponentType.md)
 - [TaskSchedulerComponentType](type-aliases/TaskSchedulerComponentType.md)
@@ -145,6 +147,8 @@
 - [MessagingSmsConnectorType](variables/MessagingSmsConnectorType.md)
 - [NftComponentType](variables/NftComponentType.md)
 - [NftConnectorType](variables/NftConnectorType.md)
+- [RightsManagementDapComponentType](variables/RightsManagementDapComponentType.md)
+- [RightsManagementDarpComponentType](variables/RightsManagementDarpComponentType.md)
 - [RightsManagementPapComponentType](variables/RightsManagementPapComponentType.md)
 - [RightsManagementPdpComponentType](variables/RightsManagementPdpComponentType.md)
 - [RightsManagementPepComponentType](variables/RightsManagementPepComponentType.md)
@@ -152,7 +156,6 @@
 - [RightsManagementPmpComponentType](variables/RightsManagementPmpComponentType.md)
 - [RightsManagementPnapComponentType](variables/RightsManagementPnapComponentType.md)
 - [RightsManagementPnpComponentType](variables/RightsManagementPnpComponentType.md)
-- [RightsManagementPnrpComponentType](variables/RightsManagementPnrpComponentType.md)
 - [RightsManagementPxpComponentType](variables/RightsManagementPxpComponentType.md)
 - [SynchronisedStorageComponentType](variables/SynchronisedStorageComponentType.md)
 - [TaskSchedulerComponentType](variables/TaskSchedulerComponentType.md)
@@ -198,6 +201,8 @@
 - [initialiseMessagingComponent](functions/initialiseMessagingComponent.md)
 - [initialiseNftConnector](functions/initialiseNftConnector.md)
 - [initialiseNftComponent](functions/initialiseNftComponent.md)
+- [initialiseRightsManagementDapComponent](functions/initialiseRightsManagementDapComponent.md)
+- [initialiseRightsManagementDarpComponent](functions/initialiseRightsManagementDarpComponent.md)
 - [initialiseRightsManagementPapComponent](functions/initialiseRightsManagementPapComponent.md)
 - [initialiseRightsManagementPdpComponent](functions/initialiseRightsManagementPdpComponent.md)
 - [initialiseRightsManagementPepComponent](functions/initialiseRightsManagementPepComponent.md)
@@ -205,7 +210,6 @@
 - [initialiseRightsManagementPmpComponent](functions/initialiseRightsManagementPmpComponent.md)
 - [initialiseRightsManagementPnapComponent](functions/initialiseRightsManagementPnapComponent.md)
 - [initialiseRightsManagementPnpComponent](functions/initialiseRightsManagementPnpComponent.md)
-- [initialiseRightsManagementPnrpComponent](functions/initialiseRightsManagementPnrpComponent.md)
 - [initialiseRightsManagementPxpComponent](functions/initialiseRightsManagementPxpComponent.md)
 - [initialiseSynchronisedStorageComponent](functions/initialiseSynchronisedStorageComponent.md)
 - [initialiseTaskSchedulerComponent](functions/initialiseTaskSchedulerComponent.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -300,11 +300,17 @@ Rights management PNP options which can be overridden by individual components b
 
 Rights management PNAP options which can be overridden by individual components by specifying types other than default.
 
-#### rightsManagementPnrpComponent?
+#### rightsManagementDapComponent?
 
-> `optional` **rightsManagementPnrpComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementPnrpComponentConfig`](../type-aliases/RightsManagementPnrpComponentConfig.md)\>[]
+> `optional` **rightsManagementDapComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementDapComponentConfig`](../type-aliases/RightsManagementDapComponentConfig.md)\>[]
 
-Rights management PNRP options which can be overridden by individual components by specifying types other than default.
+Rights management DAP options which can be overridden by individual components by specifying types other than default.
+
+#### rightsManagementDarpComponent?
+
+> `optional` **rightsManagementDarpComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementDarpComponentConfig`](../type-aliases/RightsManagementDarpComponentConfig.md)\>[]
+
+Rights management DARP options which can be overridden by individual components by specifying types other than default.
 
 #### synchronisedStorageComponent?
 

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

@@ -0,0 +1,5 @@
+# Type Alias: RightsManagementDapComponentConfig
+
+> **RightsManagementDapComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/RightsManagementDapComponentType.md#service); `options?`: `IDataAccessPointServiceConstructorOptions` & `object`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/RightsManagementDapComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
+
+Rights management DAP component config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: RightsManagementDapComponentType
+
+> **RightsManagementDapComponentType** = *typeof* [`RightsManagementDapComponentType`](../variables/RightsManagementDapComponentType.md)\[keyof *typeof* [`RightsManagementDapComponentType`](../variables/RightsManagementDapComponentType.md)\]
+
+Rights management DAP component types.

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

@@ -0,0 +1,23 @@
+# Type Alias: RightsManagementDarpComponentConfig
+
+> **RightsManagementDarpComponentConfig** = `object`
+
+Rights management DARP component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/RightsManagementDarpComponentType.md#service)
+
+***
+
+### options
+
+> **options**: `IDataAccessRequestPointServiceConstructorOptions` & `object`
+
+#### Type Declaration
+
+##### negotiatorModulesConfig?
+
+> `optional` **negotiatorModulesConfig**: `IEngineModuleConfig`[]

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

@@ -0,0 +1,5 @@
+# Type Alias: RightsManagementDarpComponentType
+
+> **RightsManagementDarpComponentType** = *typeof* [`RightsManagementDarpComponentType`](../variables/RightsManagementDarpComponentType.md)\[keyof *typeof* [`RightsManagementDarpComponentType`](../variables/RightsManagementDarpComponentType.md)\]
+
+Rights management DARP component types.

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

@@ -14,4 +14,10 @@ Rights management PDP component config types.
 
 ### options?
 
-> `optional` **options**: `IPolicyDecisionPointServiceConstructorOptions`
+> `optional` **options**: `IPolicyDecisionPointServiceConstructorOptions` & `object`
+
+#### Type Declaration
+
+##### arbiterModulesConfig?
+
+> `optional` **arbiterModulesConfig**: `IEngineModuleConfig`[]

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

@@ -1,5 +1,5 @@
 # Type Alias: RightsManagementPnpComponentConfig
 
-> **RightsManagementPnpComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/RightsManagementPnpComponentType.md#service); `options?`: `IPolicyNegotiationPointServiceConstructorOptions` & `object`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/RightsManagementPnpComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
+> **RightsManagementPnpComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/RightsManagementPnpComponentType.md#service); `options`: `IPolicyNegotiationPointServiceConstructorOptions` & `object`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/RightsManagementPnpComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Rights management PNP component config types.

package/docs/reference/variables/RightsManagementDapComponentType.md

@@ -0,0 +1,19 @@
+# Variable: RightsManagementDapComponentType
+
+> `const` **RightsManagementDapComponentType**: `object`
+
+Rights management DAP component types.
+
+## Type Declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/RightsManagementDarpComponentType.md

@@ -0,0 +1,13 @@
+# Variable: RightsManagementDarpComponentType
+
+> `const` **RightsManagementDarpComponentType**: `object`
+
+Rights management DARP component types.
+
+## Type Declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.2-next.13",
+	"version": "0.0.2-next.14",
 	"description": "Types to use in an engine.",
 	"repository": {
 		"type": "git",
@@ -51,8 +51,8 @@
 		"@twin.org/document-management-models": "next",
 		"@twin.org/document-management-rest-client": "next",
 		"@twin.org/document-management-service": "next",
-		"@twin.org/engine-core": "0.0.2-next.13",
-		"@twin.org/engine-models": "0.0.2-next.13",
+		"@twin.org/engine-core": "0.0.2-next.14",
+		"@twin.org/engine-models": "0.0.2-next.14",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",
@@ -99,6 +99,7 @@
 		"@twin.org/nft-models": "next",
 		"@twin.org/nft-rest-client": "next",
 		"@twin.org/nft-service": "next",
+		"@twin.org/rights-management-dap-service": "next",
 		"@twin.org/rights-management-models": "next",
 		"@twin.org/rights-management-pap-service": "next",
 		"@twin.org/rights-management-pdp-service": "next",

package/dist/types/models/config/rightsManagementPnrpComponentConfig.d.ts

@@ -1,9 +0,0 @@
-import type { IPolicyNegotiationRequestPointServiceConstructorOptions } from "@twin.org/rights-management-pnp-service";
-import type { RightsManagementPnrpComponentType } from "../types/rightsManagementPnrpComponentType";
-/**
- * Rights management PNRP component config types.
- */
-export type RightsManagementPnrpComponentConfig = {
-    type: typeof RightsManagementPnrpComponentType.Service;
-    options: IPolicyNegotiationRequestPointServiceConstructorOptions;
-};

package/dist/types/models/types/rightsManagementPnrpComponentType.d.ts

@@ -1,13 +0,0 @@
-/**
- * Rights management PNRP component types.
- */
-export declare const RightsManagementPnrpComponentType: {
-    /**
-     * Service.
-     */
-    readonly Service: "service";
-};
-/**
- * Rights management PNRP component types.
- */
-export type RightsManagementPnrpComponentType = (typeof RightsManagementPnrpComponentType)[keyof typeof RightsManagementPnrpComponentType];

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

@@ -1,17 +0,0 @@
-# Type Alias: RightsManagementPnrpComponentConfig
-
-> **RightsManagementPnrpComponentConfig** = `object`
-
-Rights management PNRP component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/RightsManagementPnrpComponentType.md#service)
-
-***
-
-### options
-
-> **options**: `IPolicyNegotiationRequestPointServiceConstructorOptions`

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

@@ -1,5 +0,0 @@
-# Type Alias: RightsManagementPnrpComponentType
-
-> **RightsManagementPnrpComponentType** = *typeof* [`RightsManagementPnrpComponentType`](../variables/RightsManagementPnrpComponentType.md)\[keyof *typeof* [`RightsManagementPnrpComponentType`](../variables/RightsManagementPnrpComponentType.md)\]
-
-Rights management PNRP component types.

package/docs/reference/variables/RightsManagementPnrpComponentType.md

@@ -1,13 +0,0 @@
-# Variable: RightsManagementPnrpComponentType
-
-> `const` **RightsManagementPnrpComponentType**: `object`
-
-Rights management PNRP component types.
-
-## Type Declaration
-
-### Service
-
-> `readonly` **Service**: `"service"` = `"service"`
-
-Service.