@ls-stack/utils 3.32.0 → 3.33.0

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:238](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L238)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Properties
+
+##### filterAndMap()
+
+```ts
+filterAndMap: <R>(mapFilter) => R[];
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:251](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L251)
+
+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:253](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L253)
+
+###### Parameters
+
+###### getKey
+
+(`item`) => `unknown`
+
+###### Returns
+
+`T`[]
+
+##### sortBy()
+
+```ts
+sortBy: (sortByValue, props) => T[];
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:252](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L252)
+
+###### 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

package/docs/arrayUtils/README.md

@@ -28,13 +28,51 @@ Defined in: [packages/utils/src/arrayUtils.ts:42](https://github.com/lucasols/ut
 
 ## Functions
 
+### arrayOps()
+
+```ts
+function arrayOps<T>(array): ArrayOps<T>;
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:268](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L268)
+
+Enhance an array with extra methods
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### array
+
+`T`[]
+
+#### Returns
+
+[`ArrayOps`](-internal-.md#arrayops)\<`T`\>
+
+#### Example
+
+```ts
+const enhancedItems = arrayOps(array);
+
+enhancedItems.filterAndMap((item) => item === 2 ? false : item);
+enhancedItems.sortBy((item) => item);
+enhancedItems.rejectDuplicates((item) => item);
+```
+
+***
+
 ### arrayWithPrev()
 
 ```ts
 function arrayWithPrev<T>(array): [T, null | T][];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:108](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L108)
+Defined in: [packages/utils/src/arrayUtils.ts:117](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L117)
 
 #### Type Parameters
 
@@ -60,7 +98,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:108](https://github.com/lucasols/u
 function arrayWithPrevAndIndex<T>(array): object[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:112](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L112)
+Defined in: [packages/utils/src/arrayUtils.ts:121](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L121)
 
 #### Type Parameters
 
@@ -143,7 +181,7 @@ function findAfterIndex<T>(
    predicate): undefined | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:135](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L135)
+Defined in: [packages/utils/src/arrayUtils.ts:144](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L144)
 
 #### Type Parameters
 
@@ -180,7 +218,7 @@ function findBeforeIndex<T>(
    predicate): undefined | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:149](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L149)
+Defined in: [packages/utils/src/arrayUtils.ts:158](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L158)
 
 #### Type Parameters
 
@@ -214,7 +252,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:149](https://github.com/lucasols/u
 function hasDuplicates<T>(array, getKey): boolean;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:173](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L173)
+Defined in: [packages/utils/src/arrayUtils.ts:182](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L182)
 
 #### Type Parameters
 
@@ -244,7 +282,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:173](https://github.com/lucasols/u
 function isInArray<T, U>(value, oneOf): value is U;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:122](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L122)
+Defined in: [packages/utils/src/arrayUtils.ts:131](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L131)
 
 #### Type Parameters
 
@@ -278,7 +316,7 @@ readonly `U`[]
 function rejectArrayUndefinedValues<T>(array): T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:169](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L169)
+Defined in: [packages/utils/src/arrayUtils.ts:178](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L178)
 
 #### Type Parameters
 
@@ -304,7 +342,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:169](https://github.com/lucasols/u
 function rejectDuplicates<T>(array, getKey): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:190](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L190)
+Defined in: [packages/utils/src/arrayUtils.ts:199](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L199)
 
 #### Type Parameters
 
@@ -337,7 +375,7 @@ function sortBy<T>(
    props): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:67](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L67)
+Defined in: [packages/utils/src/arrayUtils.ts:76](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L76)
 
 Sort an array based on a value
 
@@ -359,13 +397,11 @@ Use `Infinity` as as wildcard to absolute max and min values
 
 ##### sortByValue
 
-(`item`) => `string` \| `number` \| (`string` \| `number`)[]
+[`SortByValue`](-internal-.md#sortbyvalue)\<`T`\>
 
 ##### props
 
-[`SortOrder`](-internal-.md#sortorder) | [`SortOrder`](-internal-.md#sortorder)[] | \{
-`order?`: SortOrder \| SortOrder\[\] \| undefined;
-\}
+[`SortByProps`](-internal-.md#sortbyprops) = `'asc'`
 
 #### Returns
 
@@ -396,7 +432,7 @@ function truncateArray<T>(
    appendIfTruncated?): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:210](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L210)
+Defined in: [packages/utils/src/arrayUtils.ts:219](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L219)
 
 #### Type Parameters
 

package/lib/arrayUtils.cjs

@@ -20,6 +20,7 @@ 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,
@@ -155,8 +156,16 @@ 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,

package/lib/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,7 @@ 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[];
 declare function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][];
 declare function arrayWithPrevAndIndex<T>(array: T[]): {
     item: T;
@@ -58,5 +60,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, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };

package/lib/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,7 @@ 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[];
 declare function arrayWithPrev<T>(array: T[]): [current: T, prev: T | null][];
 declare function arrayWithPrevAndIndex<T>(array: T[]): {
     item: T;
@@ -58,5 +60,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, hasDuplicates, isInArray, rejectArrayUndefinedValues, rejectDuplicates, sortBy, truncateArray };

package/lib/arrayUtils.js

@@ -1,4 +1,5 @@
 import {
+  arrayOps,
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,
@@ -10,10 +11,11 @@ import {
   rejectDuplicates,
   sortBy,
   truncateArray
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-RYBJST64.js";
 import "./chunk-C2SVCIWE.js";
 import "./chunk-JF2MDHOJ.js";
 export {
+  arrayOps,
   arrayWithPrev,
   arrayWithPrevAndIndex,
   filterAndMap,

package/lib/{chunk-SRVMMYSW.js → chunk-RYBJST64.js}

@@ -115,6 +115,13 @@ 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,
@@ -127,5 +134,6 @@ export {
   rejectArrayUndefinedValues,
   hasDuplicates,
   rejectDuplicates,
-  truncateArray
+  truncateArray,
+  arrayOps
 };

package/lib/{chunk-J3ILVKZC.js → chunk-XUNY3QUT.js}

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

package/lib/concurrentCalls.js

@@ -9,7 +9,7 @@ import {
 } from "./chunk-VAAMRG4K.js";
 import {
   truncateArray
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-RYBJST64.js";
 import {
   invariant
 } from "./chunk-C2SVCIWE.js";

package/lib/filterObjectOrArrayKeys.js

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

package/lib/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/serializeXML.js

@@ -1,6 +1,6 @@
 import {
   filterAndMap
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-RYBJST64.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/testUtils.js

@@ -11,7 +11,7 @@ import {
 } from "./chunk-JQFUKJU5.js";
 import {
   filterObjectOrArrayKeys
-} from "./chunk-J3ILVKZC.js";
+} from "./chunk-XUNY3QUT.js";
 import {
   defer
 } from "./chunk-DFXNVEH6.js";
@@ -22,7 +22,7 @@ import "./chunk-3LZQMZAS.js";
 import {
   arrayWithPrevAndIndex,
   filterAndMap
-} from "./chunk-SRVMMYSW.js";
+} from "./chunk-RYBJST64.js";
 import {
   isObject
 } from "./chunk-C2SVCIWE.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Universal TypeScript utilities for browser and Node.js",
-  "version": "3.32.0",
+  "version": "3.33.0",
   "license": "MIT",
   "files": [
     "lib",