@augment-vir/core 31.36.0 → 31.37.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/object/stringify.js

@@ -25,6 +25,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/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,4 +1,5 @@
 export * from './augments/array/array.js';
+export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/tuple.js';
 export * from './augments/enum/enum-type.js';
 export * from './augments/enum/enum-values.js';
@@ -21,10 +22,12 @@ 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/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,4 +1,5 @@
 export * from './augments/array/array.js';
+export * from './augments/array/remove-duplicates.js';
 export * from './augments/array/tuple.js';
 export * from './augments/enum/enum-type.js';
 export * from './augments/enum/enum-values.js';
@@ -21,10 +22,12 @@ 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/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.37.0",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {