@eggjs/eventbus-decorator 3.28.2 → 3.30.0

package/README.md

@@ -56,3 +56,29 @@ export class Foo {
   }
 }
 ```
+
+### handle multiple event
+```ts
+@Event('hello')
+@Event('hi')
+export class Foo {
+  async handle(msg: string): Promise<void> {
+    console.log('msg: ', msg);
+  }
+}
+```
+
+### inject event context 
+inject event context  if you want to know which event is being handled.
+The context param must be the first param
+
+```ts
+@Event('hello')
+@Event('hi')
+export class Foo {
+  async handle(@EventContext() ctx: IEventContext, msg: string):Promise<void> {
+    console.log('eventName: ', ctx.eventName);
+    console.log('msg: ', msg);
+  }
+}
+```

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './src/EventBus';
 export * from './src/Event';
 export * from './src/EventInfoUtil';
+export * from './src/EventContext';
 export interface Events {
 }

package/dist/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./src/EventBus"), exports);
 __exportStar(require("./src/Event"), exports);
 __exportStar(require("./src/EventInfoUtil"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsaURBQStCO0FBQy9CLDhDQUE0QjtBQUM1QixzREFBb0MifQ==
+__exportStar(require("./src/EventContext"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsaURBQStCO0FBQy9CLDhDQUE0QjtBQUM1QixzREFBb0M7QUFDcEMscURBQW1DIn0=

package/dist/src/Event.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="src/type" />
 import { EventHandler } from '../index';
-import { Events } from '@eggjs/tegg';
+import type { Events } from '@eggjs/tegg';
 export declare function Event<E extends keyof Events>(eventName: E): (clazz: new () => EventHandler<E>) => void;

package/dist/src/Event.js

@@ -6,7 +6,7 @@ const tegg_common_util_1 = require("@eggjs/tegg-common-util");
 const EventInfoUtil_1 = require("./EventInfoUtil");
 function Event(eventName) {
     return function (clazz) {
-        EventInfoUtil_1.EventInfoUtil.setEventName(eventName, clazz);
+        EventInfoUtil_1.EventInfoUtil.addEventName(eventName, clazz);
         const func = (0, core_decorator_1.SingletonProto)({
             accessLevel: core_decorator_1.AccessLevel.PUBLIC,
         });

package/dist/src/EventBus.d.ts

@@ -1,7 +1,10 @@
 /// <reference types="src/type" />
-import TypedEventEmitter, { Arguments } from 'typed-emitter';
-import { Events } from '@eggjs/tegg';
+import TypedEventEmitter from 'typed-emitter';
+import type { Arguments } from 'typed-emitter';
+import type { Events } from '@eggjs/tegg';
+import { IEventContext } from './EventContext';
 export type EventName = string | symbol;
+export type { Arguments } from 'typed-emitter';
 /**
  * use `emit` to emit a event
  */
@@ -37,6 +40,9 @@ export interface EventWaiter {
         args: Arguments<Events[E1] | Events[E2] | Events[E3] | Events[E4]>;
     }>;
 }
-export interface EventHandler<E extends keyof Events> {
+type EventHandlerWithContext<E extends keyof Events> = {
+    handle: (ctx: IEventContext, ...args: Arguments<Events[E]>) => ReturnType<Events[E]>;
+};
+export type EventHandler<E extends keyof Events> = {
     handle: Events[E];
-}
+} | EventHandlerWithContext<E>;

package/dist/src/EventBus.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CORK_ID = void 0;
 exports.CORK_ID = Symbol.for('eventBus#corkId');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRCdXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvRXZlbnRCdXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBbUJhLFFBQUEsT0FBTyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsaUJBQWlCLENBQUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRCdXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvRXZlbnRCdXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBc0JhLFFBQUEsT0FBTyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsaUJBQWlCLENBQUMsQ0FBQyJ9

package/dist/src/EventContext.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="src/type" />
+import type { Events } from '@eggjs/tegg';
+export interface IEventContext {
+    eventName: keyof Events;
+}
+export declare function EventContext(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;

package/dist/src/EventContext.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventContext = void 0;
+const assert_1 = __importDefault(require("assert"));
+const EventInfoUtil_1 = require("./EventInfoUtil");
+function EventContext() {
+    return function (target, propertyKey, parameterIndex) {
+        (0, assert_1.default)(propertyKey === 'handle', `[eventHandler ${target.name}] expect method name be handle, but now is ${String(propertyKey)}`);
+        (0, assert_1.default)(parameterIndex === 0, `[eventHandler ${target.name}] expect param EventContext be the first param`);
+        const clazz = target.constructor;
+        EventInfoUtil_1.EventInfoUtil.setEventHandlerContextInject(true, clazz);
+    };
+}
+exports.EventContext = EventContext;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRDb250ZXh0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL0V2ZW50Q29udGV4dC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFJQSxvREFBNEI7QUFDNUIsbURBQWdEO0FBTWhELFNBQWdCLFlBQVk7SUFDMUIsT0FBTyxVQUFTLE1BQVcsRUFBRSxXQUF3QixFQUFFLGNBQXNCO1FBQzNFLElBQUEsZ0JBQU0sRUFBQyxXQUFXLEtBQUssUUFBUSxFQUM3QixpQkFBaUIsTUFBTSxDQUFDLElBQUksOENBQThDLE1BQU0sQ0FBQyxXQUFXLENBQUMsRUFBRSxDQUFDLENBQUM7UUFDbkcsSUFBQSxnQkFBTSxFQUFDLGNBQWMsS0FBSyxDQUFDLEVBQ3pCLGlCQUFpQixNQUFNLENBQUMsSUFBSSxnREFBZ0QsQ0FBQyxDQUFDO1FBQ2hGLE1BQU0sS0FBSyxHQUFHLE1BQU0sQ0FBQyxXQUFnQyxDQUFDO1FBQ3RELDZCQUFhLENBQUMsNEJBQTRCLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQzFELENBQUMsQ0FBQztBQUNKLENBQUM7QUFURCxvQ0FTQyJ9

package/dist/src/EventInfoUtil.d.ts

@@ -1,7 +1,19 @@
 import { EggProtoImplClass } from '@eggjs/core-decorator';
 import { EventName } from './EventBus';
 export declare const EVENT_NAME: unique symbol;
+export declare const EVENT_CONTEXT_INJECT: unique symbol;
 export declare class EventInfoUtil {
+    /**
+     * @deprecated
+     */
     static setEventName(eventName: EventName, clazz: EggProtoImplClass): void;
+    static addEventName(eventName: EventName, clazz: EggProtoImplClass): void;
+    static getEventNameList(clazz: EggProtoImplClass): EventName[];
+    /**
+     * @deprecated
+     * return the last eventName which is subscribed firstly by Event decorator
+     */
     static getEventName(clazz: EggProtoImplClass): EventName | undefined;
+    static setEventHandlerContextInject(enable: boolean, clazz: EggProtoImplClass): void;
+    static getEventHandlerContextInject(clazz: EggProtoImplClass): boolean;
 }

package/dist/src/EventInfoUtil.js

@@ -1,15 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventInfoUtil = exports.EVENT_NAME = void 0;
+exports.EventInfoUtil = exports.EVENT_CONTEXT_INJECT = exports.EVENT_NAME = void 0;
 const core_decorator_1 = require("@eggjs/core-decorator");
 exports.EVENT_NAME = Symbol.for('EggPrototype#eventName');
+exports.EVENT_CONTEXT_INJECT = Symbol.for('EggPrototype#event#handler#context#inject');
 class EventInfoUtil {
+    /**
+     * @deprecated
+     */
     static setEventName(eventName, clazz) {
-        core_decorator_1.MetadataUtil.defineMetaData(exports.EVENT_NAME, eventName, clazz);
+        EventInfoUtil.addEventName(eventName, clazz);
     }
+    static addEventName(eventName, clazz) {
+        const eventNameList = core_decorator_1.MetadataUtil.initOwnArrayMetaData(exports.EVENT_NAME, clazz, []);
+        eventNameList.push(eventName);
+    }
+    static getEventNameList(clazz) {
+        return core_decorator_1.MetadataUtil.getArrayMetaData(exports.EVENT_NAME, clazz);
+    }
+    /**
+     * @deprecated
+     * return the last eventName which is subscribed firstly by Event decorator
+     */
     static getEventName(clazz) {
-        return core_decorator_1.MetadataUtil.getMetaData(exports.EVENT_NAME, clazz);
+        const eventNameList = core_decorator_1.MetadataUtil.initOwnArrayMetaData(exports.EVENT_NAME, clazz, []);
+        if (eventNameList.length !== 0) {
+            return eventNameList[eventNameList.length - 1];
+        }
+        return undefined;
+    }
+    static setEventHandlerContextInject(enable, clazz) {
+        core_decorator_1.MetadataUtil.defineMetaData(exports.EVENT_CONTEXT_INJECT, enable, clazz);
+    }
+    static getEventHandlerContextInject(clazz) {
+        var _a;
+        return (_a = core_decorator_1.MetadataUtil.getMetaData(exports.EVENT_CONTEXT_INJECT, clazz)) !== null && _a !== void 0 ? _a : false;
     }
 }
 exports.EventInfoUtil = EventInfoUtil;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRJbmZvVXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9FdmVudEluZm9VdGlsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDBEQUF3RTtBQUczRCxRQUFBLFVBQVUsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUM7QUFFL0QsTUFBYSxhQUFhO0lBQ3hCLE1BQU0sQ0FBQyxZQUFZLENBQUMsU0FBb0IsRUFBRSxLQUF3QjtRQUNoRSw2QkFBWSxDQUFDLGNBQWMsQ0FBQyxrQkFBVSxFQUFFLFNBQVMsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBRUQsTUFBTSxDQUFDLFlBQVksQ0FBQyxLQUF3QjtRQUMxQyxPQUFPLDZCQUFZLENBQUMsV0FBVyxDQUFDLGtCQUFVLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDckQsQ0FBQztDQUNGO0FBUkQsc0NBUUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRJbmZvVXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9FdmVudEluZm9VdGlsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDBEQUF3RTtBQUczRCxRQUFBLFVBQVUsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUM7QUFDbEQsUUFBQSxvQkFBb0IsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLDJDQUEyQyxDQUFDLENBQUM7QUFFNUYsTUFBYSxhQUFhO0lBQ3hCOztPQUVHO0lBQ0gsTUFBTSxDQUFDLFlBQVksQ0FBQyxTQUFvQixFQUFFLEtBQXdCO1FBQ2hFLGFBQWEsQ0FBQyxZQUFZLENBQUMsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQy9DLENBQUM7SUFFRCxNQUFNLENBQUMsWUFBWSxDQUFDLFNBQW9CLEVBQUUsS0FBd0I7UUFDaEUsTUFBTSxhQUFhLEdBQUcsNkJBQVksQ0FBQyxvQkFBb0IsQ0FBWSxrQkFBVSxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUMxRixhQUFhLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ2hDLENBQUM7SUFFRCxNQUFNLENBQUMsZ0JBQWdCLENBQUMsS0FBd0I7UUFDOUMsT0FBTyw2QkFBWSxDQUFDLGdCQUFnQixDQUFDLGtCQUFVLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDMUQsQ0FBQztJQUVEOzs7T0FHRztJQUNILE1BQU0sQ0FBQyxZQUFZLENBQUMsS0FBd0I7UUFDMUMsTUFBTSxhQUFhLEdBQUcsNkJBQVksQ0FBQyxvQkFBb0IsQ0FBWSxrQkFBVSxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUMxRixJQUFJLGFBQWEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDL0IsT0FBTyxhQUFhLENBQUMsYUFBYSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNqRCxDQUFDO1FBQ0QsT0FBTyxTQUFTLENBQUM7SUFDbkIsQ0FBQztJQUVELE1BQU0sQ0FBQyw0QkFBNEIsQ0FBQyxNQUFlLEVBQUUsS0FBd0I7UUFDM0UsNkJBQVksQ0FBQyxjQUFjLENBQUMsNEJBQW9CLEVBQUUsTUFBTSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ25FLENBQUM7SUFFRCxNQUFNLENBQUMsNEJBQTRCLENBQUMsS0FBd0I7O1FBQzFELE9BQU8sTUFBQSw2QkFBWSxDQUFDLFdBQVcsQ0FBQyw0QkFBb0IsRUFBRSxLQUFLLENBQUMsbUNBQUksS0FBSyxDQUFDO0lBQ3hFLENBQUM7Q0FDRjtBQXBDRCxzQ0FvQ0MifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/eventbus-decorator",
-  "version": "3.28.2",
+  "version": "3.30.0",
   "description": "tegg eventbus decorator",
   "keywords": [
     "egg",
@@ -34,8 +34,8 @@
     "directory": "core/eventbus-decorator"
   },
   "dependencies": {
-    "@eggjs/core-decorator": "^3.28.2",
-    "@eggjs/tegg-common-util": "^3.28.2",
+    "@eggjs/core-decorator": "^3.30.0",
+    "@eggjs/tegg-common-util": "^3.30.0",
     "typed-emitter": "^1.3.1"
   },
   "engines": {
@@ -53,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "04fabefd4ad4d4ff799b9d8d1603d684f84de868"
+  "gitHead": "7ac47ca5919b706c6e65a004bef9ad48a33ee106"
 }