@web-ts-toolkit/utils 0.29.0 → 0.31.0

package/README.md

@@ -10,8 +10,8 @@ pnpm add @web-ts-toolkit/utils
 
 ## Highlights
 
-- object-path helpers such as `get(...)` and `set(...)`
-- collection helpers such as `map(...)`, `filter(...)`, `uniq(...)`, and `orderBy(...)`
+- object-path helpers such as `get(...)`, `set(...)`, and `hasOwn(...)`
+- collection helpers such as `map(...)`, `filter(...)`, `eachRight(...)`, `join(...)`, `uniq(...)`, `uniqBy(...)`, and `orderBy(...)`
 - small type guards
 - URL helpers such as `normalizeUrlPath(...)`
 - async helpers such as `mapValuesAsync(...)`
@@ -19,7 +19,16 @@ pnpm add @web-ts-toolkit/utils
 ## Quick Start
 
 ```ts
-import { get, groupBy, normalizeUrlPath, parseBooleanString, startCase, sumBy } from '@web-ts-toolkit/utils';
+import {
+  get,
+  groupBy,
+  hasOwn,
+  normalizeUrlPath,
+  parseBooleanString,
+  startCase,
+  sumBy,
+  uniqBy,
+} from '@web-ts-toolkit/utils';
 
 const payload = {
   user: {
@@ -30,6 +39,7 @@ const payload = {
 };
 
 get(payload, 'user.profile.name');
+hasOwn(payload.user.profile, 'name');
 groupBy(
   [
     { type: 'fruit', name: 'apple' },
@@ -38,6 +48,14 @@ groupBy(
   ],
   'type',
 );
+uniqBy(
+  [
+    { id: 'a', name: 'Ada' },
+    { id: 'a', name: 'Ada Lovelace' },
+    { id: 'b', name: 'Grace' },
+  ],
+  'id',
+);
 startCase('api_response_time');
 sumBy([{ hours: 2 }, { hours: 3 }], 'hours');
 normalizeUrlPath('api//users');
@@ -46,8 +64,8 @@ parseBooleanString('true', false);
 
 ## Main Exports
 
-- object helpers: `get`, `set`, `pick`, `pickBy`, `omit`, `assign`, `cloneDeep`, `mapKeys`
-- collection helpers: `map`, `filter`, `reduce`, `find`, `flatten`, `uniq`, `orderBy`, `groupBy`, `sum`, `sumBy`
+- object helpers: `get`, `set`, `hasOwn`, `pick`, `pickBy`, `omit`, `omitBy`, `assign`, `cloneDeep`, `mapKeys`
+- collection helpers: `map`, `filter`, `eachRight`, `join`, `reduce`, `find`, `flatten`, `uniq`, `uniqBy`, `orderBy`, `groupBy`, `sum`, `sumBy`
 - string helpers: `startCase`, `upperCase`
 - guards: `isArray`, `isPlainObject`, `isString`, `isPromise`
 - URL helpers: `addLeadingSlash`, `removeConsecutiveSlashesFromUrl`, `normalizeUrlPath`

package/index.d.mts

@@ -12,6 +12,9 @@ declare function compact<T>(array: T[] | null | undefined): T[];
 
 declare function difference<T>(array: T[] | null | undefined, ...values: Array<T[] | null | undefined>): T[];
 
+declare function eachRight<T>(collection: T[] | null | undefined, iteratee: (value: T, key: number, collection: T[]) => unknown): T[] | null | undefined;
+declare function eachRight<T extends object>(collection: T | null | undefined, iteratee: (value: T[keyof T], key: string, collection: T) => unknown): T | null | undefined;
+
 declare function filter<T>(collection: T[] | Record<string, T> | null | undefined, predicate: (value: T, key: number | string) => boolean): T[];
 
 declare function find<T>(collection: T[] | Record<string, T> | null | undefined, predicate: (value: T, key: number | string) => boolean): T | undefined;
@@ -29,6 +32,8 @@ declare function get<T = unknown>(object: unknown, path: PropertyPath, defaultVa
 
 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 hasOwn<TKey extends PropertyKey>(value: unknown, key: TKey): value is Record<TKey, unknown>;
+
 declare function intersection<T>(...arrays: Array<T[] | null | undefined>): T[];
 
 declare function intersectionBy<T>(...args: unknown[]): T[];
@@ -61,6 +66,8 @@ declare function isString(value: unknown): value is string;
 
 declare function isUndefined(value: unknown): value is undefined;
 
+declare function join(array: unknown[] | null | undefined, separator?: string): string;
+
 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[];
@@ -75,6 +82,8 @@ declare function noop(): void;
 
 declare function omit<T extends object>(object: T, paths: PropertyPath | PropertyPath[]): Partial<T>;
 
+declare function omitBy<TValue>(object: Record<string, TValue> | null | undefined, predicate: (value: TValue, key: string, object: Record<string, TValue>) => boolean): Record<string, TValue>;
+
 declare function parseBooleanString(str: string | undefined, defaultValue?: boolean): boolean | undefined;
 
 declare function orderBy<T>(collection: T[] | null | undefined, iteratees?: Array<string | number | ((value: T) => unknown)>, orders?: string[]): T[];
@@ -106,6 +115,8 @@ declare function toStringRecord(value: unknown): Record<string, string> | undefi
 
 declare function uniq<T>(array: T[] | null | undefined): T[];
 
+declare function uniqBy<T>(array: T[] | null | undefined, iteratee?: string | number | ((value: T, key: number, collection: T[]) => unknown)): T[];
+
 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 };
+export { addLeadingSlash, arrayToRecord, assign, castArray, cloneDeep, compact, difference, eachRight, filter, find, flatten, flattenDeep, forEach, get, groupBy, hasOwn, intersection, intersectionBy, isArray, isBoolean, isEmpty, isEqual, isFunction, isMatch, isNaNValue as isNaN, isNil, isNumber, isObject, isPlainObject, isPromise, isString, isUndefined, join, keys, map, mapKeys, mapValues, mapValuesAsync, noop, normalizeUrlPath, omit, omitBy, orderBy, padEnd, parseBooleanString, pick, pickBy, reduce, removeConsecutiveSlashesFromUrl, set, startCase, sum, sumBy, toAsyncFn, toStringRecord, uniq, uniqBy, upperCase };

package/index.d.ts

@@ -12,6 +12,9 @@ declare function compact<T>(array: T[] | null | undefined): T[];
 
 declare function difference<T>(array: T[] | null | undefined, ...values: Array<T[] | null | undefined>): T[];
 
+declare function eachRight<T>(collection: T[] | null | undefined, iteratee: (value: T, key: number, collection: T[]) => unknown): T[] | null | undefined;
+declare function eachRight<T extends object>(collection: T | null | undefined, iteratee: (value: T[keyof T], key: string, collection: T) => unknown): T | null | undefined;
+
 declare function filter<T>(collection: T[] | Record<string, T> | null | undefined, predicate: (value: T, key: number | string) => boolean): T[];
 
 declare function find<T>(collection: T[] | Record<string, T> | null | undefined, predicate: (value: T, key: number | string) => boolean): T | undefined;
@@ -29,6 +32,8 @@ declare function get<T = unknown>(object: unknown, path: PropertyPath, defaultVa
 
 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 hasOwn<TKey extends PropertyKey>(value: unknown, key: TKey): value is Record<TKey, unknown>;
+
 declare function intersection<T>(...arrays: Array<T[] | null | undefined>): T[];
 
 declare function intersectionBy<T>(...args: unknown[]): T[];
@@ -61,6 +66,8 @@ declare function isString(value: unknown): value is string;
 
 declare function isUndefined(value: unknown): value is undefined;
 
+declare function join(array: unknown[] | null | undefined, separator?: string): string;
+
 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[];
@@ -75,6 +82,8 @@ declare function noop(): void;
 
 declare function omit<T extends object>(object: T, paths: PropertyPath | PropertyPath[]): Partial<T>;
 
+declare function omitBy<TValue>(object: Record<string, TValue> | null | undefined, predicate: (value: TValue, key: string, object: Record<string, TValue>) => boolean): Record<string, TValue>;
+
 declare function parseBooleanString(str: string | undefined, defaultValue?: boolean): boolean | undefined;
 
 declare function orderBy<T>(collection: T[] | null | undefined, iteratees?: Array<string | number | ((value: T) => unknown)>, orders?: string[]): T[];
@@ -106,6 +115,8 @@ declare function toStringRecord(value: unknown): Record<string, string> | undefi
 
 declare function uniq<T>(array: T[] | null | undefined): T[];
 
+declare function uniqBy<T>(array: T[] | null | undefined, iteratee?: string | number | ((value: T, key: number, collection: T[]) => unknown)): T[];
+
 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 };
+export { addLeadingSlash, arrayToRecord, assign, castArray, cloneDeep, compact, difference, eachRight, filter, find, flatten, flattenDeep, forEach, get, groupBy, hasOwn, intersection, intersectionBy, isArray, isBoolean, isEmpty, isEqual, isFunction, isMatch, isNaNValue as isNaN, isNil, isNumber, isObject, isPlainObject, isPromise, isString, isUndefined, join, keys, map, mapKeys, mapValues, mapValuesAsync, noop, normalizeUrlPath, omit, omitBy, orderBy, padEnd, parseBooleanString, pick, pickBy, reduce, removeConsecutiveSlashesFromUrl, set, startCase, sum, sumBy, toAsyncFn, toStringRecord, uniq, uniqBy, upperCase };

package/index.js

@@ -26,6 +26,7 @@ __export(index_exports, {
   cloneDeep: () => cloneDeep,
   compact: () => compact,
   difference: () => difference,
+  eachRight: () => eachRight,
   filter: () => filter,
   find: () => find,
   flatten: () => flatten,
@@ -33,6 +34,7 @@ __export(index_exports, {
   forEach: () => forEach,
   get: () => get,
   groupBy: () => groupBy,
+  hasOwn: () => hasOwn,
   intersection: () => intersection,
   intersectionBy: () => intersectionBy,
   isArray: () => isArray,
@@ -49,6 +51,7 @@ __export(index_exports, {
   isPromise: () => isPromise,
   isString: () => isString,
   isUndefined: () => isUndefined,
+  join: () => join,
   keys: () => keys,
   map: () => map,
   mapKeys: () => mapKeys,
@@ -57,6 +60,7 @@ __export(index_exports, {
   noop: () => noop,
   normalizeUrlPath: () => normalizeUrlPath,
   omit: () => omit,
+  omitBy: () => omitBy,
   orderBy: () => orderBy,
   padEnd: () => padEnd,
   parseBooleanString: () => parseBooleanString,
@@ -71,6 +75,7 @@ __export(index_exports, {
   toAsyncFn: () => toAsyncFn,
   toStringRecord: () => toStringRecord,
   uniq: () => uniq,
+  uniqBy: () => uniqBy,
   upperCase: () => upperCase
 });
 module.exports = __toCommonJS(index_exports);
@@ -398,6 +403,30 @@ function difference(array, ...values) {
   return array.filter((item) => !arrayIncludes(excluded, item));
 }
 
+// src/eachRight.ts
+function eachRight(collection, iteratee) {
+  if (!collection) {
+    return collection;
+  }
+  const callback = iteratee;
+  if (Array.isArray(collection)) {
+    for (let index = collection.length - 1; index >= 0; index--) {
+      if (callback(collection[index], index, collection) === false) {
+        break;
+      }
+    }
+    return collection;
+  }
+  const keys2 = Object.keys(collection);
+  for (let index = keys2.length - 1; index >= 0; index--) {
+    const key = keys2[index];
+    if (callback(collection[key], key, collection) === false) {
+      break;
+    }
+  }
+  return collection;
+}
+
 // src/filter.ts
 function filter(collection, predicate) {
   if (!collection) {
@@ -537,6 +566,14 @@ function groupBy(collection, iteratee) {
   return result;
 }
 
+// src/hasOwn.ts
+function hasOwn(value, key) {
+  if (value === null || value === void 0) {
+    return false;
+  }
+  return Object.hasOwn(Object(value), key);
+}
+
 // src/intersection.ts
 function intersection(...arrays) {
   const [first = [], ...rest] = arrays;
@@ -661,6 +698,14 @@ function isUndefined(value) {
   return value === void 0;
 }
 
+// src/join.ts
+function join(array, separator) {
+  if (!Array.isArray(array)) {
+    return "";
+  }
+  return array.join(separator);
+}
+
 // src/keys.ts
 function keys(value) {
   if (value == null) {
@@ -744,6 +789,23 @@ function omit(object, paths) {
   return result;
 }
 
+// src/omitBy.ts
+function omitBy(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/parseBooleanString.ts
 function parseBooleanString(str, defaultValue) {
   return str ? str === "true" : defaultValue;
@@ -919,6 +981,26 @@ function uniq(array) {
   return baseUniq(array);
 }
 
+// src/uniqBy.ts
+function uniqBy(array, iteratee) {
+  if (!Array.isArray(array)) {
+    return [];
+  }
+  const callback = getIteratee(iteratee);
+  const result = [];
+  const seen = [];
+  for (let index = 0; index < array.length; index++) {
+    const value = array[index];
+    const computed = callback(value, index, array);
+    if (seen.some((entry) => sameValueZero(entry, computed))) {
+      continue;
+    }
+    seen.push(computed);
+    result.push(value);
+  }
+  return result;
+}
+
 // src/upperCase.ts
 function upperCase(value) {
   return words(value).join(" ").toUpperCase();
@@ -932,6 +1014,7 @@ function upperCase(value) {
   cloneDeep,
   compact,
   difference,
+  eachRight,
   filter,
   find,
   flatten,
@@ -939,6 +1022,7 @@ function upperCase(value) {
   forEach,
   get,
   groupBy,
+  hasOwn,
   intersection,
   intersectionBy,
   isArray,
@@ -955,6 +1039,7 @@ function upperCase(value) {
   isPromise,
   isString,
   isUndefined,
+  join,
   keys,
   map,
   mapKeys,
@@ -963,6 +1048,7 @@ function upperCase(value) {
   noop,
   normalizeUrlPath,
   omit,
+  omitBy,
   orderBy,
   padEnd,
   parseBooleanString,
@@ -977,5 +1063,6 @@ function upperCase(value) {
   toAsyncFn,
   toStringRecord,
   uniq,
+  uniqBy,
   upperCase
 });

package/index.mjs

@@ -321,6 +321,30 @@ function difference(array, ...values) {
   return array.filter((item) => !arrayIncludes(excluded, item));
 }
 
+// src/eachRight.ts
+function eachRight(collection, iteratee) {
+  if (!collection) {
+    return collection;
+  }
+  const callback = iteratee;
+  if (Array.isArray(collection)) {
+    for (let index = collection.length - 1; index >= 0; index--) {
+      if (callback(collection[index], index, collection) === false) {
+        break;
+      }
+    }
+    return collection;
+  }
+  const keys2 = Object.keys(collection);
+  for (let index = keys2.length - 1; index >= 0; index--) {
+    const key = keys2[index];
+    if (callback(collection[key], key, collection) === false) {
+      break;
+    }
+  }
+  return collection;
+}
+
 // src/filter.ts
 function filter(collection, predicate) {
   if (!collection) {
@@ -460,6 +484,14 @@ function groupBy(collection, iteratee) {
   return result;
 }
 
+// src/hasOwn.ts
+function hasOwn(value, key) {
+  if (value === null || value === void 0) {
+    return false;
+  }
+  return Object.hasOwn(Object(value), key);
+}
+
 // src/intersection.ts
 function intersection(...arrays) {
   const [first = [], ...rest] = arrays;
@@ -584,6 +616,14 @@ function isUndefined(value) {
   return value === void 0;
 }
 
+// src/join.ts
+function join(array, separator) {
+  if (!Array.isArray(array)) {
+    return "";
+  }
+  return array.join(separator);
+}
+
 // src/keys.ts
 function keys(value) {
   if (value == null) {
@@ -667,6 +707,23 @@ function omit(object, paths) {
   return result;
 }
 
+// src/omitBy.ts
+function omitBy(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/parseBooleanString.ts
 function parseBooleanString(str, defaultValue) {
   return str ? str === "true" : defaultValue;
@@ -842,6 +899,26 @@ function uniq(array) {
   return baseUniq(array);
 }
 
+// src/uniqBy.ts
+function uniqBy(array, iteratee) {
+  if (!Array.isArray(array)) {
+    return [];
+  }
+  const callback = getIteratee(iteratee);
+  const result = [];
+  const seen = [];
+  for (let index = 0; index < array.length; index++) {
+    const value = array[index];
+    const computed = callback(value, index, array);
+    if (seen.some((entry) => sameValueZero(entry, computed))) {
+      continue;
+    }
+    seen.push(computed);
+    result.push(value);
+  }
+  return result;
+}
+
 // src/upperCase.ts
 function upperCase(value) {
   return words(value).join(" ").toUpperCase();
@@ -854,6 +931,7 @@ export {
   cloneDeep,
   compact,
   difference,
+  eachRight,
   filter,
   find,
   flatten,
@@ -861,6 +939,7 @@ export {
   forEach,
   get,
   groupBy,
+  hasOwn,
   intersection,
   intersectionBy,
   isArray,
@@ -877,6 +956,7 @@ export {
   isPromise,
   isString,
   isUndefined,
+  join,
   keys,
   map,
   mapKeys,
@@ -885,6 +965,7 @@ export {
   noop,
   normalizeUrlPath,
   omit,
+  omitBy,
   orderBy,
   padEnd,
   parseBooleanString,
@@ -899,5 +980,6 @@ export {
   toAsyncFn,
   toStringRecord,
   uniq,
+  uniqBy,
   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.29.0",
+  "version": "0.31.0",
   "sideEffects": false,
   "keywords": [
     "utilities",