@shuvi/hook 1.0.0-rc.9 → 1.0.0

package/esm/hookGroup.d.ts

@@ -29,7 +29,7 @@ export declare type RunnerType<HM> = {
 export declare type HookRunnerType<H> = H extends SyncHook<infer T, infer E, infer R> ? SyncHook<T, E, R>['run'] : H extends SyncBailHook<infer T, infer E, infer R> ? SyncBailHook<T, E, R>['run'] : H extends SyncWaterfallHook<infer T, infer E> ? SyncWaterfallHook<T, E>['run'] : H extends AsyncParallelHook<infer T, infer E, infer R> ? AsyncParallelHook<T, E, R>['run'] : H extends AsyncSeriesHook<infer T, infer E, infer R> ? AsyncSeriesHook<T, E, R>['run'] : H extends AsyncSeriesBailHook<infer T, infer E, infer R> ? AsyncSeriesBailHook<T, E, R>['run'] : H extends AsyncSeriesWaterfallHook<infer T, infer E> ? AsyncSeriesWaterfallHook<T, E>['run'] : never;
 export declare type IPluginInstance<HM, C> = {
     handlers: IPluginHandlers<HM, C>;
-    SYNC_PLUGIN_SYMBOL: 'SYNC_PLUGIN_SYMBOL';
+    PLUGIN_SYMBOL: 'PLUGIN_SYMBOL';
 } & Required<PluginOptions>;
 export declare type IPluginHandlers<HM, C> = Partial<IPluginHandlersFullMap<HM, C>>;
 export declare type IPluginHandlersFullMap<HM, C> = {
@@ -45,11 +45,10 @@ export declare type PluginOptions = {
     group?: number;
     [x: string]: any;
 };
-export declare const DEFAULT_OPTIONS: Required<PluginOptions>;
-export declare const SYNC_PLUGIN_SYMBOL = "SYNC_PLUGIN_SYMBOL";
-export declare const isPluginInstance: (plugin: any) => any;
+export declare const isPluginInstance: <T extends IPluginInstance<any, any> = IPluginInstance<any, any>>(plugin: any) => plugin is T;
 export declare type ArrayElements<T extends {}> = {
     [K in keyof T]: T[K][];
 };
+export declare function createPlugin<HM extends HookMap, C = void>(pluginHandlers: IPluginHandlers<HM, C>, options?: PluginOptions): IPluginInstance<HM, C>;
 export declare const createHookManager: <HM extends HookMap, C = void>(hookMap: HM, hasContext?: boolean) => HookManager<HM, C>;
 export declare type RemoveManagerVoidParameter<T> = T extends (initalValue: infer I, extraArg: infer E, context: infer C) => infer R ? null extends I ? null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends I ? null extends E ? null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : void extends E ? null extends C ? (context: C) => R : void extends C ? () => R : (context: C) => R : null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : T;

package/esm/hookGroup.js

@@ -1,5 +1,5 @@
 import { createSyncHook, createSyncBailHook, createSyncWaterfallHook, createAsyncParallelHook, createAsyncSeriesWaterfallHook, createAsyncSeriesBailHook, createAsyncSeriesHook } from './hooks';
-export const DEFAULT_OPTIONS = {
+const DEFAULT_OPTIONS = {
     name: 'untitled',
     pre: [],
     post: [],
@@ -8,10 +8,10 @@ export const DEFAULT_OPTIONS = {
     order: 0,
     group: 0
 };
-export const SYNC_PLUGIN_SYMBOL = 'SYNC_PLUGIN_SYMBOL';
+const PLUGIN_SYMBOL = 'PLUGIN_SYMBOL';
 export const isPluginInstance = (plugin) => plugin &&
-    plugin.hasOwnProperty(SYNC_PLUGIN_SYMBOL) &&
-    plugin.SYNC_PLUGIN_SYMBOL === SYNC_PLUGIN_SYMBOL;
+    plugin.hasOwnProperty(PLUGIN_SYMBOL) &&
+    plugin.PLUGIN_SYMBOL === PLUGIN_SYMBOL;
 const sortPlugins = (input) => {
     let plugins = input.slice();
     plugins.sort((a, b) => {
@@ -113,6 +113,9 @@ const copyHookMap = (hookMap) => {
     }
     return newHookMap;
 };
+export function createPlugin(pluginHandlers, options = {}) {
+    return Object.assign(Object.assign(Object.assign(Object.assign({}, DEFAULT_OPTIONS), { name: `plugin-id-${uuid()}` }), options), { handlers: pluginHandlers, PLUGIN_SYMBOL });
+}
 export const createHookManager = (hookMap, hasContext = true) => {
     const setupHook = createSyncHook();
     const _hookMap = Object.assign(Object.assign({}, copyHookMap(hookMap)), { setup: setupHook });
@@ -126,9 +129,6 @@ export const createHookManager = (hookMap, hasContext = true) => {
         const setupRunner = getRunner('setup');
         setupRunner({ addHooks });
     };
-    const createPlugin = (pluginHandlers, options = {}) => {
-        return Object.assign(Object.assign(Object.assign(Object.assign({}, DEFAULT_OPTIONS), { name: `plugin-id-${uuid()}` }), options), { handlers: pluginHandlers, SYNC_PLUGIN_SYMBOL });
-    };
     const usePlugin = (...plugins) => {
         if (_initiated) {
             return;
@@ -246,7 +246,7 @@ export const createHookManager = (hookMap, hasContext = true) => {
         }
     });
     return {
-        createPlugin,
+        createPlugin: createPlugin,
         usePlugin,
         runner: runnerProxy,
         clear,

package/esm/hooks.js

@@ -63,7 +63,10 @@ export const createSyncWaterfallHook = () => {
         for (let i = 0; i < _handlers.length; i++) {
             const handler = _handlers[i];
             // @ts-ignore
-            currentParam = handler(currentParam, ...otherArgs);
+            const result = handler(currentParam, ...otherArgs);
+            if (result !== undefined) {
+                currentParam = result;
+            }
         }
         return currentParam;
     };
@@ -157,7 +160,10 @@ export const createAsyncSeriesWaterfallHook = () => {
         for (let i = 0; i < _handlers.length; i++) {
             const handler = _handlers[i];
             // @ts-ignore
-            currentParam = yield handler(currentParam, ...otherArgs);
+            const result = yield handler(currentParam, ...otherArgs);
+            if (result !== undefined) {
+                currentParam = result;
+            }
         }
         return currentParam;
     });

package/lib/hookGroup.d.ts

@@ -29,7 +29,7 @@ export declare type RunnerType<HM> = {
 export declare type HookRunnerType<H> = H extends SyncHook<infer T, infer E, infer R> ? SyncHook<T, E, R>['run'] : H extends SyncBailHook<infer T, infer E, infer R> ? SyncBailHook<T, E, R>['run'] : H extends SyncWaterfallHook<infer T, infer E> ? SyncWaterfallHook<T, E>['run'] : H extends AsyncParallelHook<infer T, infer E, infer R> ? AsyncParallelHook<T, E, R>['run'] : H extends AsyncSeriesHook<infer T, infer E, infer R> ? AsyncSeriesHook<T, E, R>['run'] : H extends AsyncSeriesBailHook<infer T, infer E, infer R> ? AsyncSeriesBailHook<T, E, R>['run'] : H extends AsyncSeriesWaterfallHook<infer T, infer E> ? AsyncSeriesWaterfallHook<T, E>['run'] : never;
 export declare type IPluginInstance<HM, C> = {
     handlers: IPluginHandlers<HM, C>;
-    SYNC_PLUGIN_SYMBOL: 'SYNC_PLUGIN_SYMBOL';
+    PLUGIN_SYMBOL: 'PLUGIN_SYMBOL';
 } & Required<PluginOptions>;
 export declare type IPluginHandlers<HM, C> = Partial<IPluginHandlersFullMap<HM, C>>;
 export declare type IPluginHandlersFullMap<HM, C> = {
@@ -45,11 +45,10 @@ export declare type PluginOptions = {
     group?: number;
     [x: string]: any;
 };
-export declare const DEFAULT_OPTIONS: Required<PluginOptions>;
-export declare const SYNC_PLUGIN_SYMBOL = "SYNC_PLUGIN_SYMBOL";
-export declare const isPluginInstance: (plugin: any) => any;
+export declare const isPluginInstance: <T extends IPluginInstance<any, any> = IPluginInstance<any, any>>(plugin: any) => plugin is T;
 export declare type ArrayElements<T extends {}> = {
     [K in keyof T]: T[K][];
 };
+export declare function createPlugin<HM extends HookMap, C = void>(pluginHandlers: IPluginHandlers<HM, C>, options?: PluginOptions): IPluginInstance<HM, C>;
 export declare const createHookManager: <HM extends HookMap, C = void>(hookMap: HM, hasContext?: boolean) => HookManager<HM, C>;
 export declare type RemoveManagerVoidParameter<T> = T extends (initalValue: infer I, extraArg: infer E, context: infer C) => infer R ? null extends I ? null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends I ? null extends E ? null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : void extends E ? null extends C ? (context: C) => R : void extends C ? () => R : (context: C) => R : null extends C ? (extraArg: E, context: C) => R : void extends C ? (extraArg: E) => R : (extraArg: E, context: C) => R : null extends E ? null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : void extends E ? null extends C ? (initialValue: I, context: C) => R : void extends C ? (initialValue: I) => R : (initialValue: I, context: C) => R : null extends C ? (initialValue: I, extraArg: E, context: C) => R : void extends C ? (initialValue: I, extraArg: E) => R : (initialValue: I, extraArg: E, context: C) => R : T;

package/lib/hookGroup.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHookManager = exports.isPluginInstance = exports.SYNC_PLUGIN_SYMBOL = exports.DEFAULT_OPTIONS = void 0;
+exports.createHookManager = exports.createPlugin = exports.isPluginInstance = void 0;
 const hooks_1 = require("./hooks");
-exports.DEFAULT_OPTIONS = {
+const DEFAULT_OPTIONS = {
     name: 'untitled',
     pre: [],
     post: [],
@@ -11,10 +11,10 @@ exports.DEFAULT_OPTIONS = {
     order: 0,
     group: 0
 };
-exports.SYNC_PLUGIN_SYMBOL = 'SYNC_PLUGIN_SYMBOL';
+const PLUGIN_SYMBOL = 'PLUGIN_SYMBOL';
 const isPluginInstance = (plugin) => plugin &&
-    plugin.hasOwnProperty(exports.SYNC_PLUGIN_SYMBOL) &&
-    plugin.SYNC_PLUGIN_SYMBOL === exports.SYNC_PLUGIN_SYMBOL;
+    plugin.hasOwnProperty(PLUGIN_SYMBOL) &&
+    plugin.PLUGIN_SYMBOL === PLUGIN_SYMBOL;
 exports.isPluginInstance = isPluginInstance;
 const sortPlugins = (input) => {
     let plugins = input.slice();
@@ -117,6 +117,10 @@ const copyHookMap = (hookMap) => {
     }
     return newHookMap;
 };
+function createPlugin(pluginHandlers, options = {}) {
+    return Object.assign(Object.assign(Object.assign(Object.assign({}, DEFAULT_OPTIONS), { name: `plugin-id-${uuid()}` }), options), { handlers: pluginHandlers, PLUGIN_SYMBOL });
+}
+exports.createPlugin = createPlugin;
 const createHookManager = (hookMap, hasContext = true) => {
     const setupHook = (0, hooks_1.createSyncHook)();
     const _hookMap = Object.assign(Object.assign({}, copyHookMap(hookMap)), { setup: setupHook });
@@ -130,9 +134,6 @@ const createHookManager = (hookMap, hasContext = true) => {
         const setupRunner = getRunner('setup');
         setupRunner({ addHooks });
     };
-    const createPlugin = (pluginHandlers, options = {}) => {
-        return Object.assign(Object.assign(Object.assign(Object.assign({}, exports.DEFAULT_OPTIONS), { name: `plugin-id-${uuid()}` }), options), { handlers: pluginHandlers, SYNC_PLUGIN_SYMBOL: exports.SYNC_PLUGIN_SYMBOL });
-    };
     const usePlugin = (...plugins) => {
         if (_initiated) {
             return;
@@ -250,7 +251,7 @@ const createHookManager = (hookMap, hasContext = true) => {
         }
     });
     return {
-        createPlugin,
+        createPlugin: createPlugin,
         usePlugin,
         runner: runnerProxy,
         clear,

package/lib/hooks.js

@@ -68,7 +68,10 @@ const createSyncWaterfallHook = () => {
         for (let i = 0; i < _handlers.length; i++) {
             const handler = _handlers[i];
             // @ts-ignore
-            currentParam = handler(currentParam, ...otherArgs);
+            const result = handler(currentParam, ...otherArgs);
+            if (result !== undefined) {
+                currentParam = result;
+            }
         }
         return currentParam;
     };
@@ -166,7 +169,10 @@ const createAsyncSeriesWaterfallHook = () => {
         for (let i = 0; i < _handlers.length; i++) {
             const handler = _handlers[i];
             // @ts-ignore
-            currentParam = yield handler(currentParam, ...otherArgs);
+            const result = yield handler(currentParam, ...otherArgs);
+            if (result !== undefined) {
+                currentParam = result;
+            }
         }
         return currentParam;
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/hook",
-  "version": "1.0.0-rc.9",
+  "version": "1.0.0",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "esm/index.js",