moderndash 2.1.4 → 2.2.0

package/dist/index.d.ts

@@ -7,12 +7,12 @@
  *
  * chunk(['a', 'b', 'c', 'd'], 3)
  * // => [['a', 'b', 'c'], ['d']]
- * @param size The length of each chunk
+ * @param chunkSize The length of each chunk
  * @param array The array to chunk.
  * @template TElem The type of the array elements.
  * @returns Returns the new array of chunks.
  */
-declare function chunk<TElem>(array: readonly TElem[], size: number): TElem[][];
+declare function chunk<TElem>(array: readonly TElem[], chunkSize: number): TElem[][];
 
 /**
  * Creates an object with counts of occurrences of items in the array.
@@ -91,7 +91,7 @@ declare function difference<TElem>(arrayOrCompFn: (a: TElem, b: TElem) => boolea
  *   { 'user': 'pebbles', 'active': true }
  * ]
  *
- * dropRightWhile(users, ({ active }) => active)
+ * dropRightWhile(users, user => user.active)
  * // => objects for ['barney']
  * @param predicate The function invoked per iteration.
  * @param array The array to query.
@@ -111,7 +111,7 @@ declare function dropRightWhile<TElem>(array: readonly TElem[], predicate: (valu
  *   { 'user': 'pebbles', 'active': false }
  * ]
  *
- * dropWhile(users, ({ active }) => active)
+ * dropWhile(users, user => user.active)
  * // => objects for ['pebbles']
  * @param predicate The function invoked per iteration.
  * @param array The array to query.
@@ -236,7 +236,7 @@ declare function sort<TElem>(array: readonly TElem[], ...orders: {
  *   { 'user': 'pebbles', 'active': true }
  * ]
  *
- * takeRightWhile(users, ({ active }) => active)
+ * takeRightWhile(users, user => user.active)
  * // => objects for ['fred', 'pebbles']
  * @param predicate The function invoked per iteration.
  * @param array The array to query.
@@ -256,7 +256,7 @@ declare function takeRightWhile<TElem>(array: readonly TElem[], predicate: (elem
  *   { 'user': 'pebbles', 'active': false }
  * ]
  *
- * takeWhile(users, ({ active }) => active)
+ * takeWhile(users, user => user.active)
  * // => objects for ['barney', 'fred']
  * @param predicate The function invoked per iteration.
  * @param array The array to query.
@@ -478,16 +478,18 @@ declare function decMaxCalls(n: number): (target: unknown, key: string, descript
 type GenericFunction<TFunc extends (...args: any) => any> = (...args: Parameters<TFunc>) => ReturnType<TFunc>;
 
 /**
- * Creates a function that caches the result of `func`.
+ * Creates a function that memoizes the result of a given function.
  *
- * The cache key is either determined by the provided `resolver` or by the arguments used in the cached function.
- *
- * The `cache` property is exposed on the cached function. It is an instance of `Map` and can be used to clear or inspect the cache.
- * The cache property can be replaced by a custom cache as long as it implements the `Map` interface.
+ * The cache key is determined by the `resolver` or by the arguments from the function call.
  *
  * **Options:**
- * - `resolver` A function that determines the cache key for storing the result based on the arguments provided.
- * - `ttl` sets the time to live for the cache in milliseconds. After `ttl` milliseconds, the next call to the memoized function will result in a cache miss.
+ * - `resolver` A function that determines the cache key based on the arguments provided.
+ * - `ttl` the time to live for the cache entries in milliseconds.
+ *
+ * **Properties:**
+ * - `cache` The cache is an instance of `Map` and can be used to clear or inspect the cache.
+ * It can be replaced by a custom cache that matches the `Map` interface.
+ *
  *
  * This function can be used as a decorator with {@link decMemoize}.
  *
@@ -803,6 +805,20 @@ declare function sum(numbers: readonly number[]): number;
  */
 type PlainObject = Record<PropertyKey, unknown>;
 
