@augment-vir/common 23.1.1 → 23.3.0

package/dist/cjs/augments/array.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.repeatArray = exports.typedMap = exports.typedArrayIncludes = exports.trimArrayStrings = exports.flatten2dArray = exports.filterOutIndexes = void 0;
+exports.filterMap = exports.arrayToObject = exports.groupArrayBy = exports.repeatArray = exports.typedMap = exports.typedArrayIncludes = exports.trimArrayStrings = exports.flatten2dArray = exports.filterOutIndexes = void 0;
+const object_entries_1 = require("./object/object-entries");
 function filterOutIndexes(array, indexes) {
     return array.filter((_, index) => !indexes.includes(index));
 }
@@ -27,3 +28,43 @@ function repeatArray(repeatCount, array) {
     return Array.from({ length: repeatCount }, () => [...array]).flat();
 }
 exports.repeatArray = repeatArray;
+/**
+ * Polyfill for `Object.groupBy`:
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ */
+function groupArrayBy(inputArray, callback) {
+    return inputArray.reduce((accum, entry, index, originalArray) => {
+        const key = callback(entry, index, originalArray);
+        if (!(key in accum)) {
+            accum[key] = [];
+        }
+        accum[key].push(entry);
+        return accum;
+    }, {});
+}
+exports.groupArrayBy = groupArrayBy;
+/**
+ * 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).
+ */
+function arrayToObject(inputArray, callback) {
+    return (0, object_entries_1.typedObjectFromEntries)(inputArray.map((entry, index, originalArray) => {
+        const key = callback(entry, index, originalArray);
+        return [
+            key,
+            entry,
+        ];
+    }));
+}
+exports.arrayToObject = arrayToObject;
+function filterMap(inputArray, mapCallback, filterCallback) {
+    return inputArray.reduce((accum, entry, index, originalArray) => {
+        const mapOutput = mapCallback(entry, index, originalArray);
+        const filterOutput = filterCallback(mapOutput, entry, index, originalArray);
+        if (filterOutput) {
+            accum.push(mapOutput);
+        }
+        return accum;
+    }, []);
+}
+exports.filterMap = filterMap;

package/dist/cjs/augments/common-string.js

@@ -38,12 +38,12 @@ function removeCommasFromNumberString(numberString) {
 }
 exports.removeCommasFromNumberString = removeCommasFromNumberString;
 /** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
-function collapseWhiteSpace(input) {
-    return (input
-        // sometimes \n isn't included in \s
-        .replace(/\n/g, ' ')
-        .trim()
-        .replace(/\s{2,}/g, ' '));
+function collapseWhiteSpace(input, { keepNewLines } = {}) {
+    const newLineReplacement = keepNewLines
+        ? input.replace(/[\s\n]*\n+[\s\n]*/g, '\n')
+        : // sometimes \n isn't included in \s
+            input.replace(/\n/g, ' ');
+    return newLineReplacement.trim().replace(/\s{2,}/g, ' ');
 }
 exports.collapseWhiteSpace = collapseWhiteSpace;
 /** Same as String.prototype.split but includes the delimiter to split by in the output array. */

