@twin.org/engine-types 0.0.1-next.25 → 0.0.1-next.26

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.
@@ -26,6 +26,9 @@ var blobStorageConnectorIpfs = require('@twin.org/blob-storage-connector-ipfs');
26
26
  var blobStorageConnectorMemory = require('@twin.org/blob-storage-connector-memory');
27
27
  var blobStorageModels = require('@twin.org/blob-storage-models');
28
28
  var blobStorageService = require('@twin.org/blob-storage-service');
29
+ var eventBusConnectorLocal = require('@twin.org/event-bus-connector-local');
30
+ var eventBusModels = require('@twin.org/event-bus-models');
31
+ var eventBusService = require('@twin.org/event-bus-service');
29
32
  var walletConnectorEntityStorage = require('@twin.org/wallet-connector-entity-storage');
30
33
  var walletConnectorIota = require('@twin.org/wallet-connector-iota');
31
34
  var walletModels = require('@twin.org/wallet-models');
@@ -695,6 +698,103 @@ function initialiseBlobStorageComponent(engineCore, context, instanceConfig, ove
695
698
  return finalInstanceType;
696
699
  }
697
700
 
701
+ // Copyright 2024 IOTA Stiftung.
702
+ // SPDX-License-Identifier: Apache-2.0.
703
+ /**
704
+ * Event bus component types.
705
+ */
706
+ // eslint-disable-next-line @typescript-eslint/naming-convention
707
+ const EventBusComponentType = {
708
+ /**
709
+ * Service.
710
+ */
711
+ Service: "service"
712
+ };
713
+
714
+ // Copyright 2024 IOTA Stiftung.
715
+ // SPDX-License-Identifier: Apache-2.0.
716
+ /**
717
+ * Event bus connector types.
718
+ */
719
+ // eslint-disable-next-line @typescript-eslint/naming-convention
720
+ const EventBusConnectorType = {
721
+ /**
722
+ * Local.
723
+ */
724
+ Local: "local"
725
+ };
726
+
727
+ // Copyright 2024 IOTA Stiftung.
728
+ // SPDX-License-Identifier: Apache-2.0.
729
+ /**
730
+ * Initialise a event bus connector.
731
+ * @param engineCore The engine core.
732
+ * @param context The context for the engine.
733
+ * @param instanceConfig The instance config.
734
+ * @param overrideInstanceType The instance type to override the default.
735
+ * @returns The name of the instance created.
736
+ * @throws GeneralError if the connector type is unknown.
737
+ */
738
+ function initialiseEventBusConnector(engineCore, context, instanceConfig, overrideInstanceType) {
739
+ engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
740
+ element: `Event Bus Connector: ${instanceConfig.type}`
741
+ }));
742
+ const type = instanceConfig.type;
743
+ let connector;
744
+ let instanceType;
745
+ if (type === EventBusConnectorType.Local) {
746
+ connector = new eventBusConnectorLocal.LocalEventBusConnector({
747
+ loggingConnectorType: context.defaultTypes.loggingConnector,
748
+ ...instanceConfig.options
749
+ });
750
+ instanceType = eventBusConnectorLocal.LocalEventBusConnector.NAMESPACE;
751
+ }
752
+ else {
753
+ throw new core.GeneralError("engineCore", "connectorUnknownType", {
754
+ type,
755
+ connectorType: "eventBusConnector"
756
+ });
757
+ }
758
+ const finalInstanceType = overrideInstanceType ?? instanceType;
759
+ context.componentInstances.push({ instanceType: finalInstanceType, component: connector });
760
+ eventBusModels.EventBusConnectorFactory.register(finalInstanceType, () => connector);
761
+ return finalInstanceType;
762
+ }
763
+ /**
764
+ * Initialise the event bus component.
765
+ * @param engineCore The engine core.
766
+ * @param context The context for the engine.
767
+ * @param instanceConfig The instance config.
768
+ * @param overrideInstanceType The instance type to override the default.
769
+ * @returns The name of the instance created.
770
+ * @throws GeneralError if the component type is unknown.
771
+ */
772
+ function initialiseEventBusComponent(engineCore, context, instanceConfig, overrideInstanceType) {
773
+ engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
774
+ element: `Event Bus Component: ${instanceConfig.type}`
775
+ }));
776
+ const type = instanceConfig.type;
777
+ let component;
778
+ let instanceType;
779
+ if (type === EventBusComponentType.Service) {
780
+ component = new eventBusService.EventBusService({
781
+ eventBusConnectorType: context.defaultTypes.eventBusConnector,
782
+ ...instanceConfig.options
783
+ });
784
+ instanceType = eventBusService.EventBusService.NAMESPACE;
785
+ }
786
+ else {
787
+ throw new core.GeneralError("engineCore", "componentUnknownType", {
788
+ type,
789
+ componentType: "EventBusComponent"
790
+ });
791
+ }
792
+ const finalInstanceType = overrideInstanceType ?? instanceType;
793
+ context.componentInstances.push({ instanceType: finalInstanceType, component });
794
+ core.ComponentFactory.register(finalInstanceType, () => component);
795
+ return finalInstanceType;
796
+ }
797
+
698
798
  // Copyright 2024 IOTA Stiftung.
