@adonisjs/events 7.0.2 → 7.1.3

package/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License
 
-Copyright 2021 Harminder Virk, contributors
+Copyright 2022 Harminder Virk, contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/build/adonis-typings/events.d.ts

@@ -17,6 +17,10 @@ declare module '@ioc:Adonis/Core/Event' {
      * Shape of event trap handler
      */
     export type TrapHandler<T extends any = any> = EventHandler<T>;
+    /**
+     * The error handler for handling events when an emit call fails
+     */
+    export type ErrorHandler = (event: string, error: any, data: any) => void;
     /**
      * Shape of trap all events handler
      */
@@ -41,6 +45,10 @@ declare module '@ioc:Adonis/Core/Event' {
      */
     export interface EmitterContract {
         transport: EmitterTransportContract;
+        /**
+         * Define a custom error handler
+         */
+        onError(handler: ErrorHandler): this;
         /**
          * Define a custom IoC Container base namespace for resolving
          * the listener bindings.
@@ -84,6 +92,10 @@ declare module '@ioc:Adonis/Core/Event' {
          */
         clearListeners<K extends keyof EventsList>(event: K): void;
         clearListeners<K extends string>(event: K): void;
+        /**
+         * Clear all listeners for all events
+         */
+        clearAllListeners(): void;
         /**
          * Returns count of listeners listening for a given event
          */

package/build/src/Emitter/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference path="../../adonis-typings/events.d.ts" />
 import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { AnyHandler, EventsList, TrapHandler, EventHandler, DataForEvent, TrapAllHandler, EmitterContract, EmitterTransportContract } from '@ioc:Adonis/Core/Event';
+import { AnyHandler, EventsList, TrapHandler, EventHandler, DataForEvent, ErrorHandler, TrapAllHandler, EmitterContract, EmitterTransportContract } from '@ioc:Adonis/Core/Event';
 /**
  * Emitter class exposes the API for async event emitter built on top of
  * Emittery. It also exposes an API to pre-define the Typescript types
@@ -12,12 +12,17 @@ export declare class Emitter implements EmitterContract {
     private trappingEvents;
     private traps;
     private trapAllHandler?;
+    private errorHandler?;
     constructor(app?: ApplicationContract);
     /**
      * Returns reference to the IoC resolver. Do not call this method until
      * handler is not a string
      */
     private getResolver;
+    /**
+     * Define a custom error handler
+     */
+    onError(handler: ErrorHandler): this;
     /**
      * Define event handler for a given event
      */

package/build/src/Emitter/index.js

@@ -39,6 +39,13 @@ class Emitter {
         }
         return this.iocResolver;
     }
+    /**
+     * Define a custom error handler
+     */
+    onError(handler) {
+        this.errorHandler = handler;
+        return this;
+    }
     /**
      * Define event handler for a given event
      */
@@ -79,21 +86,29 @@ class Emitter {
      * Emit event
      */
     async emit(event, data) {
-        if (this.trappingEvents) {
-            /**
-             * Give preference to the handler for a specific event
-             */
-            if (this.traps.has(event)) {
-                return this.traps.get(event)(data);
+        try {
+            if (this.trappingEvents) {
+                /**
+                 * Give preference to the handler for a specific event
+                 */
+                if (this.traps.has(event)) {
+                    return await this.traps.get(event)(data);
+                }
+                /**
+                 * Invoke catch all (if defined)
+                 */
+                if (this.trapAllHandler) {
+                    return await this.trapAllHandler(event, data);
+                }
             }
-            /**
-             * Invoke catch all (if defined)
-             */
-            if (this.trapAllHandler) {
-                return this.trapAllHandler(event, data);
+            return await this.transport.emit(event, data);
+        }
+        catch (error) {
+            if (this.errorHandler) {
+                return this.errorHandler(event, error, data);
             }
+            throw error;
         }
-        return this.transport.emit(event, data);
     }
     /**
      * Remove existing event listener

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/events",
-  "version": "7.0.2",
+  "version": "7.1.3",
   "description": "Event emitter with asynchronous events",
   "main": "build/providers/EventProvider.js",
   "files": [
@@ -13,12 +13,12 @@
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "node japaFile.js",
+    "test": "node .bin/test.js",
     "clean": "del build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
     "commit": "git-cz",
-    "release": "np",
+    "release": "np --message=\"chore(release): %s\"",
     "version": "npm run build",
     "format": "prettier --write .",
     "prepublishOnly": "npm run build",
@@ -32,23 +32,25 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/application": "^5.1.3",
-    "@adonisjs/mrm-preset": "^4.1.0",
-    "@adonisjs/require-ts": "^2.0.4",
-    "@poppinss/dev-utils": "^1.1.4",
-    "@types/node": "^15.6.1",
-    "del-cli": "^3.0.1",
-    "eslint": "^7.27.0",
+    "@adonisjs/application": "^5.1.5",
+    "@adonisjs/mrm-preset": "^5.0.2",
+    "@adonisjs/require-ts": "^2.0.7",
+    "@poppinss/dev-utils": "^2.0.1",
+    "@types/node": "^17.0.8",
+    "commitizen": "^4.2.4",
+    "cz-conventional-changelog": "^3.3.0",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-adonis": "^1.3.1",
-    "eslint-plugin-prettier": "^3.4.0",
-    "github-label-sync": "^2.0.0",
-    "husky": "^6.0.0",
-    "japa": "^3.1.1",
+    "eslint-plugin-adonis": "^2.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "github-label-sync": "^2.0.1",
+    "husky": "^7.0.1",
+    "japa": "^4.0.0",
     "mrm": "^3.0.2",
     "np": "^7.5.0",
-    "prettier": "^2.3.0",
-    "typescript": "^4.3.2"
+    "prettier": "^2.3.2",
+    "typescript": "^4.3.5"
   },
   "nyc": {
     "exclude": [
@@ -68,7 +70,7 @@
     "anyBranch": false
   },
   "dependencies": {
-    "emittery": "^0.9.0"
+    "emittery": "^0.10.0"
   },
   "peerDependencies": {
     "@adonisjs/application": "^5.0.0"
@@ -88,5 +90,48 @@
   "publishConfig": {
     "access": "public",
     "tag": "latest"
+  },
+  "mrmConfig": {
+    "core": true,
+    "license": "MIT",
+    "services": [
+      "github-actions"
+    ],
+    "minNodeVersion": "14.15.4",
+    "probotApps": [
+      "stale",
+      "lock"
+    ],
+    "runGhActionsOnWindows": false
+  },
+  "eslintConfig": {
+    "extends": [
+      "plugin:adonis/typescriptPackage",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "endOfLine": "auto"
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "build"
+  ],
+  "prettier": {
+    "trailingComma": "es5",
+    "semi": false,
+    "singleQuote": true,
+    "useTabs": false,
+    "quoteProps": "consistent",
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "printWidth": 100
   }
 }