@augment-vir/common 31.30.1 → 31.32.0

package/dist/augments/array/ensure-array.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Wraps the input in an array if it isn't already an array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function ensureArray<T>(input: T | T[]): T[];
+/**
+ * Wraps the input in an array if it isn't already an array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function ensureArray<T>(input: T | ReadonlyArray<T>): ReadonlyArray<T>;

package/dist/augments/array/ensure-array.js

@@ -0,0 +1,15 @@
+/**
+ * Wraps the input in an array if it isn't already an array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function ensureArray(input) {
+    if (Array.isArray(input)) {
+        return input;
+    }
+    else {
+        return [input];
+    }
+}

package/dist/augments/function/{call-with-retries.d.ts → retry.d.ts}

@@ -1,3 +1,6 @@
+import { type PartialWithUndefined } from '@augment-vir/common';
+import { type AtLeastOneDuration } from '@date-vir/duration';
+import { type IsEqual } from 'type-fest';
 /**
  * Calls `callback` until it doesn't throw an error or throws an error when `maxRetries` is reached.
  * Similar to the `waitUntil` guard from '@augment-vir/assert' but doesn't check the callback's
@@ -21,4 +24,11 @@
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function callWithRetries<const T>(maxRetries: number, callback: () => T): T;
+export declare function retry<const T, const Duration extends AtLeastOneDuration | undefined = undefined>(maxRetries: number, callback: () => T, options?: PartialWithUndefined<{
+    /**
+     * Wait this duration between each retry.
+     *
+     * @default {seconds: 1}
+     */
+    interval: Duration;
+}>): IsEqual<Duration, undefined> extends true ? T : Promise<Awaited<T>>;

package/dist/augments/function/{call-with-retries.js → retry.js}