package/dist/cjs/augments/object/object-entries.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.typedObjectFromEntries = exports.getEntriesSortedByKey = exports.getObjectTypedValues = exports.getObjectTypedKeys = exports.isKeyof = void 0;
+exports.typedObjectFromEntries = exports.getEntriesSortedByKey = exports.getObjectTypedEntries = exports.getObjectTypedValues = exports.getObjectTypedKeys = exports.isKeyof = void 0;
 const typed_has_property_1 = require("./typed-has-property");
 /** @deprecated This is the same as hasKey */
 function isKeyof(key, object) {
@@ -24,6 +24,13 @@ function getObjectTypedValues(input) {
     return getObjectTypedKeys(input).map((key) => input[key]);
 }
 exports.getObjectTypedValues = getObjectTypedValues;
+function getObjectTypedEntries(input) {
+    return getObjectTypedKeys(input).map((key) => [
+        key,
+        input[key],
+    ]);
+}
+exports.getObjectTypedEntries = getObjectTypedEntries;
 function getEntriesSortedByKey(input) {
     return Object.entries(input).sort((tupleA, tupleB) => tupleA[0].localeCompare(tupleB[0]));
 }

package/dist/esm/augments/array.js

@@ -1,3 +1,4 @@
+import { typedObjectFromEntries } from './object/object-entries';
 export function filterOutIndexes(array, indexes) {
     return array.filter((_, index) => !indexes.includes(index));
 }
@@ -18,3 +19,40 @@ export function typedMap(arrayToMap, mapCallback) {
 export function repeatArray(repeatCount, array) {
     return Array.from({ length: repeatCount }, () => [...array]).flat();
 }
+/**
+ * Polyfill for `Object.groupBy`:
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ */
+export function groupArrayBy(inputArray, callback) {
+    return inputArray.reduce((accum, entry, index, originalArray) => {
+        const key = callback(entry, index, originalArray);
+        if (!(key in accum)) {
+            accum[key] = [];
+        }
+        accum[key].push(entry);
+        return accum;
+    }, {});
+}
+/**
+ * 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).
+ */
+export function arrayToObject(inputArray, callback) {
+    return typedObjectFromEntries(inputArray.map((entry, index, originalArray) => {
+        const key = callback(entry, index, originalArray);
+        return [
+            key,
+            entry,
+        ];
+    }));
+}
+export function filterMap(inputArray, mapCallback, filterCallback) {
+    return inputArray.reduce((accum, entry, index, originalArray) => {
+        const mapOutput = mapCallback(entry, index, originalArray);
+        const filterOutput = filterCallback(mapOutput, entry, index, originalArray);
+        if (filterOutput) {
+            accum.push(mapOutput);
+        }
+        return accum;
+    }, []);
+}

package/dist/esm/augments/common-string.js

@@ -32,12 +32,12 @@ export function removeCommasFromNumberString(numberString) {
     return numberString.replace(/,/g, '');
 }
 /** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
-export function collapseWhiteSpace(input) {
-    return (input
-        // sometimes \n isn't included in \s
-        .replace(/\n/g, ' ')
-        .trim()
-        .replace(/\s{2,}/g, ' '));
+export function collapseWhiteSpace(input, { keepNewLines } = {}) {
+    const newLineReplacement = keepNewLines
+        ? input.replace(/[\s\n]*\n+[\s\n]*/g, '\n')
+        : // sometimes \n isn't included in \s
+            input.replace(/\n/g, ' ');
+    return newLineReplacement.trim().replace(/\s{2,}/g, ' ');
 }
 /** Same as String.prototype.split but includes the delimiter to split by in the output array. */
 export function splitIncludeSplit(original, splitterInput, caseSensitive) {

package/dist/esm/augments/object/object-entries.js

@@ -18,6 +18,12 @@ export function getObjectTypedKeys(input) {
 export function getObjectTypedValues(input) {
     return getObjectTypedKeys(input).map((key) => input[key]);
 }
+export function getObjectTypedEntries(input) {
+    return getObjectTypedKeys(input).map((key) => [
+        key,
+        input[key],
+    ]);
+}
 export function getEntriesSortedByKey(input) {
     return Object.entries(input).sort((tupleA, tupleB) => tupleA[0].localeCompare(tupleB[0]));
 }

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

@@ -11,4 +11,15 @@ export declare function typedMap<InputArrayGeneric extends ReadonlyArray<any>, O
     [Index in keyof InputArrayGeneric]: OutputType;
 };
 export declare function repeatArray<T>(repeatCount: number, array: T[]): T[];
+/**
+ * Polyfill for `Object.groupBy`:
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/groupBy
+ */
+export declare function groupArrayBy<ElementType, NewKey extends PropertyKey>(inputArray: ReadonlyArray<ElementType>, callback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => NewKey): 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).
+ */
+export declare function arrayToObject<ElementType, NewKey extends PropertyKey>(inputArray: ReadonlyArray<ElementType>, callback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => NewKey): Record<NewKey, ElementType>;
+export declare function filterMap<ElementType, MapReturn>(inputArray: ReadonlyArray<ElementType>, mapCallback: (entry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => MapReturn, filterCallback: (mappedOutput: MapReturn, originalEntry: ElementType, index: number, originalArray: ReadonlyArray<ElementType>) => boolean): MapReturn[];
 export {};

package/dist/types/augments/common-string.d.ts

@@ -14,7 +14,9 @@ export declare function removeAnsiEscapeCodes(input: string): string;
 export declare const removeColor: typeof removeAnsiEscapeCodes;
 export declare function removeCommasFromNumberString(numberString: string): string;
 /** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
-export declare function collapseWhiteSpace(input: string): string;
+export declare function collapseWhiteSpace(input: string, { keepNewLines }?: PartialAndUndefined<{
+    keepNewLines: boolean;
+}>): string;
 /** Same as String.prototype.split but includes the delimiter to split by in the output array. */
 export declare function splitIncludeSplit(original: string, splitterInput: string | RegExp, caseSensitive: boolean): readonly string[];
 export type CasingOptions = {

package/dist/types/augments/object/object-entries.d.ts

@@ -2,5 +2,6 @@
 export declare function isKeyof<ObjectGeneric>(key: PropertyKey, object: ObjectGeneric): key is keyof ObjectGeneric;
 export declare function getObjectTypedKeys<ObjectGeneric extends unknown>(input: ObjectGeneric): Array<keyof ObjectGeneric>;
 export declare function getObjectTypedValues<ObjectGeneric extends unknown>(input: ObjectGeneric): ObjectGeneric[keyof ObjectGeneric][];
+export declare function getObjectTypedEntries<ObjectGeneric extends unknown>(input: ObjectGeneric): [keyof ObjectGeneric, ObjectGeneric[keyof ObjectGeneric]][];
 export declare function getEntriesSortedByKey(input: object): [string, unknown][];
 export declare function typedObjectFromEntries<KeyType extends PropertyKey, ValueType>(entries: ReadonlyArray<Readonly<[KeyType, ValueType]>>): Record<KeyType, ValueType>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "23.1.1",
+    "version": "23.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"