@peter.naydenov/walk-async 3.0.4 → 3.0.6

package/Changelog.md

@@ -1,6 +1,17 @@
 # Release History
 
 
+
+### 3.0.6 (2026-07-07)
+- [x] Fix: Top-level property named 'root' was flattened into the result or dropped;
+
+
+
+### 3.0.5 (2026-05-05)
+- [x] Dependencies updates. Ask-for-promise to version 3.1.1;
+
+
+
 ### 3.0.4 (2025-10-28)
 - [x] Dependencies updates. Ask-for-promise to version 3.1.0;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.naydenov/walk-async",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "Deep copy with fine control during the process. Can be used also as a deep forEach function",
   "main": ".dist/walk-async.umd.js",
   "type": "module",
@@ -28,17 +28,21 @@
   "author": "Peter Naydenov",
   "license": "MIT",
   "dependencies": {
-    "ask-for-promise": "3.1.0"
+    "ask-for-promise": "^3.1.1"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.9",
+    "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "c8": "^10.1.3",
-    "chai": "^6.2.0",
-    "mocha": "^11.7.4",
-    "rollup": "^4.52.5",
-    "typescript": "^5.9.3"
+    "@rollup/plugin-terser": "^1.0.0",
+    "c8": "^11.0.0",
+    "chai": "^6.2.2",
+    "mocha": "^11.7.6",
+    "rollup": "^4.62.2",
+    "typescript": "^6.0.3"
+  },
+  "overrides": {
+    "diff": "^8.0.2",
+    "serialize-javascript": "^7.0.0"
   },
   "c8": {
     "include": [
@@ -54,5 +58,8 @@
       "text-summary"
     ]
   },
-  "browserslist": "> 2%, not dead"
+  "browserslist": "> 2%, not dead",
+  "allowScripts": {
+    "fsevents@2.3.3": true
+  }
 }

package/src/main.js

@@ -55,12 +55,12 @@ function walk ({
     switch ( type ) {
             case 'array'  :
                                 result = []
-                                copyObject ( {root:origin}, result, extend, cb, breadcrumbs, ...args )
+                                copyObject ( {root:origin}, result, extend, cb, breadcrumbs, true, ...args )
                                     .then ( () => goNext ( extend, result, end ))
                                 break
             case 'object' :
                                 result = {}
-                                copyObject ( {root:origin}, result, extend, cb, breadcrumbs, ...args )
+                                copyObject ( {root:origin}, result, extend, cb, breadcrumbs, true, ...args )
                                     .then ( () => {
                                             goNext ( extend, result, end )
                                         })
@@ -93,7 +93,7 @@ function findType ( x ) {
 
 
 async function* generateList ( data, location, ex, cb, breadcrumbs, args ) {
-    yield await copyObject ( data , location, ex, cb, breadcrumbs, ...args )  
+    yield await copyObject ( data , location, ex, cb, breadcrumbs, false, ...args )
 } // generateList func.
 
 
@@ -107,7 +107,10 @@ function validateForInsertion ( k, result ) {
 
 
 
-function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
+// 'isWrapper' is true only for the call from 'walk' where 'origin' is the
+// synthetic {root:origin} wrapper. Detecting the wrapper by its position in the
+// call chain (instead of by key name) keeps data keys named 'root' safe.
+function copyObject ( origin, result, extend, cb, breadcrumbs, isWrapper, ...args ) {
     let 
           [ keyCallback, objectCallback ] = cb
         , keys = Object.keys ( origin )
@@ -126,7 +129,7 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
                         , resultIsArray = (findType (result) === 'array') 
                         , keyNumber = !isNaN ( k )
                         , IGNORE = Symbol ( 'ignore___' )
-                        , isRoot = (breadcrumbs === 'root' && k === 'root' )
+                        , isRoot = isWrapper   // The wrapper has exactly one key: 'root'
                         , br = isRoot ? 'root' : `${breadcrumbs}/${k}`
                         ;
 

package/tsconfig.json

@@ -4,6 +4,7 @@
       "allowJs": true,
       "declaration": true,
       "emitDeclarationOnly": true,
+      "rootDir": "./src",
       "outDir": "types",
       "declarationMap": true
     }

package/types/main.d.ts

@@ -3,7 +3,7 @@ export type Options = {
     /**
      * - The data structure to be copied.
      */
-    data: any;
+    data: Object;
     /**
      * - A function called for every object in the data structure.
      */

package/types/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.js"],"names":[],"mappings":";;;;;;;;;oBAqBc,WAAS,IAAI;;;;iBACb,WAAS,IAAI;;AAJ3B;;;;;GAKG;AAKH;;;;;;;;;;;GAWG;AACH,qEARW,OAAO,WAIJ,GAAG,EAAA,gBAmChB"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.js"],"names":[],"mappings":";;;;;UAoBc,MAAM;;;;oBACN,WAAS,IAAI;;;;iBACb,WAAS,IAAI;;AAJ3B;;;;;GAKG;AAKH;;;;;;;;;;;GAWG;AACH,qEARW,OAAO,WAIJ,GAAG,EAAA,gBAmChB"}

package/types/src/main.d.ts

@@ -0,0 +1,35 @@
+export default walk;
+export type Options = {
+    /**
+     * - The data structure to be copied.
+     */
+    data: Object;
+    /**
+     * - A function called for every object in the data structure.
+     */
+    objectCallback: Function | null;
+    /**
+     * - A function called for every property in the data structure.
+     */
+    keyCallback: Function | null;
+};
+/**
+ * @typedef {Object} Options
+ * @property {Object} data - The data structure to be copied.
+ * @property {Function|null} objectCallback - A function called for every object in the data structure.
+ * @property {Function|null} keyCallback - A function called for every property in the data structure.
+ */
+/**
+ * Walk-async is a deep copy function that executes callback functions on every object and property.
+ * Callbacks are async functions.
+ *
+ * @param {Options} options - Object with following properties:
+ *                          - data - The data structure to be copied.
+ *                          - objectCallback - A function that will be called for every object in the data structure.
+ *                          - keyCallback - A function that will be called for every property in the data structure.
+ * @param {...any} args - Any additional arguments will be passed to the callback functions.
+ *
+ * @returns {Promise} - A promise that resolves to the immutable copy of the data structure.
+ */
+declare function walk({ data: origin, objectCallback, keyCallback }: Options, ...args: any[]): Promise<any>;
+//# sourceMappingURL=main.d.ts.map

package/types/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.js"],"names":[],"mappings":";;;;;UAoBc,MAAM;;;;oBACN,WAAS,IAAI;;;;iBACb,WAAS,IAAI;;AAJ3B;;;;;GAKG;AAKH;;;;;;;;;;;GAWG;AACH,qEARW,OAAO,WAIJ,GAAG,EAAA,gBAmChB"}