es-toolkit 1.26.1 → 1.27.0-dev.874

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # es-toolkit Changelog
 
+## Version v1.27.0
+
+Released on November 10th, 2024.
+
+- Added support for [findKey](https://es-toolkit.slash.page/reference/object/findKey.html) and [isSubsetWith](https://es-toolkit.slash.page/reference/array/isSubsetWith.html).
+- Introduced compatibility functions for [words](https://es-toolkit.slash.page/reference/string/words.html), [at](https://es-toolkit.slash.page/reference/array/at.html), [differenceBy](https://es-toolkit.slash.page/reference/array/differenceBy.html), [uniqBy](https://es-toolkit.slash.page/reference/array/uniqBy.html), [forEach](https://es-toolkit.slash.page/reference/compat/array/forEach.html), [each](https://es-toolkit.slash.page/reference/compat/array/each.html), [sum](https://es-toolkit.slash.page/reference/math/sum.html), [sumBy](https://es-toolkit.slash.page/reference/array/sumBy.html), [union](https://es-toolkit.slash.page/reference/array/union.html), [zip](https://es-toolkit.slash.page/reference/array/zip.html), [unzip](https://es-toolkit.slash.page/reference/array/unzip.html), [iteratee](https://es-toolkit.slash.page/reference/compat/util/iteratee.html), [isEmpty](https://es-toolkit.slash.page/reference/compat/predicate/isEmpty.html), and [replace](https://es-toolkit.slash.page/reference/compat/string/replace.html).
+- Fixed a bug in [cloneDeep](https://es-toolkit.slash.page/reference/object/cloneDeep.html) that prevented it from correctly cloning object prototypes.
+- Improved performance for [at](https://es-toolkit.slash.page/reference/array/at.html).
+- Enhanced performance for [toPath](https://es-toolkit.slash.page/reference/compat/util/toPath.html), [get](https://es-toolkit.slash.page/reference/compat/object/get.html), [set](https://es-toolkit.slash.page/reference/compat/object/set.html), [unset](https://es-toolkit.slash.page/reference/compat/object/unset.html), [has](https://es-toolkit.slash.page/reference/compat/object/has.html), [orderBy](https://es-toolkit.slash.page/reference/array/orderBy.html), [chunk](https://es-toolkit.slash.page/reference/array/chunk.html), [difference](https://es-toolkit.slash.page/reference/array/difference.html), [drop](https://es-toolkit.slash.page/reference/array/drop.html), [dropRight](https://es-toolkit.slash.page/reference/array/dropRight.html), [dropWhile](https://es-toolkit.slash.page/reference/array/dropWhile.html), [findLastIndex](https://es-toolkit.slash.page/reference/compat/array/findLastIndex.html), [head](https://es-toolkit.slash.page/reference/array/head.html), [last](https://es-toolkit.slash.page/reference/array/last.html), [sample](https://es-toolkit.slash.page/reference/array/sample.html), [tail](https://es-toolkit.slash.page/reference/array/tail.html), [take](https://es-toolkit.slash.page/reference/array/take.html), and [takeRight](https://es-toolkit.slash.page/reference/array/takeRight.html) in our compatibility library.
+
+We sincerely thank @scato3, @ssi02014, @filipsobol, @mass2527, @Gyumong, @D-Sketon, @dayongkr, @kyvg, @Na-hyunwoo, @kaehehehe, and @bhollis for their contributions. Special thanks to @cruelladevil for improving the documentation. We appreciate your great efforts!
+
 ## Version v1.26.1
 
 Released on October 25th, 2024.

package/dist/_chunk/{sumBy-RVppiV.js → rangeRight-w3WrXN.js}

@@ -54,14 +54,11 @@ function medianBy(items, getValue) {
     return median(nums);
 }
 
-function range(start, end, step) {
+function range(start, end, step = 1) {
     if (end == null) {
         end = start;
         start = 0;
     }
-    if (step == null) {
-        step = 1;
-    }
     if (!Number.isInteger(step) || step === 0) {
         throw new Error(`The step value must be a non-zero integer.`);
     }
@@ -73,14 +70,11 @@ function range(start, end, step) {
     return result;
 }
 
-function rangeRight(start, end, step) {
+function rangeRight(start, end, step = 1) {
     if (end == null) {
         end = start;
         start = 0;
     }
-    if (step == null) {
-        step = 1;
-    }
     if (!Number.isInteger(step) || step === 0) {
         throw new Error(`The step value must be a non-zero integer.`);
     }
@@ -92,11 +86,6 @@ function rangeRight(start, end, step) {
     return result;
 }
 
-function sumBy(items, getValue) {
-    const nums = items.map(x => getValue(x));
-    return sum(nums);
-}
-
 exports.clamp = clamp;
 exports.inRange = inRange;
 exports.mean = mean;
@@ -106,4 +95,3 @@ exports.medianBy = medianBy;
 exports.range = range;
 exports.rangeRight = rangeRight;
 exports.sum = sum;
-exports.sumBy = sumBy;

package/dist/_chunk/{toMerged-wNz52b.js → toMerged-CPY8Ug.js}

@@ -134,7 +134,7 @@ function cloneDeepImpl(obj, stack = new Map()) {
         return result;
     }
     if (typeof obj === 'object' && obj !== null) {
-        const result = {};
+        const result = Object.create(Object.getPrototypeOf(obj));
         stack.set(obj, result);
         copyProperties(result, obj, stack);
         return result;
@@ -152,6 +152,11 @@ function copyProperties(target, source, stack) {
     }
 }
 
+function findKey(obj, predicate) {
+    const keys = Object.keys(obj);
+    return keys.find(key => predicate(obj[key], key, obj));
+}
+
 function flattenObject(object) {
     return flattenObjectImpl(object);
 }
@@ -276,6 +281,7 @@ function toMerged(target, source) {
 exports.clone = clone;
 exports.cloneDeep = cloneDeep;
 exports.copyProperties = copyProperties;
+exports.findKey = findKey;
 exports.flattenObject = flattenObject;
 exports.invert = invert;
 exports.isObjectLike = isObjectLike;

package/dist/_chunk/{upperFirst-BUECmK.js → upperFirst-DK_rTF.js}

@@ -1,26 +1,26 @@
 'use strict';
 
-const CASE_SPLIT_PATTERN = /\p{Lu}?\p{Ll}+|[0-9]+|\p{Lu}+(?!\p{Ll})|\p{Emoji_Presentation}|\p{Extended_Pictographic}|\p{L}+/gu;
-function getWords(str) {
-    return Array.from(str.match(CASE_SPLIT_PATTERN) ?? []);
-}
-
 function capitalize(str) {
     return (str.charAt(0).toUpperCase() + str.slice(1).toLowerCase());
 }
 
+const CASE_SPLIT_PATTERN = /\p{Lu}?\p{Ll}+|[0-9]+|\p{Lu}+(?!\p{Ll})|\p{Emoji_Presentation}|\p{Extended_Pictographic}|\p{L}+/gu;
+function words(str) {
+    return Array.from(str.match(CASE_SPLIT_PATTERN) ?? []);
+}
+
 function camelCase(str) {
-    const words = getWords(str);
-    if (words.length === 0) {
+    const words$1 = words(str);
+    if (words$1.length === 0) {
         return '';
     }
-    const [first, ...rest] = words;
+    const [first, ...rest] = words$1;
     return `${first.toLowerCase()}${rest.map(word => capitalize(word)).join('')}`;
 }
 
 function constantCase(str) {
-    const words = getWords(str);
-    return words.map(word => word.toUpperCase()).join('_');
+    const words$1 = words(str);
+    return words$1.map(word => word.toUpperCase()).join('_');
 }
 
 const deburrMap = new Map(Object.entries({
@@ -83,13 +83,13 @@ function escapeRegExp(str) {
 }
 
 function kebabCase(str) {
-    const words = getWords(str);
-    return words.map(word => word.toLowerCase()).join('-');
+    const words$1 = words(str);
+    return words$1.map(word => word.toLowerCase()).join('-');
 }
 
 function lowerCase(str) {
-    const words = getWords(str);
-    return words.map(word => word.toLowerCase()).join(' ');
+    const words$1 = words(str);
+    return words$1.map(word => word.toLowerCase()).join(' ');
 }
 
 function lowerFirst(str) {
@@ -101,13 +101,13 @@ function pad(str, length, chars = ' ') {
 }
 
 function pascalCase(str) {
-    const words = getWords(str);
-    return words.map(word => capitalize(word)).join('');
+    const words$1 = words(str);
+    return words$1.map(word => capitalize(word)).join('');
 }
 
 function snakeCase(str) {
-    const words = getWords(str);
-    return words.map(word => word.toLowerCase()).join('_');
+    const words$1 = words(str);
+    return words$1.map(word => word.toLowerCase()).join('_');
 }
 
 function trimEnd(str, chars) {
@@ -171,11 +171,11 @@ function unescape(str) {
 }
 
 function upperCase(str) {
-    const words = getWords(str);
+    const words$1 = words(str);
     let result = '';
-    for (let i = 0; i < words.length; i++) {
-        result += words[i].toUpperCase();
-        if (i < words.length - 1) {
+    for (let i = 0; i < words$1.length; i++) {
+        result += words$1[i].toUpperCase();
+        if (i < words$1.length - 1) {
             result += ' ';
         }
     }
@@ -192,7 +192,6 @@ exports.constantCase = constantCase;
 exports.deburr = deburr;
 exports.escape = escape;
 exports.escapeRegExp = escapeRegExp;
-exports.getWords = getWords;
 exports.kebabCase = kebabCase;
 exports.lowerCase = lowerCase;
 exports.lowerFirst = lowerFirst;
@@ -205,3 +204,4 @@ exports.trimStart = trimStart;
 exports.unescape = unescape;
 exports.upperCase = upperCase;
 exports.upperFirst = upperFirst;
+exports.words = words;

package/dist/_chunk/{zipWith-Dkv3D1.js → zipWith-Bb2eZI.js}

@@ -4,9 +4,14 @@ const randomInt = require('./randomInt-CF7bZK.js');
 
 function at(arr, indices) {
     const result = new Array(indices.length);
+    const length = arr.length;
     for (let i = 0; i < indices.length; i++) {
-        const index = indices[i];
-        result[i] = arr.at(index);
+        let index = indices[i];
+        index = Number.isInteger(index) ? index : Math.trunc(index) || 0;
+        if (index < 0) {
+            index += length;
+        }
+        result[i] = arr[index];
     }
     return result;
 }
@@ -188,6 +193,10 @@ function isSubset(superset, subset) {
     return difference(subset, superset).length === 0;
 }
 
+function isSubsetWith(superset, subset, areItemsEqual) {
+    return differenceWith(subset, superset, areItemsEqual).length === 0;
+}
+
 function keyBy(arr, getKeyFromItem) {
     const result = {};
     for (let i = 0; i < arr.length; i++) {
@@ -403,8 +412,7 @@ function unzipWith(target, iteratee) {
 }
 
 function without(array, ...values) {
-    const valuesSet = new Set(values);
-    return array.filter(item => !valuesSet.has(item));
+    return difference(array, values);
 }
 
 function xor(arr1, arr2) {
@@ -424,7 +432,12 @@ function xorWith(arr1, arr2, areElementsEqual) {
 }
 
 function zip(...arrs) {
-    const rowCount = Math.max(...arrs.map(x => x.length));
+    let rowCount = 0;
+    for (let i = 0; i < arrs.length; i++) {
+        if (arrs[i].length > rowCount) {
+            rowCount = arrs[i].length;
+        }
+    }
     const columnCount = arrs.length;
     const result = Array(rowCount);
     for (let i = 0; i < rowCount; ++i) {
@@ -481,6 +494,7 @@ exports.intersection = intersection;
 exports.intersectionBy = intersectionBy;
 exports.intersectionWith = intersectionWith;
 exports.isSubset = isSubset;
+exports.isSubsetWith = isSubsetWith;
 exports.keyBy = keyBy;
 exports.last = last;
 exports.maxBy = maxBy;

package/dist/array/at.mjs

@@ -1,8 +1,13 @@
 function at(arr, indices) {
     const result = new Array(indices.length);
+    const length = arr.length;
     for (let i = 0; i < indices.length; i++) {
-        const index = indices[i];
-        result[i] = arr.at(index);
+        let index = indices[i];
+        index = Number.isInteger(index) ? index : Math.trunc(index) || 0;
+        if (index < 0) {
+            index += length;
+        }
+        result[i] = arr[index];
     }
     return result;
 }

package/dist/array/index.d.mts

@@ -22,6 +22,7 @@ export { intersection } from './intersection.mjs';
 export { intersectionBy } from './intersectionBy.mjs';
 export { intersectionWith } from './intersectionWith.mjs';
 export { isSubset } from './isSubset.mjs';
+export { isSubsetWith } from './isSubsetWith.mjs';
 export { keyBy } from './keyBy.mjs';
 export { last } from './last.mjs';
 export { maxBy } from './maxBy.mjs';

package/dist/array/index.d.ts

@@ -22,6 +22,7 @@ export { intersection } from './intersection.js';
 export { intersectionBy } from './intersectionBy.js';
 export { intersectionWith } from './intersectionWith.js';
 export { isSubset } from './isSubset.js';
+export { isSubsetWith } from './isSubsetWith.js';
 export { keyBy } from './keyBy.js';
 export { last } from './last.js';
 export { maxBy } from './maxBy.js';

package/dist/array/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const zipWith = require('../_chunk/zipWith-Dkv3D1.js');
+const zipWith = require('../_chunk/zipWith-Bb2eZI.js');
 
 function compareValues(a, b, order) {
     if (a < b) {
@@ -60,6 +60,7 @@ exports.intersection = zipWith.intersection;
 exports.intersectionBy = zipWith.intersectionBy;
 exports.intersectionWith = zipWith.intersectionWith;
 exports.isSubset = zipWith.isSubset;
+exports.isSubsetWith = zipWith.isSubsetWith;
 exports.keyBy = zipWith.keyBy;
 exports.last = zipWith.last;
 exports.maxBy = zipWith.maxBy;

package/dist/array/index.mjs

@@ -22,6 +22,7 @@ export { intersection } from './intersection.mjs';
 export { intersectionBy } from './intersectionBy.mjs';
 export { intersectionWith } from './intersectionWith.mjs';
 export { isSubset } from './isSubset.mjs';
+export { isSubsetWith } from './isSubsetWith.mjs';
 export { keyBy } from './keyBy.mjs';
 export { last } from './last.mjs';
 export { maxBy } from './maxBy.mjs';

package/dist/array/isSubsetWith.d.mts

@@ -0,0 +1,33 @@
+/**
+ * Checks if the `subset` array is entirely contained within the `superset` array based on a custom equality function.
+ *
+ * This function takes two arrays and a custom comparison function. It returns a boolean indicating
+ * whether all elements in the subset array are present in the superset array, as determined by the provided
+ * custom equality function.
+ *
+ * @template T - The type of elements contained in the arrays.
+ * @param {T[]} superset - The array that may contain all elements of the subset.
+ * @param {T[]} subset - The array to check against the superset.
+ * @param {(x: T, y: T) => boolean} areItemsEqual - A function to determine if two items are equal.
+ * @returns {boolean} - Returns `true` if all elements of the subset are present in the superset
+ * according to the custom equality function, otherwise returns `false`.
+ *
+ * @example
+ * ```typescript
+ * const superset = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ * const subset = [{ id: 2 }, { id: 1 }];
+ * const areItemsEqual = (a, b) => a.id === b.id;
+ * isSubsetWith(superset, subset, areItemsEqual); // true
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const superset = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ * const subset = [{ id: 4 }];
+ * const areItemsEqual = (a, b) => a.id === b.id;
+ * isSubsetWith(superset, subset, areItemsEqual); // false
+ * ```
+ */
+declare function isSubsetWith<T>(superset: readonly T[], subset: readonly T[], areItemsEqual: (x: T, y: T) => boolean): boolean;
+
+export { isSubsetWith };

package/dist/array/isSubsetWith.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Checks if the `subset` array is entirely contained within the `superset` array based on a custom equality function.
+ *
+ * This function takes two arrays and a custom comparison function. It returns a boolean indicating
+ * whether all elements in the subset array are present in the superset array, as determined by the provided
+ * custom equality function.
+ *
+ * @template T - The type of elements contained in the arrays.
+ * @param {T[]} superset - The array that may contain all elements of the subset.
+ * @param {T[]} subset - The array to check against the superset.
+ * @param {(x: T, y: T) => boolean} areItemsEqual - A function to determine if two items are equal.
+ * @returns {boolean} - Returns `true` if all elements of the subset are present in the superset
+ * according to the custom equality function, otherwise returns `false`.
+ *
+ * @example
+ * ```typescript
+ * const superset = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ * const subset = [{ id: 2 }, { id: 1 }];
+ * const areItemsEqual = (a, b) => a.id === b.id;
+ * isSubsetWith(superset, subset, areItemsEqual); // true
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const superset = [{ id: 1 }, { id: 2 }, { id: 3 }];
+ * const subset = [{ id: 4 }];
+ * const areItemsEqual = (a, b) => a.id === b.id;
+ * isSubsetWith(superset, subset, areItemsEqual); // false
+ * ```
+ */
+declare function isSubsetWith<T>(superset: readonly T[], subset: readonly T[], areItemsEqual: (x: T, y: T) => boolean): boolean;
+
+export { isSubsetWith };

package/dist/array/isSubsetWith.mjs

@@ -0,0 +1,7 @@
+import { differenceWith } from './differenceWith.mjs';
+
+function isSubsetWith(superset, subset, areItemsEqual) {
+    return differenceWith(subset, superset, areItemsEqual).length === 0;
+}
+
+export { isSubsetWith };

package/dist/array/without.mjs

@@ -1,6 +1,7 @@
+import { difference } from './difference.mjs';
+
 function without(array, ...values) {
-    const valuesSet = new Set(values);
-    return array.filter(item => !valuesSet.has(item));
+    return difference(array, values);
 }
 
 export { without };

package/dist/array/zip.mjs

@@ -1,5 +1,10 @@
 function zip(...arrs) {
-    const rowCount = Math.max(...arrs.map(x => x.length));
+    let rowCount = 0;
+    for (let i = 0; i < arrs.length; i++) {
+        if (arrs[i].length > rowCount) {
+            rowCount = arrs[i].length;
+        }
+    }
     const columnCount = arrs.length;
     const result = Array(rowCount);
     for (let i = 0; i < rowCount; ++i) {