699
799
  // SPDX-License-Identifier: Apache-2.0.
700
800
  /**
@@ -1598,6 +1698,8 @@ exports.BlobStorageConnectorType = BlobStorageConnectorType;
1598
1698
  exports.DltConfigType = DltConfigType;
1599
1699
  exports.EntityStorageComponentType = EntityStorageComponentType;
1600
1700
  exports.EntityStorageConnectorType = EntityStorageConnectorType;
1701
+ exports.EventBusComponentType = EventBusComponentType;
1702
+ exports.EventBusConnectorType = EventBusConnectorType;
1601
1703
  exports.FaucetConnectorType = FaucetConnectorType;
1602
1704
  exports.IdentityComponentType = IdentityComponentType;
1603
1705
  exports.IdentityConnectorType = IdentityConnectorType;
@@ -1622,6 +1724,8 @@ exports.initialiseBlobStorageComponent = initialiseBlobStorageComponent;
1622
1724
  exports.initialiseBlobStorageConnector = initialiseBlobStorageConnector;
1623
1725
  exports.initialiseEntityStorageComponent = initialiseEntityStorageComponent;
1624
1726
  exports.initialiseEntityStorageConnector = initialiseEntityStorageConnector;
1727
+ exports.initialiseEventBusComponent = initialiseEventBusComponent;
1728
+ exports.initialiseEventBusConnector = initialiseEventBusConnector;
1625
1729
  exports.initialiseFaucetConnector = initialiseFaucetConnector;
1626
1730
  exports.initialiseIdentityComponent = initialiseIdentityComponent;
1627
1731
  exports.initialiseIdentityConnector = initialiseIdentityConnector;
@@ -24,6 +24,9 @@ import { IpfsBlobStorageConnector } from '@twin.org/blob-storage-connector-ipfs'
24
24
  import { MemoryBlobStorageConnector } from '@twin.org/blob-storage-connector-memory';
25
25
  import { BlobStorageConnectorFactory } from '@twin.org/blob-storage-models';
26
26
  import { initSchema as initSchema$3, BlobStorageService } from '@twin.org/blob-storage-service';
27
+ import { LocalEventBusConnector } from '@twin.org/event-bus-connector-local';
28
+ import { EventBusConnectorFactory } from '@twin.org/event-bus-models';
29
+ import { EventBusService } from '@twin.org/event-bus-service';
27
30
  import { EntityStorageFaucetConnector, EntityStorageWalletConnector, initSchema as initSchema$b } from '@twin.org/wallet-connector-entity-storage';
28
31
  import { IotaFaucetConnector, IotaWalletConnector } from '@twin.org/wallet-connector-iota';
29
32
  import { FaucetConnectorFactory, WalletConnectorFactory } from '@twin.org/wallet-models';
@@ -693,6 +696,103 @@ function initialiseBlobStorageComponent(engineCore, context, instanceConfig, ove
693
696
  return finalInstanceType;
694
697
  }
695
698
 
699
+ // Copyright 2024 IOTA Stiftung.
700
+ // SPDX-License-Identifier: Apache-2.0.
701
+ /**
702
+ * Event bus component types.
703
+ */
704
+ // eslint-disable-next-line @typescript-eslint/naming-convention
705
+ const EventBusComponentType = {
706
+ /**
707
+ * Service.
708
+ */
709
+ Service: "service"
710
+ };
711
+
712
+ // Copyright 2024 IOTA Stiftung.
713
+ // SPDX-License-Identifier: Apache-2.0.
714
+ /**
715
+ * Event bus connector types.
716
+ */
717
+ // eslint-disable-next-line @typescript-eslint/naming-convention
718
+ const EventBusConnectorType = {
719
+ /**
720
+ * Local.
721
+ */
722
+ Local: "local"
723
+ };
724
+
725
+ // Copyright 2024 IOTA Stiftung.
726
+ // SPDX-License-Identifier: Apache-2.0.
727
+ /**
728
+ * Initialise a event bus connector.
729
+ * @param engineCore The engine core.
730
+ * @param context The context for the engine.
731
+ * @param instanceConfig The instance config.
732
+ * @param overrideInstanceType The instance type to override the default.
733
+ * @returns The name of the instance created.
734
+ * @throws GeneralError if the connector type is unknown.
735
+ */
736
+ function initialiseEventBusConnector(engineCore, context, instanceConfig, overrideInstanceType) {
737
+ engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
738
+ element: `Event Bus Connector: ${instanceConfig.type}`
739
+ }));
740
+ const type = instanceConfig.type;
741
+ let connector;
742
+ let instanceType;
743
+ if (type === EventBusConnectorType.Local) {
744
+ connector = new LocalEventBusConnector({
745
+ loggingConnectorType: context.defaultTypes.loggingConnector,
746
+ ...instanceConfig.options
747
+ });
748
+ instanceType = LocalEventBusConnector.NAMESPACE;
749
+ }
750
+ else {
751
+ throw new GeneralError("engineCore", "connectorUnknownType", {
752
+ type,
753
+ connectorType: "eventBusConnector"
754
+ });
755
+ }
756
+ const finalInstanceType = overrideInstanceType ?? instanceType;
757
+ context.componentInstances.push({ instanceType: finalInstanceType, component: connector });
758
+ EventBusConnectorFactory.register(finalInstanceType, () => connector);
759
+ return finalInstanceType;
760
+ }
761
+ /**
762
+ * Initialise the event bus component.
763
+ * @param engineCore The engine core.
764
+ * @param context The context for the engine.
765
+ * @param instanceConfig The instance config.
766
+ * @param overrideInstanceType The instance type to override the default.
767
+ * @returns The name of the instance created.
768
+ * @throws GeneralError if the component type is unknown.
769
+ */
770
+ function initialiseEventBusComponent(engineCore, context, instanceConfig, overrideInstanceType) {
771
+ engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
772
+ element: `Event Bus Component: ${instanceConfig.type}`
773
+ }));
774
+ const type = instanceConfig.type;
775
+ let component;
776
+ let instanceType;
777
+ if (type === EventBusComponentType.Service) {
778
+ component = new EventBusService({
779
+ eventBusConnectorType: context.defaultTypes.eventBusConnector,
780
+ ...instanceConfig.options
781
+ });
782
+ instanceType = EventBusService.NAMESPACE;
783
+ }
784
+ else {
785
+ throw new GeneralError("engineCore", "componentUnknownType", {
786
+ type,
787
+ componentType: "EventBusComponent"
788
+ });
789
+ }
790
+ const finalInstanceType = overrideInstanceType ?? instanceType;
791
+ context.componentInstances.push({ instanceType: finalInstanceType, component });
792
+ ComponentFactory.register(finalInstanceType, () => component);
793
+ return finalInstanceType;
794
+ }
795
+
696
796
  // Copyright 2024 IOTA Stiftung.
