si-funciona 2.0.4 → 2.1.0

package/dist/helpers/arrays/BasicQueue.d.ts

@@ -0,0 +1,61 @@
+import 'core-js/stable';
+export type callableLater = {
+    fn?: Function;
+    args?: Array<any>;
+};
+export type queuedItem = {
+    item: callableLater | any;
+    generator: Generator;
+};
+/**
+ * Define the format of a queue
+ * @typdef {Object} IsQueue
+ * @property {Array|*} innerList - Stores the data for the queue
+ * @method dequeue - Pulls the first item from the queue
+ * @method empty - Check if the queue is empty
+ * @method enqueue - Adds and item to the end of the queue
+ * @method peek - Get the next queue item but does not remove it
+ * @method size - Get the size of the queue
+ */
+export interface IsQueue<queuedItem> {
+    dequeue: () => queuedItem | null;
+    empty: () => boolean;
+    enqueue: (data: queuedItem) => void;
+    peek: () => queuedItem | null;
+    size: () => number;
+}
+/**
+ * Class BasicQueue is a functional example of a queue to be used with queueManager.
+ * @memberOf module:arrayHelpers
+ */
+declare class BasicQueue implements IsQueue<queuedItem> {
+    private readonly innerList;
+    constructor(innerList?: queuedItem[] | any);
+    /**
+     * Remove and return the next item in the queue
+     * @returns {queuedItem|*}
+     */
+    dequeue(): queuedItem | any;
+    /**
+     * Check if the queue is empty
+     * @returns {boolean}
+     */
+    empty(): boolean;
+    /**
+     * Add an item to the end of the queue
+     * @param {queuedItem|*} data
+     * @returns {BasicQueue}
+     */
+    enqueue(data: queuedItem | any): IsQueue<queuedItem>;
+    /**
+     * Retrieve the next item from the queue
+     * @returns {queuedItem|*}
+     */
+    peek(): queuedItem | any;
+    /**
+     * Get the quantity of items in the queue
+     * @returns {number}
+     */
+    size(): number;
+}
+export default BasicQueue;

package/dist/helpers/arrays/BasicQueue.js

@@ -0,0 +1,60 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+/**
+ * Class BasicQueue is a functional example of a queue to be used with queueManager.
+ * @memberOf module:arrayHelpers
+ */
+class BasicQueue {
+  constructor () {
+    const innerList = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
+    this.innerList = innerList
+  }
+
+  /**
+   * Remove and return the next item in the queue
+   * @returns {queuedItem|*}
+   */
+  dequeue () {
+    return this.innerList.shift()
+  }
+
+  /**
+   * Check if the queue is empty
+   * @returns {boolean}
+   */
+  empty () {
+    return !this.size()
+  }
+
+  /**
+   * Add an item to the end of the queue
+   * @param {queuedItem|*} data
+   * @returns {BasicQueue}
+   */
+  enqueue (data) {
+    this.innerList.push(data)
+    return this
+  }
+
+  /**
+   * Retrieve the next item from the queue
+   * @returns {queuedItem|*}
+   */
+  peek () {
+    return this.empty() ? null : this.innerList[0]
+  }
+
+  /**
+   * Get the quantity of items in the queue
+   * @returns {number}
+   */
+  size () {
+    return this.innerList.length
+  }
+}
+var _default = exports.default = BasicQueue

package/dist/helpers/arrays/BasicQueue.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");class BasicQueue{constructor(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.innerList=e}dequeue(){return this.innerList.shift()}empty(){return!this.size()}enqueue(e){return this.innerList.push(e),this}peek(){return this.empty()?null:this.innerList[0]}size(){return this.innerList.length}}var _default=exports.default=BasicQueue;

package/dist/helpers/arrays.d.ts

@@ -7,8 +7,10 @@
  * @memberOf module:siFunciona
  */
 import 'core-js/stable';
