@koine/utils 2.0.0-beta.82 → 2.0.0-beta.83

package/isServerNow.esm.js

@@ -1,6 +1,9 @@
 import { isUndefined } from './isUndefined.esm.js';
 import './getType.esm.js';
 
-let isServerNow=()=>isUndefined(window);
+/**
+ * @category ssr
+ * @category is
+ */let isServerNow=()=>isUndefined(window);
 
 export { isServerNow as default, isServerNow };

package/isSet.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isSet=t=>"Set"===getType.getType(t);
+/**
+ * Returns whether the payload is a Set
+ *
+ * @category is
+ */let isSet=t=>"Set"===getType.getType(t);
 
 exports["default"] = isSet;
 exports.isSet = isSet;

package/isSet.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isSet=t=>"Set"===getType(t);
+/**
+ * Returns whether the payload is a Set
+ *
+ * @category is
+ */let isSet=t=>"Set"===getType(t);
 
 export { isSet as default, isSet };

package/isString.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isString=r=>"String"===getType.getType(r);
+/**
+ * Returns whether the payload is a string
+ *
+ * @category is
+ */let isString=r=>"String"===getType.getType(r);
 
 exports["default"] = isString;
 exports.isString = isString;

package/isString.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isString=r=>"String"===getType(r);
+/**
+ * Returns whether the payload is a string
+ *
+ * @category is
+ */let isString=r=>"String"===getType(r);
 
 export { isString as default, isString };

package/isSymbol.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isSymbol=e=>"Symbol"===getType.getType(e);
+/**
+ * Returns whether the payload is a Symbol
+ *
+ * @category is
+ */let isSymbol=e=>"Symbol"===getType.getType(e);
 
 exports["default"] = isSymbol;
 exports.isSymbol = isSymbol;

package/isSymbol.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isSymbol=e=>"Symbol"===getType(e);
+/**
+ * Returns whether the payload is a Symbol
+ *
+ * @category is
+ */let isSymbol=e=>"Symbol"===getType(e);
 
 export { isSymbol as default, isSymbol };

package/isType.cjs.js

@@ -4,7 +4,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isType=(e,r)=>{if(!(r instanceof Function))throw TypeError("Type must be a function");if(!Object.prototype.hasOwnProperty.call(r,"prototype"))throw TypeError("Type is not a class");let o=r.name;return getType.getType(e)===o||!!(e&&e.constructor===r)};
+/**
+ * Does a generic check to check that the given payload is of a given type.
+ * In cases like Number, it will return true for NaN as NaN is a Number (thanks javascript!);
+ * It will, however, differentiate between object and null
+ *
+ * @category is
+ * @throws {TypeError} Will throw type error if type is an invalid type
+ */let isType=(e,r)=>{if(!(r instanceof Function))throw TypeError("Type must be a function");if(!Object.prototype.hasOwnProperty.call(r,"prototype"))throw TypeError("Type is not a class");// Classes usually have names (as functions usually have names)
+let o=r.name;return getType.getType(e)===o||!!(e&&e.constructor===r)};
 
 exports["default"] = isType;
 exports.isType = isType;

package/isType.esm.js

@@ -1,5 +1,13 @@
 import { getType } from './getType.esm.js';
 
-let isType=(e,r)=>{if(!(r instanceof Function))throw TypeError("Type must be a function");if(!Object.prototype.hasOwnProperty.call(r,"prototype"))throw TypeError("Type is not a class");let o=r.name;return getType(e)===o||!!(e&&e.constructor===r)};
+/**
+ * Does a generic check to check that the given payload is of a given type.
+ * In cases like Number, it will return true for NaN as NaN is a Number (thanks javascript!);
+ * It will, however, differentiate between object and null
+ *
+ * @category is
+ * @throws {TypeError} Will throw type error if type is an invalid type
+ */let isType=(e,r)=>{if(!(r instanceof Function))throw TypeError("Type must be a function");if(!Object.prototype.hasOwnProperty.call(r,"prototype"))throw TypeError("Type is not a class");// Classes usually have names (as functions usually have names)
+let o=r.name;return getType(e)===o||!!(e&&e.constructor===r)};
 
 export { isType as default, isType };

package/isUndefined.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isUndefined=d=>"Undefined"===getType.getType(d);
+/**
+ * Returns whether the payload is undefined
+ *
+ * @category is
+ */let isUndefined=d=>"Undefined"===getType.getType(d);
 
 exports["default"] = isUndefined;
 exports.isUndefined = isUndefined;

package/isUndefined.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isUndefined=d=>"Undefined"===getType(d);
+/**
+ * Returns whether the payload is undefined
+ *
+ * @category is
+ */let isUndefined=d=>"Undefined"===getType(d);
 
 export { isUndefined as default, isUndefined };

