@ls-stack/utils 3.32.0 → 3.34.0

package/{lib → dist}/arrayUtils.cjs

@@ -20,11 +20,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/arrayUtils.ts
 var arrayUtils_exports = {};
 __export(arrayUtils_exports, {
+  arrayOps: () => arrayOps,
   arrayWithPrev: () => arrayWithPrev,
   arrayWithPrevAndIndex: () => arrayWithPrevAndIndex,
   filterAndMap: () => filterAndMap,
   findAfterIndex: () => findAfterIndex,
   findBeforeIndex: () => findBeforeIndex,
+  getAscIndexOrder: () => getAscIndexOrder,
   hasDuplicates: () => hasDuplicates,
   isInArray: () => isInArray,
   rejectArrayUndefinedValues: () => rejectArrayUndefinedValues,
@@ -79,6 +81,9 @@ function sortBy(arr, sortByValue, props = "asc") {
     return 0;
   });
 }
+function getAscIndexOrder(index) {
+  return index === -1 ? Infinity : index ?? Infinity;
+}
 function arrayWithPrev(array) {
   return array.map((item, i) => [item, array[i - 1] ?? null]);
 }
@@ -155,13 +160,22 @@ function truncateArray(array, maxLength, appendIfTruncated) {
   }
   return result;
 }
