@augment-vir/common 29.2.0 → 30.0.0

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/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/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);
-}

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

@@ -1,227 +0,0 @@
-import { ansiRegex } from './ansi';
-import { deDupeRegExFlags } from './regexp';
-/**
- * Join elements into a string with commas separating each value. Add a conjunction before the final
- * item in the list. If the array has a length < 2, the conjunction is not added. If the list is
- * only of length 2, then no commas are added.
- *
- * @param list Array of items to be converted into strings. Works best if these are simply strings
- *   to begin with.
- * @param conjunction Defaults to 'and'. The conjunction to be used before the final element.
- */
-export function joinWithFinalConjunction(list, conjunction = 'and') {
-    if (list.length < 2) {
-        /**
-         * If there are not multiple things in the list to join, just turn the list into a string
-         * for an empty list, this will be '', for a single item list, this will just be the first
-         * item as a string.
-         */
-        return list.join('');
-    }
-    /** When there are only two items in the list, we don't want any commas. */
-    const commaSep = list.length > 2 ? ', ' : ' ';
-    const commaJoined = list.slice(0, -1).join(commaSep);
-    const fullyJoined = `${commaJoined}${commaSep}${conjunction} ${list[list.length - 1]}`;
-    return fullyJoined;
-}
-/** Wraps `value` on both sides with `wrapper`. */
-export function wrapString({ value, wrapper }) {
-    return [
-        wrapper,
-        wrapper,
-    ].join(value);
-}
-export function removeAnsiEscapeCodes(input) {
-    return input.replace(ansiRegex, '');
-}
-export const removeColor = removeAnsiEscapeCodes;
-export function removeCommasFromNumberString(numberString) {
-    return numberString.replace(/,/g, '');
-}
-/** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
-export function collapseWhiteSpace(input, { keepNewLines } = {}) {
-    const newLineReplacement = keepNewLines
-        ? input.replace(/[\s\n]*\n+[\s\n]*/g, '\n')
-        : // sometimes \n isn't included in \s
-            input.replace(/\n/g, ' ');
-    return newLineReplacement
-        .trim()
-        .replace(/[^\S\r\n]/g, ' ')
-        .replace(/\s{2,}/g, ' ');
-}
-/** Same as String.prototype.split but includes the delimiter to split by in the output array. */
-export function splitIncludeSplit(original, splitterInput, caseSensitive) {
-    const indexLengths = getAllIndexesOf({
-        searchIn: original,
-        searchFor: splitterInput,
-        caseSensitive,
-        includeLength: true,
-    });
-    const splitter = makeCaseInsensitiveRegExp(splitterInput, caseSensitive);
-    const splits = original.split(splitter);
-    const splitterIncluded = splits.reduce((accum, current, index) => {
-        // this will be undefined on the last index
-        const splitterLength = indexLengths[index];
-        const includeCurrent = accum.concat(current);
-        if (splitterLength) {
-            const splitterMatch = original.slice(splitterLength.index, splitterLength.index + splitterLength.length);
-            return includeCurrent.concat(splitterMatch);
-        }
-        else {
-            return includeCurrent;
-        }
-    }, []);
-    return splitterIncluded;
-}
-const defaultCasingOptions = {
-    capitalizeFirstLetter: false,
-};
-export function capitalizeFirstLetter(input) {
-    if (!input.length) {
-        return '';
-    }
-    const firstLetter = input[0];
-    return (firstLetter.toUpperCase() + input.slice(1));
-}
-function maybeCapitalize(input, casingOptions) {
-    return casingOptions.capitalizeFirstLetter ? capitalizeFirstLetter(input) : input;
-}
-export function kebabCaseToCamelCase(rawKebabCase, casingOptions = defaultCasingOptions) {
-    const kebabCase = rawKebabCase.toLowerCase();
-    if (!kebabCase.length) {
-        return '';
-    }
-    const camelCase = kebabCase
-        .replace(/^-+/, '')
-        .replace(/-{2,}/g, '-')
-        .replace(/-(?:.|$)/g, (dashMatch) => {
-        const letter = dashMatch[1];
-        if (letter) {
-            return letter.toUpperCase();
-        }
-        else {
-            return '';
-        }
-    });
-    return maybeCapitalize(camelCase, casingOptions);
-}
-export var StringCaseEnum;
-(function (StringCaseEnum) {
-    StringCaseEnum["Upper"] = "upper";
-    StringCaseEnum["Lower"] = "lower";
-})(StringCaseEnum || (StringCaseEnum = {}));
-/** Indicates whether the given string has different lower and upper case variants. */
-export function hasCase(input) {
-    return input.toLowerCase() !== input.toUpperCase();
-}
-/**
- * Checks if the given string is exclusively of the specific case.
- *
- * Note that some characters have no casing, such as punctuation (they have no difference between
- * upper and lower casings). By default, those letters always return `true` for this function,
- * regardless of which `caseType` is provided. To instead return `false` for any such characters,
- * pass in an options object and set blockNoCaseCharacters to true.
- */
-export function isCase(input, caseType, options) {
-    if (!input && options?.blockNoCaseCharacters) {
-        return false;
-    }
-    for (let letterIndex = 0; letterIndex < input.length; letterIndex++) {
-        const letter = input[letterIndex] || '';
-        if (!hasCase(letter)) {
-            if (options?.blockNoCaseCharacters) {
-                return false;
-            }
-            else {
-                continue;
-            }
-        }
-        if (caseType === StringCaseEnum.Upper && letter !== letter.toUpperCase()) {
-            return false;
-        }
-        else if (caseType === StringCaseEnum.Lower && letter !== letter.toLowerCase()) {
-            return false;
-        }
-    }
-    return true;
-}
-export function camelCaseToKebabCase(rawCamelCase) {
-    const kebabCase = rawCamelCase
-        .split('')
-        .reduce((accum, currentLetter, index, originalString) => {
-        const previousLetter = index > 0 ? originalString[index - 1] || '' : '';
-        const nextLetter = index < originalString.length - 1 ? originalString[index + 1] || '' : '';
-        const possibleWordBoundary = isCase(previousLetter, StringCaseEnum.Lower, { blockNoCaseCharacters: true }) ||
-            isCase(nextLetter, StringCaseEnum.Lower, { blockNoCaseCharacters: true });
-        if (currentLetter === currentLetter.toLowerCase() ||
-            index === 0 ||
-            !possibleWordBoundary) {
-            accum += currentLetter;
-        }
-        else {
-            accum += `-${currentLetter.toLowerCase()}`;
-        }
-        return accum;
-    }, '')
-        .toLowerCase();
-    return kebabCase;
-}
-export function replaceStringAtIndex(originalString, start, newString, length = newString.length) {
-    const before = originalString.substring(0, start);
-    const after = originalString.substring(start + length);
-    return `${before}${newString}${after}`;
-}
-/**
- * Escapes characters from the given string so that it can be used within a RegExp without being
- * parsed as RegExp syntax.
- */
-export function escapeStringForRegExp(input) {
-    return input.replace(/[\^$\\.*+?()[\]{}|]/g, '\\$&');
-}
-function makeCaseInsensitiveRegExp(searchForInput, caseSensitive) {
-    const regExpFlags = `g${!caseSensitive && typeof searchForInput === 'string' ? 'i' : ''}`;
-    const searchFor = searchForInput instanceof RegExp
-        ? new RegExp(searchForInput.source, deDupeRegExFlags(`${searchForInput.flags}${regExpFlags}`))
-        : new RegExp(escapeStringForRegExp(searchForInput), regExpFlags);
-    return searchFor;
-}
-export function getAllIndexesOf({ searchIn, searchFor, caseSensitive, includeLength, }) {
-    const searchRegExp = makeCaseInsensitiveRegExp(searchFor, caseSensitive);
-    const indexes = [];
-    const indexesAndLengths = [];
-    searchIn.replace(searchRegExp, (...matchResults) => {
-        /**
-         * Grabbing the second to last entry in the array (rather than the second) takes capture
-         * groups into account.
-         */
-        const matchIndex = matchResults[matchResults.length - 2];
-        // this is used as a type safety catch and cannot actually be triggered on purpose
-        // istanbul ignore next
-        if (typeof matchIndex !== 'number') {
-            throw new Error(`Match index "${matchIndex}" is not a number. Searching for "${searchFor}" in "${searchIn}".`);
-        }
-        const regExpMatch = matchResults[0];
-        // this is used as a type safety catch and cannot actually be triggered on purpose
-        // istanbul ignore next
-        if (typeof regExpMatch !== 'string') {
-            throw new Error(`regExpMatch should've been a string but was ${typeof regExpMatch}!`);
-        }
-        indexesAndLengths.push({ index: matchIndex, length: regExpMatch.length });
-        indexes.push(matchIndex);
-        const originalMatch = matchResults[0];
-        // this is used as a type safety catch and cannot actually be triggered on purpose
-        // istanbul ignore next
-        if (typeof originalMatch !== 'string') {
-            throw new Error(`Original match when searching for "${searchFor}" in "${searchIn}" at index ${matchIndex} is not a string.`);
-        }
-        /**
-         * Don't actually change any text. What we do here doesn't matter because we're not
-         * using the output of the .replace method, we're just producing side effects.
-         */
-        return originalMatch;
-    });
-    return (includeLength ? indexesAndLengths : indexes);
-}
-export function typedSplit(input, splitString) {
-    return input.split(splitString);
-}