package/isWeakMap.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isWeakMap=a=>"WeakMap"===getType.getType(a);
+/**
+ * Returns whether the payload is a WeakMap
+ *
+ * @category is
+ */let isWeakMap=a=>"WeakMap"===getType.getType(a);
 
 exports["default"] = isWeakMap;
 exports.isWeakMap = isWeakMap;

package/isWeakMap.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isWeakMap=a=>"WeakMap"===getType(a);
+/**
+ * Returns whether the payload is a WeakMap
+ *
+ * @category is
+ */let isWeakMap=a=>"WeakMap"===getType(a);
 
 export { isWeakMap as default, isWeakMap };

package/isWeakSet.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var getType = require('./getType.cjs.js');
 
-let isWeakSet=t=>"WeakSet"===getType.getType(t);
+/**
+ * Returns whether the payload is a WeakSet
+ *
+ * @category is
+ */let isWeakSet=t=>"WeakSet"===getType.getType(t);
 
 exports["default"] = isWeakSet;
 exports.isWeakSet = isWeakSet;

package/isWeakSet.esm.js

@@ -1,5 +1,9 @@
 import { getType } from './getType.esm.js';
 
-let isWeakSet=t=>"WeakSet"===getType(t);
+/**
+ * Returns whether the payload is a WeakSet
+ *
+ * @category is
+ */let isWeakSet=t=>"WeakSet"===getType(t);
 
 export { isWeakSet as default, isWeakSet };

package/kbToBytes.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let kbToBytes=e=>1e3*e;
+/**
+ * Kilobytes to bytes
+ *
+ * @category format
+ */let kbToBytes=e=>1e3*e;
 
 exports["default"] = kbToBytes;
 exports.kbToBytes = kbToBytes;

package/kbToBytes.esm.js

@@ -1,3 +1,7 @@
-let kbToBytes=e=>1e3*e;
+/**
+ * Kilobytes to bytes
+ *
+ * @category format
+ */let kbToBytes=e=>1e3*e;
 
 export { kbToBytes as default, kbToBytes };

package/lowercase.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let lowercase=e=>(e||"").toLowerCase();
+/**
+ * Replacement for native `toLowercase` tyescript ready (type narrowing ready)
+ *
+ * @category native
+ */let lowercase=e=>(e||"").toLowerCase();
 
 exports["default"] = lowercase;
 exports.lowercase = lowercase;

package/lowercase.esm.js

@@ -1,3 +1,7 @@
-let lowercase=e=>(e||"").toLowerCase();
+/**
+ * Replacement for native `toLowercase` tyescript ready (type narrowing ready)
+ *
+ * @category native
+ */let lowercase=e=>(e||"").toLowerCase();
 
 export { lowercase as default, lowercase };

package/mapListBy.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let mapListBy=(e=[],t="")=>e.reduce((e,p)=>(e[p[t]]=p,e),{});
+/**
+ * Maps an array of objects into a map keyed with the given key
+ *
+ * @category array
+ */let mapListBy=(e=[],t="")=>e.reduce((e,p)=>(e[p[t]]=p,e),{});
 
 exports["default"] = mapListBy;
 exports.mapListBy = mapListBy;

package/mapListBy.esm.js

@@ -1,3 +1,7 @@
-let mapListBy=(e=[],t="")=>e.reduce((e,p)=>(e[p[t]]=p,e),{});
+/**
+ * Maps an array of objects into a map keyed with the given key
+ *
+ * @category array
+ */let mapListBy=(e=[],t="")=>e.reduce((e,p)=>(e[p[t]]=p,e),{});
 
 export { mapListBy as default, mapListBy };

package/matchSorter.cjs.js

@@ -7,7 +7,96 @@ var removeAccents = require('./removeAccents.cjs.js');
 require('./getType.cjs.js');
 require('./accentsSets.cjs.js');
 
