@modern-js/plugin 1.2.1 → 1.3.2

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @modern-js/plugin
 
+## 1.3.2
+
+### Patch Changes
+
+- dc88abf9: fix: should allow to use plugin without setup function
+- 0462ff77: feat: add compatible logic of plugin options with "setup" param
+
+## 1.3.0
+
+### Minor Changes
+
+- 80d8ddfe: feat: support `setup`, `registerHook`, `usePlugins` in plugin options.
+
+### Patch Changes
+
+- 491145e3: feat: allow manger.clone to override pluginAPI
+
 ## 1.2.1
 
 ### Patch Changes

package/dist/js/modern/manager/async.js

@@ -5,48 +5,76 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 import { runWithContainer, createContainer } from 'farrow-pipeline';
-import { generateRunner, hasOwnProperty, DEFAULT_OPTIONS } from "./sync";
-import { useRunner } from "./runner"; // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-
+import { isObject, generateRunner, hasOwnProperty, DEFAULT_OPTIONS } from "./sync";
+import { useRunner } from "./runner";
 const ASYNC_PLUGIN_SYMBOL = 'ASYNC_PLUGIN_SYMBOL';
-export const createAsyncManager = processes => {
+export const createAsyncManager = (hooks, api) => {
   let index = 0;
 
-  const createPlugin = (initializer, options = {}) => _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_OPTIONS), {}, {
-    name: `No.${index++} plugin`
-  }, options), {}, {
-    ASYNC_PLUGIN_SYMBOL,
-    initializer
-  });
-
-  const isPlugin = input => hasOwnProperty(input, ASYNC_PLUGIN_SYMBOL) && input[ASYNC_PLUGIN_SYMBOL] === ASYNC_PLUGIN_SYMBOL;
+  let currentHooks = _objectSpread({}, hooks);
 
-  const registe = extraProcesses => {
-    // eslint-disable-next-line no-param-reassign
-    processes = _objectSpread(_objectSpread({}, extraProcesses), processes);
+  const registerHook = extraHooks => {
+    currentHooks = _objectSpread(_objectSpread({}, extraHooks), currentHooks);
   };
 
-  const clone = () => {
+  const isPlugin = input => isObject(input) && hasOwnProperty(input, ASYNC_PLUGIN_SYMBOL) && input[ASYNC_PLUGIN_SYMBOL] === ASYNC_PLUGIN_SYMBOL;
+
+  const pluginAPI = _objectSpread(_objectSpread({}, api), {}, {
+    useHookRunners: useRunner
+  });
+
+  const clone = overrideAPI => {
     let plugins = [];
 
+    const addPlugin = plugin => {
+      if (!includeAsyncPlugin(plugins, plugin)) {
+        plugins.push(_objectSpread({}, plugin));
+      }
+    };
+
     const usePlugin = (...input) => {
       for (const plugin of input) {
+        // already created by createPlugin
         if (isPlugin(plugin)) {
-          if (!includeAsyncPlugin(plugins, plugin)) {
-            plugins.push(_objectSpread(_objectSpread({}, plugin), {}, {
-              index: plugins.length
-            }));
-          }
-        } else {
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-expect-error
-          console.warn(`Unknown plugin: ${plugin.name}`);
+          addPlugin(plugin);
+        } // using function to return plugin options
+        else if (typeof plugin === 'function') {
+          const options = plugin();
+          addPlugin(createPlugin(options.setup, options));
+        } // plain plugin object
+        else if (isObject(plugin)) {
+          addPlugin(createPlugin(plugin.setup, plugin));
+        } // unknown plugin
+        else {
+          console.warn(`Unknown plugin: ${JSON.stringify(plugin)}`);
         }
       }
 
       return manager;
     };
 
+    const createPlugin = ( // eslint-disable-next-line @typescript-eslint/no-empty-function
+    setup = () => {}, options = {}) => {
+      var _options$usePlugins;
+
+      if ((_options$usePlugins = options.usePlugins) !== null && _options$usePlugins !== void 0 && _options$usePlugins.length) {
+        options.usePlugins.forEach(plugin => {
+          usePlugin(createPlugin(plugin.setup, plugin));
+        });
+      }
+
+      if (options.registerHook) {
+        registerHook(options.registerHook);
+      }
+
+      return _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_OPTIONS), {}, {
+        name: `No.${index++} plugin`
+      }, options), {}, {
+        ASYNC_PLUGIN_SYMBOL,
+        setup
+      });
+    };
+
     const clear = () => {
       plugins = [];
     };