package/dist/esm/augments/debounce.js

@@ -1,34 +0,0 @@
-export var DebounceStyle;
-(function (DebounceStyle) {
-    /**
-     * Fires on the first call, then waits the given amount of milliseconds until a subsequent call
-     * can be made.
-     */
-    DebounceStyle["FirstThenWait"] = "first-then-wait";
-    /**
-     * Waits the given amount of milliseconds after the first call and then fires the latest
-     * assigned callback.
-     */
-    DebounceStyle["AfterWait"] = "after-wait";
-})(DebounceStyle || (DebounceStyle = {}));
-export function createDebounce(debounceStyle, debounceDuration) {
-    let nextCallTimestamp = 0;
-    let latestCallback = undefined;
-    return (callback) => {
-        latestCallback = callback;
-        const now = Date.now();
-        if (nextCallTimestamp > now) {
-            return;
-        }
-        if (debounceStyle === DebounceStyle.FirstThenWait) {
-            latestCallback();
-        }
-        else if (debounceStyle === DebounceStyle.AfterWait) {
-            setTimeout(() => {
-                /** Use whatever the latest latestCallback is. */
-                latestCallback?.();
-            }, debounceDuration.milliseconds);
-        }
-        nextCallTimestamp = now + debounceDuration.milliseconds;
-    };
-}

