@augment-vir/common 31.73.5 → 32.1.0

package/dist/augments/array/filter.js

@@ -26,7 +26,7 @@
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function filterOutIndexes(array, indexes) {
-    return array.filter((_, index) => !indexes.includes(index));
+    return array.filter((entry, index) => !indexes.includes(index));
 }
 /**
  * Performs

package/dist/augments/function/retry.js

@@ -23,9 +23,14 @@ import { ensureErrorAndPrependMessage, wait } from '@augment-vir/core';
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function retry(maxRetries, callback, options = {}) {
-    return internalRetry(0, maxRetries, callback, options);
+    return internalRetry({
+        currentRetry: 0,
+        maxRetries,
+        callback,
+        options,
+    });
 }
-function internalRetry(currentRetry, maxRetries, callback, options = {}) {
+function internalRetry({ currentRetry, maxRetries, callback, options = {}, }) {
     try {
         const result = callback({
             retryCount: currentRetry,
@@ -42,7 +47,12 @@ function internalRetry(currentRetry, maxRetries, callback, options = {}) {
                     if (options.interval) {
                         await wait(options.interval);
                     }
-                    return internalRetry(currentRetry + 1, maxRetries, callback, options);
+                    return internalRetry({
+                        currentRetry: currentRetry + 1,
+                        maxRetries,
+                        callback,
+                        options,
+                    });
                 }
             });
         }
@@ -55,10 +65,20 @@ function internalRetry(currentRetry, maxRetries, callback, options = {}) {
             throw ensureErrorAndPrependMessage(error, 'Retry max reached');
         }
         else if (options.interval) {
-            return wait(options.interval).then(() => internalRetry(currentRetry + 1, maxRetries, callback, options));
+            return wait(options.interval).then(() => internalRetry({
+                currentRetry: currentRetry + 1,
+                maxRetries,
+                callback,
+                options,
+            }));
         }
         else {
-            return internalRetry(currentRetry + 1, maxRetries, callback, options);
+            return internalRetry({
+                currentRetry: currentRetry + 1,
+                maxRetries,
+                callback,
+                options,
+            });
         }
     }
 }

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

@@ -41,11 +41,17 @@ function combineBeforeAndAfterDot({ beforeDot, afterDot = '', maxLength, }) {
     return beforeDot;
 }
 function truncateBigNumber(numberAsString, suffixes, maxLength) {
-    const [beforeDot, afterDot,] = safeSplit(numberAsString, '.');
+    const [beforeDot, afterDot,] = safeSplit({
+        value: numberAsString,
+        splitter: '.',
+    });
     const withCommas = addCommasToNumber(beforeDot);
     const truncationDepth = safeMatch(withCommas, /,/g).length;
     const suffix = suffixes[truncationDepth - 1];
-    const [beforeComma, afterComma,] = safeSplit(withCommas, ',');
+    const [beforeComma, afterComma,] = safeSplit({
+        value: withCommas,
+        splitter: ',',
+    });
     const trailing = [
         afterComma,
         afterDot,
@@ -73,7 +79,10 @@ function truncateBigNumber(numberAsString, suffixes, maxLength) {
 const minScientificNotationLength = '1e+'.length;
 function truncateScientificNotation({ input, maxLength, }) {
     const valueString = String(input);
-    const [beforeExponent, rawExponent,] = safeSplit(valueString, 'e');
+    const [beforeExponent, rawExponent,] = safeSplit({
+        value: valueString,
+        splitter: 'e',
+    });
     const exponent = rawExponent.replace(/^[-+]/, '');
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const plusOrMinus = rawExponent[0];
@@ -82,7 +91,10 @@ function truncateScientificNotation({ input, maxLength, }) {
         plusOrMinus,
         exponent,
     ].join('');
-    const [beforeDot, afterDot,] = safeSplit(beforeExponent, '.');
+    const [beforeDot, afterDot,] = safeSplit({
+        value: beforeExponent,
+        splitter: '.',
+    });
     const minLength = exponent.length + minScientificNotationLength;
     if (minLength === maxLength) {
         // this will look like "4e+4" or "5e-234"
@@ -114,7 +126,10 @@ function truncateScientificNotation({ input, maxLength, }) {
     }
 }
 function handleSmallNumbers(numberAsString, maxLength) {
-    const [beforeDot, afterDot,] = safeSplit(addCommasToNumber(numberAsString), '.');
+    const [beforeDot, afterDot,] = safeSplit({
+        value: addCommasToNumber(numberAsString),
+        splitter: '.',
+    });
     if (beforeDot.length <= maxLength) {
         return combineBeforeAndAfterDot({
             beforeDot,

package/dist/augments/path/sanitize-path.js

@@ -30,7 +30,10 @@ export function sanitizeFileName(original) {
     const extension = extractExtension(sanitized).extension;
     if (extension) {
         return [
-            safeSplit(sanitized, extension)[0],
+            safeSplit({
+                value: sanitized,
+                splitter: extension,
+            })[0],
             extension.replaceAll('_', ''),
         ].join('');
     }

package/dist/augments/random/seeded-random.d.ts

@@ -36,7 +36,7 @@ export type SeededRandomState = [
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare class SeededRandom {
-    private readonly alea;
+    protected readonly alea: AleaRandom;
     /** Generate a new {@link SeededRandom} instance from a seed. */
     static fromSeed(seed: string | number): SeededRandom;
     /** Generate a new {@link SeededRandom} instance from a specific state. */