-let r=(e,t)=>String(e.rankedValue).localeCompare(String(t.rankedValue)),l=(e,t,l={})=>{let{keys:u,threshold:a=1,baseSort:o=r,sorter:s=e=>e.sort((e,t)=>i(e,t,o))}=l;return s(e.reduce(function(e,r,o){let i=n(r,u,t,l),{rank:s,keyThreshold:h=a}=i;return s>=h&&e.push({...i,item:r,index:o}),e},[])).map(({item:e})=>e)},n=(e,t,r,l)=>t?c(e,t).reduce(({rank:e,rankedValue:t,keyIndex:n,keyThreshold:a},{itemValue:o,attributes:i},s)=>{let h=u(o,r,l),f=t,{minRanking:c,maxRanking:d,threshold:k}=i;return h<c&&h>=1?h=c:h>d&&(h=d),h>e&&(e=h,n=s,a=k,f=o),{rankedValue:f,rank:e,keyIndex:n,keyThreshold:a}},{rankedValue:e,rank:0,keyIndex:-1,keyThreshold:l.threshold}):{rankedValue:e,rank:u(e,r,l),keyIndex:-1,keyThreshold:l.threshold},u=(e,t,r)=>(e=s(e,r),(t=s(t,r)).length>e.length)?0:e===t?7:(e=e.toLowerCase())===(t=t.toLowerCase())?6:e.startsWith(t)?5:e.includes(` ${t}`)?4:e.includes(t)?3:1===t.length?0:a(e).includes(t)?2:o(e,t),a=e=>{let t="";return e.split(" ").forEach(e=>{e.split("-").forEach(e=>{t+=e.substring(0,1);});}),t},o=(e,t)=>{let r=0,l=0;function n(e,t,l){for(let n=l,u=t.length;n<u;n++)if(t[n]===e)return r+=1,n+1;return -1}let u=n(t[0],e,0);if(u<0)return 0;l=u;for(let r=1,u=t.length;r<u;r++)if(!((l=n(t[r],e,l))>-1))return 0;return 1+1/(l-u)*(r/t.length)},i=(e,t,r)=>{let{rank:l,keyIndex:n}=e,{rank:u,keyIndex:a}=t;return l!==u?l>u?-1:1:n===a?r(e,t):n<a?-1:1},s=(e,{keepDiacritics:r})=>(e=`${e}`,r||(e=removeAccents.removeAccents(e)),e),h=(e,t)=>{let r;if("object"==typeof t&&(t=t.key),"function"==typeof t)r=t(e);else if(null==e)r=null;else if(Object.hasOwnProperty.call(e,t))r=e[t];else {if(t.includes("."))return f(t,e);r=null;}return null==r?[]:Array.isArray(r)?r:[String(r)]},f=(e,t)=>{let r=e.split("."),l=[t];for(let e=0,t=r.length;e<t;e++){let t=r[e],n=[];for(let e=0,r=l.length;e<r;e++){let r=l[e];if(null!=r){if(Object.hasOwnProperty.call(r,t)){let e=r[t];null!=e&&n.push(e);}else "*"===t&&(n=n.concat(r));}}l=n;}return Array.isArray(l[0])?[].concat(...l):l},c=(e,t)=>{let r=[];for(let l=0,n=t.length;l<n;l++){let n=t[l],u=k(n),a=h(e,n);for(let e=0,t=a.length;e<t;e++)r.push({itemValue:a[e],attributes:u});}return r},d={maxRanking:1/0,minRanking:-1/0},k=t=>isString.isString(t)?d:{...d,...t};
+let r=(e,t)=>String(e.rankedValue).localeCompare(String(t.rankedValue)),/**
+ * Takes an array of items and a value and returns a new array with the items that match the given value
+ * @param {Array} items - the items to sort
+ * @param {String} value - the value to use for ranking
+ * @param {Object} options - Some options to configure the sorter
+ * @return {Array} - the new sorted array
+ */l=(e,t,l={})=>{let{keys:u,threshold:a=1,baseSort:o=r,sorter:s=e=>e.sort((e,t)=>i(e,t,o))}=l;return s(e.reduce(function(e,r,o){let i=n(r,u,t,l),{rank:s,keyThreshold:h=a}=i;return s>=h&&e.push({...i,item:r,index:o}),e},[])).map(({item:e})=>e)},/**
+ * Gets the highest ranking for value for the given item based on its values for the given keys
+ * @param {*} item - the item to rank
+ * @param {Array} keys - the keys to get values from the item for the ranking
+ * @param {String} value - the value to rank against
+ * @param {Object} options - options to control the ranking
+ * @return {{rank: Number, keyIndex: Number, keyThreshold: Number}} - the highest ranking
+ */n=(e,t,r,l)=>t?c(e,t).reduce(({rank:e,rankedValue:t,keyIndex:n,keyThreshold:a},{itemValue:o,attributes:i},s)=>{let h=u(o,r,l),f=t,{minRanking:c,maxRanking:d,threshold:k}=i;return h<c&&h>=1?h=c:h>d&&(h=d),h>e&&(e=h,n=s,a=k,f=o),{rankedValue:f,rank:e,keyIndex:n,keyThreshold:a}},{rankedValue:e,rank:0,keyIndex:-1,keyThreshold:l.threshold}):{// ends up being duplicate of 'item' in matches but consistent
+    rankedValue:// if keys is not specified, then we assume the item given is ready to be matched
+    e,rank:u(e,r,l),keyIndex:-1,keyThreshold:l.threshold},/**
+ * Gives a rankings score based on how well the two strings match.
+ * @param {String} testString - the string to test against
+ * @param {String} stringToRank - the string to rank
+ * @param {Object} options - options for the match (like keepDiacritics for comparison)
+ * @returns {Number} the ranking for how well stringToRank matches testString
+ */u=(e,t,r)=>// too long
+    (e=s(e,r),(t=s(t,r)).length>e.length)?0:// case sensitive equals
+    e===t?7:// case insensitive equals
+    // Lower casing before further comparison
+    (e=e.toLowerCase())===(t=t.toLowerCase())?6:// starts with
+    e.startsWith(t)?5:// word starts with
+    e.includes(` ${t}`)?4:// contains
+    e.includes(t)?3:1===t.length?0:// If the only character in the given stringToRank
+    //   isn't even contained in the testString, then
+    //   it's definitely not a match.
+    // acronym
+    a(e).includes(t)?2:// will return a number between RANKING_MATCHES and
+    // RANKING_MATCHES + 1 depending  on how close of a match it is.
+    o(e,t),/**
+ * Generates an acronym for a string.
+ *
+ * @param {String} string the string for which to produce the acronym
+ * @returns {String} the acronym
+ */a=e=>{let t="";return e.split(" ").forEach(e=>{e.split("-").forEach(e=>{t+=e.substring(0,1);});}),t},/**
+ * Returns a score based on how spread apart the
+ * characters from the stringToRank are within the testString.
+ * A number close to RANKING_MATCHES represents a loose match. A number close
+ * to RANKING_MATCHES + 1 represents a tighter match.
+ * @param {String} testString - the string to test against
+ * @param {String} stringToRank - the string to rank
+ * @returns {Number} the number between RANKING_MATCHES and
+ * RANKING_MATCHES + 1 for how well stringToRank matches testString
+ */o=(e,t)=>{let r=0,l=0;function n(e,t,l){for(let n=l,u=t.length;n<u;n++)if(t[n]===e)return r+=1,n+1;return -1}let u=n(t[0],e,0);if(u<0)return 0;l=u;for(let r=1,u=t.length;r<u;r++)if(!((l=n(t[r],e,l))>-1))return 0;return 1+1/(l-u)*(r/t.length)},/**
+ * Sorts items that have a rank, index, and keyIndex
+ * @param {Object} a - the first item to sort
+ * @param {Object} b - the second item to sort
+ * @return {Number} -1 if a should come first, 1 if b should come first, 0 if equal
+ */i=(e,t,r)=>{let{rank:l,keyIndex:n}=e,{rank:u,keyIndex:a}=t;return l!==u?l>u?-1:1:n===a?// use the base sort function as a tie-breaker
+r(e,t):n<a?-1:1},/**
+ * Prepares value for comparison by stringifying it, removing diacritics (if specified)
+ * @param {String} value - the value to clean
+ * @param {Object} options - {keepDiacritics: whether to remove diacritics}
+ * @return {String} the prepared value
+ */s=(e,{keepDiacritics:r})=>(// value might not actually be a string at this point (we don't get to choose)
+    // so part of preparing the value for comparison is ensure that it is a string
+    e=`${e}`,// toString
+    r||(e=removeAccents.removeAccents(e)),e),/**
+ * Gets value for key in item at arbitrarily nested keypath
+ * @param {Object} item - the item
+ * @param {Object|Function} key - the potentially nested keypath or property callback
+ * @return {Array} - an array containing the value(s) at the nested keypath
+ */h=(e,t)=>{let r;if("object"==typeof t&&(t=t.key),"function"==typeof t)r=t(e);else if(null==e)r=null;else if(Object.hasOwnProperty.call(e,t))r=e[t];else {if(t.includes("."))// eslint-disable-next-line @typescript-eslint/no-unsafe-call
+return f(t,e);r=null;}return(// because `value` can also be undefined
+null==r?[]:Array.isArray(r)?r:[String(r)])},/**
+ * Given path: "foo.bar.baz"
+ * And item: {foo: {bar: {baz: 'buzz'}}}
+ *   -> 'buzz'
+ * @param path a dot-separated set of keys
+ * @param item the item to get the value from
+ */f=(e,t)=>{let r=e.split("."),l=[t];for(let e=0,t=r.length;e<t;e++){let t=r[e],n=[];for(let e=0,r=l.length;e<r;e++){let r=l[e];if(null!=r){if(Object.hasOwnProperty.call(r,t)){let e=r[t];null!=e&&n.push(e);}else "*"===t&&// ensure that values is an array
+(n=n.concat(r));}}l=n;}return Array.isArray(l[0])?// keep allowing the implicit wildcard for an array of strings at the end of
+// the path; don't use `.flat()` because that's not available in node.js v10
+[].concat(...l):// Based on our logic it should be an array of strings by now...
+// assuming the user's path terminated in strings
+l},/**
+ * Gets all the values for the given keys in the given item and returns an array of those values
+ * @param item - the item from which the values will be retrieved
+ * @param keys - the keys to use to retrieve the values
+ * @return objects with {itemValue, attributes}
+ */c=(e,t)=>{let r=[];for(let l=0,n=t.length;l<n;l++){let n=t[l],u=k(n),a=h(e,n);for(let e=0,t=a.length;e<t;e++)r.push({itemValue:a[e],attributes:u});}return r},d={maxRanking:1/0,minRanking:-1/0},/**
+ * Gets all the attributes for the given key
+ * @param key - the key from which the attributes will be retrieved
+ * @return object containing the key's attributes
+ */k=t=>isString.isString(t)?d:{...d,...t};
 
 exports["default"] = l;
 exports.defaultBaseSortFn = r;

