@adonisjs/events 8.2.0-0 → 8.4.0-0

package/build/index.d.ts

@@ -1 +1,2 @@
-export { Emitter as default } from './src/emitter.js';
+export { Emitter } from './src/emitter.js';
+export { BaseEvent } from './src/base_event.js';

package/build/index.js

@@ -1 +1,2 @@
-export { Emitter as default } from './src/emitter.js';
+export { Emitter } from './src/emitter.js';
+export { BaseEvent } from './src/base_event.js';

package/build/src/base_event.d.ts

@@ -0,0 +1,7 @@
+import { Emitter } from './emitter.js';
+export declare class BaseEvent {
+    constructor(..._: any[]);
+    static emitter: Emitter<any>;
+    static useEmitter(emitter: Emitter<any>): void;
+    static dispatch<T extends typeof BaseEvent>(this: T, ...args: ConstructorParameters<T>): Promise<void>;
+}

package/build/src/base_event.js

@@ -0,0 +1,10 @@
+export class BaseEvent {
+    constructor(..._) { }
+    static emitter;
+    static useEmitter(emitter) {
+        this.emitter = emitter;
+    }
+    static dispatch(...args) {
+        return this.emitter.emit(this, new this(...args));
+    }
+}

package/build/src/emitter.d.ts

@@ -1,12 +1,13 @@
 import type { Application } from '@adonisjs/application';
 import { type UnsubscribeFunction } from 'emittery';
 import { EventsBuffer } from './events_buffer.js';
-import type { Listener, Constructor, ListenerMethod, AllowedEventTypes } from './types.js';
+import type { Listener, LazyImport, Constructor, ListenerMethod, AllowedEventTypes, ListenerClassWithHandleMethod } from './types.js';
 export declare class Emitter<EventsList extends Record<string | symbol | number, any>> {
     #private;
     get eventsListeners(): Map<AllowedEventTypes, Map<Listener<any, Constructor<any>>, ListenerMethod<any>>>;
     constructor(app: Application<any, any>);
     onError(callback: (event: keyof EventsList | Constructor<any>, error: any, data: any) => void): this;
+    listen<Event extends Constructor<any>>(event: Event, listeners: (ListenerClassWithHandleMethod<InstanceType<Event>> | LazyImport<ListenerClassWithHandleMethod<InstanceType<Event>>>)[]): void;
     on<Event extends Constructor<any>, ListenerClass extends Constructor<any>>(event: Event, listener: Listener<InstanceType<Event>, ListenerClass>): UnsubscribeFunction;
     on<Name extends keyof EventsList, ListenerClass extends Constructor<any>>(event: Name, listener: Listener<EventsList[Name], ListenerClass>): UnsubscribeFunction;
     once<Event extends Constructor<any>, ListenerClass extends Constructor<any>>(event: Event, listener: Listener<InstanceType<Event>, ListenerClass>): void;

package/build/src/emitter.js

@@ -60,6 +60,9 @@ export class Emitter {
         this.#errorHandler = callback;
         return this;
     }
+    listen(event, listeners) {
+        listeners.forEach((listener) => this.on(event, [listener, 'handle']));
+    }
     on(event, listener) {
         if (debug.enabled) {
             debug('registering event listener, event: %O, listener: %O', event, listener);

package/build/src/types.d.ts

@@ -15,4 +15,7 @@ export type ListenerFn<Data> = (data: Data) => any | Promise<any>;
 export type GetListenersMethods<Listener extends Constructor<any>, Data> = {
     [K in keyof InstanceType<Listener>]: InstanceType<Listener>[K] extends ListenerMethod<Data> ? K : never;
 }[keyof InstanceType<Listener>];
+export type ListenerClassWithHandleMethod<Data> = Constructor<{
+    handle: ListenerMethod<Data>;
+}>;
 export type Listener<Data, ListenerClass extends Constructor<any>> = ListenerFn<Data> | string | [LazyImport<ListenerClass> | ListenerClass, GetListenersMethods<ListenerClass, Data>?];

package/build/test_factories/emitter.d.ts

@@ -0,0 +1,11 @@
+import { Application } from '@adonisjs/application';
+import { Emitter } from '../src/emitter.js';
+type FactoryParameters = {
+    app: Application<any, any>;
+};
+export declare class EmitterFactory {
+    #private;
+    merge(params: Partial<FactoryParameters>): this;
+    create(): Emitter<Record<string | number | symbol, any>>;
+}
+export {};

package/build/test_factories/emitter.js

@@ -0,0 +1,15 @@
+import { AppFactory } from '@adonisjs/application/test_factories/app';
+import { Emitter } from '../src/emitter.js';
+export class EmitterFactory {
+    #parameters = {};
+    #getApp() {
+        return this.#parameters.app || new AppFactory().create(new URL('./app/', import.meta.url));
+    }
+    merge(params) {
+        Object.assign(this.#parameters, params);
+        return this;
+    }
+    create() {
+        return new Emitter(this.#getApp());
+    }
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@adonisjs/events",
-  "version": "8.2.0-0",
+  "version": "8.4.0-0",
   "description": "An implementation of the event emitter built on top of emittery",
   "main": "build/index.js",
   "type": "module",
   "files": [
     "build/src",
+    "build/test_factories",
     "build/index.d.ts",
     "build/index.js"
   ],
@@ -14,6 +15,7 @@
   },
   "exports": {
     ".": "./build/index.js",
+    "./test_factories/*": "./build/test_factories/*.js",
     "./types": "./build/src/types.js"
   },
   "scripts": {
@@ -37,12 +39,12 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/application": "^6.5.1-0",
+    "@adonisjs/application": "^6.6.0-0",
     "@adonisjs/config": "^4.1.3-0",
     "@adonisjs/env": "^4.1.2-0",
     "@adonisjs/fold": "^9.9.0-0",
-    "@adonisjs/logger": "^5.1.1-0",
-    "@commitlint/cli": "^17.4.0",
+    "@adonisjs/logger": "^5.2.0-0",
+    "@commitlint/cli": "^17.4.1",
     "@commitlint/config-conventional": "^17.4.0",
     "@japa/assert": "^1.3.6",
     "@japa/expect-type": "^1.0.2",
@@ -50,8 +52,8 @@
     "@japa/runner": "^2.2.2",
     "@japa/spec-reporter": "^1.3.2",
     "@poppinss/dev-utils": "^2.0.1",
-    "@swc/core": "^1.3.24",
-    "@types/fs-extra": "^9.0.13",
+    "@swc/core": "^1.3.26",
+    "@types/fs-extra": "^11.0.1",
     "@types/node": "^18.11.18",
     "c8": "^7.12.0",
     "cross-env": "^7.0.3",
@@ -64,7 +66,7 @@
     "github-label-sync": "^2.0.1",
     "husky": "^8.0.3",
     "np": "^7.6.3",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.2",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
   },
@@ -72,7 +74,7 @@
     "emittery": "^1.0.1"
   },
   "peerDependencies": {
-    "@adonisjs/application": "^6.5.1-0",
+    "@adonisjs/application": "^6.6.0-0",
     "@adonisjs/fold": "^9.9.0-0"
   },
   "repository": {