@twin.org/engine-types 0.0.1-next.14

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 (178) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +21 -0
  3. package/dist/cjs/index.cjs +1640 -0
  4. package/dist/esm/index.mjs +1589 -0
  5. package/dist/types/components/attestation.d.ts +24 -0
  6. package/dist/types/components/auditableItemGraph.d.ts +13 -0
  7. package/dist/types/components/auditableItemStream.d.ts +13 -0
  8. package/dist/types/components/backgroundTask.d.ts +13 -0
  9. package/dist/types/components/blobStorage.d.ts +24 -0
  10. package/dist/types/components/entityStorage.d.ts +22 -0
  11. package/dist/types/components/faucet.d.ts +13 -0
  12. package/dist/types/components/identity.d.ts +24 -0
  13. package/dist/types/components/identityProfile.d.ts +24 -0
  14. package/dist/types/components/immutableProof.d.ts +13 -0
  15. package/dist/types/components/immutableStorage.d.ts +13 -0
  16. package/dist/types/components/logging.d.ts +24 -0
  17. package/dist/types/components/nft.d.ts +24 -0
  18. package/dist/types/components/telemetry.d.ts +24 -0
  19. package/dist/types/components/vault.d.ts +13 -0
  20. package/dist/types/components/wallet.d.ts +23 -0
  21. package/dist/types/index.d.ts +67 -0
  22. package/dist/types/models/IEngineCoreTypesConfig.d.ts +137 -0
  23. package/dist/types/models/config/attestationComponentConfig.d.ts +12 -0
  24. package/dist/types/models/config/attestationConnectorConfig.d.ts +21 -0
  25. package/dist/types/models/config/auditableItemGraphComponentConfig.d.ts +14 -0
  26. package/dist/types/models/config/auditableItemStreamComponentConfig.d.ts +14 -0
  27. package/dist/types/models/config/backgroundTaskConnectorConfig.d.ts +13 -0
  28. package/dist/types/models/config/blobStorageComponentConfig.d.ts +13 -0
  29. package/dist/types/models/config/blobStorageConnectorConfig.d.ts +42 -0
  30. package/dist/types/models/config/dltConfig.d.ts +11 -0
  31. package/dist/types/models/config/entityStorageComponentConfig.d.ts +12 -0
  32. package/dist/types/models/config/entityStorageConnectorConfig.d.ts +47 -0
  33. package/dist/types/models/config/faucetConnectorConfig.d.ts +18 -0
  34. package/dist/types/models/config/identityComponentConfig.d.ts +11 -0
  35. package/dist/types/models/config/identityConnectorConfig.d.ts +18 -0
  36. package/dist/types/models/config/identityProfileComponentConfig.d.ts +10 -0
  37. package/dist/types/models/config/identityProfileConnectorConfig.d.ts +10 -0
  38. package/dist/types/models/config/immutableProofComponentConfig.d.ts +16 -0
  39. package/dist/types/models/config/immutableStorageConnectorConfig.d.ts +17 -0
  40. package/dist/types/models/config/loggingComponentConfig.d.ts +10 -0
  41. package/dist/types/models/config/loggingConnectorConfig.d.ts +25 -0
  42. package/dist/types/models/config/nftComponentConfig.d.ts +11 -0
  43. package/dist/types/models/config/nftConnectorConfig.d.ts +17 -0
  44. package/dist/types/models/config/telemetryComponentConfig.d.ts +10 -0
  45. package/dist/types/models/config/telemetryConnectorConfig.d.ts +12 -0
  46. package/dist/types/models/config/vaultConnectorConfig.d.ts +17 -0
  47. package/dist/types/models/config/walletConnectorConfig.d.ts +22 -0
  48. package/dist/types/models/types/attestationComponentType.d.ts +13 -0
  49. package/dist/types/models/types/attestationConnectorType.d.ts +17 -0
  50. package/dist/types/models/types/auditableItemGraphComponentType.d.ts +13 -0
  51. package/dist/types/models/types/auditableItemStreamComponentType.d.ts +13 -0
  52. package/dist/types/models/types/backgroundTaskConnectorType.d.ts +13 -0
  53. package/dist/types/models/types/blobStorageComponentType.d.ts +13 -0
  54. package/dist/types/models/types/blobStorageConnectorType.d.ts +33 -0
  55. package/dist/types/models/types/dltConfigType.d.ts +13 -0
  56. package/dist/types/models/types/entityStorageComponentType.d.ts +13 -0
  57. package/dist/types/models/types/entityStorageConnectorType.d.ts +33 -0
  58. package/dist/types/models/types/faucetConnectorType.d.ts +17 -0
  59. package/dist/types/models/types/identityComponentType.d.ts +13 -0
  60. package/dist/types/models/types/identityConnectorType.d.ts +17 -0
  61. package/dist/types/models/types/identityProfileComponentType.d.ts +13 -0
  62. package/dist/types/models/types/identityProfileConnectorType.d.ts +13 -0
  63. package/dist/types/models/types/immutableProofComponentType.d.ts +13 -0
  64. package/dist/types/models/types/immutableStorageConnectorType.d.ts +17 -0
  65. package/dist/types/models/types/loggingComponentType.d.ts +13 -0
  66. package/dist/types/models/types/loggingConnectorType.d.ts +21 -0
  67. package/dist/types/models/types/nftComponentType.d.ts +13 -0
  68. package/dist/types/models/types/nftConnectorType.d.ts +17 -0
  69. package/dist/types/models/types/telemetryComponentType.d.ts +13 -0
  70. package/dist/types/models/types/telemetryConnectorType.d.ts +13 -0
  71. package/dist/types/models/types/vaultConnectorType.d.ts +17 -0
  72. package/dist/types/models/types/walletConnectorType.d.ts +17 -0
  73. package/docs/changelog.md +5 -0
  74. package/docs/examples.md +1 -0
  75. package/docs/reference/functions/initialiseAttestationComponent.md +33 -0
  76. package/docs/reference/functions/initialiseAttestationConnector.md +33 -0
  77. package/docs/reference/functions/initialiseAuditableItemGraphComponent.md +33 -0
  78. package/docs/reference/functions/initialiseAuditableItemStreamComponent.md +33 -0
  79. package/docs/reference/functions/initialiseBackgroundTaskConnector.md +33 -0
  80. package/docs/reference/functions/initialiseBlobStorageComponent.md +33 -0
  81. package/docs/reference/functions/initialiseBlobStorageConnector.md +33 -0
  82. package/docs/reference/functions/initialiseEntityStorageComponent.md +33 -0
  83. package/docs/reference/functions/initialiseEntityStorageConnector.md +31 -0
  84. package/docs/reference/functions/initialiseFaucetConnector.md +33 -0
  85. package/docs/reference/functions/initialiseIdentityComponent.md +33 -0
  86. package/docs/reference/functions/initialiseIdentityConnector.md +33 -0
  87. package/docs/reference/functions/initialiseIdentityProfileComponent.md +33 -0
  88. package/docs/reference/functions/initialiseIdentityProfileConnector.md +33 -0
  89. package/docs/reference/functions/initialiseImmutableProofComponent.md +33 -0
  90. package/docs/reference/functions/initialiseImmutableStorageConnector.md +33 -0
  91. package/docs/reference/functions/initialiseLoggingComponent.md +33 -0
  92. package/docs/reference/functions/initialiseLoggingConnector.md +33 -0
  93. package/docs/reference/functions/initialiseNftComponent.md +33 -0
  94. package/docs/reference/functions/initialiseNftConnector.md +33 -0
  95. package/docs/reference/functions/initialiseTelemetryComponent.md +33 -0
  96. package/docs/reference/functions/initialiseTelemetryConnector.md +33 -0
  97. package/docs/reference/functions/initialiseVaultConnector.md +33 -0
  98. package/docs/reference/functions/initialiseWalletConnector.md +33 -0
  99. package/docs/reference/functions/initialiseWalletStorage.md +33 -0
  100. package/docs/reference/index.md +114 -0
  101. package/docs/reference/interfaces/IEngineCoreTypesConfig.md +173 -0
  102. package/docs/reference/type-aliases/AttestationComponentConfig.md +23 -0
  103. package/docs/reference/type-aliases/AttestationComponentType.md +5 -0
  104. package/docs/reference/type-aliases/AttestationConnectorConfig.md +5 -0
  105. package/docs/reference/type-aliases/AttestationConnectorType.md +5 -0
  106. package/docs/reference/type-aliases/AuditableItemGraphComponentConfig.md +31 -0
  107. package/docs/reference/type-aliases/AuditableItemGraphComponentType.md +5 -0
  108. package/docs/reference/type-aliases/AuditableItemStreamComponentConfig.md +31 -0
  109. package/docs/reference/type-aliases/AuditableItemStreamComponentType.md +5 -0
  110. package/docs/reference/type-aliases/BackgroundTaskConnectorConfig.md +27 -0
  111. package/docs/reference/type-aliases/BackgroundTaskConnectorType.md +5 -0
  112. package/docs/reference/type-aliases/BlobStorageComponentConfig.md +27 -0
  113. package/docs/reference/type-aliases/BlobStorageComponentType.md +5 -0
  114. package/docs/reference/type-aliases/BlobStorageConnectorConfig.md +5 -0
  115. package/docs/reference/type-aliases/BlobStorageConnectorType.md +5 -0
  116. package/docs/reference/type-aliases/DltConfig.md +19 -0
  117. package/docs/reference/type-aliases/DltConfigType.md +5 -0
  118. package/docs/reference/type-aliases/EntityStorageComponentConfig.md +23 -0
  119. package/docs/reference/type-aliases/EntityStorageComponentType.md +5 -0
  120. package/docs/reference/type-aliases/EntityStorageConnectorConfig.md +5 -0
  121. package/docs/reference/type-aliases/EntityStorageConnectorType.md +5 -0
  122. package/docs/reference/type-aliases/FaucetConnectorConfig.md +5 -0
  123. package/docs/reference/type-aliases/FaucetConnectorType.md +5 -0
  124. package/docs/reference/type-aliases/IImmutableProofComponentType.md +5 -0
  125. package/docs/reference/type-aliases/IdentityComponentConfig.md +19 -0
  126. package/docs/reference/type-aliases/IdentityComponentType.md +5 -0
  127. package/docs/reference/type-aliases/IdentityConnectorConfig.md +5 -0
  128. package/docs/reference/type-aliases/IdentityConnectorType.md +5 -0
  129. package/docs/reference/type-aliases/IdentityProfileComponentConfig.md +19 -0
  130. package/docs/reference/type-aliases/IdentityProfileComponentType.md +5 -0
  131. package/docs/reference/type-aliases/IdentityProfileConnectorConfig.md +19 -0
  132. package/docs/reference/type-aliases/IdentityProfileConnectorType.md +5 -0
  133. package/docs/reference/type-aliases/ImmutableProofComponentConfig.md +39 -0
  134. package/docs/reference/type-aliases/ImmutableStorageConnectorConfig.md +5 -0
  135. package/docs/reference/type-aliases/ImmutableStorageConnectorType.md +5 -0
  136. package/docs/reference/type-aliases/LoggingComponentConfig.md +19 -0
  137. package/docs/reference/type-aliases/LoggingComponentType.md +5 -0
  138. package/docs/reference/type-aliases/LoggingConnectorConfig.md +5 -0
  139. package/docs/reference/type-aliases/LoggingConnectorType.md +5 -0
  140. package/docs/reference/type-aliases/NftComponentConfig.md +19 -0
  141. package/docs/reference/type-aliases/NftComponentType.md +5 -0
  142. package/docs/reference/type-aliases/NftConnectorConfig.md +5 -0
  143. package/docs/reference/type-aliases/NftConnectorType.md +5 -0
  144. package/docs/reference/type-aliases/TelemetryComponentConfig.md +19 -0
  145. package/docs/reference/type-aliases/TelemetryComponentType.md +5 -0
  146. package/docs/reference/type-aliases/TelemetryConnectorConfig.md +27 -0
  147. package/docs/reference/type-aliases/TelemetryConnectorType.md +5 -0
  148. package/docs/reference/type-aliases/VaultConnectorConfig.md +5 -0
  149. package/docs/reference/type-aliases/VaultConnectorType.md +5 -0
  150. package/docs/reference/type-aliases/WalletConnectorConfig.md +5 -0
  151. package/docs/reference/type-aliases/WalletConnectorType.md +5 -0
  152. package/docs/reference/variables/AttestationComponentType.md +13 -0
  153. package/docs/reference/variables/AttestationConnectorType.md +19 -0
  154. package/docs/reference/variables/AuditableItemGraphComponentType.md +13 -0
  155. package/docs/reference/variables/AuditableItemStreamComponentType.md +13 -0
  156. package/docs/reference/variables/BackgroundTaskConnectorType.md +13 -0
  157. package/docs/reference/variables/BlobStorageComponentType.md +13 -0
  158. package/docs/reference/variables/BlobStorageConnectorType.md +43 -0
  159. package/docs/reference/variables/DltConfigType.md +13 -0
  160. package/docs/reference/variables/EntityStorageComponentType.md +13 -0
  161. package/docs/reference/variables/EntityStorageConnectorType.md +43 -0
  162. package/docs/reference/variables/FaucetConnectorType.md +19 -0
  163. package/docs/reference/variables/IdentityComponentType.md +13 -0
  164. package/docs/reference/variables/IdentityConnectorType.md +19 -0
  165. package/docs/reference/variables/IdentityProfileComponentType.md +13 -0
  166. package/docs/reference/variables/IdentityProfileConnectorType.md +13 -0
  167. package/docs/reference/variables/ImmutableProofComponentType.md +13 -0
  168. package/docs/reference/variables/ImmutableStorageConnectorType.md +19 -0
  169. package/docs/reference/variables/LoggingComponentType.md +13 -0
  170. package/docs/reference/variables/LoggingConnectorType.md +25 -0
  171. package/docs/reference/variables/NftComponentType.md +13 -0
  172. package/docs/reference/variables/NftConnectorType.md +19 -0
  173. package/docs/reference/variables/TelemetryComponentType.md +13 -0
  174. package/docs/reference/variables/TelemetryConnectorType.md +13 -0
  175. package/docs/reference/variables/VaultConnectorType.md +19 -0
  176. package/docs/reference/variables/WalletConnectorType.md +19 -0
  177. package/locales/en.json +1 -0
  178. package/package.json +91 -0