package/matchSorter.esm.js

@@ -3,6 +3,95 @@ import { removeAccents } from './removeAccents.esm.js';
 import './getType.esm.js';
 import './accentsSets.esm.js';
 
-let r=(e,t)=>String(e.rankedValue).localeCompare(String(t.rankedValue)),l=(e,t,l={})=>{let{keys:u,threshold:a=1,baseSort:o=r,sorter:s=e=>e.sort((e,t)=>i(e,t,o))}=l;return s(e.reduce(function(e,r,o){let i=n(r,u,t,l),{rank:s,keyThreshold:h=a}=i;return s>=h&&e.push({...i,item:r,index:o}),e},[])).map(({item:e})=>e)},n=(e,t,r,l)=>t?c(e,t).reduce(({rank:e,rankedValue:t,keyIndex:n,keyThreshold:a},{itemValue:o,attributes:i},s)=>{let h=u(o,r,l),f=t,{minRanking:c,maxRanking:d,threshold:k}=i;return h<c&&h>=1?h=c:h>d&&(h=d),h>e&&(e=h,n=s,a=k,f=o),{rankedValue:f,rank:e,keyIndex:n,keyThreshold:a}},{rankedValue:e,rank:0,keyIndex:-1,keyThreshold:l.threshold}):{rankedValue:e,rank:u(e,r,l),keyIndex:-1,keyThreshold:l.threshold},u=(e,t,r)=>(e=s(e,r),(t=s(t,r)).length>e.length)?0:e===t?7:(e=e.toLowerCase())===(t=t.toLowerCase())?6:e.startsWith(t)?5:e.includes(` ${t}`)?4:e.includes(t)?3:1===t.length?0:a(e).includes(t)?2:o(e,t),a=e=>{let t="";return e.split(" ").forEach(e=>{e.split("-").forEach(e=>{t+=e.substring(0,1);});}),t},o=(e,t)=>{let r=0,l=0;function n(e,t,l){for(let n=l,u=t.length;n<u;n++)if(t[n]===e)return r+=1,n+1;return -1}let u=n(t[0],e,0);if(u<0)return 0;l=u;for(let r=1,u=t.length;r<u;r++)if(!((l=n(t[r],e,l))>-1))return 0;return 1+1/(l-u)*(r/t.length)},i=(e,t,r)=>{let{rank:l,keyIndex:n}=e,{rank:u,keyIndex:a}=t;return l!==u?l>u?-1:1:n===a?r(e,t):n<a?-1:1},s=(e,{keepDiacritics:r})=>(e=`${e}`,r||(e=removeAccents(e)),e),h=(e,t)=>{let r;if("object"==typeof t&&(t=t.key),"function"==typeof t)r=t(e);else if(null==e)r=null;else if(Object.hasOwnProperty.call(e,t))r=e[t];else {if(t.includes("."))return f(t,e);r=null;}return null==r?[]:Array.isArray(r)?r:[String(r)]},f=(e,t)=>{let r=e.split("."),l=[t];for(let e=0,t=r.length;e<t;e++){let t=r[e],n=[];for(let e=0,r=l.length;e<r;e++){let r=l[e];if(null!=r){if(Object.hasOwnProperty.call(r,t)){let e=r[t];null!=e&&n.push(e);}else "*"===t&&(n=n.concat(r));}}l=n;}return Array.isArray(l[0])?[].concat(...l):l},c=(e,t)=>{let r=[];for(let l=0,n=t.length;l<n;l++){let n=t[l],u=k(n),a=h(e,n);for(let e=0,t=a.length;e<t;e++)r.push({itemValue:a[e],attributes:u});}return r},d={maxRanking:1/0,minRanking:-1/0},k=t=>isString(t)?d:{...d,...t};
+let r=(e,t)=>String(e.rankedValue).localeCompare(String(t.rankedValue)),/**
+ * Takes an array of items and a value and returns a new array with the items that match the given value
+ * @param {Array} items - the items to sort
+ * @param {String} value - the value to use for ranking
+ * @param {Object} options - Some options to configure the sorter
+ * @return {Array} - the new sorted array
+ */l=(e,t,l={})=>{let{keys:u,threshold:a=1,baseSort:o=r,sorter:s=e=>e.sort((e,t)=>i(e,t,o))}=l;return s(e.reduce(function(e,r,o){let i=n(r,u,t,l),{rank:s,keyThreshold:h=a}=i;return s>=h&&e.push({...i,item:r,index:o}),e},[])).map(({item:e})=>e)},/**
+ * Gets the highest ranking for value for the given item based on its values for the given keys
+ * @param {*} item - the item to rank
+ * @param {Array} keys - the keys to get values from the item for the ranking
+ * @param {String} value - the value to rank against
+ * @param {Object} options - options to control the ranking
+ * @return {{rank: Number, keyIndex: Number, keyThreshold: Number}} - the highest ranking
+ */n=(e,t,r,l)=>t?c(e,t).reduce(({rank:e,rankedValue:t,keyIndex:n,keyThreshold:a},{itemValue:o,attributes:i},s)=>{let h=u(o,r,l),f=t,{minRanking:c,maxRanking:d,threshold:k}=i;return h<c&&h>=1?h=c:h>d&&(h=d),h>e&&(e=h,n=s,a=k,f=o),{rankedValue:f,rank:e,keyIndex:n,keyThreshold:a}},{rankedValue:e,rank:0,keyIndex:-1,keyThreshold:l.threshold}):{// ends up being duplicate of 'item' in matches but consistent
+    rankedValue:// if keys is not specified, then we assume the item given is ready to be matched
+    e,rank:u(e,r,l),keyIndex:-1,keyThreshold:l.threshold},/**
+ * Gives a rankings score based on how well the two strings match.
+ * @param {String} testString - the string to test against
+ * @param {String} stringToRank - the string to rank
+ * @param {Object} options - options for the match (like keepDiacritics for comparison)
+ * @returns {Number} the ranking for how well stringToRank matches testString
+ */u=(e,t,r)=>// too long
+    (e=s(e,r),(t=s(t,r)).length>e.length)?0:// case sensitive equals
+    e===t?7:// case insensitive equals
+    // Lower casing before further comparison
+    (e=e.toLowerCase())===(t=t.toLowerCase())?6:// starts with
+    e.startsWith(t)?5:// word starts with
+    e.includes(` ${t}`)?4:// contains
+    e.includes(t)?3:1===t.length?0:// If the only character in the given stringToRank
+    //   isn't even contained in the testString, then
+    //   it's definitely not a match.
+    // acronym
+    a(e).includes(t)?2:// will return a number between RANKING_MATCHES and
+    // RANKING_MATCHES + 1 depending  on how close of a match it is.
+    o(e,t),/**
+ * Generates an acronym for a string.
+ *
+ * @param {String} string the string for which to produce the acronym
+ * @returns {String} the acronym
+ */a=e=>{let t="";return e.split(" ").forEach(e=>{e.split("-").forEach(e=>{t+=e.substring(0,1);});}),t},/**
+ * Returns a score based on how spread apart the
+ * characters from the stringToRank are within the testString.
+ * A number close to RANKING_MATCHES represents a loose match. A number close
+ * to RANKING_MATCHES + 1 represents a tighter match.
+ * @param {String} testString - the string to test against
+ * @param {String} stringToRank - the string to rank
+ * @returns {Number} the number between RANKING_MATCHES and
+ * RANKING_MATCHES + 1 for how well stringToRank matches testString
+ */o=(e,t)=>{let r=0,l=0;function n(e,t,l){for(let n=l,u=t.length;n<u;n++)if(t[n]===e)return r+=1,n+1;return -1}let u=n(t[0],e,0);if(u<0)return 0;l=u;for(let r=1,u=t.length;r<u;r++)if(!((l=n(t[r],e,l))>-1))return 0;return 1+1/(l-u)*(r/t.length)},/**
+ * Sorts items that have a rank, index, and keyIndex
+ * @param {Object} a - the first item to sort
+ * @param {Object} b - the second item to sort
+ * @return {Number} -1 if a should come first, 1 if b should come first, 0 if equal
+ */i=(e,t,r)=>{let{rank:l,keyIndex:n}=e,{rank:u,keyIndex:a}=t;return l!==u?l>u?-1:1:n===a?// use the base sort function as a tie-breaker
+r(e,t):n<a?-1:1},/**
+ * Prepares value for comparison by stringifying it, removing diacritics (if specified)
+ * @param {String} value - the value to clean
+ * @param {Object} options - {keepDiacritics: whether to remove diacritics}
+ * @return {String} the prepared value
+ */s=(e,{keepDiacritics:r})=>(// value might not actually be a string at this point (we don't get to choose)
+    // so part of preparing the value for comparison is ensure that it is a string
+    e=`${e}`,// toString
+    r||(e=removeAccents(e)),e),/**
+ * Gets value for key in item at arbitrarily nested keypath
+ * @param {Object} item - the item
+ * @param {Object|Function} key - the potentially nested keypath or property callback
+ * @return {Array} - an array containing the value(s) at the nested keypath
+ */h=(e,t)=>{let r;if("object"==typeof t&&(t=t.key),"function"==typeof t)r=t(e);else if(null==e)r=null;else if(Object.hasOwnProperty.call(e,t))r=e[t];else {if(t.includes("."))// eslint-disable-next-line @typescript-eslint/no-unsafe-call
+return f(t,e);r=null;}return(// because `value` can also be undefined
+null==r?[]:Array.isArray(r)?r:[String(r)])},/**
+ * Given path: "foo.bar.baz"
+ * And item: {foo: {bar: {baz: 'buzz'}}}
+ *   -> 'buzz'
+ * @param path a dot-separated set of keys
+ * @param item the item to get the value from
+ */f=(e,t)=>{let r=e.split("."),l=[t];for(let e=0,t=r.length;e<t;e++){let t=r[e],n=[];for(let e=0,r=l.length;e<r;e++){let r=l[e];if(null!=r){if(Object.hasOwnProperty.call(r,t)){let e=r[t];null!=e&&n.push(e);}else "*"===t&&// ensure that values is an array
+(n=n.concat(r));}}l=n;}return Array.isArray(l[0])?// keep allowing the implicit wildcard for an array of strings at the end of
+// the path; don't use `.flat()` because that's not available in node.js v10
+[].concat(...l):// Based on our logic it should be an array of strings by now...
+// assuming the user's path terminated in strings
+l},/**
+ * Gets all the values for the given keys in the given item and returns an array of those values
+ * @param item - the item from which the values will be retrieved
+ * @param keys - the keys to use to retrieve the values
+ * @return objects with {itemValue, attributes}
+ */c=(e,t)=>{let r=[];for(let l=0,n=t.length;l<n;l++){let n=t[l],u=k(n),a=h(e,n);for(let e=0,t=a.length;e<t;e++)r.push({itemValue:a[e],attributes:u});}return r},d={maxRanking:1/0,minRanking:-1/0},/**
+ * Gets all the attributes for the given key
+ * @param key - the key from which the attributes will be retrieved
+ * @return object containing the key's attributes
+ */k=t=>isString(t)?d:{...d,...t};
 
 export { l as default, r as defaultBaseSortFn, l as matchSorter };

