si-funciona 2.6.1 → 2.7.0

package/dist/helpers/arrays/compareArrays.js

@@ -1,96 +1,96 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.every.js')
-require('core-js/modules/esnext.iterator.map.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-const _isObject = _interopRequireDefault(require('../objects/isObject'))
-const _mergeArrays = _interopRequireDefault(require('./mergeArrays'))
-const _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Compare two Arrays and return the Object where the value for each property is as follows:
- * -1 to indicate val1 is less than val2
- * 0 to indicate both values are the equal
- * 1 to indicate val1 is greater than val2
- * The returned Object uses the element values as the property names
- * This functions works by first creating a concatenated array of all unique values. Then for each unique values,
- * convert to a string and use it as a new property name. Array filter each array checking if it has the unique value.
- * Use the lengths of these filtered arrays to compare. So if the first array has the value and the second one doesn't
- * the first length will be one or more and the second will be zero, if the both have the value then both will be one
- * or more.
- * @example
- * // example of input and resulting output
- * compareArrays(
- *   ['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1'],
- *   ['match1', 'match2', 'secondMismatch1', 'badMatch1', 'badMatch1']
- * )
- * // unique array
- * ['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1', 'secondMismatch1']
- * // result object
- * [
- *   {
- *     value: 'match1',
- *     keys: [[0], [0]],
- *     result: [0, 0]
- *   },
- *   {
- *     value: 'firstMismatch1',
- *     keys: [[1], []],
- *     result: [1, -1]
- *   },
- *   {
- *     value: 'match2',
- *     keys: [[2], [1]],
- *     result: [0, 0]
- *   },
- *   {
- *     value: 'firstMismatch2',
- *     keys: [[3], []],
- *     result: [1, -1]
- *   },
- *   {
- *     value: 'badMatch1',
- *     keys: [[4], [3, 4]],
- *     result: [0, 0]
- *   },
- *   {
- *     value: 'secondMismatch1',
- *     keys: [[], [2]],
- *     result: [-1, 1]
- *   }
- * ]
- *
- * @memberOf module:arrayHelpers
- * @param {...Array} arrays - The arrays to compare
- * @returns {Array.<module:arrayHelpers~compareArrayResult>}
- */
-const compareArrays = (...arrays) => (0, _mergeArrays.default)(...arrays).reduce((results, attr) => {
-  const attrType = typeof attr
-  const useArray = Array.isArray(attr)
-  const keys = arrays.map(array => array.reduce((results, current, key) => {
-    const currentType = typeof current
-    if (attrType !== currentType) {
-      return results
-    }
-    if (!(0, _isObject.default)(attr)) {
-      return current === attr ? [...results, key] : results
-    }
-    if (useArray !== Array.isArray(current)) {
-      return results
-    }
-    const compareKeys = useArray ? compareArrays(attr, current) : compareArrays((0, _objectKeys.default)(attr), (0, _objectKeys.default)(current))
-    return compareKeys.every(compare => compare.result.every(result => result === 0)) ? [...results, key] : results
-  }, []))
-  const arrayResults = keys.map(array => array.length ? 1 : -1)
-  return [...results, {
-    value: attr,
-    keys,
-    result: arrayResults.every(result => result === 1) ? arrayResults.map(result => 0) : arrayResults
-  }]
-}, [])
-const _default = exports.default = compareArrays
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.every.js')
+require('core-js/modules/esnext.iterator.map.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+const _isObject = _interopRequireDefault(require('../objects/isObject'))
+const _mergeArrays = _interopRequireDefault(require('./mergeArrays'))
+const _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Compare two Arrays and return the Object where the value for each property is as follows:
+ * -1 to indicate val1 is less than val2
+ * 0 to indicate both values are the equal
+ * 1 to indicate val1 is greater than val2
+ * The returned Object uses the element values as the property names
+ * This functions works by first creating a concatenated array of all unique values. Then for each unique values,
+ * convert to a string and use it as a new property name. Array filter each array checking if it has the unique value.
+ * Use the lengths of these filtered arrays to compare. So if the first array has the value and the second one doesn't
+ * the first length will be one or more and the second will be zero, if the both have the value then both will be one
+ * or more.
+ * @example
+ * // example of input and resulting output
+ * compareArrays(
+ *   ['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1'],
+ *   ['match1', 'match2', 'secondMismatch1', 'badMatch1', 'badMatch1']
+ * )
+ * // unique array
+ * ['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1', 'secondMismatch1']
+ * // result object
+ * [
+ *   {
+ *     value: 'match1',
+ *     keys: [[0], [0]],
+ *     result: [0, 0]
+ *   },
+ *   {
+ *     value: 'firstMismatch1',
+ *     keys: [[1], []],
+ *     result: [1, -1]
+ *   },
+ *   {
+ *     value: 'match2',
+ *     keys: [[2], [1]],
+ *     result: [0, 0]
+ *   },
+ *   {
+ *     value: 'firstMismatch2',
+ *     keys: [[3], []],
+ *     result: [1, -1]
+ *   },
+ *   {
+ *     value: 'badMatch1',
+ *     keys: [[4], [3, 4]],
+ *     result: [0, 0]
+ *   },
+ *   {
+ *     value: 'secondMismatch1',
+ *     keys: [[], [2]],
+ *     result: [-1, 1]
+ *   }
+ * ]
+ *
+ * @memberOf module:arrayHelpers
+ * @param {...Array} arrays - The arrays to compare
+ * @returns {Array.<module:arrayHelpers~compareArrayResult>}
+ */
+const compareArrays = (...arrays) => (0, _mergeArrays.default)(...arrays).reduce((results, attr) => {
+  const attrType = typeof attr
+  const useArray = Array.isArray(attr)
+  const keys = arrays.map(array => array.reduce((results, current, key) => {
+    const currentType = typeof current
+    if (attrType !== currentType) {
+      return results
+    }
+    if (!(0, _isObject.default)(attr)) {
+      return current === attr ? [...results, key] : results
+    }
+    if (useArray !== Array.isArray(current)) {
+      return results
+    }
+    const compareKeys = useArray ? compareArrays(attr, current) : compareArrays((0, _objectKeys.default)(attr), (0, _objectKeys.default)(current))
+    return compareKeys.every(compare => compare.result.every(result => result === 0)) ? [...results, key] : results
+  }, []))
+  const arrayResults = keys.map(array => array.length ? 1 : -1)
+  return [...results, {
+    value: attr,
+    keys,
+    result: arrayResults.every(result => result === 1) ? arrayResults.map(result => 0) : arrayResults
+  }]
+}, [])
+const _default = exports.default = compareArrays

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

@@ -1,9 +1,9 @@
-/**
- * Take multiple arrays and then filter all these into one unique array.
- * @memberOf module:arrayHelpers
- * @param {...Array} arrays - Provide multiple arrays to create one unique array
- * @returns {Array}
- */
-declare const mergeArrays: (...arrays: Array<Array<any>>) => Array<any>;
-export default mergeArrays;
+/**
+ * Take multiple arrays and then filter all these into one unique array.
+ * @memberOf module:arrayHelpers
+ * @param {...Array} arrays - Provide multiple arrays to create one unique array
+ * @returns {Array}
+ */
+declare const mergeArrays: (...arrays: Array<Array<any>>) => Array<any>;
+export default mergeArrays;
 //# sourceMappingURL=mergeArrays.d.ts.map

package/dist/helpers/arrays/mergeArrays.js

@@ -1,21 +1,21 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/es.array.includes.js')
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.filter.js')
-require('core-js/modules/esnext.iterator.map.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-const _uniqueArray = _interopRequireDefault(require('./uniqueArray'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Take multiple arrays and then filter all these into one unique array.
- * @memberOf module:arrayHelpers
- * @param {...Array} arrays - Provide multiple arrays to create one unique array
- * @returns {Array}
- */
-const mergeArrays = (...arrays) => arrays.map(_uniqueArray.default).reduce((merged, arr) => [...merged, ...arr.filter(attr => !merged.includes(attr))], [])
-const _default = exports.default = mergeArrays
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/es.array.includes.js')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.filter.js')
+require('core-js/modules/esnext.iterator.map.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+const _uniqueArray = _interopRequireDefault(require('./uniqueArray'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Take multiple arrays and then filter all these into one unique array.
+ * @memberOf module:arrayHelpers
+ * @param {...Array} arrays - Provide multiple arrays to create one unique array
+ * @returns {Array}
+ */
+const mergeArrays = (...arrays) => arrays.map(_uniqueArray.default).reduce((merged, arr) => [...merged, ...arr.filter(attr => !merged.includes(attr))], [])
+const _default = exports.default = mergeArrays

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

@@ -1,9 +1,9 @@
-/**
- * Remove duplicate values from an array. uniqueArray
- * @memberOf module:arrayHelpers
- * @param {Array} array - The array to make unique
- * @returns {Array}
- */
-declare const uniqueArray: (array: Array<any>) => Array<any>;
-export default uniqueArray;
+/**
+ * Remove duplicate values from an array. uniqueArray
+ * @memberOf module:arrayHelpers
+ * @param {Array} array - The array to make unique
+ * @returns {Array}
+ */
+declare const uniqueArray: (array: Array<any>) => Array<any>;
+export default uniqueArray;
 //# sourceMappingURL=uniqueArray.d.ts.map

package/dist/helpers/arrays/uniqueArray.js

@@ -1,16 +1,16 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.filter.js')
-/**
- * Remove duplicate values from an array. uniqueArray
- * @memberOf module:arrayHelpers
- * @param {Array} array - The array to make unique
- * @returns {Array}
- */
-const uniqueArray = array => array.filter((item, index) => array.indexOf(item) === index)
-const _default = exports.default = uniqueArray
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.filter.js')
+/**
+ * Remove duplicate values from an array. uniqueArray
+ * @memberOf module:arrayHelpers
+ * @param {Array} array - The array to make unique
+ * @returns {Array}
+ */
+const uniqueArray = array => array.filter((item, index) => array.indexOf(item) === index)
+const _default = exports.default = uniqueArray

package/dist/helpers/arrays.d.ts

@@ -1,28 +1,28 @@
-/**
- * Utilities for building, merging, deduplicating and comparing arrays, plus a basic FIFO queue (BasicQueue) for
- * use with functionHelpers' queueManager/queueTimeout.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module arrayHelpers
- * @memberOf module:siFunciona
- */
-import addUniqueToArray from './arrays/addUniqueToArray';
-import BasicQueue from './arrays/BasicQueue';
-import buildArray from './arrays/buildArray';
-import buildArrayOfReferences from './arrays/buildArrayOfReferences';
-import compareArrays from './arrays/compareArrays';
-import mergeArrays from './arrays/mergeArrays';
-import uniqueArray from './arrays/uniqueArray';
-export { addUniqueToArray, BasicQueue, buildArray, buildArrayOfReferences, compareArrays, mergeArrays, uniqueArray };
-declare const _default: {
-    addUniqueToArray: (item: any, array: Array<any>) => Array<any>;
-    BasicQueue: typeof BasicQueue;
-    buildArray: (item: any, length: number) => Array<any>;
-    buildArrayOfReferences: (item: any, length: number) => Array<any>;
-    compareArrays: (...arrays: Array<Array<any>>) => import("./arrays/compareArrays").compareArrayResultMap;
-    mergeArrays: (...arrays: Array<Array<any>>) => Array<any>;
-    uniqueArray: (array: Array<any>) => Array<any>;
-};
-export default _default;
+/**
+ * Utilities for building, merging, deduplicating and comparing arrays, plus a basic FIFO queue (BasicQueue) for
+ * use with functionHelpers' queueManager/queueTimeout.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module arrayHelpers
+ * @memberOf module:siFunciona
+ */
+import addUniqueToArray from './arrays/addUniqueToArray';
+import BasicQueue from './arrays/BasicQueue';
+import buildArray from './arrays/buildArray';
+import buildArrayOfReferences from './arrays/buildArrayOfReferences';
+import compareArrays from './arrays/compareArrays';
+import mergeArrays from './arrays/mergeArrays';
+import uniqueArray from './arrays/uniqueArray';
+export { addUniqueToArray, BasicQueue, buildArray, buildArrayOfReferences, compareArrays, mergeArrays, uniqueArray };
+declare const _default: {
+    addUniqueToArray: (item: any, array: Array<any>) => Array<any>;
+    BasicQueue: typeof BasicQueue;
+    buildArray: (item: any, length: number) => Array<any>;
+    buildArrayOfReferences: (item: any, length: number) => Array<any>;
+    compareArrays: (...arrays: Array<Array<any>>) => import("./arrays/compareArrays").compareArrayResultMap;
+    mergeArrays: (...arrays: Array<Array<any>>) => Array<any>;
+    uniqueArray: (array: Array<any>) => Array<any>;
+};
+export default _default;
 //# sourceMappingURL=arrays.d.ts.map

package/dist/helpers/arrays.js

@@ -1,74 +1,74 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-Object.defineProperty(exports, 'BasicQueue', {
-  enumerable: true,
-  get: function () {
-    return _BasicQueue.default
-  }
-})
-Object.defineProperty(exports, 'addUniqueToArray', {
-  enumerable: true,
-  get: function () {
-    return _addUniqueToArray.default
-  }
-})
-Object.defineProperty(exports, 'buildArray', {
-  enumerable: true,
-  get: function () {
-    return _buildArray.default
-  }
-})
-Object.defineProperty(exports, 'buildArrayOfReferences', {
-  enumerable: true,
-  get: function () {
-    return _buildArrayOfReferences.default
-  }
-})
-Object.defineProperty(exports, 'compareArrays', {
-  enumerable: true,
-  get: function () {
-    return _compareArrays.default
-  }
-})
-exports.default = void 0
-Object.defineProperty(exports, 'mergeArrays', {
-  enumerable: true,
-  get: function () {
-    return _mergeArrays.default
-  }
-})
-Object.defineProperty(exports, 'uniqueArray', {
-  enumerable: true,
-  get: function () {
-    return _uniqueArray.default
-  }
-})
-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'))
-var _mergeArrays = _interopRequireDefault(require('./arrays/mergeArrays'))
-var _uniqueArray = _interopRequireDefault(require('./arrays/uniqueArray'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Utilities for building, merging, deduplicating and comparing arrays, plus a basic FIFO queue (BasicQueue) for
- * use with functionHelpers' queueManager/queueTimeout.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module arrayHelpers
- * @memberOf module:siFunciona
- */
-const _default = exports.default = {
-  addUniqueToArray: _addUniqueToArray.default,
-  BasicQueue: _BasicQueue.default,
-  buildArray: _buildArray.default,
-  buildArrayOfReferences: _buildArrayOfReferences.default,
-  compareArrays: _compareArrays.default,
-  mergeArrays: _mergeArrays.default,
-  uniqueArray: _uniqueArray.default
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+Object.defineProperty(exports, 'BasicQueue', {
+  enumerable: true,
+  get: function () {
+    return _BasicQueue.default
+  }
+})
+Object.defineProperty(exports, 'addUniqueToArray', {
+  enumerable: true,
+  get: function () {
+    return _addUniqueToArray.default
+  }
+})
+Object.defineProperty(exports, 'buildArray', {
+  enumerable: true,
+  get: function () {
+    return _buildArray.default
+  }
+})
+Object.defineProperty(exports, 'buildArrayOfReferences', {
+  enumerable: true,
+  get: function () {
+    return _buildArrayOfReferences.default
+  }
+})
+Object.defineProperty(exports, 'compareArrays', {
+  enumerable: true,
+  get: function () {
+    return _compareArrays.default
+  }
+})
+exports.default = void 0
+Object.defineProperty(exports, 'mergeArrays', {
+  enumerable: true,
+  get: function () {
+    return _mergeArrays.default
+  }
+})
+Object.defineProperty(exports, 'uniqueArray', {
+  enumerable: true,
+  get: function () {
+    return _uniqueArray.default
+  }
+})
+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'))
+var _mergeArrays = _interopRequireDefault(require('./arrays/mergeArrays'))
+var _uniqueArray = _interopRequireDefault(require('./arrays/uniqueArray'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Utilities for building, merging, deduplicating and comparing arrays, plus a basic FIFO queue (BasicQueue) for
+ * use with functionHelpers' queueManager/queueTimeout.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module arrayHelpers
+ * @memberOf module:siFunciona
+ */
+const _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/descriptors/assignDescriptor.d.ts

@@ -1,14 +1,14 @@
-import { descriptor } from './samples/descriptor';
-/**
- * Apply one or more descriptors to an existing descriptor so that they represent a merged version of the descriptors.
- * Used to widen a descriptor as more differently-shaped objects are described into it (e.g. array elements of
- * different types), rather than replacing it outright.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} originalMap - The base descriptor to merge onto (not mutated - a
- * clone is merged and returned).
- * @param  {...module:objectDescriptors~descriptor} descriptors - One or more further descriptors to merge in.
- * @returns {module:objectDescriptors~descriptor} A new descriptor representing the merge of all of the above.
- */
-declare const assignDescriptor: (originalMap: descriptor, ...descriptors: Array<descriptor>) => descriptor;
-export default assignDescriptor;
+import { descriptor } from './samples/descriptor';
+/**
+ * Apply one or more descriptors to an existing descriptor so that they represent a merged version of the descriptors.
+ * Used to widen a descriptor as more differently-shaped objects are described into it (e.g. array elements of
+ * different types), rather than replacing it outright.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} originalMap - The base descriptor to merge onto (not mutated - a
+ * clone is merged and returned).
+ * @param  {...module:objectDescriptors~descriptor} descriptors - One or more further descriptors to merge in.
+ * @returns {module:objectDescriptors~descriptor} A new descriptor representing the merge of all of the above.
+ */
+declare const assignDescriptor: (originalMap: descriptor, ...descriptors: Array<descriptor>) => descriptor;
+export default assignDescriptor;
 //# sourceMappingURL=assignDescriptor.d.ts.map