@augment-vir/core 31.36.0 → 31.38.0

package/dist/augments/array/remove-duplicates.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Removes duplicates from an array. Optionally provide a callback for calculating a unique id for
+ * entries.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example No callback
+ *
+ * ```ts
+ * import {removeDuplicates} from '@augment-vir/common';
+ *
+ * const result = removeDuplicates([
+ *     1,
+ *     1,
+ *     1,
+ *     1,
+ *     1,
+ *     2,
+ *     4,
+ * ]);
+ * // result is `[1, 2, 4]`
+ *
+ * const exampleEntry = {id: 5};
+ *
+ * const result2 = removeDuplicates([
+ *     {id: 1},
+ *     // this entry will not get filtered out because it's a new object reference
+ *     {id: 1},
+ *     exampleEntry,
+ *     // this `exampleEntry` will get filtered out because it's the same reference as the one above
+ *     exampleEntry,
+ *     {id: 4},
+ * ]);
+ * // result2 is `[{id: 1}, {id: 1}, exampleEntry, {id: 4}]`
+ * ```
+ *
+ * @example With callback
+ *
+ * ```ts
+ * import {removeDuplicates} from '@augment-vir/common';
+ *
+ * const exampleEntry = {id: 5};
+ *
+ * const result2 = removeDuplicates(
+ *     [
+ *         {id: 1},
+ *         {id: 1},
+ *         exampleEntry,
+ *         exampleEntry,
+ *         {id: 4},
+ *     ],
+ *     (entry) => entry.id,
+ * );
+ * // result2 is `[{id: 1}, exampleEntry, {id: 4}]`
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function removeDuplicates<const Entry>(originalArray: ReadonlyArray<Entry>, calculateUniqueId?: (entry: Readonly<Entry>) => unknown): Entry[];

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

@@ -0,0 +1,72 @@
+/**
+ * Removes duplicates from an array. Optionally provide a callback for calculating a unique id for
+ * entries.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example No callback
+ *
+ * ```ts
+ * import {removeDuplicates} from '@augment-vir/common';
+ *
+ * const result = removeDuplicates([
+ *     1,
+ *     1,
+ *     1,
+ *     1,
+ *     1,
+ *     2,
+ *     4,
+ * ]);
+ * // result is `[1, 2, 4]`
+ *
+ * const exampleEntry = {id: 5};
+ *
+ * const result2 = removeDuplicates([
+ *     {id: 1},
+ *     // this entry will not get filtered out because it's a new object reference
+ *     {id: 1},
+ *     exampleEntry,
+ *     // this `exampleEntry` will get filtered out because it's the same reference as the one above
+ *     exampleEntry,
+ *     {id: 4},
+ * ]);
+ * // result2 is `[{id: 1}, {id: 1}, exampleEntry, {id: 4}]`
+ * ```
+ *
+ * @example With callback
+ *
+ * ```ts
+ * import {removeDuplicates} from '@augment-vir/common';
+ *
+ * const exampleEntry = {id: 5};
+ *
+ * const result2 = removeDuplicates(
+ *     [
+ *         {id: 1},
+ *         {id: 1},
+ *         exampleEntry,
+ *         exampleEntry,
+ *         {id: 4},
+ *     ],
+ *     (entry) => entry.id,
+ * );
+ * // result2 is `[{id: 1}, exampleEntry, {id: 4}]`
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function removeDuplicates(originalArray, calculateUniqueId = (entry) => entry) {
+    const grouped = new Map();
+    return originalArray.filter((entry) => {
+        const uniqueId = calculateUniqueId(entry);
+        if (grouped.get(uniqueId)) {
+            return false;
+        }
+        else {
+            grouped.set(uniqueId, entry);
+            return true;
+        }
+    });
+}

package/dist/augments/diff/pretty-diff.d.ts

@@ -0,0 +1 @@
+export declare function prettyDiff(actual: unknown, expected: unknown): string;

package/dist/augments/diff/pretty-diff.js

