@twin.org/engine-types 0.0.2-next.2 → 0.0.2-next.20

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.
Files changed (218) hide show
  1. package/dist/cjs/index.cjs +1310 -1098
  2. package/dist/esm/index.mjs +1312 -1124
  3. package/dist/types/components/attestation.d.ts +14 -8
  4. package/dist/types/components/auditableItemGraph.d.ts +7 -4
  5. package/dist/types/components/auditableItemStream.d.ts +7 -4
  6. package/dist/types/components/authenticationGenerator.d.ts +17 -0
  7. package/dist/types/components/backgroundTask.d.ts +8 -4
  8. package/dist/types/components/blobStorage.d.ts +14 -8
  9. package/dist/types/components/dataProcessing.d.ts +20 -12
  10. package/dist/types/components/dataSpaceConnector.d.ts +16 -0
  11. package/dist/types/components/documentManagement.d.ts +7 -4
  12. package/dist/types/components/entityStorage.d.ts +10 -6
  13. package/dist/types/components/eventBus.d.ts +14 -8
  14. package/dist/types/components/faucet.d.ts +8 -4
  15. package/dist/types/components/federatedCatalogue.d.ts +7 -4
  16. package/dist/types/components/identity.d.ts +14 -8
  17. package/dist/types/components/identityProfile.d.ts +14 -8
  18. package/dist/types/components/identityResolver.d.ts +14 -8
  19. package/dist/types/components/immutableProof.d.ts +7 -4
  20. package/dist/types/components/logging.d.ts +14 -8
  21. package/dist/types/components/messaging.d.ts +39 -16
  22. package/dist/types/components/nft.d.ts +14 -8
  23. package/dist/types/components/rightsManagementDap.d.ts +16 -0
  24. package/dist/types/components/rightsManagementDarp.d.ts +16 -0
  25. package/dist/types/components/rightsManagementPap.d.ts +7 -4
  26. package/dist/types/components/rightsManagementPdp.d.ts +16 -0
  27. package/dist/types/components/rightsManagementPep.d.ts +16 -0
  28. package/dist/types/components/rightsManagementPip.d.ts +16 -0
  29. package/dist/types/components/rightsManagementPmp.d.ts +16 -0
  30. package/dist/types/components/rightsManagementPnap.d.ts +16 -0
  31. package/dist/types/components/rightsManagementPnp.d.ts +16 -0
  32. package/dist/types/components/rightsManagementPxp.d.ts +16 -0
  33. package/dist/types/components/synchronisedStorage.d.ts +16 -0
  34. package/dist/types/components/taskScheduler.d.ts +7 -4
  35. package/dist/types/components/telemetry.d.ts +14 -8
  36. package/dist/types/components/vault.d.ts +8 -4
  37. package/dist/types/components/verifiableStorage.d.ts +14 -8
  38. package/dist/types/components/wallet.d.ts +8 -14
  39. package/dist/types/index.d.ts +39 -3
  40. package/dist/types/models/IEngineConfig.d.ts +67 -7
  41. package/dist/types/models/config/authenticationGeneratorComponentConfig.d.ts +9 -0
  42. package/dist/types/models/config/dataSpaceConnectorComponentConfig.d.ts +17 -0
  43. package/dist/types/models/config/entityStorageConnectorConfig.d.ts +4 -0
  44. package/dist/types/models/config/messagingAdminComponentConfig.d.ts +9 -0
  45. package/dist/types/models/config/rightsManagementDapComponentConfig.d.ts +16 -0
  46. package/dist/types/models/config/rightsManagementDarpComponentConfig.d.ts +12 -0
  47. package/dist/types/models/config/rightsManagementPapComponentConfig.d.ts +6 -2
  48. package/dist/types/models/config/rightsManagementPdpComponentConfig.d.ts +12 -0
  49. package/dist/types/models/config/rightsManagementPepComponentConfig.d.ts +12 -0
  50. package/dist/types/models/config/rightsManagementPipComponentConfig.d.ts +12 -0
  51. package/dist/types/models/config/rightsManagementPmpComponentConfig.d.ts +9 -0
  52. package/dist/types/models/config/rightsManagementPnapComponentConfig.d.ts +13 -0
  53. package/dist/types/models/config/rightsManagementPnpComponentConfig.d.ts +17 -0
  54. package/dist/types/models/config/rightsManagementPxpComponentConfig.d.ts +12 -0
  55. package/dist/types/models/config/synchronisedStorageComponentConfig.d.ts +13 -0
  56. package/dist/types/models/types/authenticationGeneratorComponentType.d.ts +13 -0
  57. package/dist/types/models/types/dataSpaceConnectorComponentType.d.ts +21 -0
  58. package/dist/types/models/types/entityStorageConnectorType.d.ts +4 -0
  59. package/dist/types/models/types/messagingAdminComponentType.d.ts +13 -0
  60. package/dist/types/models/types/rightsManagementDapComponentType.d.ts +17 -0
  61. package/dist/types/models/types/rightsManagementDarpComponentType.d.ts +13 -0
  62. package/dist/types/models/types/rightsManagementPapComponentType.d.ts +4 -0
  63. package/dist/types/models/types/rightsManagementPdpComponentType.d.ts +13 -0
  64. package/dist/types/models/types/rightsManagementPepComponentType.d.ts +17 -0
  65. package/dist/types/models/types/rightsManagementPipComponentType.d.ts +13 -0
  66. package/dist/types/models/types/rightsManagementPmpComponentType.d.ts +13 -0
  67. package/dist/types/models/types/rightsManagementPnapComponentType.d.ts +17 -0
  68. package/dist/types/models/types/rightsManagementPnpComponentType.d.ts +17 -0
  69. package/dist/types/models/types/rightsManagementPxpComponentType.d.ts +13 -0
  70. package/dist/types/models/types/synchronisedStorageComponentType.d.ts +17 -0
  71. package/dist/types/utils/engineTypeHelper.d.ts +19 -0
  72. package/docs/changelog.md +261 -0
  73. package/docs/reference/classes/EngineTypeHelper.md +61 -0
  74. package/docs/reference/functions/initialiseAttestationComponent.md +3 -13
  75. package/docs/reference/functions/initialiseAttestationConnector.md +3 -13
  76. package/docs/reference/functions/initialiseAuditableItemGraphComponent.md +3 -13
  77. package/docs/reference/functions/initialiseAuditableItemStreamComponent.md +3 -13
  78. package/docs/reference/functions/initialiseAuthenticationGeneratorComponent.md +31 -0
  79. package/docs/reference/functions/initialiseBackgroundTaskConnector.md +3 -13
  80. package/docs/reference/functions/initialiseBlobStorageComponent.md +3 -13
  81. package/docs/reference/functions/initialiseBlobStorageConnector.md +3 -13
  82. package/docs/reference/functions/initialiseDataConverterConnector.md +3 -13
  83. package/docs/reference/functions/initialiseDataExtractorConnector.md +3 -13
  84. package/docs/reference/functions/initialiseDataProcessingComponent.md +3 -13
  85. package/docs/reference/functions/initialiseDataSpaceConnectorComponent.md +31 -0
  86. package/docs/reference/functions/initialiseDocumentManagementComponent.md +3 -13
  87. package/docs/reference/functions/initialiseEntityStorageComponent.md +3 -13
  88. package/docs/reference/functions/initialiseEntityStorageConnector.md +5 -3
  89. package/docs/reference/functions/initialiseEventBusComponent.md +3 -13
  90. package/docs/reference/functions/initialiseEventBusConnector.md +3 -13
  91. package/docs/reference/functions/initialiseFaucetConnector.md +3 -13
  92. package/docs/reference/functions/initialiseFederatedCatalogueComponent.md +3 -13
  93. package/docs/reference/functions/initialiseIdentityComponent.md +3 -13
  94. package/docs/reference/functions/initialiseIdentityConnector.md +3 -13
  95. package/docs/reference/functions/initialiseIdentityProfileComponent.md +3 -13
  96. package/docs/reference/functions/initialiseIdentityProfileConnector.md +3 -13
  97. package/docs/reference/functions/initialiseIdentityResolverComponent.md +3 -13
  98. package/docs/reference/functions/initialiseIdentityResolverConnector.md +3 -13
  99. package/docs/reference/functions/initialiseImmutableProofComponent.md +3 -13
  100. package/docs/reference/functions/initialiseLoggingComponent.md +3 -13
  101. package/docs/reference/functions/initialiseLoggingConnector.md +3 -13
  102. package/docs/reference/functions/initialiseMessagingAdminComponent.md +31 -0
  103. package/docs/reference/functions/initialiseMessagingComponent.md +3 -13
  104. package/docs/reference/functions/initialiseMessagingEmailConnector.md +3 -13
  105. package/docs/reference/functions/initialiseMessagingPushNotificationConnector.md +3 -13
  106. package/docs/reference/functions/initialiseMessagingSmsConnector.md +3 -13
  107. package/docs/reference/functions/initialiseNftComponent.md +3 -13
  108. package/docs/reference/functions/initialiseNftConnector.md +3 -13
  109. package/docs/reference/functions/initialiseRightsManagementDapComponent.md +31 -0
  110. package/docs/reference/functions/initialiseRightsManagementDarpComponent.md +31 -0
  111. package/docs/reference/functions/initialiseRightsManagementPapComponent.md +3 -13
  112. package/docs/reference/functions/initialiseRightsManagementPdpComponent.md +31 -0
  113. package/docs/reference/functions/initialiseRightsManagementPepComponent.md +31 -0
  114. package/docs/reference/functions/initialiseRightsManagementPipComponent.md +31 -0
  115. package/docs/reference/functions/initialiseRightsManagementPmpComponent.md +31 -0
  116. package/docs/reference/functions/initialiseRightsManagementPnapComponent.md +31 -0
  117. package/docs/reference/functions/initialiseRightsManagementPnpComponent.md +31 -0
  118. package/docs/reference/functions/initialiseRightsManagementPxpComponent.md +31 -0
  119. package/docs/reference/functions/initialiseSynchronisedStorageComponent.md +31 -0
  120. package/docs/reference/functions/initialiseTaskSchedulerComponent.md +3 -13
  121. package/docs/reference/functions/initialiseTelemetryComponent.md +3 -13
  122. package/docs/reference/functions/initialiseTelemetryConnector.md +3 -13
  123. package/docs/reference/functions/initialiseVaultConnector.md +3 -13
  124. package/docs/reference/functions/initialiseVerifiableStorageComponent.md +3 -13
  125. package/docs/reference/functions/initialiseVerifiableStorageConnector.md +3 -13
  126. package/docs/reference/functions/initialiseWalletConnector.md +3 -13
  127. package/docs/reference/index.md +56 -5
  128. package/docs/reference/interfaces/IEngineConfig.md +81 -9
  129. package/docs/reference/type-aliases/AuthenticationGeneratorComponentConfig.md +17 -0
  130. package/docs/reference/type-aliases/AuthenticationGeneratorComponentType.md +5 -0
  131. package/docs/reference/type-aliases/DataSpaceConnectorComponentConfig.md +5 -0
  132. package/docs/reference/type-aliases/DataSpaceConnectorComponentType.md +5 -0
  133. package/docs/reference/type-aliases/EntityStorageConnectorConfig.md +1 -1
  134. package/docs/reference/type-aliases/MessagingAdminComponentConfig.md +17 -0
  135. package/docs/reference/type-aliases/MessagingAdminComponentType.md +5 -0
  136. package/docs/reference/type-aliases/RightsManagementDapComponentConfig.md +5 -0
  137. package/docs/reference/type-aliases/RightsManagementDapComponentType.md +5 -0
  138. package/docs/reference/type-aliases/RightsManagementDarpComponentConfig.md +23 -0
  139. package/docs/reference/type-aliases/RightsManagementDarpComponentType.md +5 -0
  140. package/docs/reference/type-aliases/RightsManagementPapComponentConfig.md +1 -13
  141. package/docs/reference/type-aliases/RightsManagementPdpComponentConfig.md +23 -0
  142. package/docs/reference/type-aliases/RightsManagementPdpComponentType.md +5 -0
  143. package/docs/reference/type-aliases/RightsManagementPepComponentConfig.md +23 -0
  144. package/docs/reference/type-aliases/RightsManagementPepComponentType.md +5 -0
  145. package/docs/reference/type-aliases/RightsManagementPipComponentConfig.md +23 -0
  146. package/docs/reference/type-aliases/RightsManagementPipComponentType.md +5 -0
  147. package/docs/reference/type-aliases/RightsManagementPmpComponentConfig.md +17 -0
  148. package/docs/reference/type-aliases/RightsManagementPmpComponentType.md +5 -0
  149. package/docs/reference/type-aliases/RightsManagementPnapComponentConfig.md +5 -0
  150. package/docs/reference/type-aliases/RightsManagementPnapComponentType.md +5 -0
  151. package/docs/reference/type-aliases/RightsManagementPnpComponentConfig.md +5 -0
  152. package/docs/reference/type-aliases/RightsManagementPnpComponentType.md +5 -0
  153. package/docs/reference/type-aliases/RightsManagementPxpComponentConfig.md +23 -0
  154. package/docs/reference/type-aliases/RightsManagementPxpComponentType.md +5 -0
  155. package/docs/reference/type-aliases/SynchronisedStorageComponentConfig.md +5 -0
  156. package/docs/reference/type-aliases/SynchronisedStorageComponentType.md +5 -0
  157. package/docs/reference/variables/AttestationComponentType.md +1 -1
  158. package/docs/reference/variables/AttestationConnectorType.md +1 -1
  159. package/docs/reference/variables/AuditableItemGraphComponentType.md +1 -1
  160. package/docs/reference/variables/AuditableItemStreamComponentType.md +1 -1
  161. package/docs/reference/variables/AuthenticationGeneratorComponentType.md +13 -0
  162. package/docs/reference/variables/BackgroundTaskConnectorType.md +1 -1
  163. package/docs/reference/variables/BlobStorageComponentType.md +1 -1
  164. package/docs/reference/variables/BlobStorageConnectorType.md +1 -1
  165. package/docs/reference/variables/DataConverterConnectorType.md +1 -1
  166. package/docs/reference/variables/DataExtractorConnectorType.md +1 -1
  167. package/docs/reference/variables/DataProcessingComponentType.md +1 -1
  168. package/docs/reference/variables/DataSpaceConnectorComponentType.md +25 -0
  169. package/docs/reference/variables/DltConfigType.md +1 -1
  170. package/docs/reference/variables/DocumentManagementComponentType.md +1 -1
  171. package/docs/reference/variables/EntityStorageComponentType.md +1 -1
  172. package/docs/reference/variables/EntityStorageConnectorType.md +7 -1
  173. package/docs/reference/variables/EventBusComponentType.md +1 -1
  174. package/docs/reference/variables/EventBusConnectorType.md +1 -1
  175. package/docs/reference/variables/FaucetConnectorType.md +1 -1
  176. package/docs/reference/variables/FederatedCatalogueComponentType.md +1 -1
  177. package/docs/reference/variables/IdentityComponentType.md +1 -1
  178. package/docs/reference/variables/IdentityConnectorType.md +1 -1
  179. package/docs/reference/variables/IdentityProfileComponentType.md +1 -1
  180. package/docs/reference/variables/IdentityProfileConnectorType.md +1 -1
  181. package/docs/reference/variables/IdentityResolverComponentType.md +1 -1
  182. package/docs/reference/variables/IdentityResolverConnectorType.md +1 -1
  183. package/docs/reference/variables/ImmutableProofComponentType.md +1 -1
  184. package/docs/reference/variables/LoggingComponentType.md +1 -1
  185. package/docs/reference/variables/LoggingConnectorType.md +1 -1
  186. package/docs/reference/variables/MessagingAdminComponentType.md +13 -0
  187. package/docs/reference/variables/MessagingComponentType.md +1 -1
  188. package/docs/reference/variables/MessagingEmailConnectorType.md +1 -1
  189. package/docs/reference/variables/MessagingPushNotificationConnectorType.md +1 -1
  190. package/docs/reference/variables/MessagingSmsConnectorType.md +1 -1
  191. package/docs/reference/variables/NftComponentType.md +1 -1
  192. package/docs/reference/variables/NftConnectorType.md +1 -1
  193. package/docs/reference/variables/RightsManagementDapComponentType.md +19 -0
  194. package/docs/reference/variables/RightsManagementDarpComponentType.md +13 -0
  195. package/docs/reference/variables/RightsManagementPapComponentType.md +7 -1
  196. package/docs/reference/variables/RightsManagementPdpComponentType.md +13 -0
  197. package/docs/reference/variables/RightsManagementPepComponentType.md +19 -0
  198. package/docs/reference/variables/RightsManagementPipComponentType.md +13 -0
  199. package/docs/reference/variables/RightsManagementPmpComponentType.md +13 -0
  200. package/docs/reference/variables/RightsManagementPnapComponentType.md +19 -0
  201. package/docs/reference/variables/RightsManagementPnpComponentType.md +19 -0
  202. package/docs/reference/variables/RightsManagementPxpComponentType.md +13 -0
  203. package/docs/reference/variables/{RightsManagementComponentType.md → SynchronisedStorageComponentType.md} +4 -4
  204. package/docs/reference/variables/TaskSchedulerComponentType.md +1 -1
  205. package/docs/reference/variables/TelemetryComponentType.md +1 -1
  206. package/docs/reference/variables/TelemetryConnectorType.md +1 -1
  207. package/docs/reference/variables/VaultConnectorType.md +1 -1
  208. package/docs/reference/variables/VerifiableStorageComponentType.md +1 -1
  209. package/docs/reference/variables/VerifiableStorageConnectorType.md +1 -1
  210. package/docs/reference/variables/WalletConnectorType.md +1 -1
  211. package/package.json +28 -2
  212. package/dist/types/components/rightsManagement.d.ts +0 -13
  213. package/dist/types/models/config/rightsManagementComponentConfig.d.ts +0 -13
  214. package/dist/types/models/types/rightsManagementComponentType.d.ts +0 -17
  215. package/docs/reference/functions/initialiseRightsManagementComponent.md +0 -41
  216. package/docs/reference/functions/initialiseWalletStorage.md +0 -41
  217. package/docs/reference/type-aliases/RightsManagementComponentConfig.md +0 -5
  218. package/docs/reference/type-aliases/RightsManagementComponentType.md +0 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-types",
