@augment-vir/common 29.3.0 → 30.0.1

package/dist/index.js

@@ -0,0 +1,83 @@
+export * from './augments/array/array-map.js';
+export * from './augments/array/array-to-object.js';
+export * from './augments/array/awaited/awaited-filter.js';
+export * from './augments/array/awaited/awaited-for-each.js';
+export * from './augments/array/awaited/awaited-map.js';
+export * from './augments/array/filter.js';
+export * from './augments/array/remove-duplicates.js';
+export * from './augments/array/repeat-array.js';
+export * from './augments/array/shuffle-array.js';
+export * from './augments/array/string-array.js';
+export * from './augments/core-exports.js';
+export * from './augments/enum/enum-value-check.js';
+export * from './augments/error/combine-errors.js';
+export * from './augments/function/call-asynchronously.js';
+export * from './augments/function/call-with-retries.js';
+export * from './augments/function/debounce.js';
+export * from './augments/function/execution-duration.js';
+export * from './augments/function/if-truthy.js';
+export * from './augments/function/wrap-in-try.js';
+export * from './augments/json/append-json.js';
+export * from './augments/json/copy-through-json.js';
+export * from './augments/json/json-compatible.js';
+export * from './augments/json/jsonify.js';
+export * from './augments/log/log-colors.js';
+export * from './augments/log/log-string.js';
+export * from './augments/log/log-writer.js';
+export * from './augments/log/log.js';
+export * from './augments/log/logger.js';
+export * from './augments/number/clamp.js';
+export * from './augments/number/coords.js';
+export * from './augments/number/digit.js';
+export * from './augments/number/dimensions.js';
+export * from './augments/number/min-max.js';
+export * from './augments/number/number-conversion.js';
+export * from './augments/number/round.js';
+export * from './augments/number/scientific.js';
+export * from './augments/number/truncate-number.js';
+export * from './augments/number/wrap-number.js';
+export * from './augments/object/diff.js';
+export * from './augments/object/empty.js';
+export * from './augments/object/get-or-set.js';
+export * from './augments/object/key-count.js';
+export * from './augments/object/map-entries.js';
+export * from './augments/object/map-enum.js';
+export * from './augments/object/map-values.js';
+export * from './augments/object/merge-deep.js';
+export * from './augments/object/merge-defined-properties.js';
+export * from './augments/object/merge-property-arrays.js';
+export * from './augments/object/object-entries.js';
+export * from './augments/object/object-filter.js';
+export * from './augments/object/object-keys.js';
+export * from './augments/object/object-values.js';
+export * from './augments/path/esm-path.js';
+export * from './augments/prisma/prisma-models.js';
+export * from './augments/promise/timed-promise.js';
+export * from './augments/random/random-boolean.js';
+export * from './augments/random/random-integer.js';
+export * from './augments/random/random-string.js';
+export * from './augments/regexp/match.js';
+export * from './augments/regexp/regexp-flags.js';
+export * from './augments/regexp/regexp-string.js';
+export * from './augments/selection-set/select-collapsed.js';
+export * from './augments/selection-set/select-from.js';
+export * from './augments/selection-set/selection-set.js';
+export * from './augments/string/casing/capitalization.js';
+export * from './augments/string/casing/casing.js';
+export * from './augments/string/casing/kebab-and-camel.js';
+export * from './augments/string/comma.js';
+export * from './augments/string/join.js';
+export * from './augments/string/prefix.js';
+export * from './augments/string/remove-duplicate-characters.js';
+export * from './augments/string/replace.js';
+export * from './augments/string/split.js';
+export * from './augments/string/substring-index.js';
+export * from './augments/string/suffix.js';
+export * from './augments/string/white-space.js';
+export * from './augments/string/wrap-string.js';
+export * from './augments/type/ensure-type.js';
+export * from './augments/type/readonly.js';
+export * from './augments/type/type-recursion.js';
+export * from './augments/type/union.js';
+export * from './augments/type/void-type.js';
+export * from './augments/type/writable.js';

package/package.json

@@ -1,35 +1,63 @@
 {
     "name": "@augment-vir/common",
-    "version": "29.3.0",
-    "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
+    "version": "30.0.1",
+    "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
+    "keywords": [
+        "augment",
+        "helper",
+        "util",
+        "node",
+        "browser",
+        "backend",
+        "frontend",
+        "vir",
+        "augment-vir"
+    ],
+    "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/electrovir/augment-vir"
+        "url": "git+https://github.com/electrovir/augment-vir.git"
     },
