@web-ts-toolkit/utils 0.28.0 → 0.29.0

package/README.md

@@ -19,7 +19,7 @@ pnpm add @web-ts-toolkit/utils
 ## Quick Start
 
 ```ts
-import { get, set, normalizeUrlPath, parseBooleanString } from '@web-ts-toolkit/utils';
+import { get, groupBy, normalizeUrlPath, parseBooleanString, startCase, sumBy } from '@web-ts-toolkit/utils';
 
 const payload = {
   user: {
@@ -30,15 +30,25 @@ const payload = {
 };
 
 get(payload, 'user.profile.name');
-set(payload, 'user.profile.role', 'admin');
+groupBy(
+  [
+    { type: 'fruit', name: 'apple' },
+    { type: 'fruit', name: 'banana' },
+    { type: 'vegetable', name: 'carrot' },
+  ],
+  'type',
+);
+startCase('api_response_time');
+sumBy([{ hours: 2 }, { hours: 3 }], 'hours');
 normalizeUrlPath('api//users');
 parseBooleanString('true', false);
 ```
 
 ## Main Exports
 
-- object helpers: `get`, `set`, `pick`, `omit`, `assign`, `cloneDeep`
-- collection helpers: `map`, `filter`, `reduce`, `find`, `flatten`, `uniq`, `orderBy`
+- object helpers: `get`, `set`, `pick`, `pickBy`, `omit`, `assign`, `cloneDeep`, `mapKeys`
+- collection helpers: `map`, `filter`, `reduce`, `find`, `flatten`, `uniq`, `orderBy`, `groupBy`, `sum`, `sumBy`
+- string helpers: `startCase`, `upperCase`
 - guards: `isArray`, `isPlainObject`, `isString`, `isPromise`
 - URL helpers: `addLeadingSlash`, `removeConsecutiveSlashesFromUrl`, `normalizeUrlPath`
 

package/index.d.mts

@@ -27,6 +27,8 @@ type PropertyPath = string | number | Array<string | number>;
 
 declare function get<T = unknown>(object: unknown, path: PropertyPath, defaultValue?: T): T;
 
+declare function groupBy<T>(collection: T[] | Record<string, T> | null | undefined, iteratee: string | number | ((value: T, key: number | string, collection: T[] | Record<string, T>) => unknown)): Record<string, T[]>;
+
 declare function intersection<T>(...arrays: Array<T[] | null | undefined>): T[];
 
 declare function intersectionBy<T>(...args: unknown[]): T[];
@@ -63,6 +65,8 @@ declare function keys(value: unknown): string[];
 
 declare function map<T, TResult>(collection: T[] | Record<string, T> | null | undefined, iteratee: string | number | ((value: T, key: number | string, collection: T[] | Record<string, T>) => TResult)): TResult[];
 
+declare function mapKeys<TValue>(object: Record<string, TValue> | null | undefined, iteratee: (value: TValue, key: string, object: Record<string, TValue>) => string): Record<string, TValue>;
+
 declare function mapValues<TValue, TResult>(object: Record<string, TValue> | null | undefined, iteratee: (value: TValue, key: string, object: Record<string, TValue>) => TResult): Record<string, TResult>;
 
 declare function mapValuesAsync<TObject extends Record<string, unknown>, TResult>(object: TObject, asyncFn: (value: TObject[keyof TObject], key: string, object: TObject) => Promise<TResult> | TResult): Promise<Record<string, TResult>>;
@@ -79,6 +83,8 @@ declare function padEnd(value: unknown, length?: number, chars?: string): string
 
 declare function pick<T extends object>(object: T, paths: PropertyPath | PropertyPath[]): Partial<T>;
 
+declare function pickBy<TValue>(object: Record<string, TValue> | null | undefined, predicate: (value: TValue, key: string, object: Record<string, TValue>) => boolean): Record<string, TValue>;
+
 declare function normalizeUrlPath(url: string): string;
 
 declare function reduce<T, TResult>(collection: T[] | null | undefined, iteratee: (accumulator: TResult, value: T, key: number, collection: T[]) => TResult, accumulator?: TResult): TResult;