@@ -0,0 +1,33 @@
1
+ # Function: initialiseImmutableStorageConnector()
2
+
3
+ > **initialiseImmutableStorageConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the immutable storage connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`ImmutableStorageConnectorConfig`](../type-aliases/ImmutableStorageConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseLoggingComponent()
2
+
3
+ > **initialiseLoggingComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the logging component.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`LoggingComponentConfig`](../type-aliases/LoggingComponentConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the component type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseLoggingConnector()
2
+
3
+ > **initialiseLoggingConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the logging connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The engine core context.
16
+
17
+ • **instanceConfig**: [`LoggingConnectorConfig`](../type-aliases/LoggingConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseNftComponent()
2
+
3
+ > **initialiseNftComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the NFT component.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`NftComponentConfig`](../type-aliases/NftComponentConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the component type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseNftConnector()
2
+
3
+ > **initialiseNftConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the NFT connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`NftConnectorConfig`](../type-aliases/NftConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseTelemetryComponent()
2
+
3
+ > **initialiseTelemetryComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the telemetry component.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`TelemetryComponentConfig`](../type-aliases/TelemetryComponentConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the component type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseTelemetryConnector()
2
+
3
+ > **initialiseTelemetryConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise a telemetry connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`TelemetryConnectorConfig`](../type-aliases/TelemetryConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseVaultConnector()
2
+
3
+ > **initialiseVaultConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the vault connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`VaultConnectorConfig`](../type-aliases/VaultConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseWalletConnector()
2
+
3
+ > **initialiseWalletConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise a wallet connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the node.
16
+
17
+ • **instanceConfig**: [`WalletConnectorConfig`](../type-aliases/WalletConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ The name of the instance created.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,33 @@
1
+ # Function: initialiseWalletStorage()
2
+
3
+ > **initialiseWalletStorage**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the wallet storage.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`WalletConnectorConfig`](../type-aliases/WalletConnectorConfig.md)
18
+
19
+ The instance config.
20
+
21
+ • **overrideInstanceType?**: `string`
22
+
23
+ The instance type to override the default.
24
+
25
+ ## Returns
26
+
27
+ `string` \| `undefined`
28
+
29
+ Nothing.
30
+
31
+ ## Throws
32
+
33
+ GeneralError if the connector type is unknown.
@@ -0,0 +1,114 @@
1
+ # @twin.org/engine-types
2
+
3
+ ## Interfaces
4
+
5
+ - [IEngineCoreTypesConfig](interfaces/IEngineCoreTypesConfig.md)
6
+
7
+ ## Type Aliases
8
+
9
+ - [AttestationComponentConfig](type-aliases/AttestationComponentConfig.md)
10
+ - [AttestationConnectorConfig](type-aliases/AttestationConnectorConfig.md)
11
+ - [AuditableItemGraphComponentConfig](type-aliases/AuditableItemGraphComponentConfig.md)
12
+ - [AuditableItemStreamComponentConfig](type-aliases/AuditableItemStreamComponentConfig.md)
13
+ - [BackgroundTaskConnectorConfig](type-aliases/BackgroundTaskConnectorConfig.md)
14
+ - [BlobStorageComponentConfig](type-aliases/BlobStorageComponentConfig.md)
15
+ - [BlobStorageConnectorConfig](type-aliases/BlobStorageConnectorConfig.md)
16
+ - [DltConfig](type-aliases/DltConfig.md)
17
+ - [EntityStorageComponentConfig](type-aliases/EntityStorageComponentConfig.md)
18
+ - [EntityStorageConnectorConfig](type-aliases/EntityStorageConnectorConfig.md)
19
+ - [FaucetConnectorConfig](type-aliases/FaucetConnectorConfig.md)
20
+ - [IdentityComponentConfig](type-aliases/IdentityComponentConfig.md)
21
+ - [IdentityConnectorConfig](type-aliases/IdentityConnectorConfig.md)
22
+ - [IdentityProfileComponentConfig](type-aliases/IdentityProfileComponentConfig.md)
23
+ - [IdentityProfileConnectorConfig](type-aliases/IdentityProfileConnectorConfig.md)
24
+ - [ImmutableProofComponentConfig](type-aliases/ImmutableProofComponentConfig.md)
25
+ - [ImmutableStorageConnectorConfig](type-aliases/ImmutableStorageConnectorConfig.md)
26
+ - [LoggingComponentConfig](type-aliases/LoggingComponentConfig.md)
27
+ - [LoggingConnectorConfig](type-aliases/LoggingConnectorConfig.md)
28
+ - [NftComponentConfig](type-aliases/NftComponentConfig.md)
29
+ - [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
30
+ - [TelemetryComponentConfig](type-aliases/TelemetryComponentConfig.md)
31
+ - [TelemetryConnectorConfig](type-aliases/TelemetryConnectorConfig.md)
32
+ - [VaultConnectorConfig](type-aliases/VaultConnectorConfig.md)
33
+ - [WalletConnectorConfig](type-aliases/WalletConnectorConfig.md)
34
+ - [AttestationComponentType](type-aliases/AttestationComponentType.md)
35
+ - [AttestationConnectorType](type-aliases/AttestationConnectorType.md)
36
+ - [AuditableItemGraphComponentType](type-aliases/AuditableItemGraphComponentType.md)
37
+ - [AuditableItemStreamComponentType](type-aliases/AuditableItemStreamComponentType.md)
38
+ - [BackgroundTaskConnectorType](type-aliases/BackgroundTaskConnectorType.md)
39
+ - [BlobStorageComponentType](type-aliases/BlobStorageComponentType.md)
40
+ - [BlobStorageConnectorType](type-aliases/BlobStorageConnectorType.md)
41
+ - [DltConfigType](type-aliases/DltConfigType.md)
42
+ - [EntityStorageComponentType](type-aliases/EntityStorageComponentType.md)
43
+ - [EntityStorageConnectorType](type-aliases/EntityStorageConnectorType.md)
44
+ - [FaucetConnectorType](type-aliases/FaucetConnectorType.md)
45
+ - [IdentityComponentType](type-aliases/IdentityComponentType.md)
46
+ - [IdentityConnectorType](type-aliases/IdentityConnectorType.md)
47
+ - [IdentityProfileComponentType](type-aliases/IdentityProfileComponentType.md)
48
+ - [IdentityProfileConnectorType](type-aliases/IdentityProfileConnectorType.md)
49
+ - [IImmutableProofComponentType](type-aliases/IImmutableProofComponentType.md)
50
+ - [ImmutableStorageConnectorType](type-aliases/ImmutableStorageConnectorType.md)
51
+ - [LoggingComponentType](type-aliases/LoggingComponentType.md)
52
+ - [LoggingConnectorType](type-aliases/LoggingConnectorType.md)
53
+ - [NftComponentType](type-aliases/NftComponentType.md)
54
+ - [NftConnectorType](type-aliases/NftConnectorType.md)
55
+ - [TelemetryComponentType](type-aliases/TelemetryComponentType.md)
56
+ - [TelemetryConnectorType](type-aliases/TelemetryConnectorType.md)
57
+ - [VaultConnectorType](type-aliases/VaultConnectorType.md)
58
+ - [WalletConnectorType](type-aliases/WalletConnectorType.md)
59
+
60
+ ## Variables
61
+
62
+ - [AttestationComponentType](variables/AttestationComponentType.md)
63
+ - [AttestationConnectorType](variables/AttestationConnectorType.md)
64
+ - [AuditableItemGraphComponentType](variables/AuditableItemGraphComponentType.md)
65
+ - [AuditableItemStreamComponentType](variables/AuditableItemStreamComponentType.md)
66
+ - [BackgroundTaskConnectorType](variables/BackgroundTaskConnectorType.md)
67
+ - [BlobStorageComponentType](variables/BlobStorageComponentType.md)
68
+ - [BlobStorageConnectorType](variables/BlobStorageConnectorType.md)
69
+ - [DltConfigType](variables/DltConfigType.md)
70
+ - [EntityStorageComponentType](variables/EntityStorageComponentType.md)
71
+ - [EntityStorageConnectorType](variables/EntityStorageConnectorType.md)
72
+ - [FaucetConnectorType](variables/FaucetConnectorType.md)
73
+ - [IdentityComponentType](variables/IdentityComponentType.md)
74
+ - [IdentityConnectorType](variables/IdentityConnectorType.md)
75
+ - [IdentityProfileComponentType](variables/IdentityProfileComponentType.md)
76
+ - [IdentityProfileConnectorType](variables/IdentityProfileConnectorType.md)
77
+ - [ImmutableProofComponentType](variables/ImmutableProofComponentType.md)
78
+ - [ImmutableStorageConnectorType](variables/ImmutableStorageConnectorType.md)
79
+ - [LoggingComponentType](variables/LoggingComponentType.md)
80
+ - [LoggingConnectorType](variables/LoggingConnectorType.md)
81
+ - [NftComponentType](variables/NftComponentType.md)
82
+ - [NftConnectorType](variables/NftConnectorType.md)
83
+ - [TelemetryComponentType](variables/TelemetryComponentType.md)
84
+ - [TelemetryConnectorType](variables/TelemetryConnectorType.md)
85
+ - [VaultConnectorType](variables/VaultConnectorType.md)
86
+ - [WalletConnectorType](variables/WalletConnectorType.md)
87
+
88
+ ## Functions
89
+
90
+ - [initialiseAttestationConnector](functions/initialiseAttestationConnector.md)
91
+ - [initialiseAttestationComponent](functions/initialiseAttestationComponent.md)
92
+ - [initialiseAuditableItemGraphComponent](functions/initialiseAuditableItemGraphComponent.md)
93
+ - [initialiseAuditableItemStreamComponent](functions/initialiseAuditableItemStreamComponent.md)
94
+ - [initialiseBackgroundTaskConnector](functions/initialiseBackgroundTaskConnector.md)
95
+ - [initialiseBlobStorageConnector](functions/initialiseBlobStorageConnector.md)
96
+ - [initialiseBlobStorageComponent](functions/initialiseBlobStorageComponent.md)
97
+ - [initialiseEntityStorageConnector](functions/initialiseEntityStorageConnector.md)
98
+ - [initialiseEntityStorageComponent](functions/initialiseEntityStorageComponent.md)
99
+ - [initialiseFaucetConnector](functions/initialiseFaucetConnector.md)
100
+ - [initialiseIdentityConnector](functions/initialiseIdentityConnector.md)
101
+ - [initialiseIdentityComponent](functions/initialiseIdentityComponent.md)
102
+ - [initialiseIdentityProfileConnector](functions/initialiseIdentityProfileConnector.md)
103
+ - [initialiseIdentityProfileComponent](functions/initialiseIdentityProfileComponent.md)
104
+ - [initialiseImmutableProofComponent](functions/initialiseImmutableProofComponent.md)
105
+ - [initialiseImmutableStorageConnector](functions/initialiseImmutableStorageConnector.md)
106
+ - [initialiseLoggingConnector](functions/initialiseLoggingConnector.md)
107
+ - [initialiseLoggingComponent](functions/initialiseLoggingComponent.md)
108
+ - [initialiseNftConnector](functions/initialiseNftConnector.md)
109
+ - [initialiseNftComponent](functions/initialiseNftComponent.md)
110
+ - [initialiseTelemetryConnector](functions/initialiseTelemetryConnector.md)
111
+ - [initialiseTelemetryComponent](functions/initialiseTelemetryComponent.md)
112
+ - [initialiseVaultConnector](functions/initialiseVaultConnector.md)
113
+ - [initialiseWalletConnector](functions/initialiseWalletConnector.md)
114
+ - [initialiseWalletStorage](functions/initialiseWalletStorage.md)
@@ -0,0 +1,173 @@
1
+ # Interface: IEngineCoreTypesConfig
2
+
3
+ Extended engine core config with known types.
4
+
5
+ ## Extends
6
+
7
+ - `IEngineCoreConfig`
8
+
9
+ ## Properties
10
+
11
+ ### types
12
+
13
+ > **types**: `object`
14
+
15
+ The types to initialise in the engine.
16
+
17
+ #### Index Signature
18
+
19
+ \[`type`: `string`\]: `IEngineCoreTypeConfig`[] \| `undefined`
20
+
21
+ #### loggingConnector?
22
+
23
+ > `optional` **loggingConnector**: `IEngineCoreTypeConfig`\<[`LoggingConnectorConfig`](../type-aliases/LoggingConnectorConfig.md)\>[]
24
+
25
+ Logging connector options which can be overridden by individual components by specifying types other than default.
26
+
27
+ #### loggingComponent?
28
+
29
+ > `optional` **loggingComponent**: `IEngineCoreTypeConfig`\<[`LoggingComponentConfig`](../type-aliases/LoggingComponentConfig.md)\>[]
30
+
31
+ Logging component options which can be overridden by individual components by specifying types other than default.
32
+
33
+ #### entityStorageConnector?
34
+
35
+ > `optional` **entityStorageConnector**: `IEngineCoreTypeConfig`\<[`EntityStorageConnectorConfig`](../type-aliases/EntityStorageConnectorConfig.md)\>[]
36
+
37
+ Entity storage connector options which can be overridden by individual components by specifying types other than default.
38
+
39
+ #### entityStorageComponent?
40
+
41
+ > `optional` **entityStorageComponent**: `IEngineCoreTypeConfig`\<[`EntityStorageComponentConfig`](../type-aliases/EntityStorageComponentConfig.md)\>[]
42
+
43
+ Entity storage component options which can be overridden by individual components by specifying types other than default.
44
+
45
+ #### blobStorageConnector?
46
+
47
+ > `optional` **blobStorageConnector**: `IEngineCoreTypeConfig`\<[`BlobStorageConnectorConfig`](../type-aliases/BlobStorageConnectorConfig.md)\>[]
48
+
49
+ Blob storage connector options which can be overridden by individual components by specifying types other than default.
50
+
51
+ #### blobStorageComponent?
52
+
53
+ > `optional` **blobStorageComponent**: `IEngineCoreTypeConfig`\<[`BlobStorageComponentConfig`](../type-aliases/BlobStorageComponentConfig.md)\>[]
54
+
55
+ Blob storage component options which can be overridden by individual components by specifying types other than default.
56
+
57
+ #### telemetryConnector?
58
+
59
+ > `optional` **telemetryConnector**: `IEngineCoreTypeConfig`\<[`TelemetryConnectorConfig`](../type-aliases/TelemetryConnectorConfig.md)\>[]
60
+
61
+ Telemetry connector options which can be overridden by individual components by specifying types other than default.
62
+
63
+ #### telemetryComponent?
64
+
65
+ > `optional` **telemetryComponent**: `IEngineCoreTypeConfig`\<[`TelemetryComponentConfig`](../type-aliases/TelemetryComponentConfig.md)\>[]
66
+
67
+ Telemetry component options which can be overridden by individual components by specifying types other than default.
68
+
69
+ #### backgroundTaskConnector?
70
+
71
+ > `optional` **backgroundTaskConnector**: `IEngineCoreTypeConfig`\<[`BackgroundTaskConnectorConfig`](../type-aliases/BackgroundTaskConnectorConfig.md)\>[]
72
+
73
+ Background task connector options which can be overridden by individual components by specifying types other than default.
74
+
75
+ #### vaultConnector?
76
+
77
+ > `optional` **vaultConnector**: `IEngineCoreTypeConfig`\<[`VaultConnectorConfig`](../type-aliases/VaultConnectorConfig.md)\>[]
78
+
79
+ Vault connector options which can be overridden by individual components by specifying types other than default.
80
+
81
+ #### dltConfig?
82
+
83
+ > `optional` **dltConfig**: `IEngineCoreTypeConfig`\<[`DltConfig`](../type-aliases/DltConfig.md)\>[]
84
+
85
+ DLT options which can be overridden by individual components by specifying types other than default.
86
+
87
+ #### walletConnector?
88
+
89
+ > `optional` **walletConnector**: `IEngineCoreTypeConfig`\<[`WalletConnectorConfig`](../type-aliases/WalletConnectorConfig.md)\>[]
90
+
91
+ Wallet connector options which can be overridden by individual components by specifying types other than default.
92
+
93
+ #### immutableStorageConnector?
94
+
95
+ > `optional` **immutableStorageConnector**: `IEngineCoreTypeConfig`\<[`ImmutableStorageConnectorConfig`](../type-aliases/ImmutableStorageConnectorConfig.md)\>[]
96
+
97
+ Immutable storage connector options which can be overridden by individual components by specifying types other than default.
98
+
99
+ #### immutableProofComponent?
100
+
101
+ > `optional` **immutableProofComponent**: `IEngineCoreTypeConfig`\<[`ImmutableProofComponentConfig`](../type-aliases/ImmutableProofComponentConfig.md)\>[]
102
+
103
+ Immutable proof component options which can be overridden by individual components by specifying types other than default.
104
+
105
+ #### faucetConnector?
106
+
107
+ > `optional` **faucetConnector**: `IEngineCoreTypeConfig`\<[`FaucetConnectorConfig`](../type-aliases/FaucetConnectorConfig.md)\>[]
108
+
109
+ Faucet connector options which can be overridden by individual components by specifying types other than default.
110
+
111
+ #### identityConnector?
112
+
113
+ > `optional` **identityConnector**: `IEngineCoreTypeConfig`\<[`IdentityConnectorConfig`](../type-aliases/IdentityConnectorConfig.md)\>[]
114
+
115
+ Identity connector options which can be overridden by individual components by specifying types other than default.
116
+
117
+ #### identityComponent?
118
+
119
+ > `optional` **identityComponent**: `IEngineCoreTypeConfig`\<[`IdentityComponentConfig`](../type-aliases/IdentityComponentConfig.md)\>[]
120
+
121
+ Identity component profile options which can be overridden by individual components by specifying types other than default.
122
+
123
+ #### identityProfileConnector?
124
+
125
+ > `optional` **identityProfileConnector**: `IEngineCoreTypeConfig`\<[`IdentityProfileConnectorConfig`](../type-aliases/IdentityProfileConnectorConfig.md)\>[]
126
+
127
+ Identity profile connector options which can be overridden by individual components by specifying types other than default.
128
+
129
+ #### identityProfileComponent?
130
+
131
+ > `optional` **identityProfileComponent**: `IEngineCoreTypeConfig`\<[`IdentityProfileComponentConfig`](../type-aliases/IdentityProfileComponentConfig.md)\>[]
132
+
133
+ Identity profile component profile options which can be overridden by individual components by specifying types other than default.
134
+
135
+ #### nftConnector?
136
+
137
+ > `optional` **nftConnector**: `IEngineCoreTypeConfig`\<[`NftConnectorConfig`](../type-aliases/NftConnectorConfig.md)\>[]
138
+
139
+ NFT connector options which can be overridden by individual components by specifying types other than default.
140
+
141
+ #### nftComponent?
142
+
143
+ > `optional` **nftComponent**: `IEngineCoreTypeConfig`\<[`NftComponentConfig`](../type-aliases/NftComponentConfig.md)\>[]
144
+
145
+ NFT component options which can be overridden by individual components by specifying types other than default.
146
+
147
+ #### attestationConnector?
148
+
149
+ > `optional` **attestationConnector**: `IEngineCoreTypeConfig`\<[`AttestationConnectorConfig`](../type-aliases/AttestationConnectorConfig.md)\>[]
150
+
151
+ Attestation connector options which can be overridden by individual components by specifying types other than default.
152
+
153
+ #### attestationComponent?
154
+
155
+ > `optional` **attestationComponent**: `IEngineCoreTypeConfig`\<[`AttestationComponentConfig`](../type-aliases/AttestationComponentConfig.md)\>[]
156
+
157
+ Attestation component profile options which can be overridden by individual components by specifying types other than default.
158
+
159
+ #### auditableItemGraphComponent?
160
+
161
+ > `optional` **auditableItemGraphComponent**: `IEngineCoreTypeConfig`\<[`AuditableItemGraphComponentConfig`](../type-aliases/AuditableItemGraphComponentConfig.md)\>[]
162
+
163
+ Auditable item graph component options which can be overridden by individual components by specifying types other than default.
164
+
165
+ #### auditableItemStreamComponent?
166
+
167
+ > `optional` **auditableItemStreamComponent**: `IEngineCoreTypeConfig`\<[`AuditableItemStreamComponentConfig`](../type-aliases/AuditableItemStreamComponentConfig.md)\>[]
168
+
169
+ Auditable item stream component profile options which can be overridden by individual components by specifying types other than default.
170
+
171
+ #### Overrides
172
+
173
+ `IEngineCoreConfig.types`
@@ -0,0 +1,23 @@
1
+ # Type Alias: AttestationComponentConfig
2
+
3
+ > **AttestationComponentConfig**: `object`
4
+
5
+ Attestation component config types.
6
+
7
+ ## Type declaration
8
+
9
+ ### type
10
+
11
+ > **type**: *typeof* `AttestationComponentType.Service`
12
+
13
+ ### options?
14
+
15
+ > `optional` **options**: `object`
16
+
17
+ ### options.walletConnectorType?
18
+
19
+ > `optional` **walletConnectorType**: `string`
20
+
21
+ ### options.config?
22
+
23
+ > `optional` **config**: `IAttestationServiceConfig`
@@ -0,0 +1,5 @@
1
+ # Type Alias: AttestationComponentType
2
+
3
+ > **AttestationComponentType**: *typeof* [`AttestationComponentType`](../variables/AttestationComponentType.md)\[keyof *typeof* [`AttestationComponentType`](../variables/AttestationComponentType.md)\]
4
+
5
+ Attestation component types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AttestationConnectorConfig
2
+
3
+ > **AttestationConnectorConfig**: `object` \| `object`
4
+
5
+ Attestation config connector types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AttestationConnectorType
2
+
3
+ > **AttestationConnectorType**: *typeof* [`AttestationConnectorType`](../variables/AttestationConnectorType.md)\[keyof *typeof* [`AttestationConnectorType`](../variables/AttestationConnectorType.md)\]
4
+
5
+ Attestation connector types.