package/dist/esm/augments/environment.js

@@ -1,3 +0,0 @@
-export function isBrowser() {
-    return typeof window !== 'undefined';
-}

package/dist/esm/augments/error.js

@@ -1,45 +0,0 @@
-import { isTruthy } from './boolean';
-import { typedHasProperty } from './object/typed-has-property';
-export function combineErrors(errors) {
-    if (!errors || errors.length === 0) {
-        return undefined;
-    }
-    const firstError = errors[0];
-    if (errors.length === 1 && firstError) {
-        return firstError;
-    }
-    return new Error(errors.map((error) => extractErrorMessage(error).trim()).join('\n'));
-}
-export function combineErrorMessages(errors) {
-    if (!errors) {
-        return '';
-    }
-    return errors.map(extractErrorMessage).filter(isTruthy).join('\n');
-}
-export function extractErrorMessage(maybeError) {
-    if (!maybeError) {
-        return '';
-    }
-    if (maybeError instanceof Error) {
-        return maybeError.message;
-    }
-    else if (typedHasProperty(maybeError, 'message')) {
-        return String(maybeError.message);
-    }
-    else {
-        return String(maybeError);
-    }
-}
-export function ensureError(maybeError) {
-    if (maybeError instanceof Error) {
-        return maybeError;
-    }
-    else {
-        return new Error(extractErrorMessage(maybeError));
-    }
-}
-export function ensureErrorAndPrependMessage(maybeError, prependMessage) {
-    const error = ensureError(maybeError);
-    error.message = `${prependMessage}: ${error.message}`;
-    return error;
-}

package/dist/esm/augments/json.js

@@ -1,24 +0,0 @@
-import { wrapInTry } from './wrap-in-try';
-export function parseJson({ jsonString, errorHandler, }) {
-    try {
-        const parsedJson = JSON.parse(jsonString);
-        return parsedJson;
-    }
-    catch (error) {
-        if (errorHandler) {
-            return errorHandler(error);
-        }
-        else {
-            throw error;
-        }
-    }
-}
-export function stringifyJson(jsonValue, { whitespace, ...tryOptions } = {}) {
-    const result = wrapInTry(() => JSON.stringify(jsonValue, undefined, whitespace), tryOptions);
-    if (result instanceof Error) {
-        throw result;
-    }
-    else {
-        return result;
-    }
-}

package/dist/esm/augments/object/enum.js