3
- "version": "0.0.2-next.2",
3
+ "version": "0.0.2-next.20",
4
4
  "description": "Types to use in an engine.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,6 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
+ "@twin.org/api-models": "next",
17
18
  "@twin.org/attestation-connector-nft": "next",
18
19
  "@twin.org/attestation-models": "next",
19
20
  "@twin.org/attestation-rest-client": "next",
@@ -44,10 +45,15 @@
44
45
  "@twin.org/data-processing-models": "next",
45
46
  "@twin.org/data-processing-rest-client": "next",
46
47
  "@twin.org/data-processing-service": "next",
48
+ "@twin.org/data-space-connector-models": "next",
49
+ "@twin.org/data-space-connector-rest-client": "next",
50
+ "@twin.org/data-space-connector-service": "next",
51
+ "@twin.org/data-space-connector-socket-client": "next",
47
52
  "@twin.org/document-management-models": "next",
48
53
  "@twin.org/document-management-rest-client": "next",
49
54
  "@twin.org/document-management-service": "next",
50
- "@twin.org/engine-models": "0.0.2-next.2",
55
+ "@twin.org/engine-core": "0.0.2-next.20",
56
+ "@twin.org/engine-models": "0.0.2-next.20",
51
57
  "@twin.org/entity": "next",
