@twin.org/engine-types 0.0.2-next.7 → 0.0.2-next.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +291 -2
- package/dist/esm/index.mjs +282 -3
- package/dist/types/components/rightsManagementPdp.d.ts +13 -0
- package/dist/types/components/rightsManagementPep.d.ts +13 -0
- package/dist/types/components/rightsManagementPip.d.ts +13 -0
- package/dist/types/components/rightsManagementPmp.d.ts +13 -0
- package/dist/types/components/rightsManagementPxp.d.ts +13 -0
- package/dist/types/index.d.ts +15 -0
- package/dist/types/models/IEngineConfig.d.ts +25 -0
- package/dist/types/models/config/rightsManagementPdpComponentConfig.d.ts +9 -0
- package/dist/types/models/config/rightsManagementPepComponentConfig.d.ts +9 -0
- package/dist/types/models/config/rightsManagementPipComponentConfig.d.ts +9 -0
- package/dist/types/models/config/rightsManagementPmpComponentConfig.d.ts +9 -0
- package/dist/types/models/config/rightsManagementPxpComponentConfig.d.ts +9 -0
- package/dist/types/models/types/rightsManagementPdpComponentType.d.ts +13 -0
- package/dist/types/models/types/rightsManagementPepComponentType.d.ts +13 -0
- package/dist/types/models/types/rightsManagementPipComponentType.d.ts +13 -0
- package/dist/types/models/types/rightsManagementPmpComponentType.d.ts +13 -0
- package/dist/types/models/types/rightsManagementPxpComponentType.d.ts +13 -0
- package/docs/changelog.md +14 -0
- package/docs/reference/functions/initialiseRightsManagementPdpComponent.md +41 -0
- package/docs/reference/functions/initialiseRightsManagementPepComponent.md +41 -0
- package/docs/reference/functions/initialiseRightsManagementPipComponent.md +41 -0
- package/docs/reference/functions/initialiseRightsManagementPmpComponent.md +41 -0
- package/docs/reference/functions/initialiseRightsManagementPxpComponent.md +41 -0
- package/docs/reference/index.md +20 -0
- package/docs/reference/interfaces/IEngineConfig.md +30 -0
- package/docs/reference/type-aliases/RightsManagementPdpComponentConfig.md +17 -0
- package/docs/reference/type-aliases/RightsManagementPdpComponentType.md +5 -0
- package/docs/reference/type-aliases/RightsManagementPepComponentConfig.md +17 -0
- package/docs/reference/type-aliases/RightsManagementPepComponentType.md +5 -0
- package/docs/reference/type-aliases/RightsManagementPipComponentConfig.md +17 -0
- package/docs/reference/type-aliases/RightsManagementPipComponentType.md +5 -0
- package/docs/reference/type-aliases/RightsManagementPmpComponentConfig.md +17 -0
- package/docs/reference/type-aliases/RightsManagementPmpComponentType.md +5 -0
- package/docs/reference/type-aliases/RightsManagementPxpComponentConfig.md +17 -0
- package/docs/reference/type-aliases/RightsManagementPxpComponentType.md +5 -0
- package/docs/reference/variables/RightsManagementPdpComponentType.md +13 -0
- package/docs/reference/variables/RightsManagementPepComponentType.md +13 -0
- package/docs/reference/variables/RightsManagementPipComponentType.md +13 -0
- package/docs/reference/variables/RightsManagementPmpComponentType.md +13 -0
- package/docs/reference/variables/RightsManagementPxpComponentType.md +13 -0
- package/package.json +7 -2
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
|
|
2
|
+
import type { RightsManagementPepComponentConfig } from "../models/config/rightsManagementPepComponentConfig";
|
|
3
|
+
import type { IEngineConfig } from "../models/IEngineConfig";
|
|
4
|
+
/**
|
|
5
|
+
* Initialise the rights management PEP component.
|
|
6
|
+
* @param engineCore The engine core.
|
|
7
|
+
* @param context The context for the engine.
|
|
8
|
+
* @param instanceConfig The instance config.
|
|
9
|
+
* @param overrideInstanceType The instance type to override the default.
|
|
10
|
+
* @returns The name of the instance created.
|
|
11
|
+
* @throws GeneralError if the component type is unknown.
|
|
12
|
+
*/
|
|
13
|
+
export declare function initialiseRightsManagementPepComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: RightsManagementPepComponentConfig, overrideInstanceType?: string): string | undefined;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
|
|
2
|
+
import type { RightsManagementPipComponentConfig } from "../models/config/rightsManagementPipComponentConfig";
|
|
3
|
+
import type { IEngineConfig } from "../models/IEngineConfig";
|
|
4
|
+
/**
|
|
5
|
+
* Initialise the rights management PIP component.
|
|
6
|
+
* @param engineCore The engine core.
|
|
7
|
+
* @param context The context for the engine.
|
|
8
|
+
* @param instanceConfig The instance config.
|
|
9
|
+
* @param overrideInstanceType The instance type to override the default.
|
|
10
|
+
* @returns The name of the instance created.
|
|
11
|
+
* @throws GeneralError if the component type is unknown.
|
|
12
|
+
*/
|
|
13
|
+
export declare function initialiseRightsManagementPipComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: RightsManagementPipComponentConfig, overrideInstanceType?: string): string | undefined;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
|
|
2
|
+
import type { RightsManagementPmpComponentConfig } from "../models/config/rightsManagementPmpComponentConfig";
|
|
3
|
+
import type { IEngineConfig } from "../models/IEngineConfig";
|
|
4
|
+
/**
|
|
5
|
+
* Initialise the rights management PMP component.
|
|
6
|
+
* @param engineCore The engine core.
|
|
7
|
+
* @param context The context for the engine.
|
|
8
|
+
* @param instanceConfig The instance config.
|
|
9
|
+
* @param overrideInstanceType The instance type to override the default.
|
|
10
|
+
* @returns The name of the instance created.
|
|
11
|
+
* @throws GeneralError if the component type is unknown.
|
|
12
|
+
*/
|
|
13
|
+
export declare function initialiseRightsManagementPmpComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: RightsManagementPmpComponentConfig, overrideInstanceType?: string): string | undefined;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
|
|
2
|
+
import type { RightsManagementPxpComponentConfig } from "../models/config/rightsManagementPxpComponentConfig";
|
|
3
|
+
import type { IEngineConfig } from "../models/IEngineConfig";
|
|
4
|
+
/**
|
|
5
|
+
* Initialise the rights management PXP component.
|
|
6
|
+
* @param engineCore The engine core.
|
|
7
|
+
* @param context The context for the engine.
|
|
8
|
+
* @param instanceConfig The instance config.
|
|
9
|
+
* @param overrideInstanceType The instance type to override the default.
|
|
10
|
+
* @returns The name of the instance created.
|
|
11
|
+
* @throws GeneralError if the component type is unknown.
|
|
12
|
+
*/
|
|
13
|
+
export declare function initialiseRightsManagementPxpComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: RightsManagementPxpComponentConfig, overrideInstanceType?: string): string | undefined;
|
package/dist/types/index.d.ts
CHANGED
|
@@ -18,6 +18,11 @@ export * from "./components/messaging";
|
|
|
18
18
|
export * from "./components/nft";
|
|
19
19
|
export * from "./components/rightsManagement";
|
|
20
20
|
export * from "./components/rightsManagementPap";
|
|
21
|
+
export * from "./components/rightsManagementPdp";
|
|
22
|
+
export * from "./components/rightsManagementPep";
|
|
23
|
+
export * from "./components/rightsManagementPip";
|
|
24
|
+
export * from "./components/rightsManagementPmp";
|
|
25
|
+
export * from "./components/rightsManagementPxp";
|
|
21
26
|
export * from "./components/synchronisedStorage";
|
|
22
27
|
export * from "./components/taskScheduler";
|
|
23
28
|
export * from "./components/telemetry";
|
|
@@ -59,6 +64,11 @@ export * from "./models/config/nftComponentConfig";
|
|
|
59
64
|
export * from "./models/config/nftConnectorConfig";
|
|
60
65
|
export * from "./models/config/rightsManagementComponentConfig";
|
|
61
66
|
export * from "./models/config/rightsManagementPapComponentConfig";
|
|
67
|
+
export * from "./models/config/rightsManagementPipComponentConfig";
|
|
68
|
+
export * from "./models/config/rightsManagementPepComponentConfig";
|
|
69
|
+
export * from "./models/config/rightsManagementPdpComponentConfig";
|
|
70
|
+
export * from "./models/config/rightsManagementPxpComponentConfig";
|
|
71
|
+
export * from "./models/config/rightsManagementPmpComponentConfig";
|
|
62
72
|
export * from "./models/config/synchronisedStorageComponentConfig";
|
|
63
73
|
export * from "./models/config/taskSchedulerComponentConfig";
|
|
64
74
|
export * from "./models/config/telemetryComponentConfig";
|
|
@@ -103,6 +113,11 @@ export * from "./models/types/nftComponentType";
|
|
|
103
113
|
export * from "./models/types/nftConnectorType";
|
|
104
114
|
export * from "./models/types/rightsManagementComponentType";
|
|
105
115
|
export * from "./models/types/rightsManagementPapComponentType";
|
|
116
|
+
export * from "./models/types/rightsManagementPepComponentType";
|
|
117
|
+
export * from "./models/types/rightsManagementPipComponentType";
|
|
118
|
+
export * from "./models/types/rightsManagementPxpComponentType";
|
|
119
|
+
export * from "./models/types/rightsManagementPdpComponentType";
|
|
120
|
+
export * from "./models/types/rightsManagementPmpComponentType";
|
|
106
121
|
export * from "./models/types/synchronisedStorageComponentType";
|
|
107
122
|
export * from "./models/types/taskSchedulerComponentType";
|
|
108
123
|
export * from "./models/types/telemetryComponentType";
|
|
@@ -34,6 +34,11 @@ import type { NftComponentConfig } from "./config/nftComponentConfig";
|
|
|
34
34
|
import type { NftConnectorConfig } from "./config/nftConnectorConfig";
|
|
35
35
|
import type { RightsManagementComponentConfig } from "./config/rightsManagementComponentConfig";
|
|
36
36
|
import type { RightsManagementPapComponentConfig } from "./config/rightsManagementPapComponentConfig";
|
|
37
|
+
import type { RightsManagementPdpComponentConfig } from "./config/rightsManagementPdpComponentConfig";
|
|
38
|
+
import type { RightsManagementPepComponentConfig } from "./config/rightsManagementPepComponentConfig";
|
|
39
|
+
import type { RightsManagementPipComponentConfig } from "./config/rightsManagementPipComponentConfig";
|
|
40
|
+
import type { RightsManagementPmpComponentConfig } from "./config/rightsManagementPmpComponentConfig";
|
|
41
|
+
import type { RightsManagementPxpComponentConfig } from "./config/rightsManagementPxpComponentConfig";
|
|
37
42
|
import type { SynchronisedStorageComponentConfig } from "./config/synchronisedStorageComponentConfig";
|
|
38
43
|
import type { TaskSchedulerComponentConfig } from "./config/taskSchedulerComponentConfig";
|
|
39
44
|
import type { TelemetryComponentConfig } from "./config/telemetryComponentConfig";
|
|
@@ -215,6 +220,26 @@ export interface IEngineConfig extends IEngineCoreConfig {
|
|
|
215
220
|
* Rights management PAP options which can be overridden by individual components by specifying types other than default.
|
|
216
221
|
*/
|
|
217
222
|
rightsManagementPapComponent?: IEngineCoreTypeConfig<RightsManagementPapComponentConfig>[];
|
|
223
|
+
/**
|
|
224
|
+
* Rights management PDP options which can be overridden by individual components by specifying types other than default.
|
|
225
|
+
*/
|
|
226
|
+
rightsManagementPdpComponent?: IEngineCoreTypeConfig<RightsManagementPdpComponentConfig>[];
|
|
227
|
+
/**
|
|
228
|
+
* Rights management PEP options which can be overridden by individual components by specifying types other than default.
|
|
229
|
+
*/
|
|
230
|
+
rightsManagementPepComponent?: IEngineCoreTypeConfig<RightsManagementPepComponentConfig>[];
|
|
231
|
+
/**
|
|
232
|
+
* Rights management PIP options which can be overridden by individual components by specifying types other than default.
|
|
233
|
+
*/
|
|
234
|
+
rightsManagementPipComponent?: IEngineCoreTypeConfig<RightsManagementPipComponentConfig>[];
|
|
235
|
+
/**
|
|
236
|
+
* Rights management PMP options which can be overridden by individual components by specifying types other than default.
|
|
237
|
+
*/
|
|
238
|
+
rightsManagementPmpComponent?: IEngineCoreTypeConfig<RightsManagementPmpComponentConfig>[];
|
|
239
|
+
/**
|
|
240
|
+
* Rights management PXP options which can be overridden by individual components by specifying types other than default.
|
|
241
|
+
*/
|
|
242
|
+
rightsManagementPxpComponent?: IEngineCoreTypeConfig<RightsManagementPxpComponentConfig>[];
|
|
218
243
|
/**
|
|
219
244
|
* Synchronised storage options which can be overridden by individual components by specifying types other than default.
|
|
220
245
|
*/
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { IPolicyDecisionPointServiceOptions } from "@twin.org/rights-management-pdp-service";
|
|
2
|
+
import type { RightsManagementPdpComponentType } from "../types/rightsManagementPdpComponentType";
|
|
3
|
+
/**
|
|
4
|
+
* Rights management PDP component config types.
|
|
5
|
+
*/
|
|
6
|
+
export type RightsManagementPdpComponentConfig = {
|
|
7
|
+
type: typeof RightsManagementPdpComponentType.Service;
|
|
8
|
+
options?: IPolicyDecisionPointServiceOptions;
|
|
9
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { IPolicyEnforcementPointServiceOptions } from "@twin.org/rights-management-pep-service";
|
|
2
|
+
import type { RightsManagementPepComponentType } from "../types/rightsManagementPepComponentType";
|
|
3
|
+
/**
|
|
4
|
+
* Rights management PEP component config types.
|
|
5
|
+
*/
|
|
6
|
+
export type RightsManagementPepComponentConfig = {
|
|
7
|
+
type: typeof RightsManagementPepComponentType.Service;
|
|
8
|
+
options?: IPolicyEnforcementPointServiceOptions;
|
|
9
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { IPolicyInformationPointServiceOptions } from "@twin.org/rights-management-pip-service";
|
|
2
|
+
import type { RightsManagementPipComponentType } from "../types/rightsManagementPipComponentType";
|
|
3
|
+
/**
|
|
4
|
+
* Rights management PIP component config types.
|
|
5
|
+
*/
|
|
6
|
+
export type RightsManagementPipComponentConfig = {
|
|
7
|
+
type: typeof RightsManagementPipComponentType.Service;
|
|
8
|
+
options?: IPolicyInformationPointServiceOptions;
|
|
9
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { IPolicyManagementPointServiceOptions } from "@twin.org/rights-management-pmp-service";
|
|
2
|
+
import type { RightsManagementPmpComponentType } from "../types/rightsManagementPmpComponentType";
|
|
3
|
+
/**
|
|
4
|
+
* Rights management PMP component config types.
|
|
5
|
+
*/
|
|
6
|
+
export type RightsManagementPmpComponentConfig = {
|
|
7
|
+
type: typeof RightsManagementPmpComponentType.Service;
|
|
8
|
+
options?: IPolicyManagementPointServiceOptions;
|
|
9
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { IPolicyExecutionPointServiceOptions } from "@twin.org/rights-management-pxp-service";
|
|
2
|
+
import type { RightsManagementPxpComponentType } from "../types/rightsManagementPxpComponentType";
|
|
3
|
+
/**
|
|
4
|
+
* Rights management PXP component config types.
|
|
5
|
+
*/
|
|
6
|
+
export type RightsManagementPxpComponentConfig = {
|
|
7
|
+
type: typeof RightsManagementPxpComponentType.Service;
|
|
8
|
+
options?: IPolicyExecutionPointServiceOptions;
|
|
9
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Rights management PDP component types.
|
|
3
|
+
*/
|
|
4
|
+
export declare const RightsManagementPdpComponentType: {
|
|
5
|
+
/**
|
|
6
|
+
* Service.
|
|
7
|
+
*/
|
|
8
|
+
readonly Service: "service";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Rights management PDP component types.
|
|
12
|
+
*/
|
|
13
|
+
export type RightsManagementPdpComponentType = (typeof RightsManagementPdpComponentType)[keyof typeof RightsManagementPdpComponentType];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Rights management PEP component types.
|
|
3
|
+
*/
|
|
4
|
+
export declare const RightsManagementPepComponentType: {
|
|
5
|
+
/**
|
|
6
|
+
* Service.
|
|
7
|
+
*/
|
|
8
|
+
readonly Service: "service";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Rights management PEP component types.
|
|
12
|
+
*/
|
|
13
|
+
export type RightsManagementPepComponentType = (typeof RightsManagementPepComponentType)[keyof typeof RightsManagementPepComponentType];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Rights management PIP component types.
|
|
3
|
+
*/
|
|
4
|
+
export declare const RightsManagementPipComponentType: {
|
|
5
|
+
/**
|
|
6
|
+
* Service.
|
|
7
|
+
*/
|
|
8
|
+
readonly Service: "service";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Rights management PIP component types.
|
|
12
|
+
*/
|
|
13
|
+
export type RightsManagementPipComponentType = (typeof RightsManagementPipComponentType)[keyof typeof RightsManagementPipComponentType];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Rights management PMP component types.
|
|
3
|
+
*/
|
|
4
|
+
export declare const RightsManagementPmpComponentType: {
|
|
5
|
+
/**
|
|
6
|
+
* Service.
|
|
7
|
+
*/
|
|
8
|
+
readonly Service: "service";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Rights management PMP component types.
|
|
12
|
+
*/
|
|
13
|
+
export type RightsManagementPmpComponentType = (typeof RightsManagementPmpComponentType)[keyof typeof RightsManagementPmpComponentType];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Rights management PXP component types.
|
|
3
|
+
*/
|
|
4
|
+
export declare const RightsManagementPxpComponentType: {
|
|
5
|
+
/**
|
|
6
|
+
* Service.
|
|
7
|
+
*/
|
|
8
|
+
readonly Service: "service";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Rights management PXP component types.
|
|
12
|
+
*/
|
|
13
|
+
export type RightsManagementPxpComponentType = (typeof RightsManagementPxpComponentType)[keyof typeof RightsManagementPxpComponentType];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/engine-types - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.7...engine-types-v0.0.2-next.8) (2025-08-22)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/engine-models bumped from 0.0.2-next.7 to 0.0.2-next.8
|
|
16
|
+
|
|
3
17
|
## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.6...engine-types-v0.0.2-next.7) (2025-08-22)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Function: initialiseRightsManagementPdpComponent()
|
|
2
|
+
|
|
3
|
+
> **initialiseRightsManagementPdpComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
|
+
|
|
5
|
+
Initialise the rights management PDP component.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### engineCore
|
|
10
|
+
|
|
11
|
+
`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
12
|
+
|
|
13
|
+
The engine core.
|
|
14
|
+
|
|
15
|
+
### context
|
|
16
|
+
|
|
17
|
+
`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
18
|
+
|
|
19
|
+
The context for the engine.
|
|
20
|
+
|
|
21
|
+
### instanceConfig
|
|
22
|
+
|
|
23
|
+
[`RightsManagementPdpComponentConfig`](../type-aliases/RightsManagementPdpComponentConfig.md)
|
|
24
|
+
|
|
25
|
+
The instance config.
|
|
26
|
+
|
|
27
|
+
### overrideInstanceType?
|
|
28
|
+
|
|
29
|
+
`string`
|
|
30
|
+
|
|
31
|
+
The instance type to override the default.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`undefined` \| `string`
|
|
36
|
+
|
|
37
|
+
The name of the instance created.
|
|
38
|
+
|
|
39
|
+
## Throws
|
|
40
|
+
|
|
41
|
+
GeneralError if the component type is unknown.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Function: initialiseRightsManagementPepComponent()
|
|
2
|
+
|
|
3
|
+
> **initialiseRightsManagementPepComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
|
+
|
|
5
|
+
Initialise the rights management PEP component.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### engineCore
|
|
10
|
+
|
|
11
|
+
`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
12
|
+
|
|
13
|
+
The engine core.
|
|
14
|
+
|
|
15
|
+
### context
|
|
16
|
+
|
|
17
|
+
`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
18
|
+
|
|
19
|
+
The context for the engine.
|
|
20
|
+
|
|
21
|
+
### instanceConfig
|
|
22
|
+
|
|
23
|
+
[`RightsManagementPepComponentConfig`](../type-aliases/RightsManagementPepComponentConfig.md)
|
|
24
|
+
|
|
25
|
+
The instance config.
|
|
26
|
+
|
|
27
|
+
### overrideInstanceType?
|
|
28
|
+
|
|
29
|
+
`string`
|
|
30
|
+
|
|
31
|
+
The instance type to override the default.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`undefined` \| `string`
|
|
36
|
+
|
|
37
|
+
The name of the instance created.
|
|
38
|
+
|
|
39
|
+
## Throws
|
|
40
|
+
|
|
41
|
+
GeneralError if the component type is unknown.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Function: initialiseRightsManagementPipComponent()
|
|
2
|
+
|
|
3
|
+
> **initialiseRightsManagementPipComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
|
+
|
|
5
|
+
Initialise the rights management PIP component.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### engineCore
|
|
10
|
+
|
|
11
|
+
`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
12
|
+
|
|
13
|
+
The engine core.
|
|
14
|
+
|
|
15
|
+
### context
|
|
16
|
+
|
|
17
|
+
`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
18
|
+
|
|
19
|
+
The context for the engine.
|
|
20
|
+
|
|
21
|
+
### instanceConfig
|
|
22
|
+
|
|
23
|
+
[`RightsManagementPipComponentConfig`](../type-aliases/RightsManagementPipComponentConfig.md)
|
|
24
|
+
|
|
25
|
+
The instance config.
|
|
26
|
+
|
|
27
|
+
### overrideInstanceType?
|
|
28
|
+
|
|
29
|
+
`string`
|
|
30
|
+
|
|
31
|
+
The instance type to override the default.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`undefined` \| `string`
|
|
36
|
+
|
|
37
|
+
The name of the instance created.
|
|
38
|
+
|
|
39
|
+
## Throws
|
|
40
|
+
|
|
41
|
+
GeneralError if the component type is unknown.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Function: initialiseRightsManagementPmpComponent()
|
|
2
|
+
|
|
3
|
+
> **initialiseRightsManagementPmpComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
|
+
|
|
5
|
+
Initialise the rights management PMP component.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### engineCore
|
|
10
|
+
|
|
11
|
+
`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
12
|
+
|
|
13
|
+
The engine core.
|
|
14
|
+
|
|
15
|
+
### context
|
|
16
|
+
|
|
17
|
+
`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
18
|
+
|
|
19
|
+
The context for the engine.
|
|
20
|
+
|
|
21
|
+
### instanceConfig
|
|
22
|
+
|
|
23
|
+
[`RightsManagementPmpComponentConfig`](../type-aliases/RightsManagementPmpComponentConfig.md)
|
|
24
|
+
|
|
25
|
+
The instance config.
|
|
26
|
+
|
|
27
|
+
### overrideInstanceType?
|
|
28
|
+
|
|
29
|
+
`string`
|
|
30
|
+
|
|
31
|
+
The instance type to override the default.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`undefined` \| `string`
|
|
36
|
+
|
|
37
|
+
The name of the instance created.
|
|
38
|
+
|
|
39
|
+
## Throws
|
|
40
|
+
|
|
41
|
+
GeneralError if the component type is unknown.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Function: initialiseRightsManagementPxpComponent()
|
|
2
|
+
|
|
3
|
+
> **initialiseRightsManagementPxpComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
|
|
4
|
+
|
|
5
|
+
Initialise the rights management PXP component.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### engineCore
|
|
10
|
+
|
|
11
|
+
`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
12
|
+
|
|
13
|
+
The engine core.
|
|
14
|
+
|
|
15
|
+
### context
|
|
16
|
+
|
|
17
|
+
`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
|
|
18
|
+
|
|
19
|
+
The context for the engine.
|
|
20
|
+
|
|
21
|
+
### instanceConfig
|
|
22
|
+
|
|
23
|
+
[`RightsManagementPxpComponentConfig`](../type-aliases/RightsManagementPxpComponentConfig.md)
|
|
24
|
+
|
|
25
|
+
The instance config.
|
|
26
|
+
|
|
27
|
+
### overrideInstanceType?
|
|
28
|
+
|
|
29
|
+
`string`
|
|
30
|
+
|
|
31
|
+
The instance type to override the default.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`undefined` \| `string`
|
|
36
|
+
|
|
37
|
+
The name of the instance created.
|
|
38
|
+
|
|
39
|
+
## Throws
|
|
40
|
+
|
|
41
|
+
GeneralError if the component type is unknown.
|
package/docs/reference/index.md
CHANGED
|
@@ -41,6 +41,11 @@
|
|
|
41
41
|
- [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
|
|
42
42
|
- [RightsManagementComponentConfig](type-aliases/RightsManagementComponentConfig.md)
|
|
43
43
|
- [RightsManagementPapComponentConfig](type-aliases/RightsManagementPapComponentConfig.md)
|
|
44
|
+
- [RightsManagementPdpComponentConfig](type-aliases/RightsManagementPdpComponentConfig.md)
|
|
45
|
+
- [RightsManagementPepComponentConfig](type-aliases/RightsManagementPepComponentConfig.md)
|
|
46
|
+
- [RightsManagementPipComponentConfig](type-aliases/RightsManagementPipComponentConfig.md)
|
|
47
|
+
- [RightsManagementPmpComponentConfig](type-aliases/RightsManagementPmpComponentConfig.md)
|
|
48
|
+
- [RightsManagementPxpComponentConfig](type-aliases/RightsManagementPxpComponentConfig.md)
|
|
44
49
|
- [SynchronisedStorageComponentConfig](type-aliases/SynchronisedStorageComponentConfig.md)
|
|
45
50
|
- [TaskSchedulerComponentConfig](type-aliases/TaskSchedulerComponentConfig.md)
|
|
46
51
|
- [TelemetryComponentConfig](type-aliases/TelemetryComponentConfig.md)
|
|
@@ -84,6 +89,11 @@
|
|
|
84
89
|
- [NftConnectorType](type-aliases/NftConnectorType.md)
|
|
85
90
|
- [RightsManagementComponentType](type-aliases/RightsManagementComponentType.md)
|
|
86
91
|
- [RightsManagementPapComponentType](type-aliases/RightsManagementPapComponentType.md)
|
|
92
|
+
- [RightsManagementPdpComponentType](type-aliases/RightsManagementPdpComponentType.md)
|
|
93
|
+
- [RightsManagementPepComponentType](type-aliases/RightsManagementPepComponentType.md)
|
|
94
|
+
- [RightsManagementPipComponentType](type-aliases/RightsManagementPipComponentType.md)
|
|
95
|
+
- [RightsManagementPmpComponentType](type-aliases/RightsManagementPmpComponentType.md)
|
|
96
|
+
- [RightsManagementPxpComponentType](type-aliases/RightsManagementPxpComponentType.md)
|
|
87
97
|
- [SynchronisedStorageComponentType](type-aliases/SynchronisedStorageComponentType.md)
|
|
88
98
|
- [TaskSchedulerComponentType](type-aliases/TaskSchedulerComponentType.md)
|
|
89
99
|
- [TelemetryComponentType](type-aliases/TelemetryComponentType.md)
|
|
@@ -130,6 +140,11 @@
|
|
|
130
140
|
- [NftConnectorType](variables/NftConnectorType.md)
|
|
131
141
|
- [RightsManagementComponentType](variables/RightsManagementComponentType.md)
|
|
132
142
|
- [RightsManagementPapComponentType](variables/RightsManagementPapComponentType.md)
|
|
143
|
+
- [RightsManagementPdpComponentType](variables/RightsManagementPdpComponentType.md)
|
|
144
|
+
- [RightsManagementPepComponentType](variables/RightsManagementPepComponentType.md)
|
|
145
|
+
- [RightsManagementPipComponentType](variables/RightsManagementPipComponentType.md)
|
|
146
|
+
- [RightsManagementPmpComponentType](variables/RightsManagementPmpComponentType.md)
|
|
147
|
+
- [RightsManagementPxpComponentType](variables/RightsManagementPxpComponentType.md)
|
|
133
148
|
- [SynchronisedStorageComponentType](variables/SynchronisedStorageComponentType.md)
|
|
134
149
|
- [TaskSchedulerComponentType](variables/TaskSchedulerComponentType.md)
|
|
135
150
|
- [TelemetryComponentType](variables/TelemetryComponentType.md)
|
|
@@ -175,6 +190,11 @@
|
|
|
175
190
|
- [initialiseNftComponent](functions/initialiseNftComponent.md)
|
|
176
191
|
- [initialiseRightsManagementComponent](functions/initialiseRightsManagementComponent.md)
|
|
177
192
|
- [initialiseRightsManagementPapComponent](functions/initialiseRightsManagementPapComponent.md)
|
|
193
|
+
- [initialiseRightsManagementPdpComponent](functions/initialiseRightsManagementPdpComponent.md)
|
|
194
|
+
- [initialiseRightsManagementPepComponent](functions/initialiseRightsManagementPepComponent.md)
|
|
195
|
+
- [initialiseRightsManagementPipComponent](functions/initialiseRightsManagementPipComponent.md)
|
|
196
|
+
- [initialiseRightsManagementPmpComponent](functions/initialiseRightsManagementPmpComponent.md)
|
|
197
|
+
- [initialiseRightsManagementPxpComponent](functions/initialiseRightsManagementPxpComponent.md)
|
|
178
198
|
- [initialiseSynchronisedStorageComponent](functions/initialiseSynchronisedStorageComponent.md)
|
|
179
199
|
- [initialiseTaskSchedulerComponent](functions/initialiseTaskSchedulerComponent.md)
|
|
180
200
|
- [initialiseTelemetryConnector](functions/initialiseTelemetryConnector.md)
|
|
@@ -264,6 +264,36 @@ Rights management options which can be overridden by individual components by sp
|
|
|
264
264
|
|
|
265
265
|
Rights management PAP options which can be overridden by individual components by specifying types other than default.
|
|
266
266
|
|
|
267
|
+
#### rightsManagementPdpComponent?
|
|
268
|
+
|
|
269
|
+
> `optional` **rightsManagementPdpComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementPdpComponentConfig`](../type-aliases/RightsManagementPdpComponentConfig.md)\>[]
|
|
270
|
+
|
|
271
|
+
Rights management PDP options which can be overridden by individual components by specifying types other than default.
|
|
272
|
+
|
|
273
|
+
#### rightsManagementPepComponent?
|
|
274
|
+
|
|
275
|
+
> `optional` **rightsManagementPepComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementPepComponentConfig`](../type-aliases/RightsManagementPepComponentConfig.md)\>[]
|
|
276
|
+
|
|
277
|
+
Rights management PEP options which can be overridden by individual components by specifying types other than default.
|
|
278
|
+
|
|
279
|
+
#### rightsManagementPipComponent?
|
|
280
|
+
|
|
281
|
+
> `optional` **rightsManagementPipComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementPipComponentConfig`](../type-aliases/RightsManagementPipComponentConfig.md)\>[]
|
|
282
|
+
|
|
283
|
+
Rights management PIP options which can be overridden by individual components by specifying types other than default.
|
|
284
|
+
|
|
285
|
+
#### rightsManagementPmpComponent?
|
|
286
|
+
|
|
287
|
+
> `optional` **rightsManagementPmpComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementPmpComponentConfig`](../type-aliases/RightsManagementPmpComponentConfig.md)\>[]
|
|
288
|
+
|
|
289
|
+
Rights management PMP options which can be overridden by individual components by specifying types other than default.
|
|
290
|
+
|
|
291
|
+
#### rightsManagementPxpComponent?
|
|
292
|
+
|
|
293
|
+
> `optional` **rightsManagementPxpComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementPxpComponentConfig`](../type-aliases/RightsManagementPxpComponentConfig.md)\>[]
|
|
294
|
+
|
|
295
|
+
Rights management PXP options which can be overridden by individual components by specifying types other than default.
|
|
296
|
+
|
|
267
297
|
#### synchronisedStorageComponent?
|
|
268
298
|
|
|
269
299
|
> `optional` **synchronisedStorageComponent**: `IEngineCoreTypeConfig`\<[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md)\>[]
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Type Alias: RightsManagementPdpComponentConfig
|
|
2
|
+
|
|
3
|
+
> **RightsManagementPdpComponentConfig** = `object`
|
|
4
|
+
|
|
5
|
+
Rights management PDP component config types.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
### type
|
|
10
|
+
|
|
11
|
+
> **type**: *typeof* [`Service`](../variables/RightsManagementPdpComponentType.md#service)
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### options?
|
|
16
|
+
|
|
17
|
+
> `optional` **options**: `IPolicyDecisionPointServiceOptions`
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: RightsManagementPdpComponentType
|
|
2
|
+
|
|
3
|
+
> **RightsManagementPdpComponentType** = *typeof* [`RightsManagementPdpComponentType`](../variables/RightsManagementPdpComponentType.md)\[keyof *typeof* [`RightsManagementPdpComponentType`](../variables/RightsManagementPdpComponentType.md)\]
|
|
4
|
+
|
|
5
|
+
Rights management PDP component types.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Type Alias: RightsManagementPepComponentConfig
|
|
2
|
+
|
|
3
|
+
> **RightsManagementPepComponentConfig** = `object`
|
|
4
|
+
|
|
5
|
+
Rights management PEP component config types.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
### type
|
|
10
|
+
|
|
11
|
+
> **type**: *typeof* [`Service`](../variables/RightsManagementPepComponentType.md#service)
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### options?
|
|
16
|
+
|
|
17
|
+
> `optional` **options**: `IPolicyEnforcementPointServiceOptions`
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: RightsManagementPepComponentType
|
|
2
|
+
|
|
3
|
+
> **RightsManagementPepComponentType** = *typeof* [`RightsManagementPepComponentType`](../variables/RightsManagementPepComponentType.md)\[keyof *typeof* [`RightsManagementPepComponentType`](../variables/RightsManagementPepComponentType.md)\]
|
|
4
|
+
|
|
5
|
+
Rights management PEP component types.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Type Alias: RightsManagementPipComponentConfig
|
|
2
|
+
|
|
3
|
+
> **RightsManagementPipComponentConfig** = `object`
|
|
4
|
+
|
|
5
|
+
Rights management PIP component config types.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
### type
|
|
10
|
+
|
|
11
|
+
> **type**: *typeof* [`Service`](../variables/RightsManagementPipComponentType.md#service)
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### options?
|
|
16
|
+
|
|
17
|
+
> `optional` **options**: `IPolicyInformationPointServiceOptions`
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: RightsManagementPipComponentType
|
|
2
|
+
|
|
3
|
+
> **RightsManagementPipComponentType** = *typeof* [`RightsManagementPipComponentType`](../variables/RightsManagementPipComponentType.md)\[keyof *typeof* [`RightsManagementPipComponentType`](../variables/RightsManagementPipComponentType.md)\]
|
|
4
|
+
|
|
5
|
+
Rights management PIP component types.
|