moderndash 3.3.2 → 3.5.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Call, Tuples, Objects } from 'hotscript';
+
 /**
  * Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.
  *
@@ -8,9 +10,9 @@
  * chunk(['a', 'b', 'c', 'd'], 3)
  * // => [['a', 'b', 'c'], ['d']]
  * @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.
+ * @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[], chunkSize: number): TElem[][];
 
@@ -30,10 +32,10 @@ declare function chunk<TElem>(array: readonly TElem[], chunkSize: number): TElem
  * count(users, value => value.age);
  * // => { 36: 2, 40: 1 }
  *
- * @param criteria The criteria to count by.
- * @param array The array or record to iterate over.
- * @template TElem The type of the array elements.
- * @returns Returns the composed aggregate object.
+ * @param criteria The criteria to count by
+ * @param array The array or record to iterate over
+ * @template TElem The type of the array elements
+ * @returns Returns the composed aggregate object
  */
 declare function count<TElem, TKey extends PropertyKey>(array: readonly TElem[], criteria: (value: TElem) => TKey): Record<TKey, number>;
 
@@ -76,10 +78,10 @@ type ArrayTail<TArray extends unknown[]> = TArray extends [unknown, ...infer U]
  *
  * difference(arr1, arr2, (a, b) => a.id === b.id)
  * // => [{ id: 1, name: 'Yeet' }]
- * @param arraysOrCompareFn Two or more arrays with an optional compare function at the end.
- * @template TElem The type of the array elements.
- * @template TArrays The type of the arrays provided.
- * @returns Returns the new array of filtered values.
+ * @param arraysOrCompareFn Two or more arrays with an optional compare function at the end
+ * @template TElem The type of the array elements
+ * @template TArrays The type of the arrays provided
+ * @returns Returns the new array of filtered values
  */
 declare function difference<TElem>(...arraysOrCompareFn: ArrayMinLength<TElem[], 2>): TElem[];
 declare function difference<TArrays extends ArrayMinLength<unknown[], 2>>(...arraysOrCompareFn: [...TArrays, CompareFunction<TArrays>]): TArrays[0];
