@koine/utils 2.0.0-beta.2 → 2.0.0-beta.200

package/matchSorter.mjs

@@ -1,370 +0,0 @@
-import { __assign } from "tslib";
-/**
- * @file
- *
- * Slightly adapted from Kent C. Dodd's [match-sorter](https://github.com/kentcdodds/match-sorter)
- * differences are:
- * - less exports
- * - smaller output
- * - no external deps
- *
- * TODO: turn objects into arrays for smaller output?
- *
- * @name match-sorter
- * @license MIT license.
- * @copyright (c) 2020 Kent C. Dodds
- * @author Kent C. Dodds <me@kentcdodds.com> (https://kentcdodds.com)
- */
-import removeAccents from "./removeAccents";
-var RANKING_CASE_SENSITIVE_EQUAL = 7;
-var RANKING_EQUAL = 6;
-var RANKING_STARTS_WITH = 5;
-var RANKING_WORD_STARTS_WITH = 4;
-var RANKING_CONTAINS = 3;
-var RANKING_ACRONYM = 2;
-var RANKING_MATCHES = 1;
-var RANKING_NO_MATCH = 0;
-var defaultBaseSortFn = function (a, b) {
-    return String(a.rankedValue).localeCompare(String(b.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
- */
-function matchSorter(items, value, options) {
-    if (options === void 0) { options = {}; }
-    var keys = options.keys, _a = options.threshold, threshold = _a === void 0 ? RANKING_MATCHES : _a, _b = options.baseSort, baseSort = _b === void 0 ? defaultBaseSortFn : _b, _c = options.sorter, sorter = _c === void 0 ? function (matchedItems) {
-        return matchedItems.sort(function (a, b) { return sortRankedValues(a, b, baseSort); });
-    } : _c;
-    var matchedItems = items.reduce(reduceItemsToRanked, []);
-    return sorter(matchedItems).map(function (_a) {
-        var item = _a.item;
-        return item;
-    });
-    function reduceItemsToRanked(matches, item, index) {
-        var rankingInfo = getHighestRanking(item, keys, value, options);
-        var rank = rankingInfo.rank, _a = rankingInfo.keyThreshold, keyThreshold = _a === void 0 ? threshold : _a;
-        if (rank >= keyThreshold) {
-            matches.push(__assign(__assign({}, rankingInfo), { item: item, index: index }));
-        }
-        return matches;
-    }
-}
-/**
- * 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
- */
-function getHighestRanking(item, keys, value, options) {
-    if (!keys) {
-        // if keys is not specified, then we assume the item given is ready to be matched
-        var stringItem = item;
-        return {
-            // ends up being duplicate of 'item' in matches but consistent
-            rankedValue: stringItem,
-            rank: getMatchRanking(stringItem, value, options),
-            keyIndex: -1,
-            keyThreshold: options.threshold,
-        };
-    }
-    var valuesToRank = getAllValuesToRank(item, keys);
-    return valuesToRank.reduce(function (_a, _b, i) {
-        var rank = _a.rank, rankedValue = _a.rankedValue, keyIndex = _a.keyIndex, keyThreshold = _a.keyThreshold;
-        var itemValue = _b.itemValue, attributes = _b.attributes;
-        var newRank = getMatchRanking(itemValue, value, options);
-        var newRankedValue = rankedValue;
-        var minRanking = attributes.minRanking, maxRanking = attributes.maxRanking, threshold = attributes.threshold;
-        if (newRank < minRanking && newRank >= RANKING_MATCHES) {
-            newRank = minRanking;
-        }
-        else if (newRank > maxRanking) {
-            newRank = maxRanking;
-        }
-        if (newRank > rank) {
-            rank = newRank;
-            keyIndex = i;
-            keyThreshold = threshold;
-            newRankedValue = itemValue;
-        }
-        return { rankedValue: newRankedValue, rank: rank, keyIndex: keyIndex, keyThreshold: keyThreshold };
-    }, {
-        rankedValue: item,
-        rank: RANKING_NO_MATCH,
-        keyIndex: -1,
-        keyThreshold: options.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
- */
-function getMatchRanking(testString, stringToRank, options) {
-    testString = prepareValueForComparison(testString, options);
-    stringToRank = prepareValueForComparison(stringToRank, options);
-    // too long
-    if (stringToRank.length > testString.length) {
-        return RANKING_NO_MATCH;
-    }
-    // case sensitive equals
-    if (testString === stringToRank) {
-        return RANKING_CASE_SENSITIVE_EQUAL;
-    }
-    // Lower casing before further comparison
-    testString = testString.toLowerCase();
-    stringToRank = stringToRank.toLowerCase();
-    // case insensitive equals
-    if (testString === stringToRank) {
-        return RANKING_EQUAL;
-    }
-    // starts with
-    if (testString.startsWith(stringToRank)) {
-        return RANKING_STARTS_WITH;
-    }
-    // word starts with
-    if (testString.includes(" ".concat(stringToRank))) {
-        return RANKING_WORD_STARTS_WITH;
-    }
-    // contains
-    if (testString.includes(stringToRank)) {
-        return RANKING_CONTAINS;
-    }
-    else if (stringToRank.length === 1) {
-        // If the only character in the given stringToRank
-        //   isn't even contained in the testString, then
-        //   it's definitely not a match.
-        return RANKING_NO_MATCH;
-    }
-    // acronym
-    if (getAcronym(testString).includes(stringToRank)) {
-        return RANKING_ACRONYM;
-    }
-    // will return a number between RANKING_MATCHES and
-    // RANKING_MATCHES + 1 depending  on how close of a match it is.
-    return getClosenessRanking(testString, stringToRank);
-}
-/**
- * Generates an acronym for a string.
- *
- * @param {String} string the string for which to produce the acronym
- * @returns {String} the acronym
- */
-function getAcronym(string) {
-    var acronym = "";
-    var wordsInString = string.split(" ");
-    wordsInString.forEach(function (wordInString) {
-        var splitByHyphenWords = wordInString.split("-");
-        splitByHyphenWords.forEach(function (splitByHyphenWord) {
-            acronym += splitByHyphenWord.substring(0, 1);
-        });
-    });
-    return acronym;
-}
-/**
- * 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
- */
-function getClosenessRanking(testString, stringToRank) {
-    var matchingInOrderCharCount = 0;
-    var charNumber = 0;
-    function findMatchingCharacter(matchChar, string, index) {
-        for (var j = index, J = string.length; j < J; j++) {
-            var stringChar = string[j];
-            if (stringChar === matchChar) {
-                matchingInOrderCharCount += 1;
-                return j + 1;
-            }
-        }
-        return -1;
-    }
-    function getRanking(spread) {
-        var spreadPercentage = 1 / spread;
-        var inOrderPercentage = matchingInOrderCharCount / stringToRank.length;
-        var ranking = RANKING_MATCHES + inOrderPercentage * spreadPercentage;
-        return ranking;
-    }
-    var firstIndex = findMatchingCharacter(stringToRank[0], testString, 0);
-    if (firstIndex < 0) {
-        return RANKING_NO_MATCH;
-    }
-    charNumber = firstIndex;
-    for (var i = 1, I = stringToRank.length; i < I; i++) {
-        var matchChar = stringToRank[i];
-        charNumber = findMatchingCharacter(matchChar, testString, charNumber);
-        var found = charNumber > -1;
-        if (!found) {
-            return RANKING_NO_MATCH;
-        }
-    }
-    var spread = charNumber - firstIndex;
-    return getRanking(spread);
-}
-/**
- * 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
- */
-function sortRankedValues(a, b, baseSort) {
-    var aFirst = -1;
-    var bFirst = 1;
-    var aRank = a.rank, aKeyIndex = a.keyIndex;
-    var bRank = b.rank, bKeyIndex = b.keyIndex;
-    var same = aRank === bRank;
-    if (same) {
-        if (aKeyIndex === bKeyIndex) {
-            // use the base sort function as a tie-breaker
-            return baseSort(a, b);
-        }
-        else {
-            return aKeyIndex < bKeyIndex ? aFirst : bFirst;
-        }
-    }
-    else {
-        return aRank > bRank ? aFirst : bFirst;
-    }
-}
-/**
- * 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
- */
-function prepareValueForComparison(value, _a) {
-    var keepDiacritics = _a.keepDiacritics;
-    // 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
-    value = "".concat(value); // toString
-    if (!keepDiacritics) {
-        value = removeAccents(value);
-    }
-    return value;
-}
-/**
- * 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
- */
-function getItemValues(item, key) {
-    if (typeof key === "object") {
-        key = key.key;
-    }
-    var value;
-    if (typeof key === "function") {
-        value = key(item);
-    }
-    else if (item == null) {
-        value = null;
-    }
-    else if (Object.hasOwnProperty.call(item, key)) {
-        value = item[key];
-    }
-    else if (key.includes(".")) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-        return getNestedValues(key, item);
-    }
-    else {
-        value = null;
-    }
-    // because `value` can also be undefined
-    if (value == null) {
-        return [];
-    }
-    if (Array.isArray(value)) {
-        return value;
-    }
-    return [String(value)];
-}
-/**
- * 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
- */
-function getNestedValues(path, item) {
-    var keys = path.split(".");
-    var values = [item];
-    for (var i = 0, I = keys.length; i < I; i++) {
-        var nestedKey = keys[i];
-        var nestedValues = [];
-        for (var j = 0, J = values.length; j < J; j++) {
-            var nestedItem = values[j];
-            if (nestedItem == null)
-                continue;
-            if (Object.hasOwnProperty.call(nestedItem, nestedKey)) {
-                var nestedValue = nestedItem[nestedKey];
-                if (nestedValue != null) {
-                    nestedValues.push(nestedValue);
-                }
-            }
-            else if (nestedKey === "*") {
-                // ensure that values is an array
-                nestedValues = nestedValues.concat(nestedItem);
-            }
-        }
-        values = nestedValues;
-    }
-    if (Array.isArray(values[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
-        var result = [];
-        return result.concat.apply(result, values);
-    }
-    // Based on our logic it should be an array of strings by now...
-    // assuming the user's path terminated in strings
-    return values;
-}
-/**
- * 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}
- */
-function getAllValuesToRank(item, keys) {
-    var allValues = [];
-    for (var j = 0, J = keys.length; j < J; j++) {
-        var key = keys[j];
-        var attributes = getKeyAttributes(key);
-        var itemValues = getItemValues(item, key);
-        for (var i = 0, I = itemValues.length; i < I; i++) {
-            allValues.push({
-                itemValue: itemValues[i],
-                attributes: attributes,
-            });
-        }
-    }
-    return allValues;
-}
-var defaultKeyAttributes = {
-    maxRanking: Infinity,
-    minRanking: -Infinity,
-};
-/**
- * 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
- */
-function getKeyAttributes(key) {
-    if (typeof key === "string") {
-        return defaultKeyAttributes;
-    }
-    return __assign(__assign({}, defaultKeyAttributes), key);
-}
-export { matchSorter, defaultBaseSortFn };
-export default matchSorter;

package/mbToBytes.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mbToBytes = void 0;
-/**
- * Megabytes to bytes
- *
- * @category format
- */
-var mbToBytes = function (bytes) { return bytes * 1000 * 1000; };
-exports.mbToBytes = mbToBytes;
-exports.default = exports.mbToBytes;

package/mbToBytes.mjs

@@ -1,7 +0,0 @@
-/**
- * Megabytes to bytes
- *
- * @category format
- */
-export var mbToBytes = function (bytes) { return bytes * 1000 * 1000; };
-export default mbToBytes;

package/mergeObjects.d.ts

@@ -1,7 +0,0 @@
-/**
- * Merge two or more objects together. It mutates the target object.
- *
- * @category objects
- * @see https://stackoverflow.com/a/46973278/1938970
- */
-export declare const mergeObjects: <T extends object = object>(target: T, ...sources: T[]) => T;

package/mergeObjects.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeObjects = void 0;
-var tslib_1 = require("tslib");
-var isObject_1 = require("./isObject");
-/**
- * Merge two or more objects together. It mutates the target object.
- *
- * @category objects
- * @see https://stackoverflow.com/a/46973278/1938970
- */
-var mergeObjects = function (target) {
-    var sources = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        sources[_i - 1] = arguments[_i];
-    }
-    if (!sources.length) {
-        return target;
-    }
-    var source = sources.shift();
-    if (source === undefined) {
-        return target;
-    }
-    if ((0, isObject_1.isObject)(target) && (0, isObject_1.isObject)(source)) {
-        Object.keys(source).forEach(function (_key) {
-            var key = _key;
-            if ((0, isObject_1.isObject)(source[key])) {
-                if (!target[key]) {
-                    // @ts-expect-error FIXME: ...
-                    target[key] = {};
-                }
-                (0, exports.mergeObjects)(target[key], source[key]);
-            }
-            else {
-                target[key] = source[key];
-            }
-        });
-    }
-    return exports.mergeObjects.apply(void 0, tslib_1.__spreadArray([target], sources, false));
-};
-exports.mergeObjects = mergeObjects;

package/mergeObjects.mjs

@@ -1,37 +0,0 @@
-import { __spreadArray } from "tslib";
-import { isObject } from "./isObject";
-/**
- * Merge two or more objects together. It mutates the target object.
- *
- * @category objects
- * @see https://stackoverflow.com/a/46973278/1938970
- */
-export var mergeObjects = function (target) {
-    var sources = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        sources[_i - 1] = arguments[_i];
-    }
-    if (!sources.length) {
-        return target;
-    }
-    var source = sources.shift();
-    if (source === undefined) {
-        return target;
-    }
-    if (isObject(target) && isObject(source)) {
-        Object.keys(source).forEach(function (_key) {
-            var key = _key;
-            if (isObject(source[key])) {
-                if (!target[key]) {
-                    // @ts-expect-error FIXME: ...
-                    target[key] = {};
-                }
-                mergeObjects(target[key], source[key]);
-            }
-            else {
-                target[key] = source[key];
-            }
-        });
-    }
-    return mergeObjects.apply(void 0, __spreadArray([target], sources, false));
-};

package/mergeUrlQueryParams.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeUrlQueryParams = void 0;
-var tslib_1 = require("tslib");
-var isNull_1 = tslib_1.__importDefault(require("./isNull"));
-/**
- * Merge query parameters objects, it *mutates* the first given object argument
- *
- * @category location
- * @pure
- */
-function mergeUrlQueryParams(oldParams, newParams) {
-    if (oldParams === void 0) { oldParams = {}; }
-    if (newParams === void 0) { newParams = {}; }
-    for (var key in newParams) {
-        var value = newParams[key];
-        if (oldParams[key] && (0, isNull_1.default)(value)) {
-            delete oldParams[key];
-        }
-        else {
-            oldParams[key] = value;
-        }
-    }
-    return oldParams;
-}
-exports.mergeUrlQueryParams = mergeUrlQueryParams;
-exports.default = mergeUrlQueryParams;

package/mergeUrlQueryParams.mjs

@@ -1,22 +0,0 @@
-import isNull from "./isNull";
-/**
- * Merge query parameters objects, it *mutates* the first given object argument
- *
- * @category location
- * @pure
- */
-export function mergeUrlQueryParams(oldParams, newParams) {
-    if (oldParams === void 0) { oldParams = {}; }
-    if (newParams === void 0) { newParams = {}; }
-    for (var key in newParams) {
-        var value = newParams[key];
-        if (oldParams[key] && isNull(value)) {
-            delete oldParams[key];
-        }
-        else {
-            oldParams[key] = value;
-        }
-    }
-    return oldParams;
-}
-export default mergeUrlQueryParams;

package/moveSortableArrayItemByKey.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.moveSortableArrayItemByKey = void 0;
-var tslib_1 = require("tslib");
-/**
- * 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 arrays, dnd
- */
-function moveSortableArrayItemByKey(items, key, fromItem, toItem) {
-    var itemsKeys = items.map(function (item) { return item[key]; });
-    var idxFrom = itemsKeys.indexOf(fromItem[key]);
-    var idxTo = itemsKeys.indexOf(toItem[key]);
-    var item = items.splice(idxFrom, 1)[0];
-    items.splice(idxTo, 0, item);
-    return tslib_1.__spreadArray([], items, true);
-}
-exports.moveSortableArrayItemByKey = moveSortableArrayItemByKey;
-exports.default = moveSortableArrayItemByKey;

package/moveSortableArrayItemByKey.mjs

@@ -1,17 +0,0 @@
-import { __spreadArray } from "tslib";
-/**
- * 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 arrays, dnd
- */
-export function moveSortableArrayItemByKey(items, key, fromItem, toItem) {
-    var itemsKeys = items.map(function (item) { return item[key]; });
-    var idxFrom = itemsKeys.indexOf(fromItem[key]);
-    var idxTo = itemsKeys.indexOf(toItem[key]);
-    var item = items.splice(idxFrom, 1)[0];
-    items.splice(idxTo, 0, item);
-    return __spreadArray([], items, true);
-}
-export default moveSortableArrayItemByKey;

package/noop.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noop = void 0;
-/**
- * No operation function
- *
- * @category native
- */
-var noop = function () { return void 0; };
-exports.noop = noop;
-exports.default = exports.noop;

package/noop.mjs

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

package/normaliseUrl.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normaliseUrl = void 0;
-var tslib_1 = require("tslib");
-var removeTrailingSlash_1 = tslib_1.__importDefault(require("./removeTrailingSlash"));
-/**
- * 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
- */
-function normaliseUrl(absoluteUrl) {
-    if (absoluteUrl === void 0) { absoluteUrl = ""; }
-    return (0, removeTrailingSlash_1.default)(absoluteUrl.replace(/(:\/\/)|(\/)+/g, "$1$2"));
-}
-exports.normaliseUrl = normaliseUrl;
-exports.default = normaliseUrl;

package/normaliseUrl.mjs

@@ -1,15 +0,0 @@
-import removeTralingSlash from "./removeTrailingSlash";
-/**
- * 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
- */
-export function normaliseUrl(absoluteUrl) {
-    if (absoluteUrl === void 0) { absoluteUrl = ""; }
-    return removeTralingSlash(absoluteUrl.replace(/(:\/\/)|(\/)+/g, "$1$2"));
-}
-export default normaliseUrl;

package/normaliseUrlPathname.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normaliseUrlPathname = void 0;
-var tslib_1 = require("tslib");
-var removeTrailingSlash_1 = tslib_1.__importDefault(require("./removeTrailingSlash"));
-/**
- * Normalise URL pathname (relative URL)
- *
- * - replaces too many consecutive slashes
- * - removes the trailing slash
- *
- * @category location
- */
-function normaliseUrlPathname(pathname) {
-    if (pathname === void 0) { pathname = ""; }
-    return (0, removeTrailingSlash_1.default)(pathname.replace(/\/+/g, "/"));
-}
-exports.normaliseUrlPathname = normaliseUrlPathname;
-exports.default = normaliseUrlPathname;

package/normaliseUrlPathname.mjs

@@ -1,14 +0,0 @@
-import removeTralingSlash from "./removeTrailingSlash";
-/**
- * Normalise URL pathname (relative URL)
- *
- * - replaces too many consecutive slashes
- * - removes the trailing slash
- *
- * @category location
- */
-export function normaliseUrlPathname(pathname) {
-    if (pathname === void 0) { pathname = ""; }
-    return removeTralingSlash(pathname.replace(/\/+/g, "/"));
-}
-export default normaliseUrlPathname;