si-funciona 2.3.4 → 2.4.0

package/dist/helpers/objects/dotNotate.d.ts

@@ -1,29 +1,29 @@
-import 'core-js/stable';
-export type dotNotateableItem = Array<any> | {
-    [k: string]: any;
-};
-/**
- * A string representing the full-path to a property in an object. Each depth of the path is separated by a period.
- * @example 'a.b.c'
- * @typedef {string} DotNotationString
- * @memberOf module:objectHelpers
- */
-export type dotNotationString = string;
-/**
- * An array or object where all properties have been flatted and keyed by a dot-notated string.
- * @typedef {Object.<DotNotationString, *>} DotNotatedObject
- * @memberOf module:objectHelpers
- */
-type dotNotatedObject = {
-    [k: dotNotationString]: any;
-};
-/**
- * Convert an array or object to a single dimensional associative array with dot notation.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to dot-notate
- * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
- * @returns {DotNotatedObject} The dot-notated object
- */
-declare const dotNotate: (arrayObject: object, retainObjects?: Array<dotNotationString>) => dotNotatedObject;
-export default dotNotate;
+import 'core-js/stable';
+export type dotNotateableItem = Array<any> | {
+    [k: string]: any;
+};
+/**
+ * A string representing the full-path to a property in an object. Each depth of the path is separated by a period.
+ * @example 'a.b.c'
+ * @typedef {string} DotNotationString
+ * @memberOf module:objectHelpers
+ */
+export type dotNotationString = string;
+/**
+ * An array or object where all properties have been flatted and keyed by a dot-notated string.
+ * @typedef {Object.<DotNotationString, *>} DotNotatedObject
+ * @memberOf module:objectHelpers
+ */
+type dotNotatedObject = {
+    [k: dotNotationString]: any;
+};
+/**
+ * Convert an array or object to a single dimensional associative array with dot notation.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {DotNotatedObject} The dot-notated object
+ */
+declare const dotNotate: (arrayObject: object, retainObjects?: Array<dotNotationString>) => dotNotatedObject;
+export default dotNotate;
 //# sourceMappingURL=dotNotate.d.ts.map

package/dist/helpers/objects/dotNotate.js