+/**
+ * Flattens an object into a single level object.
+ *
+ * @example
+ * const obj = { a: { b: 2, c: [{ d: 3 }, {d: 4 }] } };
+ * flatKeys(obj);
+ * // => { 'a.b': 2, 'a.c[0].d': 3, 'a.c[1].d': 4 }
+ *
+ * @param obj The object to flatten.
+ * @template TObj The type of the object to flatten.
+ * @returns A new object with flattened keys.
+ */
+declare function flatKeys<TObj extends PlainObject>(obj: TObj): Record<string, unknown>;
+
 /**
  * This function combines two or more objects into a single new object. Arrays and other types are overwritten.
  *
@@ -876,13 +892,25 @@ declare function pick<TObj extends PlainObject, Key extends keyof TObj>(object:
  * set(obj, 'a.c', 1);
  * // => { a: { b: 2, c: 1 } }
  *
+ * // `[number]` can be used to access array elements
+ * set(obj, 'a.c[0]', 'hello');
+ * // => { a: { b: 2, c: ['hello'] } }
+ *
+ * // numbers with dots are treated as keys
+ * set(obj, 'a.c.0.d', 'world');
+ * // => { a: { b: 2, c: { 0: { d: 'world' } } }
+ *
+ * // supports numbers in keys
+ * set(obj, 'a.e0.a', 1);
+ * // => { a: { e0: { a: 1 } } }
+ *
  * @param obj The object to modify.
  * @param path The path of the property to set.
  * @param value The value to set.
  * @template TObj The type of the object.
  * @returns The modified object.
  */
-declare function set<TObj extends PlainObject>(obj: TObj, path: string, value: unknown): TObj;
+declare function set(obj: PlainObject, path: string, value: unknown): PlainObject;
 
 /**
  * A class for managing a queue of async functions that runs a set number concurrently.
@@ -1287,4 +1315,4 @@ declare function isPlainObject(value: unknown): value is PlainObject;
  */
 declare function isUrl(str: string): boolean;
 
