@tsed/event-emitter 8.0.1 → 8.0.3

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/event-emitter",
   "description": "EventEmitter package for Ts.ED framework",
   "type": "module",
-  "version": "8.0.1",
+  "version": "8.0.3",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -10,6 +10,7 @@
   "browser": "./lib/browser/event-emitter.umd.min.js",
   "exports": {
     ".": {
+      "@tsed/source": "./src/index.ts",
       "types": "./lib/types/index.d.ts",
       "browser": "./lib/browser/event-emitter.umd.min.js",
       "import": "./lib/esm/index.js",
@@ -28,11 +29,11 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.0.1",
-    "@tsed/core": "8.0.1",
-    "@tsed/di": "8.0.1",
-    "@tsed/platform-http": "8.0.1",
-    "@tsed/typescript": "8.0.1",
+    "@tsed/barrels": "8.0.3",
+    "@tsed/core": "8.0.3",
+    "@tsed/di": "8.0.3",
+    "@tsed/platform-http": "8.0.3",
+    "@tsed/typescript": "8.0.3",
     "eslint": "9.12.0",
     "eventemitter2": "^6.4.9",
     "typescript": "5.4.5",

package/src/EventEmitterModule.ts

@@ -0,0 +1,94 @@
+import {Constant, Inject, InjectorService, LOGGER, Module, Provider} from "@tsed/di";
+import type {ListenerFn} from "eventemitter2";
+
+import {EventEmitterStore} from "./interfaces/EventEmitterStore.js";
+import {EventEmitterService} from "./services/EventEmitterFactory.js";
+
+@Module()
+export class EventEmitterModule {
+  @Inject(LOGGER)
+  protected logger: LOGGER;
+
+  @Inject()
+  protected injector: InjectorService;
+
+  @Inject()
+  protected eventEmitter: EventEmitterService;
+
+  @Constant("eventEmitter.disableSummary", false)
+  private disableSummary: boolean;
+
+  @Constant("eventEmitter.enabled", false)
+  private loadEventEmitter: boolean;
+
+  $onInit() {
+    if (this.loadEventEmitter) {
+      const providers = this.injector.getProviders();
+      providers.forEach((provider) => this.bindEventListeners(provider));
+    }
+  }
+
+  $onReady() {
+    if (this.loadEventEmitter) {
+      if (!this.disableSummary) {
+        this.printEvents();
+      }
+      this.logger.info("EventEmitter listening...");
+    } else {
+      this.logger.info("EventEmitter disabled...");
+    }
+  }
+
+  public printEvents() {
+    const list = this.eventEmitter.eventNames().map((eventName) => {
+      const listenerCount = this.eventEmitter.listenerCount(eventName).toString();
+
+      return {
+        eventName,
+        listenerCount
+      };
+    });
+
+    this.logger.info("EventEmitter events mounted:");
+
+    const str = this.logger.drawTable(list, {
+      padding: 1,
+      header: {
+        eventName: "Event name",
+        listenerCount: "Number of listener"
+      }
+    });
+
+    this.logger.info("\n" + str.trim());
+  }
+
+  private bindEventListeners(provider: Provider<any>) {
+    this.bindOn(provider);
+    this.bindOnAny(provider);
+  }
+
+  private getListener(provider: Provider<any>, propertyKey: string) {
+    const instance = this.injector.get(provider.token);
+    return instance[propertyKey].bind(instance) as ListenerFn;
+  }
+
+  private bindOn(provider: Provider) {
+    const store = provider.store.get<EventEmitterStore | undefined>("eventEmitter");
+
+    Object.entries(store?.onEvent || {}).forEach(([propertyKey, {event, options}]) => {
+      const listenerFn = this.getListener(provider, propertyKey);
+
+      this.eventEmitter.on(event, listenerFn, options);
+    });
+  }
+
+  private bindOnAny(provider: Provider) {
+    const store = provider.store.get<EventEmitterStore | undefined>("eventEmitter");
+
+    Object.keys(store?.onAny || {}).forEach((propertyKey) => {
+      const listenerFn = this.getListener(provider, propertyKey);
+
+      this.eventEmitter.onAny(listenerFn);
+    });
+  }
+}

package/src/decorators/onAny.spec.ts

@@ -0,0 +1,22 @@
+import {Store} from "@tsed/core";
+
+import {OnAny} from "./onAny.js";
+
+describe("@OnAny()", () => {
+  it("should set metadata", () => {
+    class Test {
+      @OnAny()
+      testAnyEventListener() {
+        // test
+      }
+    }
+
+    const store = Store.from(Test);
+
+    expect(store.get("eventEmitter")).toEqual({
+      onAny: {
+        testAnyEventListener: {}
+      }
+    });
+  });
+});

package/src/decorators/onAny.ts

@@ -0,0 +1,15 @@
+import {Store} from "@tsed/core";
+
+import {EventEmitterStore} from "../interfaces/EventEmitterStore.js";
+
+export function OnAny(): MethodDecorator {
+  return (target: any, propertyKey: string) => {
+    const store: EventEmitterStore = {
+      onAny: {
+        [propertyKey]: {}
+      }
+    };
+
+    Store.from(target).merge("eventEmitter", store);
+  };
+}

package/src/decorators/onEvent.spec.ts

@@ -0,0 +1,36 @@
+import {Store} from "@tsed/core";
+
+import {OnEvent} from "../decorators/onEvent.js";
+
+describe("@OnEvent()", () => {
+  it("should set metadata", () => {
+    class Test {
+      @OnEvent("testEvent")
+      testEventListener1() {
+        // test
+      }
+
+      @OnEvent("testEvent2", {async: true})
+      async testEventListener2() {
+        // test
+      }
+    }
+
+    const store = Store.from(Test);
+
+    expect(store.get("eventEmitter")).toEqual({
+      onEvent: {
+        testEventListener1: {
+          event: "testEvent",
+          options: undefined
+        },
+        testEventListener2: {
+          event: "testEvent2",
+          options: {
+            async: true
+          }
+        }
+      }
+    });
+  });
+});

package/src/decorators/onEvent.ts

@@ -0,0 +1,16 @@
+import {Store} from "@tsed/core";
+import {event, eventNS, OnOptions} from "eventemitter2";
+
+import {EventEmitterStore} from "../interfaces/EventEmitterStore.js";
+
+export function OnEvent(event: event | eventNS, options?: boolean | OnOptions): MethodDecorator {
+  return (target: any, propertyKey: string) => {
+    const store: EventEmitterStore = {
+      onEvent: {
+        [propertyKey]: {event, options}
+      }
+    };
+
+    Store.from(target).merge("eventEmitter", store);
+  };
+}

package/src/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./decorators/onAny.js";
+export * from "./decorators/onEvent.js";
+export * from "./EventEmitterModule.js";
+export * from "./interfaces/EventEmitterStore.js";
+export * from "./interfaces/interfaces.js";
+export * from "./services/EventEmitterFactory.js";

package/src/interfaces/EventEmitterStore.ts

@@ -0,0 +1,6 @@
+import type {event, eventNS, OnOptions} from "eventemitter2";
+
+export interface EventEmitterStore {
+  onEvent?: {[propertyKey: string]: {event: event | eventNS; options?: boolean | OnOptions}};
+  onAny?: {[propertyKey: string]: {}};
+}

package/src/interfaces/interfaces.ts

@@ -0,0 +1,18 @@
+import {ConstructorOptions} from "eventemitter2";
+
+declare global {
+  namespace TsED {
+    interface Configuration {
+      eventEmitter?: {
+        /**
+         * Enable Event Emitter. Default `false`.
+         */
+        enabled?: boolean;
+        /**
+         * Disable event table displayed in the logger. Default `false`.
+         */
+        disableSummary?: boolean;
+      } & ConstructorOptions;
+    }
+  }
+}

package/src/services/EventEmitterFactory.ts

@@ -0,0 +1,15 @@
+import {Configuration, registerProvider} from "@tsed/di";
+import type {ConstructorOptions} from "eventemitter2";
+import eventEmitter2 from "eventemitter2";
+
+export const EventEmitterService = eventEmitter2.EventEmitter2;
+export type EventEmitterService = eventEmitter2.EventEmitter2;
+
+registerProvider({
+  token: eventEmitter2.EventEmitter2,
+  deps: [Configuration],
+  useFactory(settings: Configuration) {
+    const opts = settings.get<ConstructorOptions & {enabled: boolean}>("eventEmitter", {enabled: false});
+    return opts.enabled ? new eventEmitter2.EventEmitter2(opts) : {};
+  }
+});