@@ -50,7 +50,7 @@ export declare class SeededRandom {
      * This constructor is private. Use {@link SeededRandom.fromSeed} or
      * {@link SeededRandom.fromState} instead.
      */
-    private constructor();
+    protected constructor(alea: AleaRandom);
     /** Generates the next deterministic pseudo random number. */
     next(): number;
     /**
@@ -60,3 +60,42 @@ export declare class SeededRandom {
      */
     clone(): SeededRandom;
 }
+/**
+ * Alea algorithm has the following license from http://baagoe.com/en/RandomMusings/javascript. The
+ * code has been modified to fit into a class structure and simplify code flow and arguments. The
+ * algorithm itself has not changed.
+ *
+ * Copyright (C) 2010 by Johannes Baagøe (baagoe@baagoe.org)
+ *
+ * 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.
+ */
+/** Alea v0.9 */
+declare class AleaRandom {
+    protected n: number;
+    protected s: [
+        number,
+        number,
+        number,
+        number
+    ];
+    /** Mash v0.9. */
+    protected mash(input: any): number;
+    constructor(seed: string | number);
+    next(): number;
+    importState(state: typeof this.s): void;
+    exportState(): typeof this.s;
+}
+export {};

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

@@ -9,10 +9,15 @@
  * ```ts
  * import {replaceStringAtIndex} from '@augment-vir/common';
  *
- * replaceStringAtIndex('eat the waffles', 4, 'his'); // outputs `'eat his waffles'`
- * replaceStringAtIndex('eat the waffles', 4, 'my', 3); // outputs `'eat my waffles'`
+ * replaceStringAtIndex({original: 'eat the waffles', start: 4, replacement: 'his'}); // outputs `'eat his waffles'`
+ * replaceStringAtIndex({original: 'eat the waffles', start: 4, replacement: 'my', length: 3}); // outputs `'eat my waffles'`
  * ```
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function replaceStringAtIndex(originalString: string, start: number, newString: string, length?: number): string;
+export declare function replaceStringAtIndex({ original, start, replacement, length, }: Readonly<{
+    original: string;
+    start: number;
+    replacement: string;
+    length?: number | undefined;
+}>): string;

package/dist/augments/string/replace.js

@@ -9,14 +9,14 @@
  * ```ts
  * import {replaceStringAtIndex} from '@augment-vir/common';
  *
- * replaceStringAtIndex('eat the waffles', 4, 'his'); // outputs `'eat his waffles'`
- * replaceStringAtIndex('eat the waffles', 4, 'my', 3); // outputs `'eat my waffles'`
+ * replaceStringAtIndex({original: 'eat the waffles', start: 4, replacement: 'his'}); // outputs `'eat his waffles'`
+ * replaceStringAtIndex({original: 'eat the waffles', start: 4, replacement: 'my', length: 3}); // outputs `'eat my waffles'`
  * ```
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export function replaceStringAtIndex(originalString, start, newString, length = newString.length) {
-    const before = originalString.slice(0, Math.max(0, start));
-    const after = originalString.slice(Math.max(0, start + length));
-    return `${before}${newString}${after}`;
+export function replaceStringAtIndex({ original, start, replacement, length = replacement.length, }) {
+    const before = original.slice(0, Math.max(0, start));
+    const after = original.slice(Math.max(0, start + length));
+    return `${before}${replacement}${after}`;
 }

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

@@ -28,4 +28,7 @@ export declare function splitIncludeSplit(original: string, splitDelimiter: stri
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function safeSplit(input: string, splitString: string): AtLeastTuple<string, 1>;
+export declare function safeSplit({ value, splitter, }: Readonly<{
+    value: string;
+    splitter: string;
+}>): AtLeastTuple<string, 1>;

package/dist/augments/string/split.js

@@ -50,6 +50,6 @@ export function splitIncludeSplit(original, splitDelimiter, { caseSensitive }) {
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export function safeSplit(input, splitString) {
-    return input.split(splitString);
+export function safeSplit({ value, splitter, }) {
+    return value.split(splitter);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.73.5",
+    "version": "32.1.0",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,9 +40,9 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.73.5",
-        "@augment-vir/core": "^31.73.5",
-        "@date-vir/duration": "^8.5.0",
+        "@augment-vir/assert": "^32.1.0",
+        "@augment-vir/core": "^32.1.0",
+        "@date-vir/duration": "^8.6.1",
         "@paralleldrive/cuid2": "^3.3.0",
         "ansi-styles": "^6.2.3",
         "deepcopy-esm": "^2.1.2",
@@ -56,7 +56,7 @@
         "@web/test-runner-playwright": "^0.11.1",
         "execute-in-browser": "^1.0.9",
         "istanbul-smart-text-reporter": "^1.1.5",
-        "runstorm": "^1.0.2",
+        "runstorm": "^1.0.4",
         "typescript": "^6.0.3"
     },
     "engines": {