@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,24 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { AttestationComponentConfig } from "../models/config/attestationComponentConfig";
3
+ import type { AttestationConnectorConfig } from "../models/config/attestationConnectorConfig";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig";
5
+ /**
6
+ * Initialise the attestation connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The context for the engine.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseAttestationConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: AttestationConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the attestation component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseAttestationComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: AttestationComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { AuditableItemGraphComponentConfig } from "../models/config/auditableItemGraphComponentConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise the auditable item graph 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 initialiseAuditableItemGraphComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: AuditableItemGraphComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { AuditableItemStreamComponentConfig } from "../models/config/auditableItemStreamComponentConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise the auditable item stream 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 initialiseAuditableItemStreamComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: AuditableItemStreamComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
+ import type { BackgroundTaskConnectorConfig } from "../models/config/backgroundTaskConnectorConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise a background task connector.
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 connector type is unknown.
12
+ */
13
+ export declare function initialiseBackgroundTaskConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: BackgroundTaskConnectorConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,24 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { BlobStorageComponentConfig } from "../models/config/blobStorageComponentConfig.js";
3
+ import type { BlobStorageConnectorConfig } from "../models/config/blobStorageConnectorConfig.js";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
5
+ /**
6
+ * Initialise the blob storage connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The context for the engine.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseBlobStorageConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: BlobStorageConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the blob storage component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseBlobStorageComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: BlobStorageComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,22 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { EntityStorageComponentConfig } from "../models/config/entityStorageComponentConfig";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig";
4
+ /**
5
+ * Initialise the entity storage connector.
6
+ * @param engineCore The engine core.
7
+ * @param context The context for the engine.
8
+ * @param typeCustom Override the type of connector to use instead of default configuration.
9
+ * @param schema The schema for the entity storage.
10
+ * @throws GeneralError if the connector type is unknown.
11
+ */
12
+ export declare function initialiseEntityStorageConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, typeCustom: string | undefined, schema: string): void;
13
+ /**
14
+ * Initialise the entity storage connector.
15
+ * @param engineCore The engine core.
16
+ * @param context The context for the engine.
17
+ * @param instanceConfig The instance config.
18
+ * @param overrideInstanceType The instance type to override the default.
19
+ * @returns The name of the instance created.
20
+ * @throws GeneralError if the connector type is unknown.
21
+ */
22
+ export declare function initialiseEntityStorageComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: EntityStorageComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { FaucetConnectorConfig } from "../models/config/faucetConnectorConfig";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig";
4
+ /**
5
+ * Initialise a faucet connector.
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 connector type is unknown.
12
+ */
13
+ export declare function initialiseFaucetConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: FaucetConnectorConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,24 @@
1
+ import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
+ import type { IdentityComponentConfig } from "../models/config/identityComponentConfig.js";
3
+ import type { IdentityConnectorConfig } from "../models/config/identityConnectorConfig.js";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
5
+ /**
6
+ * Initialise the identity connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The context for the engine.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseIdentityConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: IdentityConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the identity component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseIdentityComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: IdentityComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,24 @@
1
+ import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
+ import type { IdentityProfileComponentConfig } from "../models/config/identityProfileComponentConfig.js";
3
+ import type { IdentityProfileConnectorConfig } from "../models/config/identityProfileConnectorConfig.js";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
5
+ /**
6
+ * Initialise the identity profile connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The context for the engine.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseIdentityProfileConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: IdentityProfileConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the identity profile component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseIdentityProfileComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: IdentityProfileComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { ImmutableProofComponentConfig } from "../models/config/immutableProofComponentConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise the immutable proof 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 initialiseImmutableProofComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: ImmutableProofComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
+ import type { ImmutableStorageConnectorConfig } from "../models/config/immutableStorageConnectorConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise the immutable storage connector.
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 connector type is unknown.
12
+ */
13
+ export declare function initialiseImmutableStorageConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: ImmutableStorageConnectorConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,24 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { LoggingComponentConfig } from "../models/config/loggingComponentConfig";
3
+ import type { LoggingConnectorConfig } from "../models/config/loggingConnectorConfig";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig";
5
+ /**
6
+ * Initialise the logging connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The engine core context.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseLoggingConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: LoggingConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the logging component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseLoggingComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: LoggingComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,24 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { NftComponentConfig } from "../models/config/nftComponentConfig.js";
3
+ import type { NftConnectorConfig } from "../models/config/nftConnectorConfig.js";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
5
+ /**
6
+ * Initialise the NFT connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The context for the engine.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseNftConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: NftConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the NFT component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseNftComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: NftComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,24 @@
1
+ import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
+ import type { TelemetryComponentConfig } from "../models/config/telemetryComponentConfig.js";
3
+ import type { TelemetryConnectorConfig } from "../models/config/telemetryConnectorConfig.js";
4
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
5
+ /**
6
+ * Initialise a telemetry connector.
7
+ * @param engineCore The engine core.
8
+ * @param context The context for the engine.
9
+ * @param instanceConfig The instance config.
10
+ * @param overrideInstanceType The instance type to override the default.
11
+ * @returns The name of the instance created.
12
+ * @throws GeneralError if the connector type is unknown.
13
+ */
14
+ export declare function initialiseTelemetryConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: TelemetryConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the telemetry component.
17
+ * @param engineCore The engine core.
18
+ * @param context The context for the engine.
19
+ * @param instanceConfig The instance config.
20
+ * @param overrideInstanceType The instance type to override the default.
21
+ * @returns The name of the instance created.
22
+ * @throws GeneralError if the component type is unknown.
23
+ */
24
+ export declare function initialiseTelemetryComponent(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: TelemetryComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,13 @@
1
+ import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
+ import type { VaultConnectorConfig } from "../models/config/vaultConnectorConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise the vault connector.
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 connector type is unknown.
12
+ */
13
+ export declare function initialiseVaultConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: VaultConnectorConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,23 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { WalletConnectorConfig } from "../models/config/walletConnectorConfig.js";
3
+ import type { IEngineCoreTypesConfig } from "../models/IEngineCoreTypesConfig.js";
4
+ /**
5
+ * Initialise a wallet connector.
6
+ * @param engineCore The engine core.
7
+ * @param context The context for the node.
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 connector type is unknown.
12
+ */
13
+ export declare function initialiseWalletConnector(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: WalletConnectorConfig, overrideInstanceType?: string): string | undefined;
14
+ /**
15
+ * Initialise the wallet storage.
16
+ * @param engineCore The engine core.
17
+ * @param context The context for the engine.
18
+ * @param instanceConfig The instance config.
19
+ * @param overrideInstanceType The instance type to override the default.
20
+ * @returns Nothing.
21
+ * @throws GeneralError if the connector type is unknown.
22
+ */
23
+ export declare function initialiseWalletStorage(engineCore: IEngineCore<IEngineCoreTypesConfig>, context: IEngineCoreContext<IEngineCoreTypesConfig>, instanceConfig: WalletConnectorConfig, overrideInstanceType?: string): string | undefined;
@@ -0,0 +1,67 @@
1
+ export * from "./components/attestation";
2
+ export * from "./components/auditableItemGraph";
3
+ export * from "./components/auditableItemStream";
4
+ export * from "./components/backgroundTask";
5
+ export * from "./components/blobStorage";
6
+ export * from "./components/entityStorage";
7
+ export * from "./components/faucet";
8
+ export * from "./components/identity";
9
+ export * from "./components/identityProfile";
10
+ export * from "./components/immutableProof";
11
+ export * from "./components/immutableStorage";
12
+ export * from "./components/logging";
13
+ export * from "./components/nft";
14
+ export * from "./components/telemetry";
15
+ export * from "./components/vault";
16
+ export * from "./components/wallet";
17
+ export * from "./models/config/attestationComponentConfig";
18
+ export * from "./models/config/attestationConnectorConfig";
19
+ export * from "./models/config/auditableItemGraphComponentConfig";
20
+ export * from "./models/config/auditableItemStreamComponentConfig";
21
+ export * from "./models/config/backgroundTaskConnectorConfig";
22
+ export * from "./models/config/blobStorageComponentConfig";
23
+ export * from "./models/config/blobStorageConnectorConfig";
24
+ export * from "./models/config/dltConfig";
25
+ export * from "./models/config/entityStorageComponentConfig";
26
+ export * from "./models/config/entityStorageConnectorConfig";
27
+ export * from "./models/config/faucetConnectorConfig";
28
+ export * from "./models/config/identityComponentConfig";
29
+ export * from "./models/config/identityConnectorConfig";
30
+ export * from "./models/config/identityProfileComponentConfig";
31
+ export * from "./models/config/identityProfileConnectorConfig";
32
+ export * from "./models/config/immutableProofComponentConfig";
33
+ export * from "./models/config/immutableStorageConnectorConfig";
34
+ export * from "./models/config/loggingComponentConfig";
35
+ export * from "./models/config/loggingConnectorConfig";
36
+ export * from "./models/config/nftComponentConfig";
37
+ export * from "./models/config/nftConnectorConfig";
38
+ export * from "./models/config/telemetryComponentConfig";
39
+ export * from "./models/config/telemetryConnectorConfig";
40
+ export * from "./models/config/vaultConnectorConfig";
41
+ export * from "./models/config/walletConnectorConfig";
42
+ export * from "./models/IEngineCoreTypesConfig";
43
+ export * from "./models/types/attestationComponentType";
44
+ export * from "./models/types/attestationConnectorType";
45
+ export * from "./models/types/auditableItemGraphComponentType";
46
+ export * from "./models/types/auditableItemStreamComponentType";
47
+ export * from "./models/types/backgroundTaskConnectorType";
48
+ export * from "./models/types/blobStorageComponentType";
49
+ export * from "./models/types/blobStorageConnectorType";
50
+ export * from "./models/types/dltConfigType";
51
+ export * from "./models/types/entityStorageComponentType";
52
+ export * from "./models/types/entityStorageConnectorType";
53
+ export * from "./models/types/faucetConnectorType";
54
+ export * from "./models/types/identityComponentType";
55
+ export * from "./models/types/identityConnectorType";
56
+ export * from "./models/types/identityProfileComponentType";
57
+ export * from "./models/types/identityProfileConnectorType";
58
+ export * from "./models/types/immutableProofComponentType";
59
+ export * from "./models/types/immutableStorageConnectorType";
60
+ export * from "./models/types/loggingComponentType";
61
+ export * from "./models/types/loggingConnectorType";
62
+ export * from "./models/types/nftComponentType";
63
+ export * from "./models/types/nftConnectorType";
64
+ export * from "./models/types/telemetryComponentType";
65
+ export * from "./models/types/telemetryConnectorType";
66
+ export * from "./models/types/vaultConnectorType";
67
+ export * from "./models/types/walletConnectorType";
@@ -0,0 +1,137 @@
1
+ import type { IEngineCoreConfig, IEngineCoreTypeConfig } from "@twin.org/engine-models";
2
+ import type { AttestationComponentConfig } from "./config/attestationComponentConfig";
3
+ import type { AttestationConnectorConfig } from "./config/attestationConnectorConfig";
4
+ import type { AuditableItemGraphComponentConfig } from "./config/auditableItemGraphComponentConfig";
5
+ import type { AuditableItemStreamComponentConfig } from "./config/auditableItemStreamComponentConfig";
6
+ import type { BackgroundTaskConnectorConfig } from "./config/backgroundTaskConnectorConfig";
7
+ import type { BlobStorageComponentConfig } from "./config/blobStorageComponentConfig";
8
+ import type { BlobStorageConnectorConfig } from "./config/blobStorageConnectorConfig";
9
+ import type { DltConfig } from "./config/dltConfig";
10
+ import type { EntityStorageComponentConfig } from "./config/entityStorageComponentConfig";
11
+ import type { EntityStorageConnectorConfig } from "./config/entityStorageConnectorConfig";
12
+ import type { FaucetConnectorConfig } from "./config/faucetConnectorConfig";
13
+ import type { IdentityComponentConfig } from "./config/identityComponentConfig";
14
+ import type { IdentityConnectorConfig } from "./config/identityConnectorConfig";
15
+ import type { IdentityProfileComponentConfig } from "./config/identityProfileComponentConfig";
16
+ import type { IdentityProfileConnectorConfig } from "./config/identityProfileConnectorConfig";
17
+ import type { ImmutableProofComponentConfig } from "./config/immutableProofComponentConfig";
18
+ import type { ImmutableStorageConnectorConfig } from "./config/immutableStorageConnectorConfig";
19
+ import type { LoggingComponentConfig } from "./config/loggingComponentConfig";
20
+ import type { LoggingConnectorConfig } from "./config/loggingConnectorConfig";
21
+ import type { NftComponentConfig } from "./config/nftComponentConfig";
22
+ import type { NftConnectorConfig } from "./config/nftConnectorConfig";
23
+ import type { TelemetryComponentConfig } from "./config/telemetryComponentConfig";
24
+ import type { TelemetryConnectorConfig } from "./config/telemetryConnectorConfig";
25
+ import type { VaultConnectorConfig } from "./config/vaultConnectorConfig";
26
+ import type { WalletConnectorConfig } from "./config/walletConnectorConfig";
27
+ /**
28
+ * Extended engine core config with known types.
29
+ */
30
+ export interface IEngineCoreTypesConfig extends IEngineCoreConfig {
31
+ /**
32
+ * The types to initialise in the engine.
33
+ */
34
+ types: {
35
+ [type: string]: IEngineCoreTypeConfig[] | undefined;
36
+ /**
37
+ * Logging connector options which can be overridden by individual components by specifying types other than default.
38
+ */
39
+ loggingConnector?: IEngineCoreTypeConfig<LoggingConnectorConfig>[];
40
+ /**
41
+ * Logging component options which can be overridden by individual components by specifying types other than default.
42
+ */
43
+ loggingComponent?: IEngineCoreTypeConfig<LoggingComponentConfig>[];
44
+ /**
45
+ * Entity storage connector options which can be overridden by individual components by specifying types other than default.
46
+ */
47
+ entityStorageConnector?: IEngineCoreTypeConfig<EntityStorageConnectorConfig>[];
48
+ /**
49
+ * Entity storage component options which can be overridden by individual components by specifying types other than default.
50
+ */
51
+ entityStorageComponent?: IEngineCoreTypeConfig<EntityStorageComponentConfig>[];
52
+ /**
53
+ * Blob storage connector options which can be overridden by individual components by specifying types other than default.
54
+ */
55
+ blobStorageConnector?: IEngineCoreTypeConfig<BlobStorageConnectorConfig>[];
56
+ /**
57
+ * Blob storage component options which can be overridden by individual components by specifying types other than default.
58
+ */
59
+ blobStorageComponent?: IEngineCoreTypeConfig<BlobStorageComponentConfig>[];
60
+ /**
61
+ * Telemetry connector options which can be overridden by individual components by specifying types other than default.
62
+ */
63
+ telemetryConnector?: IEngineCoreTypeConfig<TelemetryConnectorConfig>[];
64
+ /**
65
+ * Telemetry component options which can be overridden by individual components by specifying types other than default.
66
+ */
67
+ telemetryComponent?: IEngineCoreTypeConfig<TelemetryComponentConfig>[];
68
+ /**
69
+ * Background task connector options which can be overridden by individual components by specifying types other than default.
70
+ */
71
+ backgroundTaskConnector?: IEngineCoreTypeConfig<BackgroundTaskConnectorConfig>[];
72
+ /**
73
+ * Vault connector options which can be overridden by individual components by specifying types other than default.
74
+ */
75
+ vaultConnector?: IEngineCoreTypeConfig<VaultConnectorConfig>[];
76
+ /**
77
+ * DLT options which can be overridden by individual components by specifying types other than default.
78
+ */
79
+ dltConfig?: IEngineCoreTypeConfig<DltConfig>[];
80
+ /**
81
+ * Wallet connector options which can be overridden by individual components by specifying types other than default.
82
+ */
83
+ walletConnector?: IEngineCoreTypeConfig<WalletConnectorConfig>[];
84
+ /**
85
+ * Immutable storage connector options which can be overridden by individual components by specifying types other than default.
86
+ */
87
+ immutableStorageConnector?: IEngineCoreTypeConfig<ImmutableStorageConnectorConfig>[];
88
+ /**
89
+ * Immutable proof component options which can be overridden by individual components by specifying types other than default.
90
+ */
91
+ immutableProofComponent?: IEngineCoreTypeConfig<ImmutableProofComponentConfig>[];
92
+ /**
93
+ * Faucet connector options which can be overridden by individual components by specifying types other than default.
94
+ */
95
+ faucetConnector?: IEngineCoreTypeConfig<FaucetConnectorConfig>[];
96
+ /**
97
+ * Identity connector options which can be overridden by individual components by specifying types other than default.
98
+ */
99
+ identityConnector?: IEngineCoreTypeConfig<IdentityConnectorConfig>[];
100
+ /**
101
+ * Identity component profile options which can be overridden by individual components by specifying types other than default.
102
+ */
103
+ identityComponent?: IEngineCoreTypeConfig<IdentityComponentConfig>[];
104
+ /**
105
+ * Identity profile connector options which can be overridden by individual components by specifying types other than default.
106
+ */
107
+ identityProfileConnector?: IEngineCoreTypeConfig<IdentityProfileConnectorConfig>[];
108
+ /**
109
+ * Identity profile component profile options which can be overridden by individual components by specifying types other than default.
110
+ */
111
+ identityProfileComponent?: IEngineCoreTypeConfig<IdentityProfileComponentConfig>[];
112
+ /**
113
+ * NFT connector options which can be overridden by individual components by specifying types other than default.
114
+ */
115
+ nftConnector?: IEngineCoreTypeConfig<NftConnectorConfig>[];
116
+ /**
117
+ * NFT component options which can be overridden by individual components by specifying types other than default.
118
+ */
119
+ nftComponent?: IEngineCoreTypeConfig<NftComponentConfig>[];
120
+ /**
121
+ * Attestation connector options which can be overridden by individual components by specifying types other than default.
122
+ */
123
+ attestationConnector?: IEngineCoreTypeConfig<AttestationConnectorConfig>[];
124
+ /**
125
+ * Attestation component profile options which can be overridden by individual components by specifying types other than default.
126
+ */
127
+ attestationComponent?: IEngineCoreTypeConfig<AttestationComponentConfig>[];
128
+ /**
129
+ * Auditable item graph component options which can be overridden by individual components by specifying types other than default.
130
+ */
131
+ auditableItemGraphComponent?: IEngineCoreTypeConfig<AuditableItemGraphComponentConfig>[];
132
+ /**
133
+ * Auditable item stream component profile options which can be overridden by individual components by specifying types other than default.
134
+ */
135
+ auditableItemStreamComponent?: IEngineCoreTypeConfig<AuditableItemStreamComponentConfig>[];
136
+ };
137
+ }
@@ -0,0 +1,12 @@
1
+ import type { IAttestationServiceConfig } from "@twin.org/attestation-service";
2
+ import type { AttestationComponentType } from "../types/attestationComponentType";
3
+ /**
4
+ * Attestation component config types.
5
+ */
6
+ export type AttestationComponentConfig = {
7
+ type: typeof AttestationComponentType.Service;
8
+ options?: {
9
+ walletConnectorType?: string;
10
+ config?: IAttestationServiceConfig;
11
+ };
12
+ };
@@ -0,0 +1,21 @@
1
+ import type { IEntityStorageAttestationConnectorConfig } from "@twin.org/attestation-connector-entity-storage";
2
+ import type { IIotaAttestationConnectorConfig } from "@twin.org/attestation-connector-iota";
3
+ import type { AttestationConnectorType } from "../types/attestationConnectorType";
4
+ /**
5
+ * Attestation config connector types.
6
+ */
7
+ export type AttestationConnectorConfig = {
8
+ type: typeof AttestationConnectorType.EntityStorage;
9
+ options?: {
10
+ identityConnectorType?: string;
11
+ nftConnectorType?: string;
12
+ config?: IEntityStorageAttestationConnectorConfig;
13
+ };
14
+ } | {
15
+ type: typeof AttestationConnectorType.Iota;
16
+ options?: {
17
+ identityConnectorType?: string;
18
+ nftConnectorType?: string;
19
+ config?: IIotaAttestationConnectorConfig;
20
+ };
21
+ };
@@ -0,0 +1,14 @@
1
+ import type { IAuditableItemGraphServiceConfig } from "@twin.org/auditable-item-graph-service";
2
+ import type { AuditableItemGraphComponentType } from "../types/auditableItemGraphComponentType";
3
+ /**
4
+ * Auditable item graph component config types.
5
+ */
6
+ export type AuditableItemGraphComponentConfig = {
7
+ type: typeof AuditableItemGraphComponentType.Service;
8
+ options?: {
9
+ immutableProofComponentType?: string;
10
+ vertexEntityStorageType?: string;
11
+ changesetEntityStorageType?: string;
12
+ config?: IAuditableItemGraphServiceConfig;
13
+ };
14
+ };
@@ -0,0 +1,14 @@
1
+ import type { IAuditableItemStreamServiceConfig } from "@twin.org/auditable-item-stream-service";
2
+ import type { AuditableItemStreamComponentType } from "../types/auditableItemStreamComponentType";
3
+ /**
4
+ * Auditable item stream component config types.
5
+ */
6
+ export type AuditableItemStreamComponentConfig = {
7
+ type: typeof AuditableItemStreamComponentType.Service;
8
+ options?: {
9
+ immutableProofComponentType?: string;
10
+ streamEntityStorageType?: string;
11
+ streamEntryEntityStorageType?: string;
12
+ config?: IAuditableItemStreamServiceConfig;
13
+ };
14
+ };
@@ -0,0 +1,13 @@
1
+ import type { IEntityStorageBackgroundTaskConnectorConfig } from "@twin.org/background-task-connector-entity-storage";
2
+ import type { BackgroundTaskConnectorType } from "../types/backgroundTaskConnectorType";
3
+ /**
4
+ * Background task connector config types.
5
+ */
6
+ export type BackgroundTaskConnectorConfig = {
7
+ type: typeof BackgroundTaskConnectorType.EntityStorage;
8
+ options?: {
9
+ backgroundTaskEntityStorageType?: string;
10
+ loggingConnectorType?: string;
11
+ config?: IEntityStorageBackgroundTaskConnectorConfig;
12
+ };
13
+ };
@@ -0,0 +1,13 @@
1
+ import type { IBlobStorageServiceConfig } from "@twin.org/blob-storage-service";
2
+ import type { BlobStorageComponentType } from "../types/blobStorageComponentType";
3
+ /**
4
+ * Blob storage component config types.
5
+ */
6
+ export type BlobStorageComponentConfig = {
7
+ type: typeof BlobStorageComponentType.Service;
8
+ options?: {
9
+ entryEntityStorageType?: string;
10
+ vaultConnectorType?: string;
11
+ config?: IBlobStorageServiceConfig;
12
+ };
13
+ };