@augment-vir/common 30.0.0 → 30.0.2

package/README.md

@@ -0,0 +1,11 @@
+# @augment-vir/common
+
+A collection of augments, helpers types, functions, and classes for any JavaScript environment.
+
+-   Examples: [`filterObject`](https://electrovir.github.io/augment-vir/functions/filterObject.html), [`wait`](https://electrovir.github.io/augment-vir/functions/wait.html), [`getEnumValues`](https://electrovir.github.io/augment-vir/functions/getEnumValues.html)
+-   Includes a colored logger implementation: [`log`](https://electrovir.github.io/augment-vir/variables/log.html)
+-   Includes a SQL-select-like runtime implementation of TypeScript's `Pick`: [`selectFrom`](https://electrovir.github.io/augment-vir/functions/selectFrom-1.html)
+-   Includes Prisma type helpers.
+-   and much more...
+
+See all `@augment-vir` docs here: https://electrovir.github.io/augment-vir

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

@@ -1,6 +1,34 @@
 import type { ArrayElement } from '@augment-vir/core';
 import { Writable } from '../type/writable.js';
-/** Preserves tuple types. */
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but transfers the input tuple's size to the output type.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {typedMap} from '@augment-vir/common';
+ *
+ * const result = await typedMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     (value) => {
+ *         return value + 1;
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function typedMap<const ArrayGeneric extends ReadonlyArray<any>, const OutputType>(arrayToMap: ArrayGeneric, mapCallback: (value: ArrayElement<NoInfer<ArrayGeneric>>, index: number, array: NoInfer<ArrayGeneric>) => OutputType): Writable<{
     [Index in keyof ArrayGeneric]: OutputType;
 }>;

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

@@ -1,4 +1,32 @@
-/** Preserves tuple types. */
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but transfers the input tuple's size to the output type.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {typedMap} from '@augment-vir/common';
+ *
+ * const result = await typedMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     (value) => {
+ *         return value + 1;
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function typedMap(arrayToMap, mapCallback) {
     return arrayToMap.map(mapCallback);
 }

package/dist/augments/array/array-to-object.d.ts

@@ -1,17 +1,35 @@
+import { MaybePromise } from '@augment-vir/core';
 /**
  * Polyfill for `Object.groupBy`:
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ * https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
  *
- * @category Object:Common
- */
-export declare function groupArrayBy<ElementType, NewKey extends PropertyKey>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => NewKey): Partial<Record<NewKey, ElementType[]>>;
-/**
- * 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).
+ * @category Array
+ * @category Object
+ * @example
  *
- * @category Object:Common
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => `key-${value}`,
+ * );
+ * // result is `{key-a: ['a'], key-b: ['b']}`
+ * ```
  */
+export declare function groupArrayBy<ElementType, NewKey extends PropertyKey>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => NewKey): Partial<Record<NewKey, ElementType[]>>;
+export declare function arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => Promise<{
+    key: NewKey;
+    value: NewValue;
+} | undefined>): Promise<Partial<Record<NewKey, NewValue>>>;
 export declare function arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => {
     key: NewKey;
     value: NewValue;
-}): Partial<Record<NewKey, NewValue>>;
+} | undefined): Partial<Record<NewKey, NewValue>>;
+export declare function arrayToObject<ElementType, NewKey extends PropertyKey, NewValue>(inputArray: ReadonlyArray<ElementType>, callback: (value: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => MaybePromise<{
+    key: NewKey;
+    value: NewValue;
+} | undefined>): MaybePromise<Partial<Record<NewKey, NewValue>>>;

package/dist/augments/array/array-to-object.js

@@ -1,10 +1,28 @@
+import { check } from '@augment-vir/assert';
+import { ensureError } from '@augment-vir/core';
 import { getOrSet } from '../object/get-or-set.js';
 import { typedObjectFromEntries } from '../object/object-entries.js';
+import { filterMap } from './filter.js';
 /**
  * Polyfill for `Object.groupBy`:
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ * https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
  *
- * @category Object:Common
+ * @category Array
+ * @category Object
+ * @example
+ *
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => `key-${value}`,
+ * );
+ * // result is `{key-a: ['a'], key-b: ['b']}`
+ * ```
  */
 export function groupArrayBy(inputArray, callback) {
     return inputArray.reduce((accum, entry, index, originalArray) => {
@@ -15,17 +33,83 @@ export function groupArrayBy(inputArray, callback) {
     }, {});
 }
 /**
- * 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).
+ * Similar to {@link groupArrayBy} but maps array entries to a single key and requires `key` _and_
+ * `value` outputs from the callback. The resulting object does not have an array of elements
+ * (unless the original array itself contains arrays). Automatically handles the case where the
+ * callback returns a promise.
+ *
+ * @category Array
+ * @category Object
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {arrayToObject} from '@augment-vir/common';
+ *
+ * const result = arrayToObject(
+ *     [
+ *         'a',
+ *         'b',
+ *     ],
+ *     (value) => {
+ *         return {key: `key-${value}`, value};
+ *     },
+ * );
+ * // result is `{key-a: 'a', key-b: 'b'}`
+ * ```
  *
- * @category Object:Common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function arrayToObject(inputArray, callback) {
-    return typedObjectFromEntries(inputArray.map((entry, index, originalArray) => {
-        const { key, value } = callback(entry, index, originalArray);
-        return [
-            key,
-            value,
-        ];
-    }));
+    try {
+        let gotAPromise = false;
+        const mappedEntries = inputArray
+            .map((entry, index, originalArray) => {
+            const output = callback(entry, index, originalArray);
+            if (output instanceof Promise) {
+                gotAPromise = true;
+                return output;
+            }
+            else if (output) {
+                return [
+                    output.key,
+                    output.value,
+                ];
+            }
+            else {
+                return undefined;
+            }
+        })
+            .filter(check.isTruthy);
+        if (gotAPromise) {
+            return new Promise(async (resolve, reject) => {
+                try {
+                    const entries = filterMap(await Promise.all(mappedEntries), (entry) => {
+                        if (!entry) {
+                            return undefined;
+                        }
+                        else if (Array.isArray(entry)) {
+                            return entry;
+                        }
+                        else {
+                            return [
+                                entry.key,
+                                entry.value,
+                            ];
+                        }
+                    }, check.isTruthy);
+                    resolve(typedObjectFromEntries(entries));
+                }
+                catch (error) {
+                    reject(ensureError(error));
+                }
+            });
+        }
+        else {
+            return typedObjectFromEntries(mappedEntries);
+        }
+    }
+    catch (error) {
+        throw ensureError(error);
+    }
 }

package/dist/augments/array/awaited/awaited-filter.d.ts

@@ -1,3 +1,32 @@
+/**
+ * Performs
+ * [`[].filter()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
+ * on an array but supports an async callback.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedFilter} from '@augment-vir/common';
+ *
+ * const result = await awaitedFilter(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value > 2);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function awaitedFilter<OriginalGeneric>(arrayInput: ReadonlyArray<OriginalGeneric>, filterCallback: (arrayElement: OriginalGeneric, index: number, wholeArray: ReadonlyArray<OriginalGeneric>) => Promise<unknown>, options?: {
     /**
      * Each call to the filter callback is blocking, meaning the next one won't start until the

package/dist/augments/array/awaited/awaited-filter.js

@@ -1,4 +1,33 @@
 import { awaitedBlockingMap } from './awaited-map.js';
+/**
+ * Performs
+ * [`[].filter()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
+ * on an array but supports an async callback.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedFilter} from '@augment-vir/common';
+ *
+ * const result = await awaitedFilter(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value > 2);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export async function awaitedFilter(arrayInput, filterCallback, options) {
     const callbackResults = options?.blocking
         ? await awaitedBlockingMap(arrayInput, filterCallback)

package/dist/augments/array/awaited/awaited-for-each.d.ts

@@ -1,6 +1,31 @@
 /**
- * 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.
+ * Performs
+ * [`[].forEach()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedForEach} from '@augment-vir/common';
+ *
+ * await awaitedForEach(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function awaitedForEach<OriginalGeneric>(input: ReadonlyArray<OriginalGeneric>, callback: (arrayElement: OriginalGeneric, index: number, wholeArray: ReadonlyArray<OriginalGeneric>) => void | PromiseLike<void>): Promise<void>;

package/dist/augments/array/awaited/awaited-for-each.js

@@ -1,8 +1,33 @@
 import { awaitedBlockingMap } from './awaited-map.js';
 /**
- * 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.
+ * Performs
+ * [`[].forEach()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedForEach} from '@augment-vir/common';
+ *
+ * await awaitedForEach(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export async function awaitedForEach(input, callback) {
     await awaitedBlockingMap(input, callback);

package/dist/augments/array/awaited/awaited-map.d.ts

@@ -1 +1,33 @@
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2. Compare to `await Promise.all([].map(async () => {}))` which is _not_ blocking (all
+ * callbacks are called in parallel).
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedBlockingMap} from '@augment-vir/common';
+ *
+ * const result = await awaitedBlockingMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function awaitedBlockingMap<OriginalGeneric, MappedGeneric>(input: ReadonlyArray<OriginalGeneric>, callback: (arrayElement: OriginalGeneric, index: number, wholeArray: ReadonlyArray<OriginalGeneric>) => MappedGeneric | PromiseLike<MappedGeneric>): Promise<Awaited<MappedGeneric>[]>;

package/dist/augments/array/awaited/awaited-map.js

@@ -1,3 +1,35 @@
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * on an array but supports an async callback. The async callback is blocking. Meaning,
+ * `awaitedForEach` will wait for a callback on array element 1 to finish before moving on to array
+ * element 2. Compare to `await Promise.all([].map(async () => {}))` which is _not_ blocking (all
+ * callbacks are called in parallel).
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {awaitedBlockingMap} from '@augment-vir/common';
+ *
+ * const result = await awaitedBlockingMap(
+ *     [
+ *         1,
+ *         2,
+ *         3,
+ *         4,
+ *         5,
+ *     ],
+ *     async (value) => {
+ *         return await Promise.resolve(value);
+ *     },
+ * );
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export async function awaitedBlockingMap(input, callback) {
     return await input.reduce(async (accumPromise, currentElement, index, wholeArray) => {
         const accum = await accumPromise;

package/dist/augments/array/filter.d.ts

@@ -1,3 +1,32 @@
+/**
+ * Removes all given indexes from the given array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {filterOutIndexes} from '@augment-vir/common';
+ *
+ * const result = filterOutIndexes(
+ *     [
+ *         'a',
+ *         'b',
+ *         '',
+ *     ],
+ *     [
+ *         0,
+ *         2,
+ *     ],
+ * );
+ * // result is `['b']`
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function filterOutIndexes<T>(array: ReadonlyArray<T>, indexes: ReadonlyArray<number>): T[];
+/** Performs `filterMap` with a type guard filter. */
 export declare function filterMap<ElementType, MappedEntry, TypeGuarded extends MappedEntry>(inputArray: ReadonlyArray<ElementType>, mapCallback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => MappedEntry, filterCallback: (mappedOutput: MappedEntry, originalEntry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => mappedOutput is TypeGuarded): TypeGuarded[];
+/** Performs a regular `filterMap`. */
 export declare function filterMap<ElementType, MappedEntry>(inputArray: ReadonlyArray<ElementType>, mapCallback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => MappedEntry, filterCallback: (mappedOutput: MappedEntry, originalEntry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => boolean): MappedEntry[];

package/dist/augments/array/filter.js

@@ -1,6 +1,67 @@
+/**
+ * Removes all given indexes from the given array.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {filterOutIndexes} from '@augment-vir/common';
+ *
+ * const result = filterOutIndexes(
+ *     [
+ *         'a',
+ *         'b',
+ *         '',
+ *     ],
+ *     [
+ *         0,
+ *         2,
+ *     ],
+ * );
+ * // result is `['b']`
+ * ```
+ *
+ * @returns A new array (does not mutate).
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function filterOutIndexes(array, indexes) {
     return array.filter((_, index) => !indexes.includes(index));
 }
+/**
+ * Performs
+ * [`[].map()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
+ * and
+ * [`[].filter()`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
+ * (in that order) on an array with a single iteration.
+ *
+ * @category Array
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {filterMap} from '@augment-vir/common';
+ *
+ * const result = filterMap(
+ *     [
+ *         'a',
+ *         'b',
+ *         '',
+ *     ],
+ *     // map callback
+ *     (value) => {
+ *         return `value-${value}`;
+ *     },
+ *     // filter callback
+ *     (mappedValue, originalValue) => {
+ *         return !!originalValue;
+ *     },
+ * );
+ * // result is `['value-a', 'value-b']`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function filterMap(inputArray, mapCallback, filterCallback) {
     return inputArray.reduce((accum, entry, index, originalArray) => {
         const mapOutput = mapCallback(entry, index, originalArray);

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

@@ -1 +1,60 @@
-export declare function removeDuplicates<Entry, UniqueId>(originalArray: ReadonlyArray<Readonly<Entry>>, calculateUniqueIdCallback: (entry: Readonly<Entry>) => UniqueId): Readonly<Entry>[];
+/**
+ * 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[];