@web-ts-toolkit/utils 0.3.0 → 0.5.0

package/README.md

@@ -0,0 +1,49 @@
+# `@web-ts-toolkit/utils`
+
+Shared collection, object, async, and URL helpers used across the workspace.
+
+## Installation
+
+```sh
+pnpm add @web-ts-toolkit/utils
+```
+
+## Highlights
+
+- object-path helpers such as `get(...)` and `set(...)`
+- collection helpers such as `map(...)`, `filter(...)`, `uniq(...)`, and `orderBy(...)`
+- small type guards
+- URL helpers such as `normalizeUrlPath(...)`
+- async helpers such as `mapValuesAsync(...)`
+
+## Quick Start
+
+```ts
+import { get, set, normalizeUrlPath, parseBooleanString } from '@web-ts-toolkit/utils';
+
+const payload = {
+  user: {
+    profile: {
+      name: 'Ada',
+    },
+  },
+};
+
+get(payload, 'user.profile.name');
+set(payload, 'user.profile.role', 'admin');
+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`
+- guards: `isArray`, `isPlainObject`, `isString`, `isPromise`
+- URL helpers: `addLeadingSlash`, `removeConsecutiveSlashesFromUrl`, `normalizeUrlPath`
+
+## Documentation
+
+Full package documentation lives in `website/docs/packages/utils.md`.
+
+- live docs: https://web-ts-toolkit.pages.dev/docs/packages/utils

package/index.d.mts

@@ -71,6 +71,8 @@ declare function noop(): void;
 
 declare function omit<T extends object>(object: T, paths: PropertyPath | PropertyPath[]): Partial<T>;
 
+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[];
 
 declare function padEnd(value: unknown, length?: number, chars?: string): string;
@@ -92,4 +94,4 @@ declare function toStringRecord(value: unknown): Record<string, string> | undefi
 
 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, pick, reduce, removeConsecutiveSlashesFromUrl, set, toAsyncFn, toStringRecord, uniq };
+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 };

package/index.d.ts

@@ -71,6 +71,8 @@ declare function noop(): void;
 
 declare function omit<T extends object>(object: T, paths: PropertyPath | PropertyPath[]): Partial<T>;
 
+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[];
 
 declare function padEnd(value: unknown, length?: number, chars?: string): string;
@@ -92,4 +94,4 @@ declare function toStringRecord(value: unknown): Record<string, string> | undefi
 
 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, pick, reduce, removeConsecutiveSlashesFromUrl, set, toAsyncFn, toStringRecord, uniq };
+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 };

package/index.js

@@ -57,6 +57,7 @@ __export(index_exports, {
   omit: () => omit,
   orderBy: () => orderBy,
   padEnd: () => padEnd,
+  parseBooleanString: () => parseBooleanString,
   pick: () => pick,
   reduce: () => reduce,
   removeConsecutiveSlashesFromUrl: () => removeConsecutiveSlashesFromUrl,
@@ -679,6 +680,11 @@ function omit(object, paths) {
   return result;
 }
 
+// src/parseBooleanString.ts
+function parseBooleanString(str, defaultValue) {
+  return str ? str === "true" : defaultValue;
+}
+
 // src/orderBy.ts
 function orderBy(collection, iteratees = [], orders = []) {
   if (!Array.isArray(collection)) {
@@ -835,6 +841,7 @@ function uniq(array) {
   omit,
   orderBy,
   padEnd,
+  parseBooleanString,
   pick,
   reduce,
   removeConsecutiveSlashesFromUrl,

package/index.mjs

@@ -610,6 +610,11 @@ function omit(object, paths) {
   return result;
 }
 
+// src/parseBooleanString.ts
+function parseBooleanString(str, defaultValue) {
+  return str ? str === "true" : defaultValue;
+}
+
 // src/orderBy.ts
 function orderBy(collection, iteratees = [], orders = []) {
   if (!Array.isArray(collection)) {
@@ -765,6 +770,7 @@ export {
   omit,
   orderBy,
   padEnd,
+  parseBooleanString,
   pick,
   reduce,
   removeConsecutiveSlashesFromUrl,

package/package.json

@@ -1,7 +1,16 @@
 {
   "name": "@web-ts-toolkit/utils",
-  "description": "Shared utility helpers used across workspace packages",
-  "version": "0.3.0",
+  "description": "Shared collection, object, async, and URL helpers used across workspace packages",
+  "homepage": "https://web-ts-toolkit.pages.dev/docs/packages/utils",
+  "version": "0.5.0",
+  "sideEffects": false,
+  "keywords": [
+    "utilities",
+    "collections",
+    "objects",
+    "url",
+    "typescript"
+  ],
   "main": "./index.js",
   "module": "./index.mjs",
   "types": "./index.d.ts",
@@ -13,13 +22,13 @@
       "default": "./index.js"
     }
   },
+  "engines": {
+    "node": ">=20"
+  },
   "author": "Junmin Ahn",
   "bugs": {
     "url": "https://github.com/egose/web-ts-toolkit/issues"
   },
-  "engines": {
-    "node": ">=20"
-  },
   "license": "Apache-2.0",
   "repository": {
     "type": "git",