@@ -0,0 +1,84 @@
+import { diffLines, diffWords } from 'diff';
+import { stringify } from '../object/stringify.js';
+import { isRuntimeEnv, RuntimeEnv } from '../runtime-env.js';
+export function prettyDiff(actual, expected) {
+    const bothStrings = typeof expected === 'string' && typeof actual === 'string';
+    const useLines = typeof expected !== 'string' || typeof actual !== 'string';
+    const diffFunction = (useLines ? diffLines : diffWords);
+    const expectedString = [
+        bothStrings ? '' : '\n',
+        stringify(expected, 4),
+        '\n',
+    ].join('');
+    const actualString = [
+        bothStrings ? '' : '\n',
+        stringify(actual, 4),
+        '\n',
+    ].join('');
+    const changes = addDiffColors(useLines, diffFunction(expectedString, actualString));
+    const useColor = isRuntimeEnv(RuntimeEnv.Node);
+    /* node:coverage ignore next 7: currently only tested in node */
+    const explanationLine = [
+        useColor ? NodeColor.Green : '',
+        ' +added',
+        useColor ? NodeColor.Red : '',
+        ' -missing',
+        useColor ? NodeColor.Reset : '',
+    ].join('');
+    return [
+        explanationLine,
+        bothStrings ? '\n\n' : '\n',
+        changes,
+    ].join('');
+}
+var NodeColor;
+(function (NodeColor) {
+    NodeColor["Green"] = "\u001B[32m";
+    NodeColor["Red"] = "\u001B[31m";
+    NodeColor["Reset"] = "\u001B[0m";
+})(NodeColor || (NodeColor = {}));
+var DiffPrefix;
+(function (DiffPrefix) {
+    DiffPrefix["Added"] = "+";
+    DiffPrefix["Removed"] = "-";
+})(DiffPrefix || (DiffPrefix = {}));
+function addDiffColors(shouldUseLines, changes) {
+    const coloredDiff = shouldUseLines
+        ? changes
+            .flatMap((change) => {
+            return change.value
+                .split('\n')
+                .map((line) => {
+                return addColorToChange(line, change);
+            })
+                .join('\n');
+        })
+            .join('')
+        : changes
+            .map((change) => {
+            return addColorToChange(undefined, change);
+        })
+            .join('');
+    return coloredDiff;
+}
+function addColorToChange(line, change) {
+    if (line != undefined && !line) {
+        return '';
+    }
+    const useColor = isRuntimeEnv(RuntimeEnv.Node);
+    const prefix = change.added
+        ? DiffPrefix.Added
+        : change.removed
+            ? DiffPrefix.Removed
+            : line == undefined
+                ? ''
+                : ' ';
+    const color = change.added ? NodeColor.Green : change.removed ? NodeColor.Red : NodeColor.Reset;
+    return [
+        /* node:coverage ignore next 1 */
+        useColor ? color : '',
+        prefix,
+        line ?? change.value,
+        NodeColor.Reset,
+    ].join('');
+}

package/dist/augments/diff/pretty-diff.mock.d.ts

@@ -0,0 +1,5 @@
+import { type prettyDiff } from './pretty-diff.js';
+export declare const mockPrettyDiffTestCases: {
+    it: string;
+    inputs: Parameters<typeof prettyDiff>;
+}[];

package/dist/augments/diff/pretty-diff.mock.js

@@ -0,0 +1,62 @@
+export const mockPrettyDiffTestCases = [
+    {
+        it: 'handles strings',
+        inputs: [
+            'hello there why',
+            'hello what why',
+        ],
+    },
+    {
+        it: 'handles objects',
+        inputs: [
+            { a: 'hello there', b: 'goodbye now' },
+            { a: 'hello there' },
+        ],
+    },
+    {
+        it: 'handles numbers',
+        inputs: [
+            52,
+            40,
+        ],
+    },
+    {
+        it: 'expected object but got string',
+        inputs: [
+            'hello there',
+            {
+                a: 'hello there',
+            },
+        ],
+    },
+    {
+        it: 'expected string but got object',
+        inputs: [
+            {
+                a: 'hello there',
+            },
+            'hello there',
+        ],
+    },
+    {
+        it: 'expected number but got string',
+        inputs: [
+            'hello there',
+            42,
+        ],
+    },
+    {
+        it: 'expected string but got number',
+        inputs: [
+            42,
+            'hello there',
+        ],
+    },
+    {
+        it: 'got completely different strings',
+        inputs: [
+            'nothing here',
+            'hello there',
+        ],
+    },
+];

package/dist/augments/diff/pretty-diff.mock.script.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/augments/diff/pretty-diff.mock.script.js

@@ -0,0 +1,9 @@
+/* node:coverage disable */
+/** Run this script (without any args) to see what the pretty diff string printing looks like. */
+import { prettyDiff } from './pretty-diff.js';
+import { mockPrettyDiffTestCases } from './pretty-diff.mock.js';
+mockPrettyDiffTestCases.forEach((testCase) => {
+    console.info('================================');
+    console.info(testCase.it);
+    console.info(prettyDiff(...testCase.inputs));
+});

package/dist/augments/object/stringify.js