52
58
  "@twin.org/entity-storage-connector-cosmosdb": "next",
53
59
  "@twin.org/entity-storage-connector-dynamodb": "next",
@@ -58,6 +64,7 @@
58
64
  "@twin.org/entity-storage-connector-mysql": "next",
59
65
  "@twin.org/entity-storage-connector-postgresql": "next",
60
66
  "@twin.org/entity-storage-connector-scylladb": "next",
67
+ "@twin.org/entity-storage-connector-synchronised": "next",
61
68
  "@twin.org/entity-storage-models": "next",
62
69
  "@twin.org/entity-storage-rest-client": "next",
63
70
  "@twin.org/entity-storage-service": "next",
@@ -68,6 +75,7 @@
68
75
  "@twin.org/federated-catalogue-models": "next",
69
76
  "@twin.org/federated-catalogue-rest-client": "next",
70
77
  "@twin.org/federated-catalogue-service": "next",
78
+ "@twin.org/identity-authentication": "next",
71
79
  "@twin.org/identity-connector-entity-storage": "next",
72
80
  "@twin.org/identity-connector-iota": "next",
73
81
  "@twin.org/identity-connector-universal": "next",
@@ -93,10 +101,20 @@
93
101
  "@twin.org/nft-models": "next",
94
102
  "@twin.org/nft-rest-client": "next",