package/mbToBytes.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let mbToBytes=e=>1e6*e;
+/**
+ * Megabytes to bytes
+ *
+ * @category format
+ */let mbToBytes=e=>1e6*e;
 
 exports["default"] = mbToBytes;
 exports.mbToBytes = mbToBytes;

package/mbToBytes.esm.js

@@ -1,3 +1,7 @@
-let mbToBytes=e=>1e6*e;
+/**
+ * Megabytes to bytes
+ *
+ * @category format
+ */let mbToBytes=e=>1e6*e;
 
 export { mbToBytes as default, mbToBytes };

package/mergeObjects.cjs.js

@@ -7,7 +7,14 @@ var isUndefined = require('./isUndefined.cjs.js');
 require('./isPlainObject.cjs.js');
 require('./getType.cjs.js');
 
-let mergeObjects=(r,...i)=>{if(!i.length)return r;let m=i.shift();return void 0===m?r:(isObject.isObject(r)&&isObject.isObject(m)&&Object.keys(m).forEach(i=>{isObject.isObject(m[i])?(r[i]||(r[i]={}),mergeObjects(r[i],m[i])):isUndefined.isUndefined(m[i])||(r[i]=m[i]);}),mergeObjects(r,...i))};
+/**
+ * Merge two or more objects together. It mutates the target object.
+ *
+ * @category object
+ * @see https://stackoverflow.com/a/46973278/1938970
+ */let mergeObjects=(r,...i)=>{if(!i.length)return r;let m=i.shift();return void 0===m?r:(isObject.isObject(r)&&isObject.isObject(m)&&Object.keys(m).forEach(i=>{isObject.isObject(m[i])?(r[i]||(r[i]={}),mergeObjects(r[i],m[i])):isUndefined.isUndefined(m[i])||// FIXME: assertion here should not be needed but isUndefined does not
+// narrow the type here
+(r[i]=m[i]);}),mergeObjects(r,...i))};
 
 exports["default"] = mergeObjects;
 exports.mergeObjects = mergeObjects;

