@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
118 lines (117 loc) • 5.14 kB
TypeScript
/**
* @module EventBus
*/
import { type IEventBus, type IEventBusResolver, type BaseEventMap, type IEventBusAdapter } from "../../../../event-bus/contracts/_module.js";
import { type EventBusSettingsBase, type EventMapSchema } from "../../../../event-bus/implementations/derivables/event-bus/_module.js";
import { type IExecutionContext } from "../../../../execution-context/contracts/_module.js";
import { type INamespace } from "../../../../namespace/contracts/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/event-bus"`
* @group Derivables
*/
export type EventBusAdapters<TAdapters extends string = string> = Partial<Record<TAdapters, IEventBusAdapter>>;
/**
* Configuration for `EventBusResolver`.
* Registers named event-bus adapters and optionally designates a default.
*
* IMPORT_PATH: `"@daiso-tech/core/event-bus"`
* @group Derivables
*/
export type EventBusResolverSettings<TAdapters extends string = string, TEventMap extends BaseEventMap = BaseEventMap> = EventBusSettingsBase<TEventMap> & {
/**
* Named registry of event-bus adapters. Each key is an adapter alias and the corresponding value is the adapter instance.
*/
adapters: EventBusAdapters<TAdapters>;
/**
* The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map.
*/
defaultAdapter?: NoInfer<TAdapters>;
};
/**
* The `EventBusResolver` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/event-bus"`
* @group Derivables
*/
export declare class EventBusResolver<TAdapters extends string = string, TEventMap extends BaseEventMap = BaseEventMap> implements IEventBusResolver<TAdapters, TEventMap> {
private readonly settings;
/**
* @example
* ```ts
* import { type IEventBusAdapter, BaseEvent } from "@daiso-tech/core/event-bus/contracts";
* import { EventBusResolver } from "@daiso-tech/core/event-bus";
* import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/memory-event-bus-adapter";
* import { RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/redis-pub-sub-event-bus-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
* import Redis from "ioredis";
*
* type Store = Partial<Record<string, IEventBusAdapter>>;
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const store: Store = {};
* const eventBusResolver = new EventBusResolver({
* adapters: {
* memory: new MemoryEventBusAdapter(),
* redis: new RedisPubSubEventBusAdapter({
* serde,
* dispatcherClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
* listenerClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
* }),
* },
* defaultAdapter: "memory"
* });
* ```
*/
constructor(settings: EventBusResolverSettings<TAdapters, TEventMap>);
setNamespace(namespace: INamespace): EventBusResolver<TAdapters, TEventMap>;
setEventMapType<TEventMap_ extends BaseEventMap>(): EventBusResolver<TAdapters, TEventMap_>;
setEventMapSchema<TEventMap_ extends BaseEventMap>(eventMapSchema: EventMapSchema<TEventMap_>): EventBusResolver<TAdapters, TEventMap_>;
setExecutionContext(executionContext: IExecutionContext): EventBusResolver<TAdapters, TEventMap>;
/**
* @example
* ```ts
* import { type IEventBusAdapter, BaseEvent } from "@daiso-tech/core/event-bus/contracts";
* import { EventBusResolver } from "@daiso-tech/core/event-bus";
* import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/memory-event-bus-adapter";
* import { RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/redis-pub-sub-event-bus-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
* import Redis from "ioredis";
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const eventBusResolver = new EventBusResolver({
* adapters: {
* memory: new MemoryEventBusAdapter(),
* redis: new RedisPubSubEventBusAdapter({
* serde,
* dispatcherClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
* listenerClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
* }),
* },
* defaultAdapter: "memory"
* });
*
* type AddEvent = {
* a: number;
* b: number;
* };
* type EventMap = {
* add: AddEvent;
* };
*
* // Will dispatch AddEvent using the default adapter which is MemoryEventBusAdapter
* await eventBusResolver
* .setEventMapType<EventMap>()
* .use()
* .dispatch("add", { a: 1, b: 2 });
*
* // Will dispatch AddEvent using the redis adapter
* await eventBusResolver
* .setEventMapType<EventMap>()
* .use("redis")
* .dispatch("add", { a: 1, b: 2 });
* ```
*/
use(adapterName?: TAdapters | undefined): IEventBus<TEventMap>;
}