95
103
  "@twin.org/nft-service": "next",
104
+ "@twin.org/rights-management-dap-service": "next",
96
105
  "@twin.org/rights-management-models": "next",
97
106
  "@twin.org/rights-management-pap-service": "next",
107
+ "@twin.org/rights-management-pdp-service": "next",
108
+ "@twin.org/rights-management-pep-service": "next",
109
+ "@twin.org/rights-management-pip-service": "next",
110
+ "@twin.org/rights-management-pmp-service": "next",
111
+ "@twin.org/rights-management-pnp-service": "next",
112
+ "@twin.org/rights-management-pxp-service": "next",
98
113
  "@twin.org/rights-management-rest-client": "next",
99
114
  "@twin.org/rights-management-service": "next",
115
+ "@twin.org/synchronised-storage-models": "next",
116
+ "@twin.org/synchronised-storage-rest-client": "next",
117
+ "@twin.org/synchronised-storage-service": "next",
100
118
  "@twin.org/telemetry-connector-entity-storage": "next",
101
119
  "@twin.org/telemetry-models": "next",
102
120
  "@twin.org/telemetry-rest-client": "next",
@@ -130,5 +148,13 @@
130
148
  "dist/types",
131
149
  "locales",
132
150
  "docs"
151
+ ],
152
+ "keywords": [
153
+ "twin",
154
+ "trade",
155
+ "iota",
156
+ "framework",
157
+ "blockchain",
158
+ "engine"
133
159
  ]