+import BasicQueue from './arrays/BasicQueue';
 declare const _default: {
     addUniqueToArray: (item: any, array: any[]) => any[];
+    BasicQueue: typeof BasicQueue;
     buildArray: (item: any, length: number) => any[];
     buildArrayOfReferences: (item: any, length: number) => any[];
     compareArrays: (...arrays: any[][]) => import("./arrays/compareArrays").compareArrayResultMap;

package/dist/helpers/arrays.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, '__esModule', {
 exports.default = void 0
 require('core-js/stable')
 var _addUniqueToArray = _interopRequireDefault(require('./arrays/addUniqueToArray'))
+var _BasicQueue = _interopRequireDefault(require('./arrays/BasicQueue'))
 var _buildArray = _interopRequireDefault(require('./arrays/buildArray'))
 var _buildArrayOfReferences = _interopRequireDefault(require('./arrays/buildArrayOfReferences'))
 var _compareArrays = _interopRequireDefault(require('./arrays/compareArrays'))
@@ -22,6 +23,7 @@ function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { d
  */
 var _default = exports.default = {
   addUniqueToArray: _addUniqueToArray.default,
+  BasicQueue: _BasicQueue.default,
   buildArray: _buildArray.default,
   buildArrayOfReferences: _buildArrayOfReferences.default,
   compareArrays: _compareArrays.default,

package/dist/helpers/arrays.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _addUniqueToArray=_interopRequireDefault(require("./arrays/addUniqueToArray")),_buildArray=_interopRequireDefault(require("./arrays/buildArray")),_buildArrayOfReferences=_interopRequireDefault(require("./arrays/buildArrayOfReferences")),_compareArrays=_interopRequireDefault(require("./arrays/compareArrays")),_mergeArrays=_interopRequireDefault(require("./arrays/mergeArrays")),_uniqueArray=_interopRequireDefault(require("./arrays/uniqueArray"));function _interopRequireDefault(r){return r&&r.__esModule?r:{default:r}}var _default=exports.default={addUniqueToArray:_addUniqueToArray.default,buildArray:_buildArray.default,buildArrayOfReferences:_buildArrayOfReferences.default,compareArrays:_compareArrays.default,mergeArrays:_mergeArrays.default,uniqueArray:_uniqueArray.default};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _addUniqueToArray=_interopRequireDefault(require("./arrays/addUniqueToArray")),_BasicQueue=_interopRequireDefault(require("./arrays/BasicQueue")),_buildArray=_interopRequireDefault(require("./arrays/buildArray")),_buildArrayOfReferences=_interopRequireDefault(require("./arrays/buildArrayOfReferences")),_compareArrays=_interopRequireDefault(require("./arrays/compareArrays")),_mergeArrays=_interopRequireDefault(require("./arrays/mergeArrays")),_uniqueArray=_interopRequireDefault(require("./arrays/uniqueArray"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default=exports.default={addUniqueToArray:_addUniqueToArray.default,BasicQueue:_BasicQueue.default,buildArray:_buildArray.default,buildArrayOfReferences:_buildArrayOfReferences.default,compareArrays:_compareArrays.default,mergeArrays:_mergeArrays.default,uniqueArray:_uniqueArray.default};

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

@@ -0,0 +1,10 @@
+import 'core-js/stable';
+import { IsQueue, queuedItem } from '../arrays/BasicQueue';
+/**
+ * Create an instance of a basic queue.
+ * @memberOf module:functionHelpers
+ * @param {Array} initialQueue
+ * @returns {IsQueue}
+ */
+declare const makeBasicQueue: (initialQueue?: queuedItem[] | any) => IsQueue<any>;
+export default makeBasicQueue;

package/dist/helpers/functions/makeBasicQueue.js

@@ -0,0 +1,20 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _BasicQueue = _interopRequireDefault(require('../arrays/BasicQueue'))
+function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
+/**
+ * Create an instance of a basic queue.
+ * @memberOf module:functionHelpers
+ * @param {Array} initialQueue
+ * @returns {IsQueue}
+ */
+const makeBasicQueue = function () {
+  const initialQueue = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
+  return new _BasicQueue.default(initialQueue)
+}
+var _default = exports.default = makeBasicQueue

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _BasicQueue=_interopRequireDefault(require("../arrays/BasicQueue"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}const makeBasicQueue=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];return new _BasicQueue.default(e)};var _default=exports.default=makeBasicQueue;

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

@@ -1,5 +1,6 @@
 import 'core-js/stable';
 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
@@ -9,20 +10,12 @@ import 'regenerator-runtime/runtime';
  * @returns {Promise}
  */
 export type queueManagerHandle = (fn: Function, ...args: any) => Promise<any>;
-type callableLater = {
-    fn?: Function;
-    args?: Array<any>;
-};
-export type queuedItem = {
-    item: callableLater;
-    generator: Generator;
-};
 /**
  * Manage functions to run sequentially.
  * @function
  * @memberOf module:functionHelpers
- * @param {Iterable|array} [queue=[]] - The iterable that can be used to store queued functions
+ * @param {IsQueue} [queue=[]] - The iterable that can be used to store queued functions
  * @returns {module:functionHelpers~queueManagerHandle}
  */
-declare const queueManager: (queue?: Array<queuedItem>) => queueManagerHandle;
+declare const queueManager: (queue?: IsQueue<queuedItem>) => queueManagerHandle;
 export default queueManager;

package/dist/helpers/functions/queueManager.js

@@ -6,25 +6,36 @@ Object.defineProperty(exports, '__esModule', {
 exports.default = void 0
 require('core-js/stable')
 require('regenerator-runtime/runtime')
+var _makeBasicQueue = _interopRequireDefault(require('./makeBasicQueue'))
+function _interopRequireDefault (obj) { return obj && obj.__esModule ? obj : { default: obj } }
 /**
  * Manage functions to run sequentially.
  * @function
  * @memberOf module:functionHelpers
- * @param {Iterable|array} [queue=[]] - The iterable that can be used to store queued functions
+ * @param {IsQueue} [queue=[]] - The iterable that can be used to store queued functions
  * @returns {module:functionHelpers~queueManagerHandle}
  */
 const queueManager = function () {
-  const queue = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []
+  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]
     }
     const runNextItem = () => {
-      if (queue.length && !isRunning) {
+      if (!queue.empty() && !isRunning) {
         isRunning = true
-        const toRun = queue.shift()
-        toRun.generator.next(toRun.item)
+        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)
+        }
       }
       return queue
     }
@@ -34,7 +45,7 @@ const queueManager = function () {
         return typeof item.fn === 'function' ? resolve(item.fn(...item.args)) : reject(item)
       }())
       generator.next()
-      queue.push({
+      queue.enqueue({
         item: {
           fn: fn,
           args: args

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");const queueManager=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],t=!1;return function(r){for(var n=arguments.length,o=new Array(n>1?n-1:0),u=1;u<n;u++)o[u-1]=arguments[u];const i=()=>{if(e.length&&!t){t=!0;const r=e.shift();r.generator.next(r.item)}return e};return new Promise(((t,n)=>{const u=function*(){const e=yield;return"function"==typeof e.fn?t(e.fn(...e.args)):n(e)}();u.next(),e.push({item:{fn:r,args:o},generator:u}),i()})).then((e=>(t=!1,i(),e)))}};var _default=exports.default=queueManager;
+"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;

package/dist/helpers/functions.d.ts

@@ -14,10 +14,11 @@ declare const _default: {
         resolver: Promise<any>;
         cancel: () => void;
     };
+    makeBasicQueue: (initialQueue?: any) => import("./arrays/BasicQueue").IsQueue<any>;
     onBodyLoad: (callback: Function, reset?: boolean) => Function[];
     pipe: (...fns: Function[]) => any;
     preloadParams: (fn: Function, params?: any[], unassignedParam?: number) => (missing: any) => any;
-    queueManager: (queue?: import("./functions/queueManager").queuedItem[]) => import("./functions/queueManager").queueManagerHandle;
+    queueManager: (queue?: import("./arrays/BasicQueue").IsQueue<import("./arrays/BasicQueue").queuedItem>) => import("./functions/queueManager").queueManagerHandle;
     queueTimeout: (queueManagerHandle?: import("./functions/queueManager").queueManagerHandle) => (fn: Function, time: number, ...args: any) => Promise<any>;
     relevancyFilter: (map: import("./functions/relevancyFilter").relevanceMap, { mapLimit, relevancyRange }?: {
         mapLimit?: number;

package/dist/helpers/functions.js

@@ -8,6 +8,7 @@ require('core-js/stable')
 var _callWithParams = _interopRequireDefault(require('./functions/callWithParams'))
 var _curry = _interopRequireDefault(require('./functions/curry'))
 var _delay = _interopRequireDefault(require('./functions/delay'))
+var _makeBasicQueue = _interopRequireDefault(require('./functions/makeBasicQueue'))
 var _onBodyLoad = _interopRequireDefault(require('./functions/onBodyLoad'))
 var _pipe = _interopRequireDefault(require('./functions/pipe'))
 var _preloadParams = _interopRequireDefault(require('./functions/preloadParams'))
@@ -28,6 +29,7 @@ var _default = exports.default = {
   callWithParams: _callWithParams.default,
   curry: _curry.default,
   delay: _delay.default,
+  makeBasicQueue: _makeBasicQueue.default,
   onBodyLoad: _onBodyLoad.default,
   pipe: _pipe.default,
   preloadParams: _preloadParams.default,

package/dist/helpers/functions.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _callWithParams=_interopRequireDefault(require("./functions/callWithParams")),_curry=_interopRequireDefault(require("./functions/curry")),_delay=_interopRequireDefault(require("./functions/delay")),_onBodyLoad=_interopRequireDefault(require("./functions/onBodyLoad")),_pipe=_interopRequireDefault(require("./functions/pipe")),_preloadParams=_interopRequireDefault(require("./functions/preloadParams")),_queueManager=_interopRequireDefault(require("./functions/queueManager")),_queueTimeout=_interopRequireDefault(require("./functions/queueTimeout")),_relevancyFilter=_interopRequireDefault(require("./functions/relevancyFilter")),_trace=_interopRequireDefault(require("./functions/trace"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default=exports.default={callWithParams:_callWithParams.default,curry:_curry.default,delay:_delay.default,onBodyLoad:_onBodyLoad.default,pipe:_pipe.default,preloadParams:_preloadParams.default,queueManager:_queueManager.default,queueTimeout:_queueTimeout.default,relevancyFilter:_relevancyFilter.default,trace:_trace.default};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0,require("core-js/stable");var _callWithParams=_interopRequireDefault(require("./functions/callWithParams")),_curry=_interopRequireDefault(require("./functions/curry")),_delay=_interopRequireDefault(require("./functions/delay")),_makeBasicQueue=_interopRequireDefault(require("./functions/makeBasicQueue")),_onBodyLoad=_interopRequireDefault(require("./functions/onBodyLoad")),_pipe=_interopRequireDefault(require("./functions/pipe")),_preloadParams=_interopRequireDefault(require("./functions/preloadParams")),_queueManager=_interopRequireDefault(require("./functions/queueManager")),_queueTimeout=_interopRequireDefault(require("./functions/queueTimeout")),_relevancyFilter=_interopRequireDefault(require("./functions/relevancyFilter")),_trace=_interopRequireDefault(require("./functions/trace"));function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}var _default=exports.default={callWithParams:_callWithParams.default,curry:_curry.default,delay:_delay.default,makeBasicQueue:_makeBasicQueue.default,onBodyLoad:_onBodyLoad.default,pipe:_pipe.default,preloadParams:_preloadParams.default,queueManager:_queueManager.default,queueTimeout:_queueTimeout.default,relevancyFilter:_relevancyFilter.default,trace:_trace.default};

package/package.json

@@ -1,61 +1,61 @@
-{
-  "name": "si-funciona",
-  "author": "Joshua Heagle <joshuaheagle@gmail.com> (https://joshuaheagle.com)",
-  "description": "Funciones de utilidad para uso general. [General usage utility functions.]",
-  "homepage": "https://github.com/jheagle/si-funciona#readme",
-  "keywords": [
-    "functional",
-    "helpers",
-    "utility",
-    "funcional",
-    "ayudas",
-    "utilidades",
-    "general",
-    "typescript"
-  ],
-  "version": "2.0.4",
-  "license": "GPL-3.0-or-later",
-  "bugs": {
-    "url": "https://github.com/jheagle/si-funciona/issues"
-  },
-  "scripts": {
-    "build": "gulp build",
-    "dev": "gulp",
-    "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
-    "readme": "gulp readme",
-    "resolutions": "npx npm-force-resolutions",
-    "test": "gulp testFull",
-    "test:quick": "gulp testQuick",
-    "watch": "gulp watchFull",
-    "watch:test": "gulp watchTest"
-  },
-  "dependencies": {
-    "npm": "^10.2.0"
-  },
-  "devDependencies": {
-    "gulp": "^4.0.2",
-    "js-build-tools": "^2.2.8",
-    "jsdoc": "^4.0.2",
-    "standard": "^17.1.0"
-  },
-  "resolutions": {},
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/jheagle/si-funciona.git"
-  },
-  "main": "dist/main.min.js",
-  "types": "dist/main.js",
-  "files": [
-    "dist",
-    "browser"
-  ],
-  "funding": "https://www.paypal.com/donate/?business=LRYR6SZRWKXVY&no_recurring=0&item_name=Let%27s+build+together+today+to+simplify+our+jobs+tomorrow.&currency_code=CAD",
-  "standard": {
-    "env": [
-      "jest"
-    ]
-  },
-  "directories": {
-    "doc": "docs"
-  }
-}
+{
+  "name": "si-funciona",
+  "author": "Joshua Heagle <joshuaheagle@gmail.com> (https://joshuaheagle.com)",
+  "description": "Funciones de utilidad para uso general. [General usage utility functions.]",
+  "homepage": "https://github.com/jheagle/si-funciona#readme",
+  "keywords": [
+    "functional",
+    "helpers",
+    "utility",
+    "funcional",
+    "ayudas",
+    "utilidades",
+    "general",
+    "typescript"
+  ],
+  "version": "2.1.0",
+  "license": "GPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/jheagle/si-funciona/issues"
+  },
+  "scripts": {
+    "build": "gulp build",
+    "dev": "gulp",
+    "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
+    "readme": "gulp readme",
+    "resolutions": "npx npm-force-resolutions",
+    "test": "gulp testFull",
+    "test:quick": "gulp testQuick",
+    "watch": "gulp watchFull",
+    "watch:test": "gulp watchTest"
+  },
+  "dependencies": {
+    "npm": "^10.2.3"
+  },
+  "devDependencies": {
+    "gulp": "^4.0.2",
+    "js-build-tools": "^2.2.10",
+    "jsdoc": "^4.0.2",
+    "standard": "^17.1.0"
+  },
+  "resolutions": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jheagle/si-funciona.git"
+  },
+  "main": "dist/main.min.js",
+  "types": "dist/main.js",
+  "files": [
+    "dist",
+    "browser"
+  ],
+  "funding": "https://www.paypal.com/donate/?business=LRYR6SZRWKXVY&no_recurring=0&item_name=Let%27s+build+together+today+to+simplify+our+jobs+tomorrow.&currency_code=CAD",
+  "standard": {
+    "env": [
+      "jest"
+    ]
+  },
+  "directories": {
+    "doc": "docs"
+  }
+}