objwalk 1.0.1 → 1.2.0

package/README.md

@@ -13,7 +13,7 @@ npm install objwalk
 ## Usage
 
 ```ts
-import { each, extract, map, merge, pick, set } from 'objwalk'
+import { each, equally, extract, map, merge, pick, set } from 'objwalk'
 ```
 
 ## pick
@@ -59,6 +59,19 @@ pick(data, 'items[1].title')
 
 If the path cannot be resolved, `pick` returns `undefined`.
 
+By default, `pick` keeps its permissive property lookup behavior. Pass options to restrict
+lookups to own properties or ignore specific keys.
+
+```ts
+pick(data, path, {
+  inherited: false,
+  ignore: ['__proto__', 'prototype', 'constructor'],
+})
+```
+
+The options apply to every path segment, array index, and selected key. With `{*}`, ignored
+keys are omitted from the returned list.
+
 ## set
 
 Set a value inside an object by path.
@@ -81,6 +94,21 @@ set(data, 'items[0].title', 'First')
 
 `set` mutates the object passed to it and returns the same object.
 
+## equally
+
+Deeply compare two values for structural equality.
+
+```ts
+equally({ a: { b: [1, 2] } }, { a: { b: [1, 2] } })
+// true
+
+equally({ a: 1 }, { a: 1, b: 2 })
+// false
+```
+
+`equally` treats `NaN` as equal to `NaN`, compares `Date` by timestamp and `RegExp` by
+source and flags, and follows circular references without looping.
+
 ## merge
 
 Deeply merge plain objects into a target object.
@@ -205,4 +233,5 @@ extract(data, mapping)
 each(data, callback)
 map(data, callback)
 merge(target, ...sources)
