hookable 5.0.0 → 5.1.0

package/README.md

@@ -5,11 +5,8 @@
 [![packagephobia][packagephobia-src]][packagephobia-href]
 [![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
 [![Codecov][codecov-src]][codecov-href]
-[![Dependencies][david-dm-src]][david-dm-href]
 
-> Awaitable hooks for Node.js and Browser
-
-**Please see [Migration Guide](#migration) for migrating from < 4.0.0 to >= 5.0.0**
+> Awaitable hook system
 
 ## Install
 
@@ -155,6 +152,14 @@ Returns an `unregister` function that, when called, will remove all the register
 
 Used by class itself to **sequentially** call handlers of a specific hook.
 
+### `callHookWith (name, callerFn)`
+
+If you need custom control over how hooks are called, you can provide a custom function that will receive an array of handlers of a specific hook.
+
+`callerFn` if a callback function that accepts two arguments, `hooks` and `args`:
+- `hooks`: Array of user hooks to be called
+- `args`: Array of arguments that should be passed each time calling a hook
+
 ### `deprecateHook (old, name)`
 
 Deprecate hook called `old` in favor of `name` hook.
@@ -202,15 +207,13 @@ hookable.removeHooks({
 
 ## Credits
 
-Extracted from [Nuxt.js](https://github.com/nuxt/nuxt.js) hooks system
-
-Original author [Sébastien Chopin](https://github.com/Atinux)
+Extracted from [Nuxt](https://github.com/nuxt/nuxt.js) hooks system originally introduced by [Sébastien Chopin](https://github.com/Atinux)
 
-Thanks to [Joe Paice](https://github.com/RGBboy) for donating [hookable](https://www.npmjs.com/package/hookable) package name
+Thanks to [Joe Paice](https://github.com/RGBboy) for donating [hookable](https://www.npmjs.com/package/hookable) package name.
 
 ## License
 
-MIT - Made with 💖 by Nuxt.js team!
+MIT - Made with 💖
 
 <!-- Badges -->
 [npm-version-src]: https://flat.badgen.net/npm/dt/hookable
@@ -219,14 +222,11 @@ MIT - Made with 💖 by Nuxt.js team!
 [npm-downloads-src]: https://flat.badgen.net/npm/v/hookable
 [npm-downloads-href]: https://npmjs.com/package/hookable
 
-[github-actions-ci-src]: https://github.com/unjs/hookable/workflows/ci/badge.svg
-[github-actions-ci-href]: https://github.com/unjs/hookable/actions?query=workflow%3Aci
+[github-actions-ci-src]: https://flat.badgen.net/github/checks/unjs/hookable/main
+[github-actions-ci-href]: https://github.com/unjs/hookable/actions
 
 [codecov-src]: https://flat.badgen.net/codecov/c/github/unjs/hookable
 [codecov-href]: https://codecov.io/gh/unjs/hookable
 
-[david-dm-src]: https://flat.badgen.net/david/dep/unjs/hookable
-[david-dm-href]: https://david-dm.org/unjs/hookable
-
 [packagephobia-src]: https://flat.badgen.net/packagephobia/install/hookable
 [packagephobia-href]: https://packagephobia.now.sh/result?p=hookable

package/dist/index.cjs

@@ -39,6 +39,12 @@ function mergeHooks(...hooks) {
 function serial(tasks, fn) {
   return tasks.reduce((promise, task) => promise.then(() => fn(task)), Promise.resolve(null));
 }
+function serialCaller(hooks, args) {
+  return hooks.reduce((promise, hookFn) => promise.then(() => hookFn.apply(void 0, args)), Promise.resolve(null));
+}
+function parallelCaller(hooks, args) {
+  return Promise.all(hooks.map((hook) => hook.apply(void 0, args)));
+}
 
 class Hookable {
   constructor() {
@@ -46,6 +52,7 @@ class Hookable {
     this._deprecatedHooks = {};
     this.hook = this.hook.bind(this);
     this.callHook = this.callHook.bind(this);
+    this.callHookWith = this.callHookWith.bind(this);
   }
   hook(name, fn) {
     if (!name || typeof fn !== "function") {
@@ -121,10 +128,19 @@ class Hookable {
     }
   }
   callHook(name, ...args) {
-    if (!this._hooks[name]) {
-      return;
+    if (this._hooks[name]) {
+      return serialCaller(this._hooks[name], args);
+    }
+  }
+  callHookParallel(name, ...args) {
+    if (this._hooks[name]) {
+      return parallelCaller(this._hooks[name], args);
+    }
+  }
+  callHookWith(caller, name, ...args) {
+    if (this._hooks[name]) {
+      return caller(this._hooks[name], args);
     }
-    return serial(this._hooks[name], (fn) => fn(...args));
   }
 }
 function createHooks() {
@@ -135,4 +151,6 @@ exports.Hookable = Hookable;
 exports.createHooks = createHooks;
 exports.flatHooks = flatHooks;
 exports.mergeHooks = mergeHooks;
+exports.parallelCaller = parallelCaller;
 exports.serial = serial;
+exports.serialCaller = serialCaller;

package/{types → dist}/index.d.ts

@@ -48,11 +48,15 @@ declare class Hookable<HooksT = Record<string, HookCallback>, HookNameT extends
     addHooks(configHooks: NestedHooks<HooksT>): () => void;
     removeHooks(configHooks: NestedHooks<HooksT>): void;
     callHook<NameT extends HookNameT>(name: NameT, ...args: Parameters<InferCallback<HooksT, NameT>>): Promise<any>;
+    callHookParallel<NameT extends HookNameT>(name: NameT, ...args: Parameters<InferCallback<HooksT, NameT>>): Promise<any[]>;
+    callHookWith<NameT extends HookNameT, CallFunction extends (hooks: HookCallback[], args: Parameters<InferCallback<HooksT, NameT>>) => any>(caller: CallFunction, name: NameT, ...args: Parameters<InferCallback<HooksT, NameT>>): void | ReturnType<CallFunction>;
 }
 declare function createHooks<T>(): Hookable<T>;
 
 declare function flatHooks<T>(configHooks: NestedHooks<T>, hooks?: T, parentName?: string): T;
 declare function mergeHooks<T>(...hooks: NestedHooks<T>[]): T;
 declare function serial<T>(tasks: T[], fn: (task: T) => Promise<any> | any): Promise<any>;
+declare function serialCaller(hooks: HookCallback[], args?: any[]): Promise<any>;
+declare function parallelCaller(hooks: HookCallback[], args?: any[]): Promise<any[]>;
 
-export { DeprecatedHook, DeprecatedHooks, HookCallback, HookKeys, Hookable, Hooks, NestedHooks, createHooks, flatHooks, mergeHooks, serial };
+export { DeprecatedHook, DeprecatedHooks, HookCallback, HookKeys, Hookable, Hooks, NestedHooks, createHooks, flatHooks, mergeHooks, parallelCaller, serial, serialCaller };

package/dist/index.mjs

@@ -35,6 +35,12 @@ function mergeHooks(...hooks) {
 function serial(tasks, fn) {
   return tasks.reduce((promise, task) => promise.then(() => fn(task)), Promise.resolve(null));
 }
+function serialCaller(hooks, args) {
+  return hooks.reduce((promise, hookFn) => promise.then(() => hookFn.apply(void 0, args)), Promise.resolve(null));
+}
+function parallelCaller(hooks, args) {
+  return Promise.all(hooks.map((hook) => hook.apply(void 0, args)));
+}
 
 class Hookable {
   constructor() {
@@ -42,6 +48,7 @@ class Hookable {
     this._deprecatedHooks = {};
     this.hook = this.hook.bind(this);
     this.callHook = this.callHook.bind(this);
+    this.callHookWith = this.callHookWith.bind(this);
   }
   hook(name, fn) {
     if (!name || typeof fn !== "function") {
@@ -117,14 +124,23 @@ class Hookable {
     }
   }
   callHook(name, ...args) {
-    if (!this._hooks[name]) {
-      return;
+    if (this._hooks[name]) {
+      return serialCaller(this._hooks[name], args);
+    }
+  }
+  callHookParallel(name, ...args) {
+    if (this._hooks[name]) {
+      return parallelCaller(this._hooks[name], args);
+    }
+  }
+  callHookWith(caller, name, ...args) {
+    if (this._hooks[name]) {
+      return caller(this._hooks[name], args);
     }
-    return serial(this._hooks[name], (fn) => fn(...args));
   }
 }
 function createHooks() {
   return new Hookable();
 }
 
-export { Hookable, createHooks, flatHooks, mergeHooks, serial };
+export { Hookable, createHooks, flatHooks, mergeHooks, parallelCaller, serial, serialCaller };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hookable",
-  "version": "5.0.0",
-  "description": "Awaitable hooks for Node.js",
+  "version": "5.1.0",
+  "description": "Awaitable hook system",
   "keywords": [
     "hook",
     "hookable",
@@ -17,13 +17,12 @@
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./types/index.d.ts",
+  "types": "./dist/index.d.ts",
   "files": [
-    "dist",
-    "types"
+    "dist"
   ],
   "scripts": {
-    "build": "siroc build",
+    "build": "unbuild",
     "lint": "eslint --ext .ts src",
     "prepublish": "yarn build",
     "release": "yarn test && yarn build && standard-version && git push --follow-tags && npm publish",
@@ -37,10 +36,9 @@
     "eslint": "latest",
     "expect-type": "^0.12.0",
     "jest": "latest",
-    "rollup-plugin-typescript2": "latest",
-    "siroc": "latest",
     "standard-version": "latest",
     "ts-jest": "latest",
-    "typescript": "latest"
+    "typescript": "latest",
+    "unbuild": "latest"
   }
 }

package/CHANGELOG.md

@@ -1,268 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-## [5.0.0](https://github.com/unjs/hookable/compare/v5.0.0-2...v5.0.0) (2021-09-01)
-
-
-### Bug Fixes
-
-* type nested/namespaced hooks ([#32](https://github.com/unjs/hookable/issues/32)) ([a0d9146](https://github.com/unjs/hookable/commit/a0d9146c40fb9767842564225444c6c5a7dce70f))
-
-## [5.0.0-2](https://github.com/unjs/hookable/compare/v5.0.0-1...v5.0.0-2) (2021-08-27)
-
-
-### Bug Fixes
-
-* allow type inference for `hook`, `hookOnce` and `removeHook` ([#29](https://github.com/unjs/hookable/issues/29)) ([22b74d3](https://github.com/unjs/hookable/commit/22b74d30805f35000709ba32220e6e4e059f4cc5))
-
-## [5.0.0-1](https://github.com/unjs/hookable/compare/v5.0.0-0...v5.0.0-1) (2021-08-27)
-
-
-### Bug Fixes
-
-* allow nested hooks type to omit some hooks ([#28](https://github.com/unjs/hookable/issues/28)) ([75f2a05](https://github.com/unjs/hookable/commit/75f2a057a526d018b9cf39f01ddfd2a3d2a6bbc1))
-
-## [5.0.0-0](https://github.com/unjs/hookable/compare/v4.4.1...v5.0.0-0) (2021-08-26)
-
-
-### ⚠ BREAKING CHANGES
-
-* You should directly handle errors with callHook
-* use named exports and expose createHooks
-* remove mergehooks from Hookable prototype
-* drop browser build and use exports field
-* improve type checking
-
-### Features
-
-* drop browser build and use exports field ([b626770](https://github.com/unjs/hookable/commit/b626770192a62b23acc1be16b4e4eac2383e9136))
-* drop logger and global error handler ([ee6ea87](https://github.com/unjs/hookable/commit/ee6ea87ad0e15a52252389b9b3112060bd411330))
-* improve type checking ([c2e1e22](https://github.com/unjs/hookable/commit/c2e1e223d16e7bf87117cd8d72ad3ba211a333d8))
-* use named exports and expose createHooks ([fadfcbd](https://github.com/unjs/hookable/commit/fadfcbd07c3e2fa6905d0e31deabc37fc55d8317))
-
-
-* remove mergehooks from Hookable prototype ([d50af59](https://github.com/unjs/hookable/commit/d50af595d3cb05be8fb5060374f4e28b3d6259fa))
-
-### [4.4.1](https://github.com/unjs/hookable/compare/v4.4.0...v4.4.1) (2021-02-26)
-
-
-### Bug Fixes
-
-* avoid creating extra wrapper when merging hooks ([790c1c4](https://github.com/unjs/hookable/commit/790c1c4dbbd1f7b9cb1995b40baeecead5346ed0))
-
-## [4.4.0](https://github.com/unjs/hookable/compare/v4.3.1...v4.4.0) (2021-01-21)
-
-
-### Features
-
-* **pkg:** expose module format ([2987b09](https://github.com/unjs/hookable/commit/2987b0901e292eb4570f8141ca51cfd9d2d3f94f))
-
-### [4.3.1](https://github.com/unjs/hookable/compare/v4.3.0...v4.3.1) (2020-11-06)
-
-
-### Bug Fixes
-
-* expose types ([0ffbaff](https://github.com/unjs/hookable/commit/0ffbaffa91d38e333e0818cd73a084cf1e8657c8))
-
-## [4.3.0](https://github.com/unjs/hookable/compare/v4.2.0...v4.3.0) (2020-11-06)
-
-
-### Features
-
-* `mergeHooks` helper ([#26](https://github.com/unjs/hookable/issues/26)) ([8c52d03](https://github.com/unjs/hookable/commit/8c52d034aa1a40bafb13d0b847c72593c51fcba5))
-
-## [4.2.0](https://github.com/unjs/hookable/compare/v4.1.2...v4.2.0) (2020-10-23)
-
-
-### Features
-
-* hookOnce ([225fa8a](https://github.com/unjs/hookable/commit/225fa8af85e1a504916c357f57b047143b6bc5ab))
-
-
-### Bug Fixes
-
-* typecheck for flatHooks ([7800190](https://github.com/unjs/hookable/commit/7800190feb82134be5dd089ca184a18a6644da19))
-
-### [4.1.2](https://github.com/unjs/hookable/compare/v4.1.1...v4.1.2) (2020-08-24)
-
-
-### Bug Fixes
-
-* **build:** exclude regenerator and update target to ie 11 ([48acfc5](https://github.com/unjs/hookable/commit/48acfc5c0a4b0fb8edc6e9790b37ad336c966215))
-
-### [4.1.1](https://github.com/unjs/hookable/compare/v4.1.0...v4.1.1) (2020-04-28)
-
-
-### Bug Fixes
-
-* **pkg:** typo in types entry name (fixes [#19](https://github.com/unjs/hookable/issues/19)) ([b9ba90f](https://github.com/unjs/hookable/commit/b9ba90fbc725097e41c430d7df4205985c2faaec))
-
-## [4.1.0](https://github.com/unjs/hookable/compare/v4.0.0...v4.1.0) (2020-04-17)
-
-
-### Features
-
-* **types:** implement strict types ([823cdca](https://github.com/unjs/hookable/commit/823cdcac728d189b802f75faa9a361ac5ea4883d))
-
-## [4.0.0](https://github.com/unjs/hookable/compare/v3.0.0...v4.0.0) (2020-04-17)
-
-
-### ⚠ BREAKING CHANGES
-
-* only dist and types getting published
-
-### Features
-
-* allow disabling logger ([f8fb742](https://github.com/unjs/hookable/commit/f8fb74224f1277ec7f7d5a37bd312af7514fc962))
-* allow removing registered hooks ([#16](https://github.com/unjs/hookable/issues/16)) ([4134c31](https://github.com/unjs/hookable/commit/4134c31c44256cc82cac3a7a3610ece9252431dc))
-* migrate to typescript ([d63ea3e](https://github.com/unjs/hookable/commit/d63ea3e408ebea74ea3855af0c6e51880ebf9cac))
-
-## [3.0.0](https://github.com/unjs/hookable/compare/v2.3.0...v3.0.0) (2020-02-25)
-
-
-### Bug Fixes
-
-* revert back hooks ([07f52dc](https://github.com/unjs/hookable/commit/07f52dc))
-
-
-### Features
-
-* advanced deprecation ([5b88628](https://github.com/unjs/hookable/commit/5b88628))
-* bundle package ([53a2a0e](https://github.com/unjs/hookable/commit/53a2a0e))
-
-# [2.3.0](https://github.com/unjs/hookable/compare/v2.2.1...v2.3.0) (2019-09-01)
-
-
-### Features
-
-* hide deprecate warnings on production builds ([0861df3](https://github.com/unjs/hookable/commit/0861df3))
-
-
-
-## [2.2.1](https://github.com/unjs/hookable/compare/v2.2.0...v2.2.1) (2019-08-21)
-
-
-
-# [2.2.0](https://github.com/unjs/hookable/compare/v2.1.0...v2.2.0) (2019-08-21)
-
-
-### Features
-
-* deprecateHooks ([62f2d38](https://github.com/unjs/hookable/commit/62f2d38))
-
-
-
-# [2.1.0](https://github.com/unjs/hookable/compare/v2.0.1...v2.1.0) (2019-08-21)
-
-
-### Features
-
-* optional fatal support for logger ([7c7355d](https://github.com/unjs/hookable/commit/7c7355d))
-
-
-
-## [2.0.1](https://github.com/unjs/hookable/compare/v2.0.0...v2.0.1) (2019-08-21)
-
-
-
-# [2.0.0](https://github.com/unjs/hookable/compare/v1.0.1...v2.0.0) (2019-08-21)
-
-
-### Features
-
-* custom logger ([ada6e37](https://github.com/unjs/hookable/commit/ada6e37))
-
-
-### BREAKING CHANGES
-
-* console is replaced by consola by default
-
-
-
-## [1.0.1](https://github.com/unjs/hookable/compare/v1.0.0...v1.0.1) (2019-03-16)
-
-
-### Bug Fixes
-
-* fix package.json (2) ([7ff4ce9](https://github.com/unjs/hookable/commit/7ff4ce9))
-
-
-
-<a name="1.0.0"></a>
-# [1.0.0](https://github.com/unjs/hookable/compare/v0.0.7...v1.0.0) (2019-02-11)
-
-
-### Features
-
-* rewrite for 1.0.0 ([88decae](https://github.com/unjs/hookable/commit/88decae))
-
-
-### BREAKING CHANGES
-
-* api change
-
-
-
-<a name="0.0.7"></a>
-## [0.0.7](https://github.com/pi0/hookable/compare/v0.0.6...v0.0.7) (2018-01-28)
-
-
-### Bug Fixes
-
-* hook with array or falsy key ([7e90de1](https://github.com/pi0/hookable/commit/7e90de1))
-
-
-### Performance Improvements
-
-* use for in for hookObj ([3c8e2e7](https://github.com/pi0/hookable/commit/3c8e2e7))
-
-
-
-<a name="0.0.6"></a>
-## [0.0.6](https://github.com/pi0/hookable/compare/v0.0.5...v0.0.6) (2018-01-26)
-
-
-### Performance Improvements
-
-* reduce transpiled dist size ([df607cf](https://github.com/pi0/hookable/commit/df607cf))
-
-
-
-<a name="0.0.5"></a>
-## [0.0.5](https://github.com/pi0/hookable/compare/v0.0.4...v0.0.5) (2018-01-26)
-
-
-### Bug Fixes
-
-* **package:** lib ~> dist ([34a8d5c](https://github.com/pi0/hookable/commit/34a8d5c))
-
-
-
-<a name="0.0.4"></a>
-## [0.0.4](https://github.com/pi0/hookable/compare/v0.0.3...v0.0.4) (2018-01-26)
-
-
-### Performance Improvements
-
-* handle fn as array faster ([ec35edc](https://github.com/pi0/hookable/commit/ec35edc))
-
-
-
-<a name="0.0.3"></a>
-## [0.0.3](https://github.com/pi0/hookable/compare/v0.0.2...v0.0.3) (2018-01-26)
-
-
-### Bug Fixes
-
-* bind hookObj to this context ([6f6f7bc](https://github.com/pi0/hookable/commit/6f6f7bc))
-
-
-### Performance Improvements
-
-* minor refactor ([e4083aa](https://github.com/pi0/hookable/commit/e4083aa))
-
-
-
-<a name="0.0.2"></a>
-## 0.0.2 (2018-01-26)

package/types/hookable.d.ts

@@ -1,43 +0,0 @@
-declare type HookCallback = (...args: any) => Promise<void> | void;
-interface Hooks {
-    [key: string]: HookCallback;
-}
-declare type HookKeys<T> = keyof T & string;
-declare type NestedHooks<T> = {
-    [name in HookKeys<T>]: NestedHooks<T> | HookCallback;
-};
-declare type DeprecatedHook<T> = string | {
-    message: string;
-    to: HookKeys<T>;
-};
-declare type DeprecatedHooks<T> = {
-    [name in HookKeys<T>]: DeprecatedHook<T>;
-};
-interface LoggerT {
-    error(...args: any): void;
-    fatal?(...args: any): void;
-    warn(...args: any): void;
-}
-
-declare function mergeHooks<T>(...hooks: NestedHooks<T>[]): T;
-
-declare class Hookable<_HooksT = Record<string, HookCallback>, HooksT = _HooksT & {
-    error: (error: Error | any) => void;
-}, HookNameT extends HookKeys<HooksT> = HookKeys<HooksT>> {
-    private _hooks;
-    private _deprecatedHooks;
-    private _logger;
-    static mergeHooks: typeof mergeHooks;
-    mergeHooks: typeof mergeHooks;
-    constructor(logger?: LoggerT | false);
-    hook<NameT extends HookNameT>(name: NameT, fn: HooksT[NameT] & HookCallback): () => void;
-    hookOnce<NameT extends HookNameT>(name: NameT, fn: HooksT[NameT] & HookCallback): any;
-    removeHook<NameT extends HookNameT>(name: NameT, fn: HooksT[NameT] & HookCallback): void;
-    deprecateHook<NameT extends HookNameT>(name: NameT, deprecated: DeprecatedHook<HooksT>): void;
-    deprecateHooks(deprecatedHooks: Record<HookNameT, DeprecatedHook<HooksT>>): void;
-    addHooks(configHooks: NestedHooks<HooksT>): () => void;
-    removeHooks(configHooks: NestedHooks<HooksT>): void;
-    callHook<NameT extends HookNameT>(name: NameT, ...args: Parameters<HooksT[NameT]>): Promise<void>;
-}
-
-export { DeprecatedHook, DeprecatedHooks, HookCallback, HookKeys, Hooks, LoggerT, NestedHooks, Hookable as default };