@@ -88,10 +94,18 @@ declare function removeConsecutiveSlashesFromUrl(url: string): string;
 
 declare function set<T>(object: T, path: PropertyPath, value: unknown): T;
 
+declare function startCase(value: unknown): string;
+
+declare function sum(values: number[] | null | undefined): number;
+
+declare function sumBy<T>(collection: T[] | null | undefined, iteratee: string | number | ((value: T, key: number, collection: T[]) => number | undefined)): number;
+
 declare function toAsyncFn<TArgs extends unknown[], TResult>(fn?: ((this: unknown, ...args: TArgs) => TResult | PromiseLike<TResult>) | null, defaultValue?: TResult): (this: unknown, ...args: TArgs) => PromiseLike<unknown> | Promise<any>;
 
 declare function toStringRecord(value: unknown): Record<string, string> | undefined;
 
 declare function uniq<T>(array: T[] | null | undefined): T[];
 
-export { addLeadingSlash, arrayToRecord, assign, castArray, cloneDeep, compact, difference, filter, find, flatten, flattenDeep, forEach, get, intersection, intersectionBy, isArray, isBoolean, isEmpty, isEqual, isFunction, isMatch, isNaNValue as isNaN, isNil, isNumber, isObject, isPlainObject, isPromise, isString, isUndefined, keys, map, mapValues, mapValuesAsync, noop, normalizeUrlPath, omit, orderBy, padEnd, parseBooleanString, pick, reduce, removeConsecutiveSlashesFromUrl, set, toAsyncFn, toStringRecord, uniq };
+declare function upperCase(value: unknown): string;
+
+export { addLeadingSlash, arrayToRecord, assign, castArray, cloneDeep, compact, difference, filter, find, flatten, flattenDeep, forEach, get, groupBy, intersection, intersectionBy, isArray, isBoolean, isEmpty, isEqual, isFunction, isMatch, isNaNValue as isNaN, isNil, isNumber, isObject, isPlainObject, isPromise, isString, isUndefined, keys, map, mapKeys, mapValues, mapValuesAsync, noop, normalizeUrlPath, omit, orderBy, padEnd, parseBooleanString, pick, pickBy, reduce, removeConsecutiveSlashesFromUrl, set, startCase, sum, sumBy, toAsyncFn, toStringRecord, uniq, upperCase };

package/index.d.ts

@@ -27,6 +27,8 @@ type PropertyPath = string | number | Array<string | number>;
 
 declare function get<T = unknown>(object: unknown, path: PropertyPath, defaultValue?: T): T;
 
+declare function groupBy<T>(collection: T[] | Record<string, T> | null | undefined, iteratee: string | number | ((value: T, key: number | string, collection: T[] | Record<string, T>) => unknown)): Record<string, T[]>;
+
 declare function intersection<T>(...arrays: Array<T[] | null | undefined>): T[];
 
 declare function intersectionBy<T>(...args: unknown[]): T[];
@@ -63,6 +65,8 @@ declare function keys(value: unknown): string[];
 
 declare function map<T, TResult>(collection: T[] | Record<string, T> | null | undefined, iteratee: string | number | ((value: T, key: number | string, collection: T[] | Record<string, T>) => TResult)): TResult[];
 
+declare function mapKeys<TValue>(object: Record<string, TValue> | null | undefined, iteratee: (value: TValue, key: string, object: Record<string, TValue>) => string): Record<string, TValue>;
+
 declare function mapValues<TValue, TResult>(object: Record<string, TValue> | null | undefined, iteratee: (value: TValue, key: string, object: Record<string, TValue>) => TResult): Record<string, TResult>;
 
 declare function mapValuesAsync<TObject extends Record<string, unknown>, TResult>(object: TObject, asyncFn: (value: TObject[keyof TObject], key: string, object: TObject) => Promise<TResult> | TResult): Promise<Record<string, TResult>>;
@@ -79,6 +83,8 @@ declare function padEnd(value: unknown, length?: number, chars?: string): string
 
 declare function pick<T extends object>(object: T, paths: PropertyPath | PropertyPath[]): Partial<T>;
 