package/mergeObjects.esm.js

@@ -3,6 +3,13 @@ import { isUndefined } from './isUndefined.esm.js';
 import './isPlainObject.esm.js';
 import './getType.esm.js';
 
-let mergeObjects=(r,...i)=>{if(!i.length)return r;let m=i.shift();return void 0===m?r:(isObject(r)&&isObject(m)&&Object.keys(m).forEach(i=>{isObject(m[i])?(r[i]||(r[i]={}),mergeObjects(r[i],m[i])):isUndefined(m[i])||(r[i]=m[i]);}),mergeObjects(r,...i))};
+/**
+ * Merge two or more objects together. It mutates the target object.
+ *
+ * @category object
+ * @see https://stackoverflow.com/a/46973278/1938970
+ */let mergeObjects=(r,...i)=>{if(!i.length)return r;let m=i.shift();return void 0===m?r:(isObject(r)&&isObject(m)&&Object.keys(m).forEach(i=>{isObject(m[i])?(r[i]||(r[i]={}),mergeObjects(r[i],m[i])):isUndefined(m[i])||// FIXME: assertion here should not be needed but isUndefined does not
+// narrow the type here
+(r[i]=m[i]);}),mergeObjects(r,...i))};
 
 export { mergeObjects as default, mergeObjects };

