si-funciona 2.1.0 → 2.2.0

package/dist/helpers/functions/onBodyLoad.js

@@ -36,13 +36,14 @@ var __awaiter = void 0 && (void 0).__awaiter || function (thisArg, _arguments, P
 }
 const queue = []
 const manager = (0, _queueManager.default)()
+manager.start()
 let observer = null
 const doReset = () => observer = null
 const initializeObserver = () => __awaiter(void 0, void 0, void 0, function * () {
   observer = new MutationObserver(() => {
     if (document.body) {
       while (queue.length) {
-        manager(queue.shift())
+        manager.push(queue.shift())
       }
       observer.disconnect()
       doReset()

package/dist/helpers/functions/onBodyLoad.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _queueManager=_interopRequireDefault(require("./queueManager"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var __awaiter=function(e,r,t,n){return new(t||(t=Promise))((function(u,o){function i(e){try{s(n.next(e))}catch(e){o(e)}}function a(e){try{s(n.throw(e))}catch(e){o(e)}}function s(e){var r;e.done?u(e.value):(r=e.value,r instanceof t?r:new t((function(e){e(r)}))).then(i,a)}s((n=n.apply(e,r||[])).next())}))};const queue=[],manager=(0,_queueManager.default)();let observer=null;const doReset=()=>observer=null,initializeObserver=()=>__awaiter(void 0,void 0,void 0,(function*(){return observer=new MutationObserver((()=>{if(document.body){for(;queue.length;)manager(queue.shift());observer.disconnect(),doReset()}})),observer.observe(document.documentElement,{childList:!0}),observer})),onBodyLoad=function(e){return arguments.length>1&&void 0!==arguments[1]&&arguments[1]&&doReset(),queue.push(e),null===observer&&initializeObserver(),queue};var _default=exports.default=onBodyLoad;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _queueManager=_interopRequireDefault(require("./queueManager"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var __awaiter=function(e,r,t,n){return new(t||(t=Promise))((function(u,o){function a(e){try{s(n.next(e))}catch(e){o(e)}}function i(e){try{s(n.throw(e))}catch(e){o(e)}}function s(e){var r;e.done?u(e.value):(r=e.value,r instanceof t?r:new t((function(e){e(r)}))).then(a,i)}s((n=n.apply(e,r||[])).next())}))};const queue=[],manager=(0,_queueManager.default)();manager.start();let observer=null;const doReset=()=>observer=null,initializeObserver=()=>__awaiter(void 0,void 0,void 0,(function*(){return observer=new MutationObserver((()=>{if(document.body){for(;queue.length;)manager.push(queue.shift());observer.disconnect(),doReset()}})),observer.observe(document.documentElement,{childList:!0}),observer})),onBodyLoad=function(e){return arguments.length>1&&void 0!==arguments[1]&&arguments[1]&&doReset(),queue.push(e),null===observer&&initializeObserver(),queue};var _default=exports.default=onBodyLoad;

package/dist/helpers/functions/queueManager.d.ts

@@ -3,13 +3,40 @@ import 'regenerator-runtime/runtime';
 import { IsQueue, queuedItem } from '../arrays/BasicQueue';
 /**
  * Each time queue handle is called the passed function is added to the queue to be called when ready.
- * @typedef {Function} module:functionHelpers~queueManagerHandle
+ * @typedef {Object} module:functionHelpers~queueedRunnable
+ * @memberOf module:functionHelpers
+ * @property {Object.<fn|args, Function|Array.<*>>} item - Stores the function and the arguments to apply to it when called
+ * @property {Generator} generator - The generator instance which can be used to yield function results
+ */
+export type queuedRunnable = {
+    item: {
+        fn: Function | queuedItem;
+        args: any[];
+    };
+    generator: Generator;
+};
+/**
+ * The pushed function is added to the queue to be called when ready.
+ * @typedef {Function} module:functionHelpers~queueManagerPush
  * @memberOf module:functionHelpers
  * @param {Function} fn - A function to enqueue
  * @param  {...*} args - Arguments to be passed to the function once it is ready
  * @returns {Promise}
  */
-export type queueManagerHandle = (fn: Function, ...args: any) => Promise<any>;
+export type queuePush = (fn: Function, ...args: any) => Promise<any>;
+/**
+ * Each time queue handle is called the passed function is added to the queue to be called when ready.
+ * @typedef {Object} module:functionHelpers~queueManagerHandle
+ * @memberOf module:functionHelpers
+ * @property {Function} start - Callable property that will disable paused state and run the next queue
+ * @property  {Function} pause - Callable property that will switch state to paused
+ * @property {module:functionHelpers~queueManagerPush} push - Callable property that takes a function to add to the queue
+ */
+export type queueManagerHandle = {
+    start: () => void;
+    pause: () => void;
+    push: queuePush;
+};
 /**
  * Manage functions to run sequentially.
  * @function

package/dist/helpers/functions/queueManager.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 exports.default = void 0
+require('core-js/modules/esnext.async-iterator.for-each.js')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.for-each.js')
 require('core-js/stable')
 require('regenerator-runtime/runtime')
 var _makeBasicQueue = _interopRequireDefault(require('./makeBasicQueue'))
@@ -17,47 +20,114 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  */
 const queueManager = function () {
   let queue = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
-  if (Array.isArray(queue)) {
-    queue = (0, _makeBasicQueue.default)(queue)
-  }
-  if (queue === null) {
-    queue = (0, _makeBasicQueue.default)()
-  }
   let isRunning = false
-  return function (fn) {
-    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-      args[_key - 1] = arguments[_key]
+  let isPaused = true
+  /**
+   * Convert a function to a queueable object.
+   * @param {Promise.resolve} resolve
+   * @param {Promise.reject} reject
+   * @param {Function} fn
+   * @param {...*} args
+   * @returns {queuedRunnable}
+   */
+  const makeQueuedRunnable = function (resolve, reject, fn) {
+    const generator = (function * () {
+      const item = yield
+      return typeof item.fn === 'function' ? resolve(item.fn(...item.args)) : reject(item)
+    }())
+    // Prepare the generator to be used on the subsequent call
+    generator.next()
+    for (var _len = arguments.length, args = new Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
+      args[_key - 3] = arguments[_key]
+    }
+    return {
+      item: {
+        fn: fn,
+        args: args
+      },
+      generator: generator
     }
-    const runNextItem = () => {
-      if (!queue.empty() && !isRunning) {
-        isRunning = true
-        const toRun = queue.dequeue()
-        if (toRun.generator && toRun.item) {
-          // Ensure the returned result has both the generator and the item to be valid
-          toRun.generator.next(toRun.item)
+  }
+  /**
+   * After an item is run, THEN run this function to reset isRunning
+   * @param {*} result
+   * @returns {*}
+   */
+  const postRun = result => {
+    isRunning = false
+    runNextItem()
+    return result
+  }
+  /**
+   * When ready, runs the next queued runnable generator.
+   * @returns {IteratorYieldResult|null}
+   */
+  const runNextItem = () => {
+    if (!isPaused && !queue.empty() && !isRunning) {
+      isRunning = true
+      let toRun = queue.dequeue()
+      if (typeof toRun === 'undefined' || toRun === null) {
+        return null
+      }
+      if (typeof toRun === 'function') {
+        new Promise((resolve, reject) => {
+          toRun = makeQueuedRunnable(resolve, reject, toRun)
+          runNextItem()
+        }).then(postRun)
+      }
+      if ('success' in toRun) {
+        // Some run responses return an object with 'success' property.
+        console.info(toRun.success)
+        return null
+      }
+      if (!toRun.generator || 'error' in toRun) {
+        // Some run responses return an object with an 'error' property
+        let errorMessage = 'Verify queued function implements "done()" state.'
+        if ('error' in toRun && toRun.error) {
+          errorMessage = `[${toRun.error}]: ${errorMessage}`
         }
+        throw new Error(errorMessage)
       }
-      return queue
+      if (toRun.generator && toRun.item) {
+        // Ensure the returned result has both the generator and the item to be valid
+        return toRun.generator.next(toRun.item)
+      }
+    }
+    return null
+  }
+  /**
+   * Add a function into the queue to be run when ready.
+   * @param {Function} fn - The function to run when ready
+   * @param {...*} args - Optional arguments to apply when the function is ready to be run
+   * @returns Promise
+   */
+  const pushAnother = function (fn) {
+    for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+      args[_key2 - 1] = arguments[_key2]
     }
     return new Promise((resolve, reject) => {
-      const generator = (function * () {
-        const item = yield
-        return typeof item.fn === 'function' ? resolve(item.fn(...item.args)) : reject(item)
-      }())
-      generator.next()
-      queue.enqueue({
-        item: {
-          fn: fn,
-          args: args
-        },
-        generator: generator
-      })
+      queue.enqueue(makeQueuedRunnable(resolve, reject, fn, ...args))
       runNextItem()
-    }).then(resolvedResult => {
-      isRunning = false
+    }).then(postRun)
+  }
+  if (Array.isArray(queue)) {
+    const queueArray = queue
+    queue = (0, _makeBasicQueue.default)()
+    queueArray.forEach(queued => pushAnother(queued))
+  }
+  if (queue === null) {
+    queue = (0, _makeBasicQueue.default)()
+  }
+  runNextItem()
+  return {
+    start: () => {
+      isPaused = false
       runNextItem()
-      return resolvedResult
-    })
+    },
+    pause: () => {
+      isPaused = true
+    },
+    push: pushAnother
   }
 }
 var _default = exports.default = queueManager

package/dist/helpers/functions/queueManager.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable"),require("regenerator-runtime/runtime");var _makeBasicQueue=_interopRequireDefault(require("./makeBasicQueue"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const queueManager=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null;Array.isArray(e)&&(e=(0,_makeBasicQueue.default)(e)),null===e&&(e=(0,_makeBasicQueue.default)());let r=!1;return function(t){for(var u=arguments.length,n=new Array(u>1?u-1:0),a=1;a<u;a++)n[a-1]=arguments[a];const i=()=>{if(!e.empty()&&!r){r=!0;const t=e.dequeue();t.generator&&t.item&&t.generator.next(t.item)}return e};return new Promise(((r,u)=>{const a=function*(){const e=yield;return"function"==typeof e.fn?r(e.fn(...e.args)):u(e)}();a.next(),e.enqueue({item:{fn:t,args:n},generator:a}),i()})).then((e=>(r=!1,i(),e)))}};var _default=exports.default=queueManager;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/modules/esnext.async-iterator.for-each.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.for-each.js"),require("core-js/stable"),require("regenerator-runtime/runtime");var _makeBasicQueue=_interopRequireDefault(require("./makeBasicQueue"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const queueManager=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null,r=!1,t=!0;const n=function(e,r,t){const n=function*(){const t=yield;return"function"==typeof t.fn?e(t.fn(...t.args)):r(t)}();n.next();for(var u=arguments.length,o=new Array(u>3?u-3:0),i=3;i<u;i++)o[i-3]=arguments[i];return{item:{fn:t,args:o},generator:n}},u=e=>(r=!1,o(),e),o=()=>{if(!t&&!e.empty()&&!r){r=!0;let t=e.dequeue();if(null==t)return null;if("function"==typeof t&&new Promise(((e,r)=>{t=n(e,r,t),o()})).then(u),"success"in t)return console.info(t.success),null;if(!t.generator||"error"in t){let e='Verify queued function implements "done()" state.';throw"error"in t&&t.error&&(e=`[${t.error}]: ${e}`),new Error(e)}if(t.generator&&t.item)return t.generator.next(t.item)}return null},i=function(r){for(var t=arguments.length,i=new Array(t>1?t-1:0),s=1;s<t;s++)i[s-1]=arguments[s];return new Promise(((t,u)=>{e.enqueue(n(t,u,r,...i)),o()})).then(u)};if(Array.isArray(e)){const r=e;e=(0,_makeBasicQueue.default)(),r.forEach((e=>i(e)))}return null===e&&(e=(0,_makeBasicQueue.default)()),o(),{start:()=>{t=!1,o()},pause:()=>{t=!0},push:i}};var _default=exports.default=queueManager;

package/dist/helpers/functions/queueTimeout.js

@@ -19,12 +19,13 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
 const queueTimeout = function () {
   const queueManagerHandle = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
   const manager = queueManagerHandle || (0, _queueManager.default)()
+  manager.start()
   return function (fn) {
     const time = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0
     for (var _len = arguments.length, args = new Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) {
       args[_key - 2] = arguments[_key]
     }
-    return manager(() => (0, _delay.default)(time).resolver.then(() => fn(...args)))
+    return manager.push(() => (0, _delay.default)(time).resolver.then(() => fn(...args)))
   }
 }
 var _default = exports.default = queueTimeout

package/dist/helpers/functions/queueTimeout.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable"),require("regenerator-runtime/runtime");var _delay=_interopRequireDefault(require("./delay")),_queueManager=_interopRequireDefault(require("./queueManager"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const queueTimeout=function(){const e=(arguments.length>0&&void 0!==arguments[0]?arguments[0]:null)||(0,_queueManager.default)();return function(r){let u=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;for(var t=arguments.length,n=new Array(t>2?t-2:0),a=2;a<t;a++)n[a-2]=arguments[a];return e((()=>(0,_delay.default)(u).resolver.then((()=>r(...n)))))}};var _default=exports.default=queueTimeout;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable"),require("regenerator-runtime/runtime");var _delay=_interopRequireDefault(require("./delay")),_queueManager=_interopRequireDefault(require("./queueManager"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const queueTimeout=function(){const e=(arguments.length>0&&void 0!==arguments[0]?arguments[0]:null)||(0,_queueManager.default)();return e.start(),function(r){let u=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;for(var t=arguments.length,n=new Array(t>2?t-2:0),a=2;a<t;a++)n[a-2]=arguments[a];return e.push((()=>(0,_delay.default)(u).resolver.then((()=>r(...n)))))}};var _default=exports.default=queueTimeout;

package/package.json

@@ -13,7 +13,7 @@
     "general",
     "typescript"
   ],
-  "version": "2.1.0",
+  "version": "2.2.0",
   "license": "GPL-3.0-or-later",
   "bugs": {
     "url": "https://github.com/jheagle/si-funciona/issues"
@@ -30,11 +30,12 @@
     "watch:test": "gulp watchTest"
   },
   "dependencies": {
-    "npm": "^10.2.3"
+    "npm": "^10.2.5"
   },
   "devDependencies": {
+    "collect-your-stuff": "^1.1.2",
     "gulp": "^4.0.2",
-    "js-build-tools": "^2.2.10",
+    "js-build-tools": "^2.2.11",
     "jsdoc": "^4.0.2",
     "standard": "^17.1.0"
   },