@@ -1,4 +1,4 @@
-import { ensureErrorAndPrependMessage } from '@augment-vir/core';
+import { ensureErrorAndPrependMessage, wait } from '@augment-vir/core';
 /**
  * Calls `callback` until it doesn't throw an error or throws an error when `maxRetries` is reached.
  * Similar to the `waitUntil` guard from '@augment-vir/assert' but doesn't check the callback's
@@ -22,16 +22,19 @@ import { ensureErrorAndPrependMessage } from '@augment-vir/core';
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export function callWithRetries(maxRetries, callback) {
+export function retry(maxRetries, callback, options = {}) {
     try {
         const result = callback();
         if (result instanceof Promise) {
-            return result.catch((error) => {
+            return result.catch(async (error) => {
                 if (maxRetries <= 1) {
                     throw ensureErrorAndPrependMessage(error, 'Retry max reached');
                 }
                 else {
-                    return callWithRetries(maxRetries - 1, callback);
+                    if (options.interval) {
+                        await wait(options.interval);
+                    }
+                    return retry(maxRetries - 1, callback, options);
                 }
             });
         }
@@ -43,8 +46,11 @@ export function callWithRetries(maxRetries, callback) {
         if (maxRetries <= 1) {
             throw ensureErrorAndPrependMessage(error, 'Retry max reached');
         }
+        else if (options.interval) {
+            return wait(options.interval).then(() => retry(maxRetries - 1, callback, options));
+        }
         else {
-            return callWithRetries(maxRetries - 1, callback);
+            return retry(maxRetries - 1, callback, options);
         }
     }
 }

package/dist/augments/log/log-countdown.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Logs each second as a countdown, then resolves.
+ *
+ * @category Log
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function logCountdown(start: number, logCallback?: (value: string) => void): Promise<void>;

package/dist/augments/log/log-countdown.js

@@ -0,0 +1,19 @@
+import { wait } from '@augment-vir/core';
+import { log } from './log.js';
+/**
+ * Logs each second as a countdown, then resolves.
+ *
+ * @category Log
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export async function logCountdown(start, logCallback = log.warning) {
+    logCallback(String(start));
+    await wait({ seconds: 1.5 });
+    if (start) {
+        return await logCountdown(start - 1, logCallback);
+    }
+    else {
+        return;
+    }
+}

package/dist/augments/promise/race-object.d.ts

@@ -0,0 +1,12 @@
+import { type Values } from '@augment-vir/core';
+/**
+ * Race all the given values and return the one that finished first.
+ *
+ * @category Promise
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function racePromiseObject<const PromiseObject extends Readonly<Record<string, Promise<any>>>>(promises: PromiseObject): Promise<{
+    value: Awaited<Values<PromiseObject>>;
+    key: keyof PromiseObject;
+}>;

package/dist/augments/promise/race-object.js

@@ -0,0 +1,17 @@
+/**
+ * Race all the given values and return the one that finished first.
+ *
+ * @category Promise
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export async function racePromiseObject(promises) {
+    return await Promise.race(Object.entries(promises).map(([key, value,]) => {
+        return value.then((value) => {
+            return {
+                value,
+                key,
+            };
+        });
+    }));
+}

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

@@ -0,0 +1,8 @@
+/**
+ * A case insensitive match between strings.
+ *
+ * @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;

package/dist/augments/string/match.js

@@ -0,0 +1,11 @@
+import { escapeStringForRegExp } from '../regexp/regexp-string.js';
+/**
+ * A case insensitive match between strings.
+ *
+ * @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);
+}

package/dist/augments/string/substring-index.js

@@ -12,6 +12,7 @@ export function findSubstringIndexes({ searchIn, searchFor, caseSensitive, inclu
     const searchRegExp = addRegExpFlags(setRegExpCaseSensitivity(searchFor, { caseSensitive }), 'g');
     const indexes = [];
     const indexesAndLengths = [];
+    // eslint-disable-next-line sonarjs/no-ignored-return
     searchIn.replace(searchRegExp, (...matchResults) => {
         /**
          * Grabbing the second to last entry in the array (rather than the second) takes capture

package/dist/index.d.ts

@@ -5,6 +5,7 @@ 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/create-array.js';
+export * from './augments/array/ensure-array.js';
 export * from './augments/array/extract-duplicates.js';
 export * from './augments/array/filter.js';
 export * from './augments/array/remove-duplicates.js';
@@ -15,16 +16,17 @@ 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/retry.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/json5.js';
 export * from './augments/json/jsonify.js';
 export * from './augments/log/log-colors.js';
+export * from './augments/log/log-countdown.js';
 export * from './augments/log/log-string.js';
 export * from './augments/log/log-writer.js';
 export * from './augments/log/log.js';
@@ -62,6 +64,7 @@ export * from './augments/prisma/prisma-full-model.js';
 export * from './augments/prisma/prisma-model-create.js';
 export * from './augments/prisma/prisma-model-name.js';
 export * from './augments/promise/promise-object.js';
+export * from './augments/promise/race-object.js';
 export * from './augments/promise/timed-promise.js';
 export * from './augments/random/random-boolean.js';
 export * from './augments/random/random-integer.js';
@@ -77,7 +80,9 @@ 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/indent.js';
 export * from './augments/string/join.js';
+export * from './augments/string/match.js';
 export * from './augments/string/prefix.js';
 export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/replace.js';

package/dist/index.js

@@ -5,6 +5,7 @@ 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/create-array.js';
+export * from './augments/array/ensure-array.js';
 export * from './augments/array/extract-duplicates.js';
 export * from './augments/array/filter.js';
 export * from './augments/array/remove-duplicates.js';
@@ -15,16 +16,17 @@ 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/retry.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/json5.js';
 export * from './augments/json/jsonify.js';
 export * from './augments/log/log-colors.js';
+export * from './augments/log/log-countdown.js';
 export * from './augments/log/log-string.js';
 export * from './augments/log/log-writer.js';
 export * from './augments/log/log.js';
@@ -62,6 +64,7 @@ export * from './augments/prisma/prisma-full-model.js';
 export * from './augments/prisma/prisma-model-create.js';
 export * from './augments/prisma/prisma-model-name.js';
 export * from './augments/promise/promise-object.js';
+export * from './augments/promise/race-object.js';
 export * from './augments/promise/timed-promise.js';
 export * from './augments/random/random-boolean.js';
 export * from './augments/random/random-integer.js';
@@ -77,7 +80,9 @@ 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/indent.js';
 export * from './augments/string/join.js';
+export * from './augments/string/match.js';
 export * from './augments/string/prefix.js';
 export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/replace.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.30.1",
+    "version": "31.32.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.30.1",
-        "@augment-vir/core": "^31.30.1",
-        "@date-vir/duration": "^7.3.2",
+        "@augment-vir/assert": "^31.32.0",
+        "@augment-vir/core": "^31.32.0",
+        "@date-vir/duration": "^7.4.0",
         "ansi-styles": "^6.2.1",
         "deepcopy-esm": "^2.1.1",
         "json5": "^2.2.3",
@@ -58,7 +58,7 @@
         "concurrently": "^9.2.0",
         "execute-in-browser": "^1.0.8",
         "istanbul-smart-text-reporter": "^1.1.5",
-        "typescript": "^5.8.3"
+        "typescript": "^5.9.2"
     },
     "engines": {
         "node": ">=22"