@@ -18,6 +18,9 @@ const undefinedSentinelStringRegExp = new RegExp(`['"]${undefinedSentinel}['"]`)
 export function stringify(input, 
 /** Passed directly to the `space` parameter of `JSON.stringify`. */
 space) {
+    if (typeof input === 'string') {
+        return input;
+    }
     try {
         const json5String = JSON5.stringify(input, 
         // Use a replacer to turn undefined into a unique string so the key is kept.
@@ -25,6 +28,9 @@ space) {
             if (value === undefined) {
                 return undefinedSentinel;
             }
+            else if (typeof value === 'bigint') {
+                return Number(value);
+            }
             return value;
         }, space || undefined);
         return json5String.split(undefinedSentinelStringRegExp).join('undefined');

package/dist/augments/regexp/regexp-flags.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Creates a new RegExp by adding the given `flags` to the original RegExp.
+ *
+ * @category RegExp
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {addRegExpFlags} from '@augment-vir/common';
+ *
+ * addRegExpFlags(/a/i, 'gm');
+ * // output is `/a/igm`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function addRegExpFlags(originalRegExpOrString: RegExp | string, flags: string): RegExp;
+/**
+ * Creates a new RegExp with the given `flags`.
+ *
+ * @category RegExp
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {setRegExpFlags} from '@augment-vir/common';
+ *
+ * setRegExpFlags(/a/i, 'gm');
+ * // output is `/a/gm`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function setRegExpFlags(originalRegExpOrString: RegExp | string, flags: string): RegExp;
+/**
+ * Creates a new RegExp by adding or removing the case insensitivity flag `'i'`, based on the given
+ * `caseSensitive` input. The first input can also be a string and it will be converted into a
+ * RegExp.
+ *
+ * @category RegExp
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {setRegExpCaseSensitivity} from '@augment-vir/common';
+ *
+ * setRegExpCaseSensitivity(/abc/i, {caseSensitive: true}); // output is `/abc/`
+ * setRegExpCaseSensitivity(/abc/, {caseSensitive: false}); // output is `/abc/i`
+ * setRegExpCaseSensitivity('abc', {caseSensitive: true}); // output is `/abc/i`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function setRegExpCaseSensitivity(originalRegExpOrString: string | RegExp, { caseSensitive }: {
+    caseSensitive: boolean;
+}): RegExp;

package/dist/augments/regexp/regexp-flags.js

@@ -0,0 +1,80 @@
+import { removeDuplicateCharacters } from '../string/remove-duplicate-characters.js';
+import { escapeStringForRegExp } from './regexp-string.js';
+/**
+ * Creates a new RegExp by adding the given `flags` to the original RegExp.
+ *
+ * @category RegExp
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {addRegExpFlags} from '@augment-vir/common';
+ *
+ * addRegExpFlags(/a/i, 'gm');
+ * // output is `/a/igm`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function addRegExpFlags(originalRegExpOrString, flags) {
+    const allFlags = removeDuplicateCharacters([
+        typeof originalRegExpOrString === 'string' ? '' : originalRegExpOrString.flags,
+        flags,
+    ]
+        .join('')
+        .toLowerCase());
+    return setRegExpFlags(originalRegExpOrString, allFlags);
+}
+/**
+ * Creates a new RegExp with the given `flags`.
+ *
+ * @category RegExp
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {setRegExpFlags} from '@augment-vir/common';
+ *
+ * setRegExpFlags(/a/i, 'gm');
+ * // output is `/a/gm`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function setRegExpFlags(originalRegExpOrString, flags) {
+    const allFlags = removeDuplicateCharacters(flags);
+    if (typeof originalRegExpOrString === 'string') {
+        return new RegExp(escapeStringForRegExp(originalRegExpOrString), allFlags);
+    }
+    else {
+        return new RegExp(originalRegExpOrString.source, allFlags);
+    }
+}
+/**
+ * Creates a new RegExp by adding or removing the case insensitivity flag `'i'`, based on the given
+ * `caseSensitive` input. The first input can also be a string and it will be converted into a
+ * RegExp.
+ *
+ * @category RegExp
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {setRegExpCaseSensitivity} from '@augment-vir/common';
+ *
+ * setRegExpCaseSensitivity(/abc/i, {caseSensitive: true}); // output is `/abc/`
+ * setRegExpCaseSensitivity(/abc/, {caseSensitive: false}); // output is `/abc/i`
+ * setRegExpCaseSensitivity('abc', {caseSensitive: true}); // output is `/abc/i`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function setRegExpCaseSensitivity(originalRegExpOrString, { caseSensitive }) {
+    const originalFlags = typeof originalRegExpOrString === 'string'
+        ? ''
+        : originalRegExpOrString.flags.toLowerCase();
+    const newFlags = caseSensitive
+        ? originalFlags.replaceAll('i', '')
+        : removeDuplicateCharacters(originalFlags + 'i');
+    return setRegExpFlags(originalRegExpOrString, newFlags);
+}

package/dist/augments/string/indent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Indent all lines in a string by 4 spaces * count.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function indent(value: string, count?: number): string;

package/dist/augments/string/indent.js

@@ -0,0 +1,16 @@
+/**
+ * Indent all lines in a string by 4 spaces * count.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function indent(value, count = 1) {
+    return value
+        .split('\n')
+        .map((line) => [
+        '    '.repeat(Math.round(count)),
+        line,
+    ].join(''))
+        .join('\n');
+}

package/dist/augments/string/match.d.ts

@@ -1,8 +1,8 @@
 /**
- * A case insensitive match between strings.
+ * A case insensitive match between strings or RegExp.
  *
  * @category String
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function match(haystack: string, needle: string): boolean;
+export declare function match(haystack: string, needle: string | RegExp): boolean;

package/dist/augments/string/match.js

@@ -1,11 +1,20 @@
+import { addRegExpFlags } from '../regexp/regexp-flags.js';
 import { escapeStringForRegExp } from '../regexp/regexp-string.js';
 /**
- * A case insensitive match between strings.
+ * A case insensitive match between strings or RegExp.
  *
  * @category String
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function match(haystack, needle) {
-    return !!needle && !!new RegExp(escapeStringForRegExp(needle), 'i').exec(haystack);
+    if (!needle) {
+        return false;
+    }
+    else if (typeof needle === 'string') {
+        return !!new RegExp(escapeStringForRegExp(needle), 'i').exec(haystack);
+    }
+    else {
+        return !!addRegExpFlags(needle, 'i').exec(haystack);
+    }
 }

package/dist/augments/string/remove-duplicate-characters.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Removes duplicate characters from any number of strings.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {removeDuplicateCharacters} from '@augment-vir/common';
+ *
+ * removeDuplicateCharacters('aAaBc', 'QrsAa');
+ * // output is `'aABcQrs'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function removeDuplicateCharacters(...values: ReadonlyArray<string>): string;

package/dist/augments/string/remove-duplicate-characters.js

@@ -0,0 +1,22 @@
+import { removeDuplicates } from '../array/remove-duplicates.js';
+/**
+ * Removes duplicate characters from any number of strings.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {removeDuplicateCharacters} from '@augment-vir/common';
+ *
+ * removeDuplicateCharacters('aAaBc', 'QrsAa');
+ * // output is `'aABcQrs'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function removeDuplicateCharacters(...values) {
+    const combined = values.join('');
+    const deDuped = removeDuplicates(Array.from(combined));
+    return Array.from(deDuped).join('');
+}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export * from './augments/array/array.js';
+export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/tuple.js';
+export * from './augments/diff/pretty-diff.js';
 export * from './augments/enum/enum-type.js';
 export * from './augments/enum/enum-values.js';
 export * from './augments/error/ensure-error.js';
@@ -21,10 +23,13 @@ export * from './augments/partial-type.js';
 export * from './augments/promise/deferred-promise.js';
 export * from './augments/promise/maybe-promise.js';
 export * from './augments/promise/wait.js';
+export * from './augments/regexp/regexp-flags.js';
 export * from './augments/regexp/regexp-string.js';
 export * from './augments/runtime-env.js';
 export * from './augments/string/ansi.js';
 export * from './augments/string/casing.js';
+export * from './augments/string/indent.js';
 export * from './augments/string/match.js';
 export * from './augments/string/punctuation.js';
+export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/uuid.js';

package/dist/index.js

@@ -1,5 +1,7 @@
 export * from './augments/array/array.js';
+export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/tuple.js';
+export * from './augments/diff/pretty-diff.js';
 export * from './augments/enum/enum-type.js';
 export * from './augments/enum/enum-values.js';
 export * from './augments/error/ensure-error.js';
@@ -21,10 +23,13 @@ export * from './augments/partial-type.js';
 export * from './augments/promise/deferred-promise.js';
 export * from './augments/promise/maybe-promise.js';
 export * from './augments/promise/wait.js';
+export * from './augments/regexp/regexp-flags.js';
 export * from './augments/regexp/regexp-string.js';
 export * from './augments/runtime-env.js';
 export * from './augments/string/ansi.js';
 export * from './augments/string/casing.js';
+export * from './augments/string/indent.js';
 export * from './augments/string/match.js';
 export * from './augments/string/punctuation.js';
+export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/uuid.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/core",
-    "version": "31.36.0",
+    "version": "31.38.0",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {
@@ -25,16 +25,17 @@
         "start": "tsx src/index.ts",
         "test": "virmator test --no-deps node",
         "test:coverage": "npm run test coverage",
-        "test:update": "npm test"
+        "test:update": "npm test update"
     },
     "dependencies": {
         "@date-vir/duration": "^7.4.2",
         "browser-or-node": "^3.0.0",
+        "diff": "^8.0.2",
         "json5": "^2.2.3",
-        "type-fest": "^5.0.0"
+        "type-fest": "^5.0.1"
     },
     "devDependencies": {
-        "@types/node": "^24.4.0",
+        "@types/node": "^24.5.2",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",
         "typescript": "^5.9.2"