+declare function pickBy<TValue>(object: Record<string, TValue> | null | undefined, predicate: (value: TValue, key: string, object: Record<string, TValue>) => boolean): Record<string, TValue>;
+
 declare function normalizeUrlPath(url: string): string;
 
 declare function reduce<T, TResult>(collection: T[] | null | undefined, iteratee: (accumulator: TResult, value: T, key: number, collection: T[]) => TResult, accumulator?: TResult): TResult;
@@ -88,10 +94,18 @@ declare function removeConsecutiveSlashesFromUrl(url: string): string;
 
 declare function set<T>(object: T, path: PropertyPath, value: unknown): T;
 
+declare function startCase(value: unknown): string;
+
+declare function sum(values: number[] | null | undefined): number;
+
+declare function sumBy<T>(collection: T[] | null | undefined, iteratee: string | number | ((value: T, key: number, collection: T[]) => number | undefined)): number;
+
 declare function toAsyncFn<TArgs extends unknown[], TResult>(fn?: ((this: unknown, ...args: TArgs) => TResult | PromiseLike<TResult>) | null, defaultValue?: TResult): (this: unknown, ...args: TArgs) => PromiseLike<unknown> | Promise<any>;
 
 declare function toStringRecord(value: unknown): Record<string, string> | undefined;
 
 declare function uniq<T>(array: T[] | null | undefined): T[];
 
-export { addLeadingSlash, arrayToRecord, assign, castArray, cloneDeep, compact, difference, filter, find, flatten, flattenDeep, forEach, get, intersection, intersectionBy, isArray, isBoolean, isEmpty, isEqual, isFunction, isMatch, isNaNValue as isNaN, isNil, isNumber, isObject, isPlainObject, isPromise, isString, isUndefined, keys, map, mapValues, mapValuesAsync, noop, normalizeUrlPath, omit, orderBy, padEnd, parseBooleanString, pick, reduce, removeConsecutiveSlashesFromUrl, set, toAsyncFn, toStringRecord, uniq };
+declare function upperCase(value: unknown): string;
+
+export { addLeadingSlash, arrayToRecord, assign, castArray, cloneDeep, compact, difference, filter, find, flatten, flattenDeep, forEach, get, groupBy, intersection, intersectionBy, isArray, isBoolean, isEmpty, isEqual, isFunction, isMatch, isNaNValue as isNaN, isNil, isNumber, isObject, isPlainObject, isPromise, isString, isUndefined, keys, map, mapKeys, mapValues, mapValuesAsync, noop, normalizeUrlPath, omit, orderBy, padEnd, parseBooleanString, pick, pickBy, reduce, removeConsecutiveSlashesFromUrl, set, startCase, sum, sumBy, toAsyncFn, toStringRecord, uniq, upperCase };

package/index.js