134
160
  }
@@ -1,13 +0,0 @@
1
- import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
- import type { RightsManagementComponentConfig } from "../models/config/rightsManagementComponentConfig";
3
- import type { IEngineConfig } from "../models/IEngineConfig";
4
- /**
5
- * Initialise the rights management 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 initialiseRightsManagementComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: RightsManagementComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -1,13 +0,0 @@
1
- import type { IBaseRestClientConfig } from "@twin.org/api-models";
2
- import type { IRightsManagementServiceConstructorOptions } from "@twin.org/rights-management-service";
3
- import type { RightsManagementComponentType } from "../types/rightsManagementComponentType";
4
- /**
5
- * Rights management component config types.
6
- */
7
- export type RightsManagementComponentConfig = {
8
- type: typeof RightsManagementComponentType.Service;
9
- options?: IRightsManagementServiceConstructorOptions;
10
- } | {
11
- type: typeof RightsManagementComponentType.RestClient;
12
- options: IBaseRestClientConfig;
13
- };
@@ -1,17 +0,0 @@
1
- /**
2
- * Rights management component types.
3
- */
4
- export declare const RightsManagementComponentType: {
5
- /**
6
- * Service.
7
- */
8
- readonly Service: "service";
9
- /**
10
- * REST client.
11
- */
12
- readonly RestClient: "rest-client";
13
- };
14
- /**
15
- * Rights management component types.
16
- */
17
- export type RightsManagementComponentType = (typeof RightsManagementComponentType)[keyof typeof RightsManagementComponentType];
@@ -1,41 +0,0 @@
1
- # Function: initialiseRightsManagementComponent()
2
-
3
- > **initialiseRightsManagementComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
4
-
5
- Initialise the rights management 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
- [`RightsManagementComponentConfig`](../type-aliases/RightsManagementComponentConfig.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.
@@ -1,41 +0,0 @@
1
- # Function: initialiseWalletStorage()
2
-
3
- > **initialiseWalletStorage**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
4
-
5
- Initialise the wallet storage.
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
- [`WalletConnectorConfig`](../type-aliases/WalletConnectorConfig.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
- Nothing.
38
-
39
- ## Throws
40
-
41
- GeneralError if the connector type is unknown.
@@ -1,5 +0,0 @@
1
- # Type Alias: RightsManagementComponentConfig
2
-
3
- > **RightsManagementComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/RightsManagementComponentType.md#service); `options?`: `IRightsManagementServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/RightsManagementComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
-
5
- Rights management component config types.
@@ -1,5 +0,0 @@
1
- # Type Alias: RightsManagementComponentType
2
-
3
- > **RightsManagementComponentType** = *typeof* [`RightsManagementComponentType`](../variables/RightsManagementComponentType.md)\[keyof *typeof* [`RightsManagementComponentType`](../variables/RightsManagementComponentType.md)\]
4
-
5
- Rights management component types.