@@ -1,41 +0,0 @@
-import { getObjectTypedKeys } from './object-entries';
-export function getEnumTypedKeys(input) {
-    // enum keys are always strings
-    return getObjectTypedKeys(input).filter((key) => isNaN(Number(key)));
-}
-export function getEnumTypedValues(input) {
-    const keys = getEnumTypedKeys(input);
-    return keys.map((key) => input[key]);
-}
-/** Check if the given value is within the given enum. */
-export function isEnumValue(input, checkEnum) {
-    return getEnumTypedValues(checkEnum).includes(input);
-}
-/** Interpret a primitive as an enum value with type safety. */
-export function ensureEnum(value, checkEnum) {
-    if (isEnumValue(value, checkEnum)) {
-        return value;
-    }
-    else {
-        const enumValues = getEnumTypedValues(checkEnum);
-        throw new Error(`Given value '${value}' does not match given enum. Possible enum values: ${enumValues.join(',')}`);
-    }
-}
-export function filterToEnumValues(inputs, checkEnum, caseInsensitive = false) {
-    if (caseInsensitive) {
-        return inputs.reduce((accum, currentInput) => {
-            const matchedEnumValue = getEnumTypedValues(checkEnum).find((actualEnumValue) => {
-                return String(actualEnumValue).toUpperCase() === String(currentInput).toUpperCase();
-            });
-            if (matchedEnumValue) {
-                return accum.concat(matchedEnumValue);
-            }
-            else {
-                return accum;
-            }
-        }, []);
-    }
-    else {
-        return inputs.filter((input) => isEnumValue(input, checkEnum));
-    }
-}

package/dist/esm/augments/object/filter-object.js

@@ -1,21 +0,0 @@
-import { getObjectTypedKeys } from './object-entries';
-export function filterObject(inputObject, callback) {
-    const filteredKeys = getObjectTypedKeys(inputObject).filter((key) => {
-        const value = inputObject[key];
-        return callback(key, value, inputObject);
-    });
-    return filteredKeys.reduce((accum, key) => {
-        accum[key] = inputObject[key];
-        return accum;
-    }, {});
-}
-export function omitObjectKeys(inputObject, omitTheseKeys) {
-    return filterObject(inputObject, (currentKey) => {
-        return !omitTheseKeys.includes(currentKey);
-    });
-}
-export function pickObjectKeys(inputObject, pickTheseKeys) {
-    return filterObject(inputObject, (currentKey) => {
-        return pickTheseKeys.includes(currentKey);
-    });
-}

package/dist/esm/augments/object/has-key.js

@@ -1,3 +0,0 @@
-export function hasKey(parent, property) {
-    return property in parent;
-}

package/dist/esm/augments/object/jsonify.js

@@ -1,3 +0,0 @@
-export function jsonify(input) {
-    return JSON.parse(JSON.stringify(input));
-}

package/dist/esm/augments/object/object-entries.js

@@ -1,32 +0,0 @@
-import { typedHasProperty } from './typed-has-property';
-/** @deprecated This is the same as hasKey */
-export function isKeyof(key, object) {
-    return typedHasProperty(object, key);
-}
-export function getObjectTypedKeys(input) {
-    let reflectKeys;
-    try {
-        reflectKeys = Reflect.ownKeys(input);
-    }
-    catch (error) { }
-    return (reflectKeys ??
-        [
-            ...Object.keys(input),
-            ...Object.getOwnPropertySymbols(input),
-        ]);
-}
-export function getObjectTypedValues(input) {
-    return getObjectTypedKeys(input).map((key) => input[key]);
-}
-export function getObjectTypedEntries(input) {
-    return getObjectTypedKeys(input).map((key) => [
-        key,
-        input[key],
-    ]);
-}
-export function getEntriesSortedByKey(input) {
-    return Object.entries(input).sort((tupleA, tupleB) => tupleA[0].localeCompare(tupleB[0]));
-}
-export function typedObjectFromEntries(entries) {
-    return Object.fromEntries(entries);
-}

package/dist/esm/augments/object/object.js

@@ -1,14 +0,0 @@
-/** Checks if the input is non-null and an object. Includes arrays. */
-export function isObject(input) {
-    return !!input && typeof input === 'object';
-}
-/** The input here must be serializable otherwise JSON parsing errors will be thrown */
-export function copyThroughJson(input) {
-    try {
-        return JSON.parse(JSON.stringify(input));
-    }
-    catch (error) {
-        console.error(`Failed to JSON copy for`, input);
-        throw error;
-    }
-}