package/mergeUrlQueryParams.cjs.js

@@ -5,7 +5,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var isNull = require('./isNull.cjs.js');
 require('./getType.cjs.js');
 
-let mergeUrlQueryParams=(r={},l={})=>{for(let t in l){let m=l[t];r[t]&&isNull.isNull(m)?delete r[t]:r[t]=m;}return r};
+/**
+ * Merge query parameters objects, it *mutates* the first given object argument
+ *
+ * @category location
+ */let mergeUrlQueryParams=(r={},l={})=>{for(let t in l){let m=l[t];r[t]&&isNull.isNull(m)?delete r[t]:r[t]=m;}return r};
 
 exports["default"] = mergeUrlQueryParams;
 exports.mergeUrlQueryParams = mergeUrlQueryParams;

package/mergeUrlQueryParams.esm.js

@@ -1,6 +1,10 @@
 import { isNull } from './isNull.esm.js';
 import './getType.esm.js';
 
-let mergeUrlQueryParams=(r={},l={})=>{for(let t in l){let m=l[t];r[t]&&isNull(m)?delete r[t]:r[t]=m;}return r};
+/**
+ * Merge query parameters objects, it *mutates* the first given object argument
+ *
+ * @category location
+ */let mergeUrlQueryParams=(r={},l={})=>{for(let t in l){let m=l[t];r[t]&&isNull(m)?delete r[t]:r[t]=m;}return r};
 
 export { mergeUrlQueryParams as default, mergeUrlQueryParams };