-export { ArrayMinLength, GenericFunction, Jsonifiable, PlainObject, Queue, average, camelCase, capitalize, chunk, count, debounce, deburr, decDebounce, decMaxCalls, decMemoize, decMinCalls, decThrottle, difference, dropRightWhile, dropWhile, escapeHtml, escapeRegExp, group, hash, intersection, isEmpty, isEqual, isPlainObject, isUrl, kebabCase, maxCalls, median, memoize, merge, minCalls, omit, pascalCase, pick, races, randomElem, randomFloat, randomInt, randomString, range, retry, round, set, shuffle, sleep, snakeCase, sort, splitWords, sum, takeRightWhile, takeWhile, throttle, timeout, times, titleCase, toDecorator, tryCatch, unescapeHtml, unique };
+export { ArrayMinLength, GenericFunction, Jsonifiable, PlainObject, Queue, average, camelCase, capitalize, chunk, count, debounce, deburr, decDebounce, decMaxCalls, decMemoize, decMinCalls, decThrottle, difference, dropRightWhile, dropWhile, escapeHtml, escapeRegExp, flatKeys, group, hash, intersection, isEmpty, isEqual, isPlainObject, isUrl, kebabCase, maxCalls, median, memoize, merge, minCalls, omit, pascalCase, pick, races, randomElem, randomFloat, randomInt, randomString, range, retry, round, set, shuffle, sleep, snakeCase, sort, splitWords, sum, takeRightWhile, takeWhile, throttle, timeout, times, titleCase, toDecorator, tryCatch, unescapeHtml, unique };

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/array/chunk.ts
-function chunk(array, size) {
-  const intSize = Math.trunc(size);
+function chunk(array, chunkSize) {
+  const intSize = Math.trunc(chunkSize);
   if (array.length === 0 || intSize < 1) {
     return [];
   }
@@ -402,6 +402,29 @@ function isPlainObject(value) {
   return value?.constructor === Object;
 }
 
+// src/object/flatKeys.ts
+function flatKeys(obj) {
+  const result = {};
+  function addToResult(prefix, value) {
+    if (isPlainObject(value)) {
+      const flatObj = flatKeys(value);
+      for (const [flatKey, flatValue] of Object.entries(flatObj)) {
+        result[`${prefix}.${flatKey}`] = flatValue;
+      }
+    } else if (Array.isArray(value)) {
+      for (const [index, element] of value.entries()) {
+        addToResult(`${prefix}[${index}]`, element);
+      }
+    } else {
+      result[prefix] = value;
+    }
+  }
+  for (const [key, value] of Object.entries(obj)) {
+    addToResult(key, value);
+  }
+  return result;
+}
+
 // src/object/merge.ts
 function merge(target, ...sources) {
   const targetCopy = { ...target };
@@ -430,18 +453,28 @@ function omit(object, keysToOmit) {
 }
 
 // src/object/set.ts
+var validPathRegex = /^(?:[^.[\]]+(?:\[\d+])*(?:\.|\[\d+]))+(?:[^.[\]]+(?:\[\d+])*)+$/;
+var pathSplitRegex = /\.|(?=\[)/g;
+var matchBracketsRegex = /[[\]]/g;
 function set(obj, path, value) {
-  const pathParts = path.split(/[.[\]]/g).filter((x) => Boolean(x.trim()));
+  if (!validPathRegex.test(path))
+    throw new Error("Invalid path, look at the examples for the correct format.");
+  const pathParts = path.split(pathSplitRegex);
   let currentObj = obj;
   for (let index = 0; index < pathParts.length; index++) {
-    const key = pathParts[index];
+    const key = pathParts[index].replace(matchBracketsRegex, "");
     if (index === pathParts.length - 1) {
       currentObj[key] = value;
       break;
     }
-    const nextIsNumber = !Number.isNaN(Number.parseInt(pathParts[index + 1]));
-    if (currentObj[key] === void 0)
-      currentObj[key] = nextIsNumber ? [] : {};
+    const nextElemIn = pathParts[index + 1].startsWith("[") ? "array" : "object";
+    if (currentObj[key] === void 0) {
+      currentObj[key] = nextElemIn === "array" ? [] : {};
+    } else if (nextElemIn === "array" && !Array.isArray(currentObj[key])) {
+      currentObj[key] = [];
+    } else if (nextElemIn === "object" && !isPlainObject(currentObj[key])) {
+      currentObj[key] = {};
+    }
     currentObj = currentObj[key];
   }
   return obj;
@@ -598,17 +631,18 @@ async function tryCatch(promise) {
 }
 
 // src/string/splitWords.ts
+var splitWordsRegex = new RegExp(
+  "[^\\dA-Za-z]|(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])"
+  // lookahead for an uppercase letter followed by a lowercase letter
+);
 function splitWords(str) {
-  const regex = new RegExp(
-    "[^\\dA-Za-z]|(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])"
-    // lookahead for an uppercase letter followed by a lowercase letter
-  );
-  return str.split(regex).filter(Boolean);
+  return str.split(splitWordsRegex).filter(Boolean);
 }
 
 // src/string/deburr.ts
+var accentControlRegex = /[\u0300-\u036F]/g;
 function deburr(str) {
-  return str.normalize("NFD").replace(/[\u0300-\u036F]/g, "");
+  return str.normalize("NFD").replace(accentControlRegex, "");
 }
 
 // src/string/camelCase.ts
@@ -630,20 +664,22 @@ function capitalize(str) {
 }
 
 // src/string/escapeHtml.ts
+var charRegex = /["&'<>]/g;
+var escapeChars = /* @__PURE__ */ new Map([
+  ["&", "&amp;"],
+  ["<", "&lt;"],
+  [">", "&gt;"],
+  ["'", "&#39;"],
+  ['"', "&quot;"]
+]);
 function escapeHtml(str) {
-  const escapeChars = {
-    "&": "&amp;",
-    "<": "&lt;",
-    ">": "&gt;",
-    "'": "&#39;",
-    '"': "&quot;"
-  };
-  return str.replace(/["&'<>]/g, (char) => escapeChars[char]);
+  return str.replace(charRegex, (char) => escapeChars.get(char));
 }
 
 // src/string/escapeRegExp.ts
+var escapleCharsRegex = /[$()*+.?[\\\]^{|}]/g;
 function escapeRegExp(str) {
-  return str.replace(/[$()*+.?[\\\]^{|}]/g, "\\$&");
+  return str.replace(escapleCharsRegex, "\\$&");
 }
 
 // src/string/kebabCase.ts
@@ -694,15 +730,16 @@ function titleCase(str) {
 }
 
 // src/string/unescapeHtml.ts
+var htmlEntitiesRegex = /&(?:amp|lt|gt|quot|#39);/g;
+var entityMap = /* @__PURE__ */ new Map([
+  ["&amp;", "&"],
+  ["&lt;", "<"],
+  ["&gt;", ">"],
+  ["&quot;", '"'],
+  ["&#39;", "'"]
+]);
 function unescapeHtml(str) {
-  const entityMap = {
-    "&amp;": "&",
-    "&lt;": "<",
-    "&gt;": ">",
-    "&quot;": '"',
-    "&#39;": "'"
-  };
-  return str.replace(/&(?:amp|lt|gt|quot|#(0+)?39);/g, (entity) => entityMap[entity]);
+  return str.replace(htmlEntitiesRegex, (entity) => entityMap.get(entity));
 }
 
 // src/validate/isEmpty.ts
@@ -791,6 +828,7 @@ export {
   dropWhile,
   escapeHtml,
   escapeRegExp,
+  flatKeys,
   group,
   hash,
   intersection,