@flusys/nestjs-shared 6.4.0 → 7.0.0-beta.1

package/interfaces/event-bus.interface.d.ts

@@ -0,0 +1,74 @@
+import { EventAction } from '../enums/event-action.enum';
+export type EventTransportLabel = 'memory' | 'rabbitmq' | 'kafka' | 'hybrid';
+export type DomainEventActionName = EventAction | string;
+export interface IDomainEventActor {
+    userId?: string | null;
+    companyId?: string | null;
+    tenantId?: string | null;
+    requestId?: string | null;
+}
+export interface IDomainEventPayload<T = Record<string, unknown>> {
+    ids: string[];
+    data?: T[];
+    metadata?: Record<string, unknown>;
+}
+export interface IDomainEvent<T = unknown> {
+    id: string;
+    name: string;
+    module: string;
+    entity: string;
+    action: DomainEventActionName;
+    payload: T;
+    actor: IDomainEventActor;
+    occurredAt: string;
+    version: number;
+}
+export type DomainEvent<T = Record<string, unknown>> = IDomainEvent<IDomainEventPayload<T>>;
+export type DomainEventHandler<T = unknown> = (event: IDomainEvent<T>) => void | Promise<void>;
+export interface IEventTransport {
+    readonly name: string;
+    connect(): Promise<void>;
+    publish(event: IDomainEvent): Promise<void>;
+    bind(pattern: string): Promise<void>;
+    onMessage(handler: DomainEventHandler): void;
+    close(): Promise<void>;
+    isReady(): boolean;
+}
+export interface IEventBus {
+    publish<T>(event: IDomainEvent<T>): Promise<void>;
+    subscribe<T>(pattern: string, handler: DomainEventHandler<T>): Promise<void>;
+    close(): Promise<void>;
+}
+export interface IModuleEventsConfig {
+    enabled?: boolean;
+    actions?: DomainEventActionName[];
+    includePayload?: boolean;
+    entities?: string[];
+    excludeEntities?: string[];
+}
+export interface IRabbitMqTransportConfig {
+    url?: string;
+    exchange?: string;
+    queue?: string;
+    durable?: boolean;
+    prefetch?: number;
+    reconnectDelay?: number;
+}
+export interface IKafkaTransportConfig {
+    brokers?: string[];
+    clientId?: string;
+    groupId?: string;
+    topic?: string;
+    ssl?: boolean;
+    sasl?: Record<string, unknown>;
+}
+export interface IEventBusModuleOptions {
+    global?: boolean;
+    enabled?: boolean;
+    transport?: EventTransportLabel;
+    serviceName?: string;
+    defaultModuleEvents?: IModuleEventsConfig;
+    rabbitmq?: IRabbitMqTransportConfig;
+    kafka?: IKafkaTransportConfig;
+    dedupeSize?: number;
+}

package/interfaces/index.d.ts

@@ -1,6 +1,7 @@
 export * from './ai-assistant-adapter.interface';
 export * from './api.interface';
 export * from './datasource.interface';
+export * from './event-bus.interface';
 export * from './event-manager-adapter.interface';
 export * from './identity.interface';
 export * from './logged-user-info.interface';

package/modules/event-bus/event-bus.explorer.d.ts

@@ -0,0 +1,14 @@
+import { OnApplicationBootstrap } from '@nestjs/common';
+import { DiscoveryService, MetadataScanner } from '@nestjs/core';
+import { HybridEventBus } from '../../classes/hybrid-event-bus.class';
+export declare class EventBusExplorer implements OnApplicationBootstrap {
+    private readonly eventBus;
+    private readonly discovery;
+    private readonly metadataScanner;
+    private readonly logger;
+    constructor(eventBus: HybridEventBus | undefined, discovery: DiscoveryService, metadataScanner: MetadataScanner);
+    onApplicationBootstrap(): Promise<void>;
+    private bindInstance;
+    private warnIfUnreachableConsumer;
+    private readPatterns;
+}

package/modules/event-bus/event-bus.module.d.ts

@@ -0,0 +1,8 @@
+import { DynamicModule, OnApplicationShutdown } from '@nestjs/common';
+import { IEventBusModuleOptions } from '../../interfaces/event-bus.interface';
+export declare class EventBusModule implements OnApplicationShutdown {
+    static forRoot(options?: IEventBusModuleOptions): DynamicModule;
+    private static enabledModule;
+    private static disabledModule;
+    onApplicationShutdown(): Promise<void>;
+}

package/modules/event-bus/module-events.provider.d.ts

@@ -0,0 +1,3 @@
+import { Provider } from '@nestjs/common';
+export declare const moduleEventsToken: (moduleName: string) => string;
+export declare function createModuleEventsProvider(moduleName: string, optionsToken: string): Provider;

package/modules/index.d.ts

@@ -1,5 +1,8 @@
 export * from './cache/cache.module';
 export * from './datasource';
+export * from './event-bus/event-bus.explorer';
+export * from './event-bus/event-bus.module';
+export * from './event-bus/module-events.provider';
 export * from './shared-permission-cache/shared-permission-cache.module';
 export * from './shared-permission-cache/shared-permission-cache.service';
 export * from './utils/utils.module';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-shared",
-  "version": "6.4.0",
+  "version": "7.0.0-beta.1",
   "description": "Common shared utilities for Flusys NestJS applications",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -112,6 +112,6 @@
     "rxjs": "^7.8.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "6.4.0"
+    "@flusys/nestjs-core": "7.0.0-beta.1"
   }
 }

package/utils/event-pattern.util.d.ts

@@ -0,0 +1,3 @@
+export declare function matchEventPattern(pattern: string, eventName: string): boolean;
+export declare function isMultiWildcard(segment: string): boolean;
+export declare function sanitizeEventPayload<T>(value: T): T;

package/utils/index.d.ts

@@ -1,5 +1,7 @@
 export * from './date-time.util';
+export * from './event-pattern.util';
 export * from './html-sanitizer.util';
+export * from './optional-module.util';
 export * from './permission-cache-key.util';
 export * from './query-helpers.util';
 export * from './request.util';

package/utils/optional-module.util.d.ts

@@ -0,0 +1 @@
+export declare function loadOptionalModule<T = any>(name: string): Promise<T>;