@@ -56,9 +84,12 @@ export const createAsyncManager = processes => {
     const init = async options => {
       const container = (options === null || options === void 0 ? void 0 : options.container) || currentContainer;
       const sortedPlugins = sortAsyncPlugins(plugins);
+
+      const mergedPluginAPI = _objectSpread(_objectSpread({}, pluginAPI), overrideAPI);
+
       checkAsyncPlugins(sortedPlugins);
-      const hooksList = await Promise.all(sortedPlugins.map(plugin => runWithContainer(() => plugin.initializer(), container)));
-      return generateRunner(hooksList, container, processes);
+      const hooksList = await Promise.all(sortedPlugins.map(plugin => runWithContainer(() => plugin.setup(mergedPluginAPI), container)));
+      return generateRunner(hooksList, container, currentHooks);
     };
 
     const run = (cb, options) => {
@@ -74,7 +105,7 @@ export const createAsyncManager = processes => {
       run,
       clear,
       clone,
-      registe,
+      registerHook,
       useRunner
     };
     return manager;

package/dist/js/modern/manager/index.js

@@ -1,3 +1,4 @@
 export * from "./sync";
 export * from "./async";
-export * from "./runner";
+export * from "./runner";
+export * from "./types";

package/dist/js/modern/manager/sync.js

@@ -4,68 +4,85 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-// eslint-disable-next-line eslint-comments/disable-enable-pair
-
-/* eslint-disable max-lines */
 import { isPipeline, createPipeline, runWithContainer, createContainer } from 'farrow-pipeline';
 import { isWaterfall, createWaterfall, isAsyncWaterfall, createAsyncWaterfall } from "../waterfall";
 import { isWorkflow, createWorkflow, isAsyncWorkflow, createAsyncWorkflow, isParallelWorkflow, createParallelWorkflow } from "../workflow";
-import { RunnerContext, useRunner } from "./runner"; // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-
+import { RunnerContext, useRunner } from "./runner";
 const SYNC_PLUGIN_SYMBOL = 'SYNC_PLUGIN_SYMBOL';
 export const DEFAULT_OPTIONS = {
   name: 'untitled',
   pre: [],
   post: [],
   rivals: [],
-  required: []
+  required: [],
+  usePlugins: [],
+  registerHook: {}
 };
-export const createManager = processes => {
+export const createManager = (hooks, api) => {
   let index = 0;
 
-  const createPlugin = (initializer, options = {}) => _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_OPTIONS), {}, {
-    name: `No.${index++} plugin`
-  }, options), {}, {
-    SYNC_PLUGIN_SYMBOL,
-    initializer
-  });
-
-  const isPlugin = input => hasOwnProperty(input, SYNC_PLUGIN_SYMBOL) && input[SYNC_PLUGIN_SYMBOL] === SYNC_PLUGIN_SYMBOL;
+  let currentHooks = _objectSpread({}, hooks);
 
-  const registe = extraProcesses => {
-    // eslint-disable-next-line no-param-reassign
-    processes = _objectSpread(_objectSpread({}, extraProcesses), processes);
+  const registerHook = extraHooks => {
+    currentHooks = _objectSpread(_objectSpread({}, extraHooks), currentHooks);
   };
 
-  const clone = () => {
+  const isPlugin = input => isObject(input) && hasOwnProperty(input, SYNC_PLUGIN_SYMBOL) && input[SYNC_PLUGIN_SYMBOL] === SYNC_PLUGIN_SYMBOL;
+
+  const pluginAPI = _objectSpread(_objectSpread({}, api), {}, {
+    useHookRunners: useRunner
+  });
+
+  const clone = overrideAPI => {
     let plugins = [];
 
+    const addPlugin = plugin => {
+      if (!includePlugin(plugins, plugin)) {
+        plugins.push(_objectSpread({}, plugin));
+      }
+    };
+
     const usePlugin = (...input) => {
       for (const plugin of input) {
+        // already created by createPlugin
         if (isPlugin(plugin)) {
-          if (!includePlugin(plugins, plugin)) {
-            plugins.push(_objectSpread(_objectSpread({}, plugin), {}, {
-              index: plugins.length
-            }));
-          }
-        } else {
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-expect-error
-          console.warn(`Unknown plugin: ${plugin.name}`);
+          addPlugin(plugin);
+        } // using function to return plugin options
+        else if (typeof plugin === 'function') {
+          const options = plugin();
+          addPlugin(createPlugin(options.setup, options));
+        } // plain plugin object
+        else if (isObject(plugin)) {
+          addPlugin(createPlugin(plugin.setup, plugin));
+        } // unknown plugin
+        else {
+          console.warn(`Unknown plugin: ${JSON.stringify(plugin)}`);
         }
       }
 
-      return {
-        createPlugin,
-        isPlugin,
-        usePlugin,
-        init,
-        run,
-        clear,
-        registe,
-        useRunner,
-        clone
-      };
+      return manager;
+    };
+
+    const createPlugin = ( // eslint-disable-next-line @typescript-eslint/no-empty-function
+    setup = () => {}, options = {}) => {
+      var _options$usePlugins;
+
+      if ((_options$usePlugins = options.usePlugins) !== null && _options$usePlugins !== void 0 && _options$usePlugins.length) {
+        options.usePlugins.forEach(plugin => {
+          usePlugin(createPlugin(plugin.setup, plugin));
+        });
+      }
+
+      if (options.registerHook) {
+        registerHook(options.registerHook);
+      }
+
+      return _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_OPTIONS), {}, {
+        name: `No.${index++} plugin`
+      }, options), {}, {
+        SYNC_PLUGIN_SYMBOL,
+        setup
+      });
     };
 
     const clear = () => {
@@ -77,9 +94,12 @@ export const createManager = processes => {
     const init = options => {
       const container = (options === null || options === void 0 ? void 0 : options.container) || currentContainer;
       const sortedPlugins = sortPlugins(plugins);
+
+      const mergedPluginAPI = _objectSpread(_objectSpread({}, pluginAPI), overrideAPI);
+
       checkPlugins(sortedPlugins);
-      const hooksList = sortedPlugins.map(plugin => runWithContainer(() => plugin.initializer(), container));
-      return generateRunner(hooksList, container, processes);
+      const hooksList = sortedPlugins.map(plugin => runWithContainer(() => plugin.setup(mergedPluginAPI), container));
+      return generateRunner(hooksList, container, currentHooks);
     };
 
     const run = (cb, options) => {
@@ -87,26 +107,27 @@ export const createManager = processes => {
       return runWithContainer(cb, container);
     };
 
-    return {
+    const manager = {
       createPlugin,
       isPlugin,
       usePlugin,
       init,
       clear,
       run,
-      registe,
+      registerHook,
       useRunner,
       clone
     };
+    return manager;
   };
 
   return clone();
 };
-export const generateRunner = (hooksList, container, processes) => {
+export const generateRunner = (hooksList, container, hooksMap) => {
   const runner = {};
-  const cloneShape = cloneProgressRecord(processes);
+  const cloneShape = closeHooksMap(hooksMap);
 
-  if (processes) {
+  if (hooksMap) {
     for (const key in cloneShape) {
       for (const hooks of hooksList) {
         if (!hooks) {
@@ -114,8 +135,6 @@ export const generateRunner = (hooksList, container, processes) => {
         }
 
         if (hooks[key]) {
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-expect-error
           cloneShape[key].use(hooks[key]);
         }
       } // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -131,36 +150,35 @@ export const generateRunner = (hooksList, container, processes) => {
   container.write(RunnerContext, runner);
   return runner;
 };
-export const cloneProgress = progress => {
-  if (isWaterfall(progress)) {
+export const cloneHook = hook => {
+  if (isWaterfall(hook)) {
     return createWaterfall();
   }
 
-  if (isAsyncWaterfall(progress)) {
+  if (isAsyncWaterfall(hook)) {
     return createAsyncWaterfall();
   }
 
-  if (isWorkflow(progress)) {
+  if (isWorkflow(hook)) {
     return createWorkflow();
   }
 
-  if (isAsyncWorkflow(progress)) {
+  if (isAsyncWorkflow(hook)) {
     return createAsyncWorkflow();
   }
 
-  if (isParallelWorkflow(progress)) {
+  if (isParallelWorkflow(hook)) {
     return createParallelWorkflow();
   }
 
-  if (isPipeline(progress)) {
+  if (isPipeline(hook)) {
     return createPipeline();
   } // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 
 
-  throw new Error(`Unknown progress: ${progress}`);
-}; // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-
-export const cloneProgressRecord = record => {
+  throw new Error(`Unknown hook: ${hook}`);
+};
+export const closeHooksMap = record => {
   if (!record) {
     return record;
   }
@@ -170,7 +188,7 @@ export const cloneProgressRecord = record => {
   for (const key in record) {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-expect-error
-    result[key] = cloneProgress(record[key]);
+    result[key] = cloneHook(record[key]);
   }
 
   return result;
@@ -230,4 +248,5 @@ const checkPlugins = plugins => {
   }
 };
 
+export const isObject = obj => obj !== null && typeof obj === 'object';
 export const hasOwnProperty = (obj, prop) => obj.hasOwnProperty(prop);

package/dist/js/modern/waterfall/async.js

@@ -16,7 +16,6 @@ export const getAsyncBrook = input => {
 
   throw new Error(`${input} is not a AsyncBrook or { brook: AsyncBrook }`);
 };
-// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
 export const createAsyncWaterfall = () => {
   const pipeline = createAsyncPipeline();
 

package/dist/js/modern/waterfall/sync.js

@@ -16,7 +16,6 @@ export const getBrook = input => {
 
   throw new Error(`${input} is not a Brook or { brook: Brook }`);
 };
-// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
 export const createWaterfall = () => {
   const pipeline = createPipeline();
 

package/dist/js/modern/workflow/async.js

@@ -6,8 +6,7 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 import { createAsyncPipeline } from 'farrow-pipeline';
 const ASYNC_WORKFLOW_SYMBOL = Symbol('ASYNC_WORKFLOW_SYMBOL');
-export const isAsyncWorkflow = input => Boolean(input === null || input === void 0 ? void 0 : input[ASYNC_WORKFLOW_SYMBOL]); // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-
+export const isAsyncWorkflow = input => Boolean(input === null || input === void 0 ? void 0 : input[ASYNC_WORKFLOW_SYMBOL]);
 export const createAsyncWorkflow = () => {
   const pipeline = createAsyncPipeline();
 

package/dist/js/modern/workflow/sync.js

@@ -6,7 +6,6 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 import { createPipeline } from 'farrow-pipeline';
 const WORKFLOW_SYMBOL = Symbol('WORKFLOW_SYMBOL');
-// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
 export const createWorkflow = () => {
   const pipeline = createPipeline();
 

package/dist/js/node/manager/async.js

@@ -19,44 +19,73 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 const ASYNC_PLUGIN_SYMBOL = 'ASYNC_PLUGIN_SYMBOL';
 
-const createAsyncManager = processes => {
+const createAsyncManager = (hooks, api) => {
   let index = 0;
 
-  const createPlugin = (initializer, options = {}) => _objectSpread(_objectSpread(_objectSpread({}, _sync.DEFAULT_OPTIONS), {}, {
-    name: `No.${index++} plugin`
-  }, options), {}, {
-    ASYNC_PLUGIN_SYMBOL,
-    initializer
-  });
-
-  const isPlugin = input => (0, _sync.hasOwnProperty)(input, ASYNC_PLUGIN_SYMBOL) && input[ASYNC_PLUGIN_SYMBOL] === ASYNC_PLUGIN_SYMBOL;
+  let currentHooks = _objectSpread({}, hooks);
 
-  const registe = extraProcesses => {
-    // eslint-disable-next-line no-param-reassign
-    processes = _objectSpread(_objectSpread({}, extraProcesses), processes);
+  const registerHook = extraHooks => {
+    currentHooks = _objectSpread(_objectSpread({}, extraHooks), currentHooks);
   };
 
-  const clone = () => {
+  const isPlugin = input => (0, _sync.isObject)(input) && (0, _sync.hasOwnProperty)(input, ASYNC_PLUGIN_SYMBOL) && input[ASYNC_PLUGIN_SYMBOL] === ASYNC_PLUGIN_SYMBOL;
+
+  const pluginAPI = _objectSpread(_objectSpread({}, api), {}, {
+    useHookRunners: _runner.useRunner
+  });
+
+  const clone = overrideAPI => {
     let plugins = [];
 
+    const addPlugin = plugin => {
+      if (!includeAsyncPlugin(plugins, plugin)) {
+        plugins.push(_objectSpread({}, plugin));
+      }
+    };
+
     const usePlugin = (...input) => {
       for (const plugin of input) {
+        // already created by createPlugin
         if (isPlugin(plugin)) {
-          if (!includeAsyncPlugin(plugins, plugin)) {
-            plugins.push(_objectSpread(_objectSpread({}, plugin), {}, {
-              index: plugins.length
-            }));
-          }
-        } else {
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-expect-error
-          console.warn(`Unknown plugin: ${plugin.name}`);
+          addPlugin(plugin);
+        } // using function to return plugin options
+        else if (typeof plugin === 'function') {
+          const options = plugin();
+          addPlugin(createPlugin(options.setup, options));
+        } // plain plugin object
+        else if ((0, _sync.isObject)(plugin)) {
+          addPlugin(createPlugin(plugin.setup, plugin));
+        } // unknown plugin
+        else {
+          console.warn(`Unknown plugin: ${JSON.stringify(plugin)}`);
         }
       }
 
       return manager;
     };
 
+    const createPlugin = ( // eslint-disable-next-line @typescript-eslint/no-empty-function
+    setup = () => {}, options = {}) => {
+      var _options$usePlugins;
+
+      if ((_options$usePlugins = options.usePlugins) !== null && _options$usePlugins !== void 0 && _options$usePlugins.length) {
+        options.usePlugins.forEach(plugin => {
+          usePlugin(createPlugin(plugin.setup, plugin));
+        });
+      }
+
+      if (options.registerHook) {
+        registerHook(options.registerHook);
+      }
+
+      return _objectSpread(_objectSpread(_objectSpread({}, _sync.DEFAULT_OPTIONS), {}, {
+        name: `No.${index++} plugin`
+      }, options), {}, {
+        ASYNC_PLUGIN_SYMBOL,
+        setup
+      });
+    };
+
     const clear = () => {
       plugins = [];
     };
@@ -66,9 +95,12 @@ const createAsyncManager = processes => {
     const init = async options => {
       const container = (options === null || options === void 0 ? void 0 : options.container) || currentContainer;
       const sortedPlugins = sortAsyncPlugins(plugins);
+
+      const mergedPluginAPI = _objectSpread(_objectSpread({}, pluginAPI), overrideAPI);
+
       checkAsyncPlugins(sortedPlugins);
-      const hooksList = await Promise.all(sortedPlugins.map(plugin => (0, _farrowPipeline.runWithContainer)(() => plugin.initializer(), container)));
-      return (0, _sync.generateRunner)(hooksList, container, processes);
+      const hooksList = await Promise.all(sortedPlugins.map(plugin => (0, _farrowPipeline.runWithContainer)(() => plugin.setup(mergedPluginAPI), container)));
+      return (0, _sync.generateRunner)(hooksList, container, currentHooks);
     };
 
     const run = (cb, options) => {
@@ -84,7 +116,7 @@ const createAsyncManager = processes => {
       run,
       clear,
       clone,
-      registe,
+      registerHook,
       useRunner: _runner.useRunner
     };
     return manager;

package/dist/js/node/manager/index.js

@@ -41,4 +41,17 @@ Object.keys(_runner).forEach(function (key) {
       return _runner[key];
     }
   });
+});
+
+var _types = require("./types");
+
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
 });