@@ -1,80 +1,80 @@
-'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.map.js')
-require('core-js/stable')
-var _isObject = _interopRequireDefault(require('./isObject'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Convert an array of keys into a regex, return a function to test if incoming keys match.
- * @inner
- * @memberOf module:objectHelpers
- * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
- * @returns {Function} The dot-notated array
- */
-const handleRetainObjects = (retainObjects = []) => {
-  if (!retainObjects.length) {
-    /**
-     * Bypass the test function if there are no retainObjects.
-     * @returns {false}
-     */
-    return (currentKey, value, results) => false
-  }
-  retainObjects = retainObjects.map(key => key.replace('\.', '\\.'))
-  const retainRegex = new RegExp(`(${retainObjects.join('|')})$`)
-  /**
-   * Test if a key should be retained as an object.
-   * @param {string} currentKey - The key to test
-   * @param {*} value - The value of the key
-   * @param {Object} results - The results object to add to
-   * @returns {boolean}
-   */
-  return (currentKey, value, results) => {
-    if (!currentKey.match(retainRegex)) {
-      return false
-    }
-    // @ts-ignore
-    results[currentKey] = value
-    return true
-  }
-}
-/**
- * The underlying logic function for converting arrays to dot-notation.
- * @inner
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to dot-notate
- * @param {Function} didRetain - The test function to see if a key should be retained
- * @param {DotNotationString} [prepend=''] - The path for the property being processed
- * @param {DotNotatedObject} [results={}] - The final array to return
- * @returns {DotNotatedObject} The dot-notated object
- */
-const performDotNotate = (arrayObject, didRetain, prepend = '', results = {}) => {
-  // @ts-ignore
-  for (const key in arrayObject) {
-    // @ts-ignore
-    const value = arrayObject[key]
-    const currentKey = `${prepend}${key}`
-    if (didRetain(currentKey, value, results)) {
-      continue
-    }
-    if ((0, _isObject.default)(value)) {
-      performDotNotate(value, didRetain, `${currentKey}.`, results)
-      continue
-    }
-    results[currentKey] = value
-  }
-  return results
-}
-/**
- * Convert an array or object to a single dimensional associative array with dot notation.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to dot-notate
- * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
- * @returns {DotNotatedObject} The dot-notated object
- */
-const dotNotate = (arrayObject, retainObjects = []) => performDotNotate(arrayObject, handleRetainObjects(retainObjects))
-var _default = exports.default = dotNotate
+'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.map.js')
+require('core-js/stable')
+var _isObject = _interopRequireDefault(require('./isObject'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Convert an array of keys into a regex, return a function to test if incoming keys match.
+ * @inner
+ * @memberOf module:objectHelpers
+ * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {Function} The dot-notated array
+ */
+const handleRetainObjects = (retainObjects = []) => {
+  if (!retainObjects.length) {
+    /**
+     * Bypass the test function if there are no retainObjects.
+     * @returns {false}
+     */
+    return (currentKey, value, results) => false
+  }
+  retainObjects = retainObjects.map(key => key.replace('\.', '\\.'))
+  const retainRegex = new RegExp(`(${retainObjects.join('|')})$`)
+  /**
+   * Test if a key should be retained as an object.
+   * @param {string} currentKey - The key to test
+   * @param {*} value - The value of the key
+   * @param {Object} results - The results object to add to
+   * @returns {boolean}
+   */
+  return (currentKey, value, results) => {
+    if (!currentKey.match(retainRegex)) {
+      return false
+    }
+    // @ts-ignore
+    results[currentKey] = value
+    return true
+  }
+}
+/**
+ * The underlying logic function for converting arrays to dot-notation.
+ * @inner
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Function} didRetain - The test function to see if a key should be retained
+ * @param {DotNotationString} [prepend=''] - The path for the property being processed
+ * @param {DotNotatedObject} [results={}] - The final array to return
+ * @returns {DotNotatedObject} The dot-notated object
+ */
+const performDotNotate = (arrayObject, didRetain, prepend = '', results = {}) => {
+  // @ts-ignore
+  for (const key in arrayObject) {
+    // @ts-ignore
+    const value = arrayObject[key]
+    const currentKey = `${prepend}${key}`
+    if (didRetain(currentKey, value, results)) {
+      continue
+    }
+    if ((0, _isObject.default)(value)) {
+      performDotNotate(value, didRetain, `${currentKey}.`, results)
+      continue
+    }
+    results[currentKey] = value
+  }
+  return results
+}
+/**
+ * Convert an array or object to a single dimensional associative array with dot notation.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Array.<DotNotationString>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {DotNotatedObject} The dot-notated object
+ */
+const dotNotate = (arrayObject, retainObjects = []) => performDotNotate(arrayObject, handleRetainObjects(retainObjects))
+var _default = exports.default = dotNotate

package/dist/helpers/objects/dotSet.d.ts

@@ -1,13 +1,13 @@
-import 'core-js/stable';
-import { dotNotateableItem, dotNotationString } from './dotNotate';
-/**
- * Set a nested property value an object.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to set the property on
- * @param {string} dotNotation - The path for the property
- * @param {*} value - The default value to return if the property is not found
- * @returns {Object} The modified object
- */
-declare const dotSet: (arrayObject: dotNotateableItem, dotNotation: dotNotationString, value?: any) => dotNotateableItem;
-export default dotSet;
+import 'core-js/stable';
+import { dotNotateableItem, dotNotationString } from './dotNotate';
+/**
+ * Set a nested property value an object.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to set the property on
+ * @param {string} dotNotation - The path for the property
+ * @param {*} value - The default value to return if the property is not found
+ * @returns {Object} The modified object
+ */
+declare const dotSet: (arrayObject: dotNotateableItem, dotNotation: dotNotationString, value?: any) => dotNotateableItem;
+export default dotSet;
 //# sourceMappingURL=dotSet.d.ts.map

package/dist/helpers/objects/dotSet.js

@@ -1,54 +1,54 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _isObject = _interopRequireDefault(require('./isObject'))
-var _strAfter = _interopRequireDefault(require('../strings/strAfter'))
-var _strBefore = _interopRequireDefault(require('../strings/strBefore'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Set a nested property value an object.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to set the property on
- * @param {string} dotNotation - The path for the property
- * @param {*} value - The default value to return if the property is not found
- * @returns {Object} The modified object
- */
-const dotSet = (arrayObject, dotNotation, value = null) => {
-  var _a
-  let key = (0, _strBefore.default)(dotNotation, '.')
-  const lastKey = !key
-  if (lastKey) {
-    key = dotNotation
-  }
-  if (key === '*') {
-    for (const wildKey in arrayObject) {
-      if (lastKey) {
-        // @ts-ignore
-        arrayObject[wildKey] = value
-        continue
-      }
-      // @ts-ignore
-      if (!(0, _isObject.default)(arrayObject[wildKey])) {
-        continue
-      }
-      // @ts-ignore
-      dotSet(arrayObject[wildKey], (0, _strAfter.default)(dotNotation, '.'), value)
-    }
-    return arrayObject
-  }
-  if (lastKey) {
-    // @ts-ignore
-    arrayObject[dotNotation] = value
-    return arrayObject
-  }
-  // @ts-ignore
-  const next = (_a = arrayObject[key]) !== null && _a !== void 0 ? _a : []
-  // @ts-ignore
-  arrayObject[key] = dotSet(next, (0, _strAfter.default)(dotNotation, '.'), value)
-  return arrayObject
-}
-var _default = exports.default = dotSet
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _isObject = _interopRequireDefault(require('./isObject'))
+var _strAfter = _interopRequireDefault(require('../strings/strAfter'))
+var _strBefore = _interopRequireDefault(require('../strings/strBefore'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Set a nested property value an object.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to set the property on
+ * @param {string} dotNotation - The path for the property
+ * @param {*} value - The default value to return if the property is not found
+ * @returns {Object} The modified object
+ */
+const dotSet = (arrayObject, dotNotation, value = null) => {
+  var _a
+  let key = (0, _strBefore.default)(dotNotation, '.')
+  const lastKey = !key
+  if (lastKey) {
+    key = dotNotation
+  }
+  if (key === '*') {
+    for (const wildKey in arrayObject) {
+      if (lastKey) {
+        // @ts-ignore
+        arrayObject[wildKey] = value
+        continue
+      }
+      // @ts-ignore
+      if (!(0, _isObject.default)(arrayObject[wildKey])) {
+        continue
+      }
+      // @ts-ignore
+      dotSet(arrayObject[wildKey], (0, _strAfter.default)(dotNotation, '.'), value)
+    }
+    return arrayObject
+  }
+  if (lastKey) {
+    // @ts-ignore
+    arrayObject[dotNotation] = value
+    return arrayObject
+  }
+  // @ts-ignore
+  const next = (_a = arrayObject[key]) !== null && _a !== void 0 ? _a : []
+  // @ts-ignore
+  arrayObject[key] = dotSet(next, (0, _strAfter.default)(dotNotation, '.'), value)
+  return arrayObject
+}
+var _default = exports.default = dotSet

package/dist/helpers/objects/dotUnset.d.ts

@@ -1,12 +1,12 @@
-import 'core-js/stable';
-import { dotNotateableItem, dotNotationString } from './dotNotate';
-/**
- * Unset a nested property value an object.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to set the property on
- * @param {string} dotNotation - The path for the property
- * @returns {Object} The modified object
- */
-declare const dotUnset: (arrayObject: dotNotateableItem, dotNotation: dotNotationString) => dotNotateableItem;
-export default dotUnset;
+import 'core-js/stable';
+import { dotNotateableItem, dotNotationString } from './dotNotate';
+/**
+ * Unset a nested property value an object.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to set the property on
+ * @param {string} dotNotation - The path for the property
+ * @returns {Object} The modified object
+ */
+declare const dotUnset: (arrayObject: dotNotateableItem, dotNotation: dotNotationString) => dotNotateableItem;
+export default dotUnset;
 //# sourceMappingURL=dotUnset.d.ts.map

package/dist/helpers/objects/dotUnset.js

@@ -1,53 +1,53 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _isObject = _interopRequireDefault(require('./isObject'))
-var _strAfter = _interopRequireDefault(require('../strings/strAfter'))
-var _strBefore = _interopRequireDefault(require('../strings/strBefore'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Unset a nested property value an object.
- * @memberOf module:objectHelpers
- * @param {Object} arrayObject - The array or object to set the property on
- * @param {string} dotNotation - The path for the property
- * @returns {Object} The modified object
- */
-const dotUnset = (arrayObject, dotNotation) => {
-  var _a
-  let key = (0, _strBefore.default)(dotNotation, '.')
-  const lastKey = !key
-  if (lastKey) {
-    key = dotNotation
-  }
-  if (key === '*') {
-    for (const wildKey in arrayObject) {
-      if (lastKey) {
-        // @ts-ignore
-        delete arrayObject[wildKey]
-        continue
-      }
-      // @ts-ignore
-      if (!(0, _isObject.default)(arrayObject[wildKey])) {
-        continue
-      }
-      // @ts-ignore
-      dotUnset(arrayObject[wildKey], (0, _strAfter.default)(dotNotation, '.'))
-    }
-    return arrayObject
-  }
-  if (lastKey) {
-    // @ts-ignore
-    delete arrayObject[dotNotation]
-    return arrayObject
-  }
-  // @ts-ignore
-  const next = (_a = arrayObject[key]) !== null && _a !== void 0 ? _a : []
-  // @ts-ignore
-  arrayObject[key] = dotUnset(next, (0, _strAfter.default)(dotNotation, '.'))
-  return arrayObject
-}
-var _default = exports.default = dotUnset
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _isObject = _interopRequireDefault(require('./isObject'))
+var _strAfter = _interopRequireDefault(require('../strings/strAfter'))
+var _strBefore = _interopRequireDefault(require('../strings/strBefore'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Unset a nested property value an object.
+ * @memberOf module:objectHelpers
+ * @param {Object} arrayObject - The array or object to set the property on
+ * @param {string} dotNotation - The path for the property
+ * @returns {Object} The modified object
+ */
+const dotUnset = (arrayObject, dotNotation) => {
+  var _a
+  let key = (0, _strBefore.default)(dotNotation, '.')
+  const lastKey = !key
+  if (lastKey) {
+    key = dotNotation
+  }
+  if (key === '*') {
+    for (const wildKey in arrayObject) {
+      if (lastKey) {
+        // @ts-ignore
+        delete arrayObject[wildKey]
+        continue
+      }
+      // @ts-ignore
+      if (!(0, _isObject.default)(arrayObject[wildKey])) {
+        continue
+      }
+      // @ts-ignore
+      dotUnset(arrayObject[wildKey], (0, _strAfter.default)(dotNotation, '.'))
+    }
+    return arrayObject
+  }
+  if (lastKey) {
+    // @ts-ignore
+    delete arrayObject[dotNotation]
+    return arrayObject
+  }
+  // @ts-ignore
+  const next = (_a = arrayObject[key]) !== null && _a !== void 0 ? _a : []
+  // @ts-ignore
+  arrayObject[key] = dotUnset(next, (0, _strAfter.default)(dotNotation, '.'))
+  return arrayObject
+}
+var _default = exports.default = dotUnset

package/dist/helpers/objects/emptyObject.d.ts

@@ -1,10 +1,10 @@
-import 'core-js/stable';
-/**
- * Helper function for testing if the item is an Object or Array that does not have any properties
- * @memberOf module:objectHelpers
- * @param {Object|Array} item - Object or Array to test
- * @returns {boolean}
- */
-declare const emptyObject: (item: Array<any> | Object) => boolean;
-export default emptyObject;
+import 'core-js/stable';
+/**
+ * Helper function for testing if the item is an Object or Array that does not have any properties
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} item - Object or Array to test
+ * @returns {boolean}
+ */
+declare const emptyObject: (item: Array<any> | Object) => boolean;
+export default emptyObject;
 //# sourceMappingURL=emptyObject.d.ts.map

package/dist/helpers/objects/emptyObject.js

@@ -1,18 +1,18 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _isObject = _interopRequireDefault(require('./isObject'))
-var _objectKeys = _interopRequireDefault(require('./objectKeys'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Helper function for testing if the item is an Object or Array that does not have any properties
- * @memberOf module:objectHelpers
- * @param {Object|Array} item - Object or Array to test
- * @returns {boolean}
- */
-const emptyObject = item => (typeof item === 'function' || (0, _isObject.default)(item)) && !(0, _objectKeys.default)(item).length
-var _default = exports.default = emptyObject
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _isObject = _interopRequireDefault(require('./isObject'))
+var _objectKeys = _interopRequireDefault(require('./objectKeys'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Helper function for testing if the item is an Object or Array that does not have any properties
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} item - Object or Array to test
+ * @returns {boolean}
+ */
+const emptyObject = item => (typeof item === 'function' || (0, _isObject.default)(item)) && !(0, _objectKeys.default)(item).length
+var _default = exports.default = emptyObject

package/dist/helpers/objects/filterObject.d.ts

@@ -1,28 +1,28 @@
-import 'core-js/stable';
-type filterableItem = Array<any> | {
-    [k: number | string]: any;
-};
-/**
- * Function is a predicate, to test each property value of the object. Return true to keep the element, false
- * otherwise, taking three arguments
- * @callback module:objectHelpers~filterCallback
- * @memberOf module:objectHelpers
- * @param {*} currentProperty - The current property being processed in the object.
- * @param {string} [currentIndex] - The property name of the current property being processed in the object.
- * @param {Object|Array} [object] - The object filter was called upon.
- * @returns {boolean}
- */
-type filterCallback = (currentProperty: any, currentIndex: keyof filterableItem, object: filterableItem) => boolean;
-/**
- * This function is intended to replicate behaviour of the Array.filter() function but for Objects.
- * If an array is passed in instead then it will perform standard filter(). It is recommended to
- * always use the standard filter() function when it is known that the object is actually an array.
- * @memberOf module:objectHelpers
- * @param {Object|Array} obj - The Object (or Array) to be filtered
- * @param {module:objectHelpers~filterCallback|Function} fn - The function to be processed for each filtered property
- * @param {Object|Array} [thisArg] - Optional. Value to use as this when executing callback.
- * @returns {Object|Array}
- */
-declare const filterObject: (obj: filterableItem, fn: filterCallback, thisArg?: filterableItem) => filterableItem;
-export default filterObject;
+import 'core-js/stable';
+type filterableItem = Array<any> | {
+    [k: number | string]: any;
+};
+/**
+ * Function is a predicate, to test each property value of the object. Return true to keep the element, false
+ * otherwise, taking three arguments
+ * @callback module:objectHelpers~filterCallback
+ * @memberOf module:objectHelpers
+ * @param {*} currentProperty - The current property being processed in the object.
+ * @param {string} [currentIndex] - The property name of the current property being processed in the object.
+ * @param {Object|Array} [object] - The object filter was called upon.
+ * @returns {boolean}
+ */
+type filterCallback = (currentProperty: any, currentIndex: keyof filterableItem, object: filterableItem) => boolean;
+/**
+ * This function is intended to replicate behaviour of the Array.filter() function but for Objects.
+ * If an array is passed in instead then it will perform standard filter(). It is recommended to
+ * always use the standard filter() function when it is known that the object is actually an array.
+ * @memberOf module:objectHelpers
+ * @param {Object|Array} obj - The Object (or Array) to be filtered
+ * @param {module:objectHelpers~filterCallback|Function} fn - The function to be processed for each filtered property
+ * @param {Object|Array} [thisArg] - Optional. Value to use as this when executing callback.
+ * @returns {Object|Array}
+ */
+declare const filterObject: (obj: filterableItem, fn: filterCallback, thisArg?: filterableItem) => filterableItem;
+export default filterObject;
 //# sourceMappingURL=filterObject.d.ts.map