@augment-vir/common 29.3.0 → 30.0.1

package/dist/cjs/augments/truncate-number.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.truncateNumber = truncateNumber;
-const common_number_1 = require("./common-number");
-const common_string_1 = require("./common-string");
-const regexp_1 = require("./regexp");
-const defaultTruncationSuffixes = [
-    'k', // thousand
-    'M', // million
-    'B', // billion
-    'T', // trillion
-    'P', // peta-, quadrillion
-    'E', // exa- quintillion
-    'Z', // zetta- sextillion
-    'Y', // yotta- septillion
-];
-function combineBeforeAndAfterDot({ beforeDot, afterDot = '', maxLength, }) {
-    if (afterDot.length) {
-        const allowedAfterDotLength = maxLength -
-            beforeDot.length -
-            // 1 for the period
-            1;
-        if (allowedAfterDotLength > 0) {
-            const slicedAfterDot = afterDot.slice(0, allowedAfterDotLength);
-            // if slicedAfterDot is just a bunch of 0
-            if (!Number(slicedAfterDot)) {
-                return beforeDot;
-            }
-            return [
-                beforeDot,
-                slicedAfterDot,
-            ].join('.');
-        }
-    }
-    return beforeDot;
-}
-function truncateBigNumber(numberAsString, suffixes, maxLength) {
-    const [beforeDot, afterDot,] = (0, common_string_1.typedSplit)(numberAsString, '.');
-    const withCommas = (0, common_number_1.addCommasToNumber)(beforeDot);
-    const truncationDepth = (0, regexp_1.safeMatch)(withCommas, /,/g).length;
-    const suffix = suffixes[truncationDepth - 1];
-    const [beforeComma, afterComma,] = (0, common_string_1.typedSplit)(withCommas, ',');
-    const trailing = [
-        afterComma,
-        afterDot,
-    ].join('');
-    if (beforeComma.length + 1 > maxLength) {
-        // will look like 0.9M
-        const minimumString = [
-            '0.',
-            beforeComma[0],
-            suffixes[truncationDepth],
-        ].join('');
-        return minimumString;
-    }
-    else {
-        const combined = combineBeforeAndAfterDot({
-            beforeDot: beforeComma,
-            afterDot: trailing,
-            maxLength: maxLength - 1 /* -1 to account for the suffix*/,
-        });
-        return [
-            combined,
-            suffix,
-        ].join('');
-    }
-}
-const minScientificNotationLength = '1e+'.length;
-function truncateScientificNotation({ input, maxLength, }) {
-    const valueString = String(input);
-    const [beforeExponent, rawExponent,] = (0, common_string_1.typedSplit)(valueString, 'e');
-    const exponent = rawExponent.replace(/^[\-\+]/, '');
-    const plusOrMinus = rawExponent[0];
-    const eSuffix = [
-        'e',
-        plusOrMinus,
-        exponent,
-    ].join('');
-    const [beforeDot, afterDot,] = (0, common_string_1.typedSplit)(beforeExponent, '.');
-    const minLength = exponent.length + minScientificNotationLength;
-    if (minLength === maxLength) {
-        // this will look like "4e+4" or "5e-234"
-        return [
-            beforeDot,
-            eSuffix,
-        ].join('');
-    }
-    else if (minLength > maxLength) {
-        // in this case the number is either way too big or way to small for its exponent to fit within the max length so we just jump to 0 or Infinity
-        if (plusOrMinus === '-') {
-            return '0';
-        }
-        else {
-            return String(Infinity);
-        }
-    }
-    else {
-        // in this case we have room to add some decimal values to the number
-        const beforeE = combineBeforeAndAfterDot({
-            afterDot,
-            beforeDot,
-            maxLength: maxLength - exponent.length + minScientificNotationLength,
-        });
-        return [
-            beforeE,
-            eSuffix,
-        ].join('');
-    }
-}
-function handleSmallNumbers(numberAsString, maxLength) {
-    const [beforeDot, afterDot,] = (0, common_string_1.typedSplit)((0, common_number_1.addCommasToNumber)(numberAsString), '.');
-    if (beforeDot.length <= maxLength) {
-        return combineBeforeAndAfterDot({
-            beforeDot,
-            afterDot,
-            maxLength,
-        });
-    }
-    // in this case, the number is not small enough to be handled by this function
-    return undefined;
-}
-/**
- * This truncates a number such that is will at a max have 6 characters including suffix, decimal
- * point, or comma.
- *
- * Default suffixes are:
- *
- *     'k', // thousand
- *     'M', // million
- *     'B', // billion
- *     'T', // trillion
- *     'P', // peta-, quadrillion
- *     'E', // exa- quintillion
- *     'Z', // zetta- sextillion
- *     'Y', // yotta- septillion
- */
-function truncateNumber(originalValue, { customSuffixes = defaultTruncationSuffixes, maxLength = 6, } = {}) {
-    const inputNumber = (0, common_number_1.convertIntoNumber)(originalValue);
-    // handle edge cases
-    if (isNaN(inputNumber) || inputNumber === Infinity) {
-        return String(inputNumber);
-    }
-    // handle too big or too small edge cases
-    if ((0, common_number_1.doesRequireScientificNotation)(inputNumber)) {
-        return truncateScientificNotation({ input: inputNumber, maxLength });
-    }
-    const numberAsString = String(inputNumber);
-    const smallResult = handleSmallNumbers(numberAsString, maxLength);
-    if (smallResult != undefined) {
-        return smallResult;
-    }
-    return truncateBigNumber(numberAsString, customSuffixes, maxLength);
-}