+function arrayOps(array) {
+  return {
+    filterAndMap: (mapFilter) => filterAndMap(array, mapFilter),
+    sortBy: (sortByValue, props) => sortBy(array, sortByValue, props),
+    rejectDuplicates: (getKey) => rejectDuplicates(array, getKey)
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  arrayOps,
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,
   findAfterIndex,
   findBeforeIndex,
+  getAscIndexOrder,
   hasDuplicates,
   isInArray,
   rejectArrayUndefinedValues,

package/{lib → dist}/arrayUtils.d.cts

@@ -21,6 +21,10 @@
 declare function filterAndMap<T, R>(array: IterableIterator<T> | readonly T[], mapFilter: (item: T, index: number) => false | R): R[];
 type FilterAndMapReturn<T> = false | T;
 type SortOrder = 'desc' | 'asc';
+type SortByValue<T> = (item: T) => (number | string)[] | number | string;
+type SortByProps = {
+    order?: SortOrder | SortOrder[];
+} | SortOrder | SortOrder[];
 /**
  * Sort an array based on a value
  *
@@ -42,9 +46,25 @@ type SortOrder = 'desc' | 'asc';
  * // return a array to sort by multiple values
  * const sortedItems = sortBy(items, (item) => [item.a, item.b]);
  */
-declare function sortBy<T>(arr: T[], sortByValue: (item: T) => (number | string)[] | number | string, props?: {
-    order?: SortOrder | SortOrder[];
-} | SortOrder | SortOrder[]): T[];
+declare function sortBy<T>(arr: T[], sortByValue: SortByValue<T>, props?: SortByProps): T[];
+/**
+ * Get the correct 0 based value for sync with other array in ascending order
+ *
+ * @param index
+ *
+ * @example
+ * ```ts
+ * const items = [1, 2, 3];
+ *
+ * const index = sortBy(
+ *   items,
+ *   (item) => getAscIndexOrder(
+ *     followOrder.findIndex((order) => order === item)
+ *   )
+ * );
+ * ```
+ */
+declare function getAscIndexOrder(index: number | undefined): number;
 declare function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][];
 declare function arrayWithPrevAndIndex<T>(array: T[]): {
     item: T;
@@ -58,5 +78,35 @@ declare function rejectArrayUndefinedValues<T extends unknown[]>(array: T): T;
 declare function hasDuplicates<T>(array: T[], getKey?: (item: T) => unknown): boolean;
 declare function rejectDuplicates<T>(array: T[], getKey?: (item: T) => unknown): T[];
 declare function truncateArray<T>(array: T[], maxLength: number, appendIfTruncated?: T | ((truncatedCount: number) => T)): T[];
+type ArrayOps<T> = {
+    /**
+     * Filter and map an array
+     *
+     * @param mapFilter - A function that takes an item and returns a value or `false`
+     * to reject the item.
+     * @example
+     * const items = [1, 2, 3];
+     *
+     * const enhancedItems = arrayOps(items);
+     *
+     * enhancedItems.filterAndMap((item) => item === 2 ? false : item);
+     */
+    filterAndMap: <R>(mapFilter: (item: T, index: number) => false | R) => R[];
+    sortBy: (sortByValue: SortByValue<T>, props: SortByProps) => T[];
+    rejectDuplicates: (getKey: (item: T) => unknown) => T[];
+};
+/**
+ * Enhance an array with extra methods
+ *
+ * @param array
+ * @example
+ *
+ * const enhancedItems = arrayOps(array);
+ *
+ * enhancedItems.filterAndMap((item) => item === 2 ? false : item);
+ * enhancedItems.sortBy((item) => item);
+ * enhancedItems.rejectDuplicates((item) => item);
+ */
+declare function arrayOps<T>(array: T[]): ArrayOps<T>;
 
-export { type FilterAndMapReturn, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findBeforeIndex, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };
+export { type FilterAndMapReturn, arrayOps, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findBeforeIndex, getAscIndexOrder, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };

package/{lib → dist}/arrayUtils.d.ts

@@ -21,6 +21,10 @@
 declare function filterAndMap<T, R>(array: IterableIterator<T> | readonly T[], mapFilter: (item: T, index: number) => false | R): R[];
 type FilterAndMapReturn<T> = false | T;
 type SortOrder = 'desc' | 'asc';
+type SortByValue<T> = (item: T) => (number | string)[] | number | string;
+type SortByProps = {
+    order?: SortOrder | SortOrder[];
+} | SortOrder | SortOrder[];
 /**
  * Sort an array based on a value
  *
@@ -42,9 +46,25 @@ type SortOrder = 'desc' | 'asc';
  * // return a array to sort by multiple values
  * const sortedItems = sortBy(items, (item) => [item.a, item.b]);
  */
-declare function sortBy<T>(arr: T[], sortByValue: (item: T) => (number | string)[] | number | string, props?: {
-    order?: SortOrder | SortOrder[];
-} | SortOrder | SortOrder[]): T[];
+declare function sortBy<T>(arr: T[], sortByValue: SortByValue<T>, props?: SortByProps): T[];
+/**
+ * Get the correct 0 based value for sync with other array in ascending order
+ *
+ * @param index
+ *
+ * @example
+ * ```ts
+ * const items = [1, 2, 3];
+ *
+ * const index = sortBy(
+ *   items,
+ *   (item) => getAscIndexOrder(
+ *     followOrder.findIndex((order) => order === item)
+ *   )
+ * );
+ * ```
+ */
+declare function getAscIndexOrder(index: number | undefined): number;
 declare function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][];
 declare function arrayWithPrevAndIndex<T>(array: T[]): {
     item: T;
@@ -58,5 +78,35 @@ declare function rejectArrayUndefinedValues<T extends unknown[]>(array: T): T;
 declare function hasDuplicates<T>(array: T[], getKey?: (item: T) => unknown): boolean;
 declare function rejectDuplicates<T>(array: T[], getKey?: (item: T) => unknown): T[];
 declare function truncateArray<T>(array: T[], maxLength: number, appendIfTruncated?: T | ((truncatedCount: number) => T)): T[];
+type ArrayOps<T> = {
+    /**
+     * Filter and map an array
+     *
+     * @param mapFilter - A function that takes an item and returns a value or `false`
+     * to reject the item.
+     * @example
+     * const items = [1, 2, 3];
+     *
+     * const enhancedItems = arrayOps(items);
+     *
+     * enhancedItems.filterAndMap((item) => item === 2 ? false : item);
+     */
+    filterAndMap: <R>(mapFilter: (item: T, index: number) => false | R) => R[];
+    sortBy: (sortByValue: SortByValue<T>, props: SortByProps) => T[];
+    rejectDuplicates: (getKey: (item: T) => unknown) => T[];
+};
+/**
+ * Enhance an array with extra methods
+ *
+ * @param array
+ * @example
+ *
+ * const enhancedItems = arrayOps(array);
+ *
+ * enhancedItems.filterAndMap((item) => item === 2 ? false : item);
+ * enhancedItems.sortBy((item) => item);
+ * enhancedItems.rejectDuplicates((item) => item);
+ */
+declare function arrayOps<T>(array: T[]): ArrayOps<T>;
 
-export { type FilterAndMapReturn, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findBeforeIndex, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };
+export { type FilterAndMapReturn, arrayOps, arrayWithPrev, arrayWithPrevAndIndex, filterAndMap, findAfterIndex, findBeforeIndex, getAscIndexOrder, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };

package/{lib → dist}/arrayUtils.js

@@ -1,24 +1,28 @@
 import {
+  arrayOps,
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,
   findAfterIndex,
   findBeforeIndex,
+  getAscIndexOrder,
   hasDuplicates,
   isInArray,
   rejectArrayUndefinedValues,
   rejectDuplicates,
   sortBy,
   truncateArray
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-4DVTWCXL.js";
 import "./chunk-C2SVCIWE.js";
 import "./chunk-JF2MDHOJ.js";
 export {
+  arrayOps,
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,
   findAfterIndex,
   findBeforeIndex,
+  getAscIndexOrder,
   hasDuplicates,
   isInArray,
   rejectArrayUndefinedValues,

package/{lib/chunk-SRVMMYSW.js → dist/chunk-4DVTWCXL.js}

@@ -39,6 +39,9 @@ function sortBy(arr, sortByValue, props = "asc") {
     return 0;
   });
 }
+function getAscIndexOrder(index) {
+  return index === -1 ? Infinity : index ?? Infinity;
+}
 function arrayWithPrev(array) {
   return array.map((item, i) => [item, array[i - 1] ?? null]);
 }
@@ -115,10 +118,18 @@ function truncateArray(array, maxLength, appendIfTruncated) {
   }
   return result;
 }
+function arrayOps(array) {
+  return {
+    filterAndMap: (mapFilter) => filterAndMap(array, mapFilter),
+    sortBy: (sortByValue, props) => sortBy(array, sortByValue, props),
+    rejectDuplicates: (getKey) => rejectDuplicates(array, getKey)
+  };
+}
 
 export {
   filterAndMap,
   sortBy,
+  getAscIndexOrder,
   arrayWithPrev,
   arrayWithPrevAndIndex,
   isInArray,
@@ -127,5 +138,6 @@ export {
   rejectArrayUndefinedValues,
   hasDuplicates,
   rejectDuplicates,
-  truncateArray
+  truncateArray,
+  arrayOps
 };

package/{lib/chunk-IY3KYH32.js → dist/chunk-ADM37GSC.js}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-IATIXMCE.js";
 import {
   truncateString
-} from "./chunk-3LZQMZAS.js";
+} from "./chunk-KW55OTUG.js";
 import {
   isObject,
   isPlainObject

package/{lib/chunk-3LZQMZAS.js → dist/chunk-KW55OTUG.js}

@@ -42,6 +42,9 @@ function truncateString(str, length, ellipsis = "\u2026") {
   if (str.length <= length) return str;
   return str.slice(0, length - 1) + ellipsis;
 }
+function removeANSIColors(str) {
+  return str.replace(/\u001b\[\d+m/g, "");
+}
 
 export {
   concatStrings,
@@ -53,5 +56,6 @@ export {
   convertToCamelCase,
   convertToSentenceCase,
   convertToTitleCase,
-  truncateString
+  truncateString,
+  removeANSIColors
 };

package/{lib/chunk-J3ILVKZC.js → dist/chunk-XPOGWCUC.js}

@@ -1,6 +1,6 @@
 import {
   sortBy
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-4DVTWCXL.js";
 import {
   isPlainObject
 } from "./chunk-JF2MDHOJ.js";

package/{lib → dist}/concurrentCalls.js

@@ -1,6 +1,6 @@
 import {
   truncateString
-} from "./chunk-3LZQMZAS.js";
+} from "./chunk-KW55OTUG.js";
 import {
   sleep
 } from "./chunk-5DZT3Z5Z.js";
@@ -9,7 +9,7 @@ import {
 } from "./chunk-VAAMRG4K.js";
 import {
   truncateArray
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-4DVTWCXL.js";
 import {
   invariant
 } from "./chunk-C2SVCIWE.js";

package/{lib → dist}/filterObjectOrArrayKeys.js

@@ -1,7 +1,7 @@
 import {
   filterObjectOrArrayKeys
-} from "./chunk-J3ILVKZC.js";
-import "./chunk-SRVMMYSW.js";
+} from "./chunk-XPOGWCUC.js";
+import "./chunk-4DVTWCXL.js";
 import "./chunk-C2SVCIWE.js";
 import "./chunk-JF2MDHOJ.js";
 export {

package/{lib → dist}/serializeXML.cjs

@@ -69,7 +69,7 @@ function serializeXML(node, options) {
 function serializeWithLevel(node, options = {}, level) {
   const {
     indent,
-    escapeText: globalEscapeText = true,
+    escapeText: globalEscapeText = false,
     validateTagName = true,
     invalidNodes = "throw"
   } = options;

package/{lib → dist}/serializeXML.js

@@ -1,6 +1,6 @@
 import {
   filterAndMap
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-4DVTWCXL.js";
 import "./chunk-C2SVCIWE.js";
 import {
   isTruthy
@@ -32,7 +32,7 @@ function serializeXML(node, options) {
 function serializeWithLevel(node, options = {}, level) {
   const {
     indent,
-    escapeText: globalEscapeText = true,
+    escapeText: globalEscapeText = false,
     validateTagName = true,
     invalidNodes = "throw"
   } = options;

package/{lib → dist}/stringUtils.cjs

@@ -29,6 +29,7 @@ __export(stringUtils_exports, {
   formatNum: () => formatNum,
   isSnakeCase: () => isSnakeCase,
   joinStrings: () => joinStrings,
+  removeANSIColors: () => removeANSIColors,
   truncateString: () => truncateString
 });
 module.exports = __toCommonJS(stringUtils_exports);
@@ -75,6 +76,9 @@ function truncateString(str, length, ellipsis = "\u2026") {
   if (str.length <= length) return str;
   return str.slice(0, length - 1) + ellipsis;
 }
+function removeANSIColors(str) {
+  return str.replace(/\u001b\[\d+m/g, "");
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   concatStrings,
@@ -86,5 +90,6 @@ function truncateString(str, length, ellipsis = "\u2026") {
   formatNum,
   isSnakeCase,
   joinStrings,
+  removeANSIColors,
   truncateString
 });

package/{lib → dist}/stringUtils.d.cts

@@ -21,5 +21,6 @@ declare function convertToCamelCase(str: string): string;
 declare function convertToSentenceCase(str: string): string;
 declare function convertToTitleCase(str: string): string;
 declare function truncateString(str: string, length: number, ellipsis?: string): string;
+declare function removeANSIColors(str: string): string;
 
-export { concatStrings, convertToCamelCase, convertToPascalCase, convertToSentenceCase, convertToSnakeCase, convertToTitleCase, formatNum, isSnakeCase, joinStrings, truncateString };
+export { concatStrings, convertToCamelCase, convertToPascalCase, convertToSentenceCase, convertToSnakeCase, convertToTitleCase, formatNum, isSnakeCase, joinStrings, removeANSIColors, truncateString };

package/{lib → dist}/stringUtils.d.ts

@@ -21,5 +21,6 @@ declare function convertToCamelCase(str: string): string;
 declare function convertToSentenceCase(str: string): string;
 declare function convertToTitleCase(str: string): string;
 declare function truncateString(str: string, length: number, ellipsis?: string): string;
+declare function removeANSIColors(str: string): string;
 
-export { concatStrings, convertToCamelCase, convertToPascalCase, convertToSentenceCase, convertToSnakeCase, convertToTitleCase, formatNum, isSnakeCase, joinStrings, truncateString };
+export { concatStrings, convertToCamelCase, convertToPascalCase, convertToSentenceCase, convertToSnakeCase, convertToTitleCase, formatNum, isSnakeCase, joinStrings, removeANSIColors, truncateString };

package/{lib → dist}/stringUtils.js

@@ -8,8 +8,9 @@ import {
   formatNum,
   isSnakeCase,
   joinStrings,
+  removeANSIColors,
   truncateString
-} from "./chunk-3LZQMZAS.js";
+} from "./chunk-KW55OTUG.js";
 export {
   concatStrings,
   convertToCamelCase,
@@ -20,5 +21,6 @@ export {
   formatNum,
   isSnakeCase,
   joinStrings,
+  removeANSIColors,
   truncateString
 };

package/{lib → dist}/testUtils.js

@@ -1,6 +1,6 @@
 import {
   yamlStringify
-} from "./chunk-IY3KYH32.js";
+} from "./chunk-ADM37GSC.js";
 import {
   omit,
   pick
@@ -11,18 +11,18 @@ import {
 } from "./chunk-JQFUKJU5.js";
 import {
   filterObjectOrArrayKeys
-} from "./chunk-J3ILVKZC.js";
+} from "./chunk-XPOGWCUC.js";
 import {
   defer
 } from "./chunk-DFXNVEH6.js";
 import {
   clampMin
 } from "./chunk-HTCYUMDR.js";
-import "./chunk-3LZQMZAS.js";
+import "./chunk-KW55OTUG.js";
 import {
   arrayWithPrevAndIndex,
   filterAndMap
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-4DVTWCXL.js";
 import {
   isObject
 } from "./chunk-C2SVCIWE.js";

package/{lib → dist}/yamlStringify.js

@@ -1,8 +1,8 @@
 import {
   yamlStringify
-} from "./chunk-IY3KYH32.js";
+} from "./chunk-ADM37GSC.js";
 import "./chunk-IATIXMCE.js";
-import "./chunk-3LZQMZAS.js";
+import "./chunk-KW55OTUG.js";
 import "./chunk-JF2MDHOJ.js";
 export {
   yamlStringify

package/docs/arrayUtils/-internal-.md

@@ -8,6 +8,144 @@
 
 ## Type Aliases
 
+### ArrayOps\<T\>
+
+```ts
+type ArrayOps<T> = object;
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:259](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L259)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Properties
+
+##### filterAndMap()
+
+```ts
+filterAndMap: <R>(mapFilter) => R[];
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:272](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L272)
+
+Filter and map an array
+
+###### Type Parameters
+
+###### R
+
+`R`
+
+###### Parameters
+
+###### mapFilter
+
+(`item`, `index`) => `false` \| `R`
+
+A function that takes an item and returns a value or `false`
+to reject the item.
+
+###### Returns
+
+`R`[]
+
+###### Example
+
+```ts
+const items = [1, 2, 3];
+
+const enhancedItems = arrayOps(items);
+
+enhancedItems.filterAndMap((item) => item === 2 ? false : item);
+```
+
+##### rejectDuplicates()
+
+```ts
+rejectDuplicates: (getKey) => T[];
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:274](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L274)
+
+###### Parameters
+
+###### getKey
+
+(`item`) => `unknown`
+
+###### Returns
+
+`T`[]
+
+##### sortBy()
+
+```ts
+sortBy: (sortByValue, props) => T[];
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:273](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L273)
+
+###### Parameters
+
+###### sortByValue
+
+[`SortByValue`](#sortbyvalue)\<`T`\>
+
+###### props
+
+[`SortByProps`](#sortbyprops)
+
+###### Returns
+
+`T`[]
+
+***
+
+### SortByProps
+
+```ts
+type SortByProps = 
+  | {
+  order?: SortOrder | SortOrder[];
+}
+  | SortOrder
+  | SortOrder[];
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:48](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L48)
+
+***
+
+### SortByValue()\<T\>
+
+```ts
+type SortByValue<T> = (item) => (number | string)[] | number | string;
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:46](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L46)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### item
+
+`T`
+
+#### Returns
+
+(`number` \| `string`)[] \| `number` \| `string`
+
+***
+
 ### SortOrder
 
 ```ts