@@ -97,10 +99,10 @@ declare function difference<TArrays extends ArrayMinLength<unknown[], 2>>(...arr
  *
  * dropRightWhile(users, user => user.active)
  * // => objects for ['barney']
- * @param predicate The function invoked per iteration.
- * @param array The array to query.
- * @template TElem The type of the array elements.
- * @returns Returns the slice of `array`.
+ * @param predicate The function invoked per iteration
+ * @param array The array to query
+ * @template TElem The type of the array elements
+ * @returns Returns the slice of `array`
  */
 declare function dropRightWhile<TElem>(array: readonly TElem[], predicate: (value: TElem) => boolean): TElem[];
 
@@ -117,10 +119,10 @@ declare function dropRightWhile<TElem>(array: readonly TElem[], predicate: (valu
  *
  * dropWhile(users, user => user.active)
  * // => objects for ['pebbles']
- * @param predicate The function invoked per iteration.
- * @param array The array to query.
- * @template TElem The type of the array elements.
- * @returns Returns the slice of `array`.
+ * @param predicate The function invoked per iteration
+ * @param array The array to query
+ * @template TElem The type of the array elements
+ * @returns Returns the slice of `array`
  */
 declare function dropWhile<TElem>(array: readonly TElem[], predicate: (value: TElem) => boolean): TElem[];
 
@@ -134,10 +136,10 @@ declare function dropWhile<TElem>(array: readonly TElem[], predicate: (value: TE
  * group([6.1, 4.2, 6.3], value => value > 5 ? '>5' : '<=5')
  * // => { '<=5': [4.2], '>5': [6.1, 6.3] }
  *
- * @param collection The array or object to iterate over.
- * @param getGroupKey A function that returns the group id for each item.
- * @template TElem The type of the array elements.
- * @returns An object with grouped items.
+ * @param collection The array or object to iterate over
+ * @param getGroupKey A function that returns the group id for each item
+ * @template TElem The type of the array elements
+ * @returns An object with grouped items
  */
 declare function group<TElem, TKey extends PropertyKey>(array: readonly TElem[], getGroupKey: (elem: TElem) => TKey): Record<TKey, TElem[]>;
 
@@ -146,6 +148,7 @@ declare function group<TElem, TKey extends PropertyKey>(array: readonly TElem[],
  * The order of the values is based on the first array.
  *
  * Optionally, use a compare function for element comparison (default is `===`).
+ *
  * @example
  * intersection([2, 1], [2, 3], [6, 2])
  * // => [2]
@@ -162,17 +165,35 @@ declare function group<TElem, TKey extends PropertyKey>(array: readonly TElem[],
  *
  * intersection(arr1, arr2, (a, b) => a.id === b.id)
  * // => [{ id: 3, name: 'John' }]
- * @param arraysOrCompareFn Two or more arrays with an optional compare function at the end.
- * @template TElem The type of the array elements.
- * @template TArrays The type of the arrays provided.
- * @returns Returns the new array of intersecting values.
+ *
+ * @param arraysOrCompareFn Two or more arrays with an optional compare function at the end
+ * @template TElem Type of the array elements
+ * @template TArrays Type of the arrays provided
+ * @returns New array of intersecting values
  */
 declare function intersection<TElem>(...arraysOrCompareFn: ArrayMinLength<TElem[], 2>): TElem[];
 declare function intersection<TArrays extends ArrayMinLength<unknown[], 2>>(...arraysOrCompareFn: [...TArrays, CompareFunction<TArrays>]): TArrays[0];
 
 /**
- * Generates an iterable sequence of numbers starting from `start`, up to and including `end`,
- * with a given `step` between each number.
+ * Moves an element within an array.
+ *
+ * @example
+ * ```typescript
+ * move([1, 2, 3, 4, 5], 0, 2);
+ * // => [2, 3, 1, 4, 5]
+ * ```
+ *
+ * @param array The input array
+ * @param fromIndex Index of the element to move
+ * @param toIndex Target index for the element
+ * @throws If index is out of bounds
+ * @returns The modified array with the moved element
+ * @template TArr Type of the array elements
+ */
+declare function move<TArr>(array: TArr[], fromIndex: number, toIndex: number): TArr[];
+
+/**
+ * Generates iterable sequence including numbers from start to end, with step increments.
  *
  * @example
  * for (const num of range(1, 5)) {
@@ -184,11 +205,11 @@ declare function intersection<TArrays extends ArrayMinLength<unknown[], 2>>(...a
  * const arr = [...range(0, 10, 2)];
  * // => [0, 2, 4, 6, 8, 10]
  *
- * @param start The starting number of the sequence.
- * @param end The end number of the sequence.
- * @param step The step between each number in the sequence. Defaults to 1.
- *
- * @returns An iterable sequence of numbers between `start` and `end`, inclusive, with increments of `step`.
+ * @param start Start number of sequence
+ * @param end End number of sequence
+ * @param step Step between numbers, default: 1
+ * @throws If range is negative or step is 0
+ * @returns Generator of numbers within the range
  */
 declare function range(start: number, end: number, step?: number): Generator<number>;
 
@@ -198,14 +219,14 @@ declare function range(start: number, end: number, step?: number): Generator<num
  * @example
  * shuffle([1, 2, 3, 4])
  * // => [4, 1, 3, 2]
- * @param array The array or object to shuffle.
- * @template TElem The type of the array elements.
- * @returns Returns a new shuffled array.
+ * @param array Array to shuffle
+ * @template TElem The type of the array elements
+ * @returns A new shuffled array
  */
 declare function shuffle<TElem>(array: readonly TElem[]): TElem[];
 
 /**
- * Creates a new sorted array in ascending or descending order based on one or multiple sorting criteria.
+ * Creates new array sorted in ascending/descending order with single or multiple criteria.
  *
  * @example
  * sort([1, 2, 3, 4], { order: 'desc' })
@@ -219,14 +240,15 @@ declare function shuffle<TElem>(array: readonly TElem[]): TElem[];
  *   { order: 'desc', by: item => item.b }
  * )
  * // => [{ a: 1, b: 2 }, { a: 1, b: 1 }, { a: 2, b: 1 }]
- * @param array The array to sort.
- * @param orders The sorting criteria, one or multiple objects with properties order (either 'asc' or 'desc') and by (iteratee function to sort based on a specific property).
- * @param orders.order - The order to sort in, either 'asc' or 'desc'.
- * @param orders.by - The iteratee function to sort based on a specific property.
- * @template TElem The type of the array elements.
- * @returns Returns a new sorted array.
+ *
+ * @param array Array to sort
+ * @param criteria Criteria to sort by
+ * @param criteria.order Order to sort in, either 'asc' or 'desc'
+ * @param criteria.by Iteratee function to sort based on a specific property
+ * @template TElem Type of the array elements
+ * @returns New sorted array
 */
-declare function sort<TElem>(array: readonly TElem[], ...orders: {
+declare function sort<TElem>(array: readonly TElem[], ...criteria: {
     order?: "asc" | "desc";
     by?: (item: TElem) => number | bigint | Date | string;
 }[]): TElem[];
@@ -272,10 +294,9 @@ declare function takeRightWhile<TElem>(array: readonly TElem[], predicate: (elem
 declare function takeWhile<TElem>(array: readonly TElem[], predicate: (elem: TElem) => boolean): TElem[];
 
 /**
- * Creates a duplicate-free version of an array, in which only the first occurrence of each element is kept.
- * The order of result values is determined by the order they occur in the array.
+ * Creates unique array retaining first occurrence of elements.
  *
- * A compare function is optional to specify how the array is compared (default is `===`).
+ * A compare function is optional (default is `===`).
  *
  * @example
  * unique([2, 1, 2])
@@ -295,10 +316,10 @@ declare function takeWhile<TElem>(array: readonly TElem[], predicate: (elem: TEl
  * unique(users, (a, b) => a.name === b.name)
  * // => [{ id: 1, name: 'john' }]
  *
- * @param array The array to inspect.
- * @param iteratee The iteratee invoked per element.
- * @template TElem The type of the array elements.
- * @returns Returns the new duplicate free array.
+ * @param array Array to inspect
+ * @param iteratee Iteratee invoked per element
+ * @template TElem Type of the array elements
+ * @returns A new unique array
  */
 declare function unique<TElem>(array: readonly TElem[], compareFn?: (a: TElem, b: TElem) => boolean): TElem[];
 
@@ -795,7 +816,8 @@ declare function round(number: number, precision?: number): number;
  * @param numbers The input array of numbers
  * @returns The sum of the input array
  */
-declare function sum(numbers: readonly number[]): number;
+declare function sum(numbers: number[]): number;
+declare function sum<TNum extends readonly number[]>(numbers: TNum): Call<Tuples.Sum, TNum>;
 
 /**
  * The type of a plain object.
@@ -811,6 +833,8 @@ declare function sum(numbers: readonly number[]): number;
  */
 type PlainObject = Record<PropertyKey, unknown>;
 
+type StringIfNever<Type> = [Type] extends [never] ? string : Type;
+type Paths$1<TObj> = StringIfNever<Call<Objects.AllPaths, TObj>>;
 /**
  * Flattens an object into a single level object.
  *
@@ -823,7 +847,7 @@ type PlainObject = Record<PropertyKey, unknown>;
  * @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>;
+declare function flatKeys<TObj extends PlainObject>(obj: TObj): Record<Paths$1<TObj>, unknown>;
 
 /**
  * This function combines two or more objects into a single new object. Arrays and other types are overwritten.
@@ -890,6 +914,8 @@ declare function omit<TObj extends PlainObject, Key extends keyof TObj>(object:
  */
 declare function pick<TObj extends PlainObject, Key extends keyof TObj>(object: TObj, keysToPick: Key[]): Pick<TObj, Key>;
 
+type Paths<TObj> = Call<Objects.AllPaths, TObj> | string & {};
+type UpdateObj<TObj extends PlainObject, TPath extends string, TVal> = Call<Objects.Update<TPath, TVal>, TObj>;
 /**
  * Sets the value at path of object. If a portion of path doesn’t exist, it’s created.
  *
@@ -914,9 +940,11 @@ declare function pick<TObj extends PlainObject, Key extends keyof TObj>(object:
  * @param path The path of the property to set.
  * @param value The value to set.
  * @template TObj The type of the object.
+ * @template TPath The type of the object path.
+ * @template TVal The type of the value to set.
  * @returns The modified object.
  */
-declare function set(obj: PlainObject, path: string, value: unknown): PlainObject;
+declare function set<TObj extends PlainObject, TPath extends Paths<TObj>, TVal>(obj: TObj, path: TPath, value: TVal): UpdateObj<TObj, TPath, TVal>;
 
 /**
  * A class for managing a queue of async functions that runs a set number concurrently.
@@ -1182,6 +1210,22 @@ declare function kebabCase(str: string): string;
  */
 declare function pascalCase(str: string): string;
 
+/**
+ * Replaces the last occurrence of a string.
+ *
+ * @example
+ * ```typescript
+ * replaceLast("Foo Bar Bar", "Bar", "Boo");
+ * // => "Foo Bar Boo"
+ * ```
+ *
+ * @param str The string to replace in.
+ * @param searchFor The string to search for.
+ * @param replaceWith The string to replace with.
+ * @returns The replaced string.
+ */
+declare function replaceLast(str: string, searchFor: string, replaceWith: string): string;
+
 /**
  * Converts a string to snake_case.
  *
@@ -1370,4 +1414,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, 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, trim, trimEnd, trimStart, 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, move, omit, pascalCase, pick, races, randomElem, randomFloat, randomInt, randomString, range, replaceLast, retry, round, set, shuffle, sleep, snakeCase, sort, splitWords, sum, takeRightWhile, takeWhile, throttle, timeout, times, titleCase, toDecorator, trim, trimEnd, trimStart, tryCatch, unescapeHtml, unique };

package/dist/index.js

@@ -1,9 +1,8 @@
 // src/array/chunk.ts
 function chunk(array, chunkSize) {
   const intSize = Math.trunc(chunkSize);
-  if (array.length === 0 || intSize < 1) {
+  if (array.length === 0 || intSize < 1)
     return [];
-  }
   let index = 0;
   let resultIndex = 0;
   const result = new Array(Math.ceil(array.length / intSize));
@@ -116,6 +115,25 @@ function intersection(...arraysOrCompareFn) {
   return intersection2;
 }
 
+// src/array/move.ts
+function move(array, fromIndex, toIndex) {
+  if (fromIndex < 0 || fromIndex >= array.length)
+    throw new Error(`Invalid 'fromIndex': ${fromIndex}. Must be between 0 and ${array.length - 1}.`);
+  if (toIndex < 0 || toIndex >= array.length)
+    throw new Error(`Invalid 'toIndex': ${toIndex}. Must be between 0 and ${array.length - 1}.`);
+  if (fromIndex === toIndex)
+    return array;
+  const item = array[fromIndex];
+  if (fromIndex < toIndex)
+    for (let index = fromIndex; index < toIndex; index++)
+      array[index] = array[index + 1];
+  else
+    for (let index = fromIndex; index > toIndex; index--)
+      array[index] = array[index - 1];
+  array[toIndex] = item;
+  return array;
+}
+
 // src/array/range.ts
 function* range(start, end, step = 1) {
   if (start > end)
@@ -138,9 +156,9 @@ function shuffle(array) {
 }
 
 // src/array/sort.ts
-function sort(array, ...orders) {
+function sort(array, ...criteria) {
   return [...array].sort((a, b) => {
-    for (const { order, by } of orders) {
+    for (const { order, by } of criteria) {
       const aValue = by ? by(a) : a;
       const bValue = by ? by(b) : b;
       if (aValue < bValue) {
@@ -468,7 +486,7 @@ function omit(object, keysToOmit) {
 }
 
 // src/object/set.ts
-var validPathRegex = /^(?:[^.[\]]+(?:\[\d+])*(?:\.|\[\d+]))+(?:[^.[\]]+(?:\[\d+])*)+$/;
+var validPathRegex = /^[^.[\]]+(?:\.[^.[\]]+)*(?:\[\d+])*(?:\.[^.[\]]+(?:\[\d+])*)*$/;
 var pathSplitRegex = /\.|(?=\[)/g;
 var matchBracketsRegex = /[[\]]/g;
 function set(obj, path, value) {
@@ -714,6 +732,14 @@ function pascalCase(str) {
   return pascalCase2;
 }
 
+// src/string/replaceLast.ts
+function replaceLast(str, searchFor, replaceWith) {
+  const index = str.lastIndexOf(searchFor);
+  if (index === -1)
+    return str;
+  return str.slice(0, index) + replaceWith + str.slice(index + searchFor.length);
+}
+
 // src/string/snakeCase.ts
 function snakeCase(str) {
   str = deburr(str);
@@ -894,6 +920,7 @@ export {
   memoize,
   merge,
   minCalls,
+  move,
   omit,
   pascalCase,
   pick,
@@ -903,6 +930,7 @@ export {
   randomInt,
   randomString,
   range,
+  replaceLast,
   retry,
   round,
   set,