-    "license": "MIT",
+    "license": "(MIT or CC0 1.0)",
     "author": {
         "name": "electrovir",
         "url": "https://github.com/electrovir"
     },
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
-    "types": "dist/types/index.d.ts",
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
     "scripts": {
-        "compile": "rm -rf dist && tsc --project tsconfig.json && tsc --project tsconfig.cjs.json",
-        "test": "echo \"use common-test to run tests\" && exit 0",
-        "test:coverage": "npm test",
-        "test:types": "tsc --noEmit"
+        "compile": "virmator compile",
+        "test": "concurrently --colors --kill-others-on-fail -c red,blue --names node,web \"npm run test:node\" \"npm run test:web\"",
+        "test:coverage": "virmator --no-deps test web coverage",
+        "test:node": "virmator --no-deps test node",
+        "test:update": "npm test",
+        "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "browser-or-node": "^3.0.0",
-        "run-time-assertions": "^1.5.1",
-        "type-fest": "^4.21.0"
+        "@augment-vir/assert": "^30.0.1",
+        "@augment-vir/core": "^30.0.1",
+        "@date-vir/duration": "^6.0.0",
+        "ansi-styles": "^6.2.1",
+        "json5": "^2.2.3",
+        "type-fest": "^4.25.0"
     },
     "devDependencies": {
-        "typescript": "5.5.2"
+        "@web/dev-server-esbuild": "^1.0.2",
+        "@web/test-runner": "^0.18.3",
+        "@web/test-runner-commands": "^0.9.0",
+        "@web/test-runner-playwright": "^0.11.0",
+        "@web/test-runner-visual-regression": "^0.9.0",
+        "concurrently": "^8.2.2",
+        "execute-in-browser": "^1.0.3",
+        "istanbul-smart-text-reporter": "^1.1.4"
+    },
+    "engines": {
+        "node": ">=22"
     },
     "publishConfig": {
         "access": "public"

package/dist/cjs/augments/ansi.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ansiRegex = void 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=><~]))',
-];
-exports.ansiRegex = new RegExp(patterns.join('|'), 'g');

package/dist/cjs/augments/array/array.js

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterOutIndexes = filterOutIndexes;
-exports.flatten2dArray = flatten2dArray;
-exports.trimArrayStrings = trimArrayStrings;
-exports.typedArrayIncludes = typedArrayIncludes;
-exports.typedMap = typedMap;
-exports.repeatArray = repeatArray;
-exports.groupArrayBy = groupArrayBy;
-exports.arrayToObject = arrayToObject;
-exports.filterMap = filterMap;
-const get_or_set_1 = require("../object/get-or-set");
-const object_entries_1 = require("../object/object-entries");
-function filterOutIndexes(array, indexes) {
-    return array.filter((_, index) => !indexes.includes(index));
-}
-function flatten2dArray(array2d) {
-    const flattened = array2d.reduce((accum, row) => accum.concat(row), []);
-    return flattened;
-}
-function trimArrayStrings(input) {
-    return input.map((line) => line.trim()).filter((line) => line !== '');
-}
-function typedArrayIncludes(array, input) {
-    return array.includes(input);
-}
-/** Preserves tuple types. */
-function typedMap(arrayToMap, mapCallback) {
-    return arrayToMap.map(mapCallback);
-}
-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
- */
-function groupArrayBy(inputArray, callback) {
-    return inputArray.reduce((accum, entry, index, originalArray) => {
-        const key = callback(entry, index, originalArray);
-        const entryArray = (0, get_or_set_1.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).
- */
-function arrayToObject(inputArray, callback) {
-    return (0, object_entries_1.typedObjectFromEntries)(inputArray.map((entry, index, originalArray) => {
-        const key = callback(entry, index, originalArray);
-        return [
-            key,
-            entry,
-        ];
-    }));
-}
-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/cjs/augments/array/remove-duplicates.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeDuplicates = removeDuplicates;
-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/cjs/augments/async.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.awaitedForEach = awaitedForEach;
-exports.awaitedBlockingMap = awaitedBlockingMap;
-exports.awaitedFilter = awaitedFilter;
-/**
- * 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.
- */
-async function awaitedForEach(input, callback) {
-    await awaitedBlockingMap(input, callback);
-}
-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;
-}
-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/cjs/augments/boolean.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTruthy = isTruthy;
-exports.isFalsy = isFalsy;
-exports.ifTruthy = ifTruthy;
-function isTruthy(input) {
-    return !!input;
-}
-function isFalsy(input) {
-    return !input;
-}
-function ifTruthy(checkThis, ifTruthyCallback, ifFalsyCallback) {
-    if (isTruthy(checkThis)) {
-        return ifTruthyCallback(checkThis);
-    }
-    else {
-        return ifFalsyCallback(checkThis);
-    }
-}

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

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertIntoNumber = exports.NaNString = void 0;
-exports.addCommasToNumber = addCommasToNumber;
-exports.doesRequireScientificNotation = doesRequireScientificNotation;
-exports.ensureMinAndMax = ensureMinAndMax;
-exports.toNumber = toNumber;
-exports.toEnsuredNumber = toEnsuredNumber;
-exports.toMaybeNumber = toMaybeNumber;
-exports.wrapNumber = wrapNumber;
-exports.round = round;
-exports.clamp = clamp;
-const common_string_1 = require("./common-string");
-const regexp_1 = require("./regexp");
-exports.NaNString = String(NaN);
-function addCommasToNumber(input) {
-    if (typeof input === 'string' && isNaN(Number(input))) {
-        return exports.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 = (0, regexp_1.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('');
-}
-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.
- */
-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`.
- */
-function toNumber(input) {
-    if (typeof input === 'number') {
-        return input;
-    }
-    else if (typeof input === 'string') {
-        return Number((0, common_string_1.removeCommasFromNumberString)(input));
-    }
-    else {
-        return Number(input);
-    }
-}
-/** @deprecated Use {@link toNumber} instead. */
-exports.convertIntoNumber = toNumber;
-/** Tries to convert the input into a number and throws an error if `NaN` is created. */
-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. */
-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;
- */
-function wrapNumber({ max, min, value }) {
-    if (value > max) {
-        return min;
-    }
-    else if (value < min) {
-        return max;
-    }
-    return value;
-}
-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. */
-function clamp({ value, min, max }) {
-    return Math.min(Math.max(value, min), max);
-}