697
797
  // SPDX-License-Identifier: Apache-2.0.
698
798
  /**
@@ -1586,4 +1686,4 @@ const DltConfigType = {
1586
1686
  Iota: "iota"
1587
1687
  };
1588
1688
 
1589
- export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DltConfigType, EntityStorageComponentType, EntityStorageConnectorType, FaucetConnectorType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, ImmutableProofComponentType, ImmutableStorageConnectorType, LoggingComponentType, LoggingConnectorType, NftComponentType, NftConnectorType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseFaucetConnector, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseImmutableProofComponent, initialiseImmutableStorageConnector, initialiseLoggingComponent, initialiseLoggingConnector, initialiseNftComponent, initialiseNftConnector, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseWalletConnector, initialiseWalletStorage };
1689
+ export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DltConfigType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, ImmutableProofComponentType, ImmutableStorageConnectorType, LoggingComponentType, LoggingConnectorType, NftComponentType, NftConnectorType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseImmutableProofComponent, initialiseImmutableStorageConnector, initialiseLoggingComponent, initialiseLoggingConnector, initialiseNftComponent, initialiseNftConnector, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseWalletConnector, initialiseWalletStorage };
@@ -0,0 +1,24 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { EventBusComponentConfig } from "../models/config/eventBusComponentConfig.js";
3
+ import type { EventBusConnectorConfig } from "../models/config/eventBusConnectorConfig.js";
4
+ import type { IEngineConfig } from "../models/IEngineConfig.js";
5
+ /**
6
+ * Initialise a event bus 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 initialiseEventBusConnector(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: EventBusConnectorConfig, overrideInstanceType?: string): string | undefined;
15
+ /**
16
+ * Initialise the event bus 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 initialiseEventBusComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: EventBusComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -4,6 +4,7 @@ export * from "./components/auditableItemStream";
4
4
  export * from "./components/backgroundTask";
5
5
  export * from "./components/blobStorage";
6
6
  export * from "./components/entityStorage";
7
+ export * from "./components/eventBus";
7
8
  export * from "./components/faucet";
8
9
  export * from "./components/identity";
9
10
  export * from "./components/identityProfile";
@@ -24,6 +25,8 @@ export * from "./models/config/blobStorageConnectorConfig";
24
25
  export * from "./models/config/dltConfig";
25
26
  export * from "./models/config/entityStorageComponentConfig";
26
27
  export * from "./models/config/entityStorageConnectorConfig";
28
+ export * from "./models/config/eventBusConnectorConfig";
29
+ export * from "./models/config/eventBusComponentConfig";
27
30
  export * from "./models/config/faucetConnectorConfig";
28
31
  export * from "./models/config/identityComponentConfig";
29
32
  export * from "./models/config/identityConnectorConfig";
@@ -50,6 +53,8 @@ export * from "./models/types/blobStorageConnectorType";
50
53
  export * from "./models/types/dltConfigType";
51
54
  export * from "./models/types/entityStorageComponentType";
52
55
  export * from "./models/types/entityStorageConnectorType";
56
+ export * from "./models/types/eventBusConnectorType";
57
+ export * from "./models/types/eventBusComponentType";
53
58
  export * from "./models/types/faucetConnectorType";
54
59
  export * from "./models/types/identityComponentType";
55
60
  export * from "./models/types/identityConnectorType";
@@ -0,0 +1,10 @@
1
+ import type { EventBusComponentType } from "../types/eventBusComponentType";
2
+ /**
3
+ * Event bus storage component config types.
4
+ */
5
+ export type EventBusComponentConfig = {
6
+ type: typeof EventBusComponentType.Service;
7
+ options?: {
8
+ eventBusConnectorType?: string;
9
+ };
10
+ };
@@ -0,0 +1,10 @@
1
+ import type { EventBusConnectorType } from "../types/eventBusConnectorType";
2
+ /**
3
+ * Event bus connector config types.
4
+ */
5
+ export type EventBusConnectorConfig = {
6
+ type: typeof EventBusConnectorType.Local;
7
+ options?: {
8
+ loggingConnectorType?: string;
9
+ };
10
+ };
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Event bus component types.
3
+ */
4
+ export declare const EventBusComponentType: {
5
+ /**
6
+ * Service.
7
+ */
8
+ readonly Service: "service";
9
+ };
10
+ /**
11
+ * Event bus component types.
12
+ */
13
+ export type EventBusComponentType = (typeof EventBusComponentType)[keyof typeof EventBusComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Event bus connector types.
3
+ */
4
+ export declare const EventBusConnectorType: {
5
+ /**
6
+ * Local.
7
+ */
8
+ readonly Local: "local";
9
+ };
10
+ /**
11
+ * Event bus connector types.
12
+ */
13
+ export type EventBusConnectorType = (typeof EventBusConnectorType)[keyof typeof EventBusConnectorType];
@@ -0,0 +1,33 @@
1
+ # Function: initialiseEventBusComponent()
2
+
3
+ > **initialiseEventBusComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise the event bus component.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`EventBusComponentConfig`](../type-aliases/EventBusComponentConfig.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: initialiseEventBusConnector()
2
+
3
+ > **initialiseEventBusConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
4
+
5
+ Initialise a event bus connector.
6
+
7
+ ## Parameters
8
+
9
+ • **engineCore**: `IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md), `IEngineState`\>
10
+
11
+ The engine core.
12
+
13
+ • **context**: `IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md), `IEngineState`\>
14
+
15
+ The context for the engine.
16
+
17
+ • **instanceConfig**: [`EventBusConnectorConfig`](../type-aliases/EventBusConnectorConfig.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.
@@ -16,6 +16,8 @@
16
16
  - [DltConfig](type-aliases/DltConfig.md)
17
17
  - [EntityStorageComponentConfig](type-aliases/EntityStorageComponentConfig.md)
18
18
  - [EntityStorageConnectorConfig](type-aliases/EntityStorageConnectorConfig.md)
19
+ - [EventBusComponentConfig](type-aliases/EventBusComponentConfig.md)
20
+ - [EventBusConnectorConfig](type-aliases/EventBusConnectorConfig.md)
19
21
  - [FaucetConnectorConfig](type-aliases/FaucetConnectorConfig.md)
20
22
  - [IdentityComponentConfig](type-aliases/IdentityComponentConfig.md)
21
23
  - [IdentityConnectorConfig](type-aliases/IdentityConnectorConfig.md)
@@ -41,6 +43,8 @@
41
43
  - [DltConfigType](type-aliases/DltConfigType.md)
42
44
  - [EntityStorageComponentType](type-aliases/EntityStorageComponentType.md)
43
45
  - [EntityStorageConnectorType](type-aliases/EntityStorageConnectorType.md)
46
+ - [EventBusComponentType](type-aliases/EventBusComponentType.md)
47
+ - [EventBusConnectorType](type-aliases/EventBusConnectorType.md)
44
48
  - [FaucetConnectorType](type-aliases/FaucetConnectorType.md)
45
49
  - [IdentityComponentType](type-aliases/IdentityComponentType.md)
46
50
  - [IdentityConnectorType](type-aliases/IdentityConnectorType.md)
@@ -69,6 +73,8 @@
69
73
  - [DltConfigType](variables/DltConfigType.md)
70
74
  - [EntityStorageComponentType](variables/EntityStorageComponentType.md)
71
75
  - [EntityStorageConnectorType](variables/EntityStorageConnectorType.md)
76
+ - [EventBusComponentType](variables/EventBusComponentType.md)
77
+ - [EventBusConnectorType](variables/EventBusConnectorType.md)
72
78
  - [FaucetConnectorType](variables/FaucetConnectorType.md)
73
79
  - [IdentityComponentType](variables/IdentityComponentType.md)
74
80
  - [IdentityConnectorType](variables/IdentityConnectorType.md)
@@ -96,6 +102,8 @@
96
102
  - [initialiseBlobStorageComponent](functions/initialiseBlobStorageComponent.md)
97
103
  - [initialiseEntityStorageConnector](functions/initialiseEntityStorageConnector.md)
98
104
  - [initialiseEntityStorageComponent](functions/initialiseEntityStorageComponent.md)
105
+ - [initialiseEventBusConnector](functions/initialiseEventBusConnector.md)
106
+ - [initialiseEventBusComponent](functions/initialiseEventBusComponent.md)
99
107
  - [initialiseFaucetConnector](functions/initialiseFaucetConnector.md)
100
108
  - [initialiseIdentityConnector](functions/initialiseIdentityConnector.md)
101
109
  - [initialiseIdentityComponent](functions/initialiseIdentityComponent.md)
@@ -0,0 +1,19 @@
1
+ # Type Alias: EventBusComponentConfig
2
+
3
+ > **EventBusComponentConfig**: `object`
4
+
5
+ Event bus storage component config types.
6
+
7
+ ## Type declaration
8
+
9
+ ### type
10
+
11
+ > **type**: *typeof* `EventBusComponentType.Service`
12
+
13
+ ### options?
14
+
15
+ > `optional` **options**: `object`
16
+
17
+ ### options.eventBusConnectorType?
18
+
19
+ > `optional` **eventBusConnectorType**: `string`
@@ -0,0 +1,5 @@
1
+ # Type Alias: EventBusComponentType
2
+
3
+ > **EventBusComponentType**: *typeof* [`EventBusComponentType`](../variables/EventBusComponentType.md)\[keyof *typeof* [`EventBusComponentType`](../variables/EventBusComponentType.md)\]
4
+
5
+ Event bus component types.
@@ -0,0 +1,19 @@
1
+ # Type Alias: EventBusConnectorConfig
2
+
3
+ > **EventBusConnectorConfig**: `object`
4
+
5
+ Event bus connector config types.
6
+
7
+ ## Type declaration
8
+
9
+ ### type
10
+
11
+ > **type**: *typeof* `EventBusConnectorType.Local`
12
+
13
+ ### options?
14
+
15
+ > `optional` **options**: `object`
16
+
17
+ ### options.loggingConnectorType?
18
+
19
+ > `optional` **loggingConnectorType**: `string`
@@ -0,0 +1,5 @@
1
+ # Type Alias: EventBusConnectorType
2
+
3
+ > **EventBusConnectorType**: *typeof* [`EventBusConnectorType`](../variables/EventBusConnectorType.md)\[keyof *typeof* [`EventBusConnectorType`](../variables/EventBusConnectorType.md)\]
4
+
5
+ Event bus connector types.
@@ -0,0 +1,13 @@
1
+ # Variable: EventBusComponentType
2
+
3
+ > `const` **EventBusComponentType**: `object`
4
+
5
+ Event bus component types.
6
+
7
+ ## Type declaration
8
+
9
+ ### Service
10
+
11
+ > `readonly` **Service**: `"service"` = `"service"`
12
+
13
+ Service.
@@ -0,0 +1,13 @@
1
+ # Variable: EventBusConnectorType
2
+
3
+ > `const` **EventBusConnectorType**: `object`
4
+
5
+ Event bus connector types.
6
+
7
+ ## Type declaration
8
+
9
+ ### Local
10
+
11
+ > `readonly` **Local**: `"local"` = `"local"`
12
+
13
+ Local.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-types",
3
- "version": "0.0.1-next.25",
3
+ "version": "0.0.1-next.26",
4
4
  "description": "Types to use in an engine.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -18,7 +18,7 @@
18
18
  "@twin.org/crypto": "next",
19
19
  "@twin.org/data-core": "next",
20
20
  "@twin.org/data-schema-org": "next",
21
- "@twin.org/engine-models": "0.0.1-next.25",
21
+ "@twin.org/engine-models": "0.0.1-next.26",
22
22
  "@twin.org/entity": "next",
23
23
  "@twin.org/modules": "next",
24
24
  "@twin.org/nameof": "next"
@@ -50,6 +50,9 @@
50
50
  "@twin.org/entity-storage-connector-scylladb": "next",
51
51
  "@twin.org/entity-storage-models": "next",
52
52
  "@twin.org/entity-storage-service": "next",
53
+ "@twin.org/event-bus-connector-local": "next",
54
+ "@twin.org/event-bus-models": "next",
55
+ "@twin.org/event-bus-service": "next",
53
56
  "@twin.org/identity-connector-entity-storage": "next",
54
57
  "@twin.org/identity-connector-iota": "next",
55
58
  "@twin.org/identity-models": "next",