package/dist/cjs/augments/tuple.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLengthAtLeast = isLengthAtLeast;
-exports.assertLengthAtLeast = assertLengthAtLeast;
-function isLengthAtLeast(array, length) {
-    try {
-        assertLengthAtLeast(array, length);
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-function assertLengthAtLeast(array, length, arrayName) {
-    if (array.length < length) {
-        throw new Error(arrayName
-            ? `'${arrayName}' is not at least '${length}' in length.`
-            : `Array is not at least '${length}' in length.`);
-    }
-}

package/dist/cjs/augments/type-recursion.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/type.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeWritable = makeWritable;
-exports.makeReadonly = makeReadonly;
-exports.wrapNarrowTypeWithTypeCheck = wrapNarrowTypeWithTypeCheck;
-exports.ensureType = ensureType;
-function makeWritable(input) {
-    return input;
-}
-function makeReadonly(input) {
-    return input;
-}
-/**
- * This function returns another function that simply returns whatever input it's given. However, it
- * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while
- * maintaining strict "const" like typing.
- *
- * Use like this: wrapNarrowTypeWithTypeCheck<EnforcedTypeHere>()(valueToEnforceTypeOn as const)
- *
- * Sometimes "as const" isn't required, usually it is for any object or array though.
- */
-function wrapNarrowTypeWithTypeCheck() {
-    return (input) => {
-        return input;
-    };
-}
-/**
- * This is a type helper that ensures the given input matches the given generic type. The generic is
- * setup in such a way that if it is omitted (which is typically allowed in TypeScript, resulting in
- * the generic being inferred from the inputs), there will actually be a type error. This forces
- * each usage of this function to explicitly specify the generic, thus giving us type safety for the
- * input.
- */
-function ensureType(input) {
-    return input;
-}

package/dist/cjs/augments/union.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/wrap-in-try.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapInTry = wrapInTry;
-const run_time_assertions_1 = require("run-time-assertions");
-const error_1 = require("./error");
-function wrapInTry(callback, options = {}) {
-    try {
-        const value = callback();
-        if (value instanceof Promise) {
-            return value.catch((error) => {
-                if (options.handleError) {
-                    return options.handleError(error);
-                }
-                else if ((0, run_time_assertions_1.hasProperty)(options, 'fallbackValue')) {
-                    return options.fallbackValue;
-                }
-                else {
-                    return (0, error_1.ensureError)(error);
-                }
-            });
-        }
-        else {
-            return value;
-        }
-    }
-    catch (error) {
-        if (options.handleError) {
-            return options.handleError(error);
-        }
-        else if ((0, run_time_assertions_1.hasProperty)(options, 'fallbackValue')) {
-            return options.fallbackValue;
-        }
-        else {
-            return (0, error_1.ensureError)(error);
-        }
-    }
-}

package/dist/cjs/index.js

@@ -1,60 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./augments/ansi"), exports);
-__exportStar(require("./augments/array/array"), exports);
-__exportStar(require("./augments/array/remove-duplicates"), exports);
-__exportStar(require("./augments/async"), exports);
-__exportStar(require("./augments/boolean"), exports);
-__exportStar(require("./augments/common-number"), exports);
-__exportStar(require("./augments/common-string"), exports);
-__exportStar(require("./augments/debounce"), exports);
-__exportStar(require("./augments/environment"), exports);
-__exportStar(require("./augments/error"), exports);
-__exportStar(require("./augments/esm-path"), exports);
-__exportStar(require("./augments/function"), exports);
-__exportStar(require("./augments/json"), exports);
-__exportStar(require("./augments/json-compatible"), exports);
-__exportStar(require("./augments/object/any-object"), exports);
-__exportStar(require("./augments/object/enum"), exports);
-__exportStar(require("./augments/object/filter-object"), exports);
-__exportStar(require("./augments/object/get-or-set"), exports);
-__exportStar(require("./augments/object/has-key"), exports);
-__exportStar(require("./augments/object/jsonify"), exports);
-__exportStar(require("./augments/object/key-count"), exports);
-__exportStar(require("./augments/object/map-object"), exports);
-__exportStar(require("./augments/object/merge-deep"), exports);
-__exportStar(require("./augments/object/merge-property-arrays"), exports);
-__exportStar(require("./augments/object/object"), exports);
-__exportStar(require("./augments/object/object-entries"), exports);
-__exportStar(require("./augments/object/pick-deep"), exports);
-__exportStar(require("./augments/object/selection-set"), exports);
-__exportStar(require("./augments/object/typed-has-property"), exports);
-__exportStar(require("./augments/promise/deferred-promise"), exports);
-__exportStar(require("./augments/promise/promise"), exports);
-__exportStar(require("./augments/promise/wait"), exports);
-__exportStar(require("./augments/random"), exports);
-__exportStar(require("./augments/regexp"), exports);
-__exportStar(require("./augments/string/prefixes"), exports);
-__exportStar(require("./augments/string/suffixes"), exports);
-__exportStar(require("./augments/string/uuid"), exports);
-__exportStar(require("./augments/time"), exports);
-__exportStar(require("./augments/truncate-number"), exports);
-__exportStar(require("./augments/tuple"), exports);
-__exportStar(require("./augments/type"), exports);
-__exportStar(require("./augments/type-recursion"), exports);
-__exportStar(require("./augments/union"), exports);
-__exportStar(require("./augments/wrap-in-try"), exports);

package/dist/esm/augments/ansi.js

@@ -1,24 +0,0 @@
-// cspell:disable
-/*
-Copied from
-https://github.com/chalk/ansi-regex/blob/1b337add136eb520764634a328e2f6354398eee5/index.js
-because the published ansi-regex package exports this in a manner that Jest can't handle and the
-latest version of the package that doesn't do that has a security vulnerability. The package has
-the following license from
-https://github.com/chalk/ansi-regex/blob/1b337add136eb520764634a328e2f6354398eee5/license
-
-MIT License
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-*/
-// cspell:enable
-const patterns = [
-    '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
-    '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))',
-];
-export const ansiRegex = new RegExp(patterns.join('|'), 'g');

package/dist/esm/augments/array/array.js

@@ -1,57 +0,0 @@
-import { getOrSet } from '../object/get-or-set';
-import { typedObjectFromEntries } from '../object/object-entries';
-export function filterOutIndexes(array, indexes) {
-    return array.filter((_, index) => !indexes.includes(index));
-}
-export function flatten2dArray(array2d) {
-    const flattened = array2d.reduce((accum, row) => accum.concat(row), []);
-    return flattened;
-}
-export function trimArrayStrings(input) {
-    return input.map((line) => line.trim()).filter((line) => line !== '');
-}
-export function typedArrayIncludes(array, input) {
-    return array.includes(input);
-}
-/** Preserves tuple types. */
-export function typedMap(arrayToMap, mapCallback) {
-    return arrayToMap.map(mapCallback);
-}
-export function repeatArray(repeatCount, array) {
-    return Array.from({ length: repeatCount }, () => [...array]).flat();
-}
-/**
- * Polyfill for `Object.groupBy`:
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
- */
-export function groupArrayBy(inputArray, callback) {
-    return inputArray.reduce((accum, entry, index, originalArray) => {
-        const key = callback(entry, index, originalArray);
-        const entryArray = getOrSet(accum, key, () => []);
-        entryArray.push(entry);
-        return accum;
-    }, {});
-}
-/**
- * Like `groupArrayBy` but maps array entries to a single key. Meaning, the resulting object does
- * not have an array of elements (unless the original array itself contains arrays).
- */
-export function arrayToObject(inputArray, callback) {
-    return typedObjectFromEntries(inputArray.map((entry, index, originalArray) => {
-        const key = callback(entry, index, originalArray);
-        return [
-            key,
-            entry,
-        ];
-    }));
-}
-export function filterMap(inputArray, mapCallback, filterCallback) {
-    return inputArray.reduce((accum, entry, index, originalArray) => {
-        const mapOutput = mapCallback(entry, index, originalArray);
-        const filterOutput = filterCallback(mapOutput, entry, index, originalArray);
-        if (filterOutput) {
-            accum.push(mapOutput);
-        }
-        return accum;
-    }, []);
-}

package/dist/esm/augments/array/remove-duplicates.js

@@ -1,13 +0,0 @@
-export function removeDuplicates(originalArray, calculateUniqueIdCallback) {
-    const grouped = new Map();
-    return originalArray.filter((entry) => {
-        const uniqueId = calculateUniqueIdCallback(entry);
-        if (grouped.get(uniqueId)) {
-            return false;
-        }
-        else {
-            grouped.set(uniqueId, entry);
-            return true;
-        }
-    });
-}

package/dist/esm/augments/async.js

@@ -1,23 +0,0 @@
-/**
- * Acts like calling Array.prototype.forEach in that all elements are executed upon in order, and
- * each execution is blocking. Meaning, the callback won't be called on element 2 until the callback
- * has finished its call on element 1.
- */
-export async function awaitedForEach(input, callback) {
-    await awaitedBlockingMap(input, callback);
-}
-export async function awaitedBlockingMap(input, callback) {
-    const mappedValues = await input.reduce(async (accumPromise, currentElement, index, wholeArray) => {
-        const accum = await accumPromise;
-        const mappedValue = await callback(currentElement, index, wholeArray);
-        accum.push(mappedValue);
-        return accum;
-    }, Promise.resolve([]));
-    return mappedValues;
-}
-export async function awaitedFilter(arrayInput, filterCallback, options) {
-    const callbackResults = options?.blocking
-        ? await awaitedBlockingMap(arrayInput, filterCallback)
-        : await Promise.all(arrayInput.map(filterCallback));
-    return arrayInput.filter((originalValue, index) => !!callbackResults[index]);
-}

package/dist/esm/augments/boolean.js

@@ -1,14 +0,0 @@
-export function isTruthy(input) {
-    return !!input;
-}
-export function isFalsy(input) {
-    return !input;
-}
-export function ifTruthy(checkThis, ifTruthyCallback, ifFalsyCallback) {
-    if (isTruthy(checkThis)) {
-        return ifTruthyCallback(checkThis);
-    }
-    else {
-        return ifFalsyCallback(checkThis);
-    }
-}

package/dist/esm/augments/common-number.js

@@ -1,100 +0,0 @@
-import { removeCommasFromNumberString } from './common-string';
-import { safeMatch } from './regexp';
-export const NaNString = String(NaN);
-export function addCommasToNumber(input) {
-    if (typeof input === 'string' && isNaN(Number(input))) {
-        return NaNString;
-    }
-    const numericValue = Number(input);
-    const isNegative = numericValue < 0;
-    const stringValue = String(Math.abs(numericValue));
-    const [digits, decimalValues,] = stringValue.split('.');
-    const decimalString = decimalValues ? `.${decimalValues}` : '';
-    const separated = safeMatch(digits.split('').reverse().join(''), /.{1,3}/g)
-        .reverse()
-        .map((entry) => entry.split('').reverse().join(''));
-    const valueWithCommas = separated.join(',');
-    const negativeMarker = isNegative ? '-' : '';
-    return [
-        negativeMarker,
-        valueWithCommas,
-        decimalString,
-    ].join('');
-}
-export function doesRequireScientificNotation(input) {
-    return String(input).includes('e');
-}
-/**
- * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
- * that is not the case, the returned value is the given min and max values swapped.
- */
-export function ensureMinAndMax({ min, max }) {
-    if (min > max) {
-        return { min: max, max: min };
-    }
-    else {
-        return { min, max };
-    }
-}
-/**
- * Tries to convert the input into a number. Handles strings with commas. Note: this might return
- * `NaN`.
- */
-export function toNumber(input) {
-    if (typeof input === 'number') {
-        return input;
-    }
-    else if (typeof input === 'string') {
-        return Number(removeCommasFromNumberString(input));
-    }
-    else {
-        return Number(input);
-    }
-}
-/** @deprecated Use {@link toNumber} instead. */
-export const convertIntoNumber = toNumber;
-/** Tries to convert the input into a number and throws an error if `NaN` is created. */
-export function toEnsuredNumber(input) {
-    const numeric = toMaybeNumber(input);
-    if (numeric == undefined) {
-        throw new Error(`Cannot convert to a number: ${input}`);
-    }
-    else {
-        return numeric;
-    }
-}
-/** Tries to convert the input into a number and returns `undefined` if `NaN` is created. */
-export function toMaybeNumber(input) {
-    const numeric = toNumber(input);
-    if (isNaN(numeric)) {
-        return undefined;
-    }
-    else {
-        return numeric;
-    }
-}
-/**
- * If the given value is outside the given min/max bounds, instead of clamping the number (as the
- * `clamp` function does), this function wraps the value around to the next bound.
- *
- * @example
- *     wrapNumber({min: 0, max: 100, value: 101}) == 0;
- */
-export function wrapNumber({ max, min, value }) {
-    if (value > max) {
-        return min;
-    }
-    else if (value < min) {
-        return max;
-    }
-    return value;
-}
-export function round(inputs) {
-    const digitFactor = Math.pow(10, inputs.digits);
-    const multiplied = inputs.number * digitFactor;
-    return Number((Math.round(multiplied) / digitFactor).toFixed(inputs.digits));
-}
-/** Clamp's the given value to within the min and max bounds, inclusive. */
-export function clamp({ value, min, max }) {
-    return Math.min(Math.max(value, min), max);
-}