package/moveSortableArrayItemByKey.cjs.js

@@ -2,7 +2,13 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let moveSortableArrayItemByKey=(e,r,t,l)=>{let a=e.map(e=>e[r]),o=a.indexOf(t[r]),y=a.indexOf(l[r]),[m]=e.splice(o,1);return e.splice(y,0,m),[...e]};
+/**
+ * Move item from one place to another in a sortable array of objects, re-ordering
+ * the array accrodingly (no swapping of position).
+ * This is useful for drag and drop functionalities
+ *
+ * @category array
+ */let moveSortableArrayItemByKey=(e,r,t,l)=>{let a=e.map(e=>e[r]),o=a.indexOf(t[r]),y=a.indexOf(l[r]),[m]=e.splice(o,1);return e.splice(y,0,m),[...e]};
 
 exports["default"] = moveSortableArrayItemByKey;
 exports.moveSortableArrayItemByKey = moveSortableArrayItemByKey;

package/moveSortableArrayItemByKey.esm.js

@@ -1,3 +1,9 @@
-let moveSortableArrayItemByKey=(e,r,t,l)=>{let a=e.map(e=>e[r]),o=a.indexOf(t[r]),y=a.indexOf(l[r]),[m]=e.splice(o,1);return e.splice(y,0,m),[...e]};
+/**
+ * Move item from one place to another in a sortable array of objects, re-ordering
+ * the array accrodingly (no swapping of position).
+ * This is useful for drag and drop functionalities
+ *
+ * @category array
+ */let moveSortableArrayItemByKey=(e,r,t,l)=>{let a=e.map(e=>e[r]),o=a.indexOf(t[r]),y=a.indexOf(l[r]),[m]=e.splice(o,1);return e.splice(y,0,m),[...e]};
 
 export { moveSortableArrayItemByKey as default, moveSortableArrayItemByKey };

package/noop.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let noop=()=>void 0;
+/**
+ * No operation function
+ *
+ * @category native
+ */let noop=()=>void 0;
 
 exports["default"] = noop;
 exports.noop = noop;

package/noop.esm.js

@@ -1,3 +1,7 @@
-let noop=()=>void 0;
+/**
+ * No operation function
+ *
+ * @category native
+ */let noop=()=>void 0;
 
 export { noop as default, noop };

package/normaliseUrl.cjs.js

@@ -4,7 +4,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var removeTrailingSlash = require('./removeTrailingSlash.cjs.js');
 
-let normaliseUrl=(e="")=>removeTrailingSlash.removeTrailingSlash(e.replace(/(:\/\/)|(\/)+/g,"$1$2"));
+/**
+ * Normalise URL, it works both for absolute and relative URLs
+ *
+ * - replaces too many consecutive slashes (except `http{s}://`)
+ * - removes the trailing slash
+ *
+ * @category location
+ * @see https://stackoverflow.com/a/40649435/1938970
+ */let normaliseUrl=(e="")=>removeTrailingSlash.removeTrailingSlash(e.replace(/(:\/\/)|(\/)+/g,"$1$2"));
 
 exports["default"] = normaliseUrl;
 exports.normaliseUrl = normaliseUrl;