+equally(a, b)
 ```

package/dist/index.cjs

@@ -29,9 +29,17 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/helpers/getValueByKey.ts
+var getValueByKey = (object, key, { inherited = true, ignore = [] } = {}) => {
+  if (object === null || object === void 0 || ignore.includes(key) || !inherited && !Object.hasOwn(object, key)) {
+    return void 0;
+  }
+  return object[key];
+};
+
 // src/helpers/getValueByPath.ts
 var arraySegmentRegex = /^(\w+)\[(\d+)\]$/;
-var getValueByPath = (obj, path) => {
+var getValueByPath = (obj, path, options = {}) => {
   if (!path) return obj;
   return path.split(".").reduce((result, current) => {
     if (result === null || result === void 0) {
@@ -40,10 +48,10 @@ var getValueByPath = (obj, path) => {
     const match = current.match(arraySegmentRegex);
     if (match) {
       const [, key, index] = match;
-      const array = result[key];
-      return Array.isArray(array) ? array[parseInt(index, 10)] : void 0;
+      const array = getValueByKey(result, key, options);
+      return Array.isArray(array) ? getValueByKey(array, index, options) : void 0;
     }
-    return result[current];
+    return getValueByKey(result, current, options);
   }, obj);
 };
 
@@ -118,26 +126,26 @@ var each = (data, callback) => {
 };
 
 // src/pick.ts
-var pick = (data = {}, path = "") => {
+var pick = (data = {}, path = "", options = {}) => {
   const { cleanPath, keys } = parsePathSelection(path);
-  const value = getValueByPath(data, cleanPath);
+  const value = getValueByPath(data, cleanPath, options);
   if (keys.length === 0 && keys !== "all") {
     return value;
   }
   if (keys === "all") {
     if (value && typeof value === "object" && !Array.isArray(value)) {
-      return Object.keys(value);
+      return Object.keys(value).filter((key) => !options.ignore?.includes(key));
     }
     return [];
   }
   if (value && typeof value === "object") {
     if (keys.length === 1) {
-      return value[keys[0]];
+      return getValueByKey(value, keys[0], options);
     }
     return keys.reduce(
       (result, key) => ({
         ...result,
-        [key]: value[key]
+        [key]: getValueByKey(value, key, options)
       }),
       {}
     );

package/dist/index.d.cts

@@ -1,10 +1,14 @@
 type WalkKey = string | number;
+type PickOptions = {
+    inherited?: boolean;
+    ignore?: readonly string[];
+};
 
 type EachCallback = (key: WalkKey, value: any, path: string) => void;
 declare const each: (data: any, callback: EachCallback) => void;
 
 type ObjwalkObject$1 = Record<string, any>;
-declare const pick: (data?: ObjwalkObject$1, path?: string) => any;
+declare const pick: (data?: ObjwalkObject$1, path?: string, options?: PickOptions) => any;
 
 type ExtractMapping = Record<string, string | string[]>;
 declare const extract: (source: ObjwalkObject$1, mapping: ExtractMapping) => ObjwalkObject$1;
@@ -17,4 +21,4 @@ declare const merge: <T extends ObjwalkObject$1>(target: T, ...sources: unknown[
 type ObjwalkObject = Record<string, any>;
 declare const set: (data: ObjwalkObject | undefined, path: string, value: any) => ObjwalkObject;
 
-export { type EachCallback, type ExtractMapping, type MapCallback, type ObjwalkObject$1 as ObjwalkObject, type WalkKey, each, extract, map, merge, pick, set };
+export { type EachCallback, type ExtractMapping, type MapCallback, type ObjwalkObject$1 as ObjwalkObject, type PickOptions, type WalkKey, each, extract, map, merge, pick, set };

package/dist/index.d.ts

@@ -1,10 +1,14 @@
 type WalkKey = string | number;
+type PickOptions = {
+    inherited?: boolean;
+    ignore?: readonly string[];
+};
 
 type EachCallback = (key: WalkKey, value: any, path: string) => void;
 declare const each: (data: any, callback: EachCallback) => void;
 
 type ObjwalkObject$1 = Record<string, any>;
-declare const pick: (data?: ObjwalkObject$1, path?: string) => any;
+declare const pick: (data?: ObjwalkObject$1, path?: string, options?: PickOptions) => any;
 
 type ExtractMapping = Record<string, string | string[]>;
 declare const extract: (source: ObjwalkObject$1, mapping: ExtractMapping) => ObjwalkObject$1;
@@ -17,4 +21,4 @@ declare const merge: <T extends ObjwalkObject$1>(target: T, ...sources: unknown[
 type ObjwalkObject = Record<string, any>;
 declare const set: (data: ObjwalkObject | undefined, path: string, value: any) => ObjwalkObject;
 
-export { type EachCallback, type ExtractMapping, type MapCallback, type ObjwalkObject$1 as ObjwalkObject, type WalkKey, each, extract, map, merge, pick, set };
+export { type EachCallback, type ExtractMapping, type MapCallback, type ObjwalkObject$1 as ObjwalkObject, type PickOptions, type WalkKey, each, extract, map, merge, pick, set };

package/dist/index.js

@@ -1,6 +1,14 @@
+// src/helpers/getValueByKey.ts
+var getValueByKey = (object, key, { inherited = true, ignore = [] } = {}) => {
+  if (object === null || object === void 0 || ignore.includes(key) || !inherited && !Object.hasOwn(object, key)) {
+    return void 0;
+  }
+  return object[key];
+};
+
 // src/helpers/getValueByPath.ts
 var arraySegmentRegex = /^(\w+)\[(\d+)\]$/;
-var getValueByPath = (obj, path) => {
+var getValueByPath = (obj, path, options = {}) => {
   if (!path) return obj;
   return path.split(".").reduce((result, current) => {
     if (result === null || result === void 0) {
@@ -9,10 +17,10 @@ var getValueByPath = (obj, path) => {
     const match = current.match(arraySegmentRegex);
     if (match) {
       const [, key, index] = match;
-      const array = result[key];
-      return Array.isArray(array) ? array[parseInt(index, 10)] : void 0;
+      const array = getValueByKey(result, key, options);
+      return Array.isArray(array) ? getValueByKey(array, index, options) : void 0;
     }
-    return result[current];
+    return getValueByKey(result, current, options);
   }, obj);
 };
 
@@ -87,26 +95,26 @@ var each = (data, callback) => {
 };
 
 // src/pick.ts
-var pick = (data = {}, path = "") => {
+var pick = (data = {}, path = "", options = {}) => {
   const { cleanPath, keys } = parsePathSelection(path);
-  const value = getValueByPath(data, cleanPath);
+  const value = getValueByPath(data, cleanPath, options);
   if (keys.length === 0 && keys !== "all") {
     return value;
   }
   if (keys === "all") {
     if (value && typeof value === "object" && !Array.isArray(value)) {
-      return Object.keys(value);
+      return Object.keys(value).filter((key) => !options.ignore?.includes(key));
     }
     return [];
   }
   if (value && typeof value === "object") {
     if (keys.length === 1) {
-      return value[keys[0]];
+      return getValueByKey(value, keys[0], options);
     }
     return keys.reduce(
       (result, key) => ({
         ...result,
-        [key]: value[key]
+        [key]: getValueByKey(value, key, options)
       }),
       {}
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "objwalk",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Small utilities for reading, writing, walking, and reshaping nested JavaScript objects.",
   "keywords": [
     "object",