@@ -32,6 +32,7 @@ __export(index_exports, {
   flattenDeep: () => flattenDeep,
   forEach: () => forEach,
   get: () => get,
+  groupBy: () => groupBy,
   intersection: () => intersection,
   intersectionBy: () => intersectionBy,
   isArray: () => isArray,
@@ -50,6 +51,7 @@ __export(index_exports, {
   isUndefined: () => isUndefined,
   keys: () => keys,
   map: () => map,
+  mapKeys: () => mapKeys,
   mapValues: () => mapValues,
   mapValuesAsync: () => mapValuesAsync,
   noop: () => noop,
@@ -59,12 +61,17 @@ __export(index_exports, {
   padEnd: () => padEnd,
   parseBooleanString: () => parseBooleanString,
   pick: () => pick,
+  pickBy: () => pickBy,
   reduce: () => reduce,
   removeConsecutiveSlashesFromUrl: () => removeConsecutiveSlashesFromUrl,
   set: () => set,
+  startCase: () => startCase,
+  sum: () => sum,
+  sumBy: () => sumBy,
   toAsyncFn: () => toAsyncFn,
   toStringRecord: () => toStringRecord,
-  uniq: () => uniq
+  uniq: () => uniq,
+  upperCase: () => upperCase
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -94,6 +101,7 @@ function castArray(value) {
 
 // src/_internal.ts
 var pathPattern = /[^.[\]]+|\[(?:([^"'[\]]+)|["']([^"']+)["'])\]/g;
+var unsafePathParts = /* @__PURE__ */ new Set(["__proto__", "constructor", "prototype"]);
 function isObject(value) {
   return value !== null && (typeof value === "object" || typeof value === "function");
 }
@@ -126,6 +134,15 @@ function toPath(path) {
   });
   return result.length > 0 ? result : [input];
 }
+function hasUnsafePathPart(parts) {
+  for (let index = 0; index < parts.length; index++) {
+    const part = parts[index];
+    if (typeof part === "string" && unsafePathParts.has(part)) {
+      return true;
+    }
+  }
+  return false;
+}
 function hasPath(value, path) {
   const parts = toPath(path);
   if (parts.length === 0) {
@@ -160,7 +177,7 @@ function setPath(target, path, value) {
     return target;
   }
   const parts = toPath(path);
-  if (parts.length === 0) {
+  if (parts.length === 0 || hasUnsafePathPart(parts)) {
     return target;
   }
   let current = target;
@@ -181,7 +198,7 @@ function deletePath(target, path) {
     return;
   }
   const parts = toPath(path);
-  if (parts.length === 0) {
+  if (parts.length === 0 || hasUnsafePathPart(parts)) {
     return;
   }
   let current = target;
@@ -227,6 +244,14 @@ function getIteratee(iteratee) {
   }
   return (value) => getPath(value, iteratee);
 }
+var wordPattern = /[A-Z]{2,}(?=[A-Z][a-z]|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]+|[0-9]+/g;
+function words(value) {
+  const input = String(value ?? "");
+  if (input.length === 0) {
+    return [];
+  }
+  return input.replace(/[']/g, "").match(wordPattern) ?? [];
+}
 function compareAscending(left, right) {
   if (sameValueZero(left, right)) {
     return 0;
@@ -487,6 +512,31 @@ function get(object, path, defaultValue) {
   return getPath(object, path, defaultValue);
 }
 
+// src/groupBy.ts
+function groupBy(collection, iteratee) {
+  if (!collection) {
+    return {};
+  }
+  const callback = getIteratee(iteratee);
+  const result = {};
+  if (Array.isArray(collection)) {
+    for (let index = 0; index < collection.length; index++) {
+      const value = collection[index];
+      const key = String(callback(value, index, collection));
+      (result[key] ??= []).push(value);
+    }
+    return result;
+  }
+  const keys2 = Object.keys(collection);
+  for (let index = 0; index < keys2.length; index++) {
+    const key = keys2[index];
+    const value = collection[key];
+    const group = String(callback(value, key, collection));
+    (result[group] ??= []).push(value);
+  }
+  return result;
+}
+
 // src/intersection.ts
 function intersection(...arrays) {
   const [first = [], ...rest] = arrays;
@@ -640,6 +690,20 @@ function map(collection, iteratee) {
   return result;
 }
 
+// src/mapKeys.ts
+function mapKeys(object, iteratee) {
+  if (!object) {
+    return {};
+  }
+  const result = {};
+  const keys2 = Object.keys(object);
+  for (let index = 0; index < keys2.length; index++) {
+    const key = keys2[index];
+    result[String(iteratee(object[key], key, object))] = object[key];
+  }
+  return result;
+}
+
 // src/mapValues.ts
 function mapValues(object, iteratee) {
   if (!object) {
@@ -725,6 +789,23 @@ function pick(object, paths) {
   return result;
 }
 
+// src/pickBy.ts
+function pickBy(object, predicate) {
+  if (!object) {
+    return {};
+  }
+  const result = {};
+  const keys2 = Object.keys(object);
+  for (let index = 0; index < keys2.length; index++) {
+    const key = keys2[index];
+    const value = object[key];
+    if (predicate(value, key, object)) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+
 // src/removeConsecutiveSlashesFromUrl.ts
 function removeConsecutiveSlashesFromUrl(url) {
   return url.replace(/\/{2,}/g, "/");
@@ -771,6 +852,42 @@ function set(object, path, value) {
   return setPath(object, path, value);
 }
 
+// src/startCase.ts
+function startCase(value) {
+  return words(value).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+}
+
+// src/sum.ts
+function sum(values) {
+  if (!Array.isArray(values)) {
+    return 0;
+  }
+  let result = 0;
+  for (let index = 0; index < values.length; index++) {
+    const value = values[index];
+    if (value !== void 0) {
+      result += value;
+    }
+  }
+  return result;
+}
+
+// src/sumBy.ts
+function sumBy(collection, iteratee) {
+  if (!Array.isArray(collection)) {
+    return 0;
+  }
+  const callback = getIteratee(iteratee);
+  let result = 0;
+  for (let index = 0; index < collection.length; index++) {
+    const current = callback(collection[index], index, collection);
+    if (current !== void 0) {
+      result += current;
+    }
+  }
+  return result;
+}
+
 // src/toAsyncFn.ts
 function toAsyncFn(fn, defaultValue) {
   if (!fn) return () => Promise.resolve(defaultValue);
@@ -801,6 +918,11 @@ function uniq(array) {
   }
   return baseUniq(array);
 }
+
+// src/upperCase.ts
+function upperCase(value) {
+  return words(value).join(" ").toUpperCase();
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addLeadingSlash,
@@ -816,6 +938,7 @@ function uniq(array) {
   flattenDeep,
   forEach,
   get,
+  groupBy,
   intersection,
   intersectionBy,
   isArray,
@@ -834,6 +957,7 @@ function uniq(array) {
   isUndefined,
   keys,
   map,
+  mapKeys,
   mapValues,
   mapValuesAsync,
   noop,
@@ -843,10 +967,15 @@ function uniq(array) {
   padEnd,
   parseBooleanString,
   pick,
+  pickBy,
   reduce,
   removeConsecutiveSlashesFromUrl,
   set,
+  startCase,
+  sum,
+  sumBy,
   toAsyncFn,
   toStringRecord,
-  uniq
+  uniq,
+  upperCase
 });

package/index.mjs

@@ -24,6 +24,7 @@ function castArray(value) {
 
 // src/_internal.ts
 var pathPattern = /[^.[\]]+|\[(?:([^"'[\]]+)|["']([^"']+)["'])\]/g;
+var unsafePathParts = /* @__PURE__ */ new Set(["__proto__", "constructor", "prototype"]);
 function isObject(value) {
   return value !== null && (typeof value === "object" || typeof value === "function");
 }
@@ -56,6 +57,15 @@ function toPath(path) {
   });
   return result.length > 0 ? result : [input];
 }
+function hasUnsafePathPart(parts) {
+  for (let index = 0; index < parts.length; index++) {
+    const part = parts[index];
+    if (typeof part === "string" && unsafePathParts.has(part)) {
+      return true;
+    }
+  }
+  return false;
+}
 function hasPath(value, path) {
   const parts = toPath(path);
   if (parts.length === 0) {
@@ -90,7 +100,7 @@ function setPath(target, path, value) {
     return target;
   }
   const parts = toPath(path);
-  if (parts.length === 0) {
+  if (parts.length === 0 || hasUnsafePathPart(parts)) {
     return target;
   }
   let current = target;
@@ -111,7 +121,7 @@ function deletePath(target, path) {
     return;
   }
   const parts = toPath(path);
-  if (parts.length === 0) {
+  if (parts.length === 0 || hasUnsafePathPart(parts)) {
     return;
   }
   let current = target;
@@ -157,6 +167,14 @@ function getIteratee(iteratee) {
   }
   return (value) => getPath(value, iteratee);
 }
+var wordPattern = /[A-Z]{2,}(?=[A-Z][a-z]|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]+|[0-9]+/g;
+function words(value) {
+  const input = String(value ?? "");
+  if (input.length === 0) {
+    return [];
+  }
+  return input.replace(/[']/g, "").match(wordPattern) ?? [];
+}
 function compareAscending(left, right) {
   if (sameValueZero(left, right)) {
     return 0;
@@ -417,6 +435,31 @@ function get(object, path, defaultValue) {
   return getPath(object, path, defaultValue);
 }
 
+// src/groupBy.ts
+function groupBy(collection, iteratee) {
+  if (!collection) {
+    return {};
+  }
+  const callback = getIteratee(iteratee);
+  const result = {};
+  if (Array.isArray(collection)) {
+    for (let index = 0; index < collection.length; index++) {
+      const value = collection[index];
+      const key = String(callback(value, index, collection));
+      (result[key] ??= []).push(value);
+    }
+    return result;
+  }
+  const keys2 = Object.keys(collection);
+  for (let index = 0; index < keys2.length; index++) {
+    const key = keys2[index];
+    const value = collection[key];
+    const group = String(callback(value, key, collection));
+    (result[group] ??= []).push(value);
+  }
+  return result;
+}
+
 // src/intersection.ts
 function intersection(...arrays) {
   const [first = [], ...rest] = arrays;
@@ -570,6 +613,20 @@ function map(collection, iteratee) {
   return result;
 }
 
+// src/mapKeys.ts
+function mapKeys(object, iteratee) {
+  if (!object) {
+    return {};
+  }
+  const result = {};
+  const keys2 = Object.keys(object);
+  for (let index = 0; index < keys2.length; index++) {
+    const key = keys2[index];
+    result[String(iteratee(object[key], key, object))] = object[key];
+  }
+  return result;
+}
+
 // src/mapValues.ts
 function mapValues(object, iteratee) {
   if (!object) {
@@ -655,6 +712,23 @@ function pick(object, paths) {
   return result;
 }
 
+// src/pickBy.ts
+function pickBy(object, predicate) {
+  if (!object) {
+    return {};
+  }
+  const result = {};
+  const keys2 = Object.keys(object);
+  for (let index = 0; index < keys2.length; index++) {
+    const key = keys2[index];
+    const value = object[key];
+    if (predicate(value, key, object)) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+
 // src/removeConsecutiveSlashesFromUrl.ts
 function removeConsecutiveSlashesFromUrl(url) {
   return url.replace(/\/{2,}/g, "/");
@@ -701,6 +775,42 @@ function set(object, path, value) {
   return setPath(object, path, value);
 }
 
+// src/startCase.ts
+function startCase(value) {
+  return words(value).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+}
+
+// src/sum.ts
+function sum(values) {
+  if (!Array.isArray(values)) {
+    return 0;
+  }
+  let result = 0;
+  for (let index = 0; index < values.length; index++) {
+    const value = values[index];
+    if (value !== void 0) {
+      result += value;
+    }
+  }
+  return result;
+}
+
+// src/sumBy.ts
+function sumBy(collection, iteratee) {
+  if (!Array.isArray(collection)) {
+    return 0;
+  }
+  const callback = getIteratee(iteratee);
+  let result = 0;
+  for (let index = 0; index < collection.length; index++) {
+    const current = callback(collection[index], index, collection);
+    if (current !== void 0) {
+      result += current;
+    }
+  }
+  return result;
+}
+
 // src/toAsyncFn.ts
 function toAsyncFn(fn, defaultValue) {
   if (!fn) return () => Promise.resolve(defaultValue);
@@ -731,6 +841,11 @@ function uniq(array) {
   }
   return baseUniq(array);
 }
+
+// src/upperCase.ts
+function upperCase(value) {
+  return words(value).join(" ").toUpperCase();
+}
 export {
   addLeadingSlash,
   arrayToRecord,
@@ -745,6 +860,7 @@ export {
   flattenDeep,
   forEach,
   get,
+  groupBy,
   intersection,
   intersectionBy,
   isArray,
@@ -763,6 +879,7 @@ export {
   isUndefined,
   keys,
   map,
+  mapKeys,
   mapValues,
   mapValuesAsync,
   noop,
@@ -772,10 +889,15 @@ export {
   padEnd,
   parseBooleanString,
   pick,
+  pickBy,
   reduce,
   removeConsecutiveSlashesFromUrl,
   set,
+  startCase,
+  sum,
+  sumBy,
   toAsyncFn,
   toStringRecord,
-  uniq
+  uniq,
+  upperCase
 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@web-ts-toolkit/utils",
   "description": "Shared collection, object, async, and URL helpers used across workspace packages",
   "homepage": "https://web-ts-toolkit.pages.dev/docs/packages/utils",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "sideEffects": false,
   "keywords": [
     "utilities",