@peter.naydenov/walk-async 3.0.0 → 3.0.2

package/Changelog.md

@@ -2,6 +2,17 @@
 
 
 
+### 3.0.2 (2025-01-07)
+- [x] JSDoc was added to the project;
+- [x] Generatated typescript definitions;
+
+
+
+### 3.0.1 ( 2024-12-18)
+- [x] Dependencies updates. Ask-for-promise to version 3.0.1;
+
+
+
 ### 3.0.0 ( 2024-12-04)
 - [x] Object callback will be triggered on 'root' object as well;
 

package/dist/walk-async.cjs

@@ -1 +1 @@
-"use strict";var e=require("ask-for-promise");async function n(e,n,o){for await(const n of e)await n.next();o.done(n)}function o(e){return null==e||e.nodeType?"simple":e instanceof Array?"array":"object"==typeof e?"object":"simple"}async function*r(e,n,o,r,a,s){yield await t(e,n,o,r,a,...s)}function t(n,t,a,s,c,...l){let[i,d]=s,u=Object.keys(n),p=e(u),$=e();return u.forEach(((u,$)=>{let f=o(n[u]),y=n[u],b="simple"!==f&&null!=d,m=e(),k=e(),h=e(),j="array"===o(t),v=!isNaN(u),C=Symbol("ignore___");b?d({resolve:m.done,reject:()=>m.done(C),value:y,key:u,breadcrumbs:`${c}/${u}`},...l):m.done("$$cancel"),m.onComplete((e=>{if("$$cancel"===e&&n.hasOwnProperty(y))k.done("$$noUpdates");else if("$$cancel"!==e&&(y=e,f=o(y)),y!=C)if("simple"===f){if(!i)return void k.done("$$noUpdates");i({resolve:k.done,reject:()=>k.done(C),value:y,key:u,breadcrumbs:`${c}/${u}`},...l)}else k.done("$$cancel");else p[$].done("ignore object")})),k.onComplete((e=>{if(e!=C)if("$$cancel"!==e){if("$$noUpdates"!==e&&(y=e,f=o(y)),"simple"===f){const e=function(e,n){return n instanceof Array&&!isNaN(e)}(u,t);return e?t.push(y):t[u]=y,void p[$].done("key")}h.done()}else h.done();else p[$].done("ignore key")})),h.onComplete((()=>{if("object"===f){const e={};j&&v?t.push(e):t[u]=e,a.push(r(y,e,a,s,`${c}/${u}`,l)),p[$].done("object")}if("array"===f){const e=[];j&&v?t.push(e):t[u]=e,a.push(r(y,e,a,s,`${c}/${u}`,l)),p[$].done("array")}}))})),p.onComplete((e=>$.done())),$.promise}module.exports=function({data:r,objectCallback:a=null,keyCallback:s=null},...c){let l,i=o(r),d=[],u="root",p=[s,a],$=e();switch(i){case"array":l=[],t(r,l,d,p,u,...c).then((()=>n(d,l,$)));break;case"object":l={},t(r,l,d,p,u,...c).then((()=>{n(d,l,$)}));break;case"simple":$.done(r)}return $.promise};
+"use strict";var e=require("ask-for-promise");async function o(e,o,n){for await(const o of e)await o.next();n.done(o)}function n(e){return null==e||e.nodeType?"simple":e instanceof Array?"array":"object"==typeof e?"object":"simple"}async function*r(e,o,n,r,s,a){yield await t(e,o,n,r,s,...a)}function t(o,t,s,a,i,...c){let[l,d]=a,p=Object.keys(o),u=e(p),f=e();return p.forEach(((p,f)=>{let m=n(o[p]),y=o[p],$="simple"!==m&&null!=d,b=e(),k=e(),h=e(),j="array"===n(t),v=!isNaN(p),C=Symbol("ignore___"),w="root"===i&&"root"===p,N=w?"root":`${i}/${p}`;$?d({resolve:b.done,reject:()=>b.done(C),value:y,key:p,breadcrumbs:N},...c):b.done("$$cancel"),b.onComplete((e=>{if("$$cancel"!==e||l)if("$$cancel"!==e&&(y=e,m=n(y)),y!=C)if("simple"===m){if(!l)return void k.done("$$noUpdates");l({resolve:k.done,reject:()=>k.done(C),value:y,key:p,breadcrumbs:N},...c)}else k.done("$$cancel");else u.promises[f].done("ignore object");else k.done("$$noUpdates")})),k.onComplete((e=>{if(w)return s.push(r(y,t,s,a,"root",c)),void u.promises[f].done("root");if(e!=C)if("$$cancel"!==e){if("$$noUpdates"!==e&&(y=e,m=n(y)),"simple"===m){const e=function(e,o){return o instanceof Array&&!isNaN(e)}(p,t);return e?t.push(y):t[p]=y,void u.promises[f].done("key")}h.done()}else h.done();else u.promises[f].done("ignore key")})),h.onComplete((()=>{if("object"===m){const e={};j&&v?t.push(e):t[p]=e,s.push(r(y,e,s,a,N,c)),u.promises[f].done("object")}if("array"===m){const e=[];j&&v?t.push(e):t[p]=e,s.push(r(y,e,s,a,N,c)),u.promises[f].done("array")}}))})),u.onComplete((e=>f.done())),f.promise}module.exports=function({data:r,objectCallback:s=null,keyCallback:a=null},...i){let c,l=n(r),d=[],p="root",u=[a,s],f=e();switch(l){case"array":c=[],t({root:r},c,d,u,p,...i).then((()=>o(d,c,f)));break;case"object":c={},t({root:r},c,d,u,p,...i).then((()=>{o(d,c,f)}));break;case"simple":f.done(r)}return f.promise};

package/dist/walk-async.esm.mjs

@@ -1 +1 @@
-import e from"ask-for-promise";function o({data:o,objectCallback:t=null,keyCallback:s=null},...c){let l,i=a(o),d=[],p="root",u=[s,t],f=e();switch(i){case"array":l=[],r(o,l,d,u,p,...c).then((()=>n(d,l,f)));break;case"object":l={},r(o,l,d,u,p,...c).then((()=>{n(d,l,f)}));break;case"simple":f.done(o)}return f.promise}async function n(e,o,n){for await(const o of e)await o.next();n.done(o)}function a(e){return null==e||e.nodeType?"simple":e instanceof Array?"array":"object"==typeof e?"object":"simple"}async function*t(e,o,n,a,t,s){yield await r(e,o,n,a,t,...s)}function r(o,n,r,s,c,...l){let[i,d]=s,p=Object.keys(o),u=e(p),f=e();return p.forEach(((p,f)=>{let $=a(o[p]),y=o[p],m="simple"!==$&&null!=d,b=e(),k=e(),h=e(),j="array"===a(n),v=!isNaN(p),C=Symbol("ignore___");m?d({resolve:b.done,reject:()=>b.done(C),value:y,key:p,breadcrumbs:`${c}/${p}`},...l):b.done("$$cancel"),b.onComplete((e=>{if("$$cancel"===e&&o.hasOwnProperty(y))k.done("$$noUpdates");else if("$$cancel"!==e&&(y=e,$=a(y)),y!=C)if("simple"===$){if(!i)return void k.done("$$noUpdates");i({resolve:k.done,reject:()=>k.done(C),value:y,key:p,breadcrumbs:`${c}/${p}`},...l)}else k.done("$$cancel");else u[f].done("ignore object")})),k.onComplete((e=>{if(e!=C)if("$$cancel"!==e){if("$$noUpdates"!==e&&(y=e,$=a(y)),"simple"===$){const e=function(e,o){return o instanceof Array&&!isNaN(e)}(p,n);return e?n.push(y):n[p]=y,void u[f].done("key")}h.done()}else h.done();else u[f].done("ignore key")})),h.onComplete((()=>{if("object"===$){const e={};j&&v?n.push(e):n[p]=e,r.push(t(y,e,r,s,`${c}/${p}`,l)),u[f].done("object")}if("array"===$){const e=[];j&&v?n.push(e):n[p]=e,r.push(t(y,e,r,s,`${c}/${p}`,l)),u[f].done("array")}}))})),u.onComplete((e=>f.done())),f.promise}export{o as default};
+import e from"ask-for-promise";function o({data:o,objectCallback:t=null,keyCallback:a=null},...i){let c,l=r(o),p=[],d="root",u=[a,t],f=e();switch(l){case"array":c=[],s({root:o},c,p,u,d,...i).then((()=>n(p,c,f)));break;case"object":c={},s({root:o},c,p,u,d,...i).then((()=>{n(p,c,f)}));break;case"simple":f.done(o)}return f.promise}async function n(e,o,n){for await(const o of e)await o.next();n.done(o)}function r(e){return null==e||e.nodeType?"simple":e instanceof Array?"array":"object"==typeof e?"object":"simple"}async function*t(e,o,n,r,t,a){yield await s(e,o,n,r,t,...a)}function s(o,n,s,a,i,...c){let[l,p]=a,d=Object.keys(o),u=e(d),f=e();return d.forEach(((d,f)=>{let m=r(o[d]),y=o[d],$="simple"!==m&&null!=p,b=e(),k=e(),h=e(),j="array"===r(n),v=!isNaN(d),C=Symbol("ignore___"),w="root"===i&&"root"===d,N=w?"root":`${i}/${d}`;$?p({resolve:b.done,reject:()=>b.done(C),value:y,key:d,breadcrumbs:N},...c):b.done("$$cancel"),b.onComplete((e=>{if("$$cancel"!==e||l)if("$$cancel"!==e&&(y=e,m=r(y)),y!=C)if("simple"===m){if(!l)return void k.done("$$noUpdates");l({resolve:k.done,reject:()=>k.done(C),value:y,key:d,breadcrumbs:N},...c)}else k.done("$$cancel");else u.promises[f].done("ignore object");else k.done("$$noUpdates")})),k.onComplete((e=>{if(w)return s.push(t(y,n,s,a,"root",c)),void u.promises[f].done("root");if(e!=C)if("$$cancel"!==e){if("$$noUpdates"!==e&&(y=e,m=r(y)),"simple"===m){const e=function(e,o){return o instanceof Array&&!isNaN(e)}(d,n);return e?n.push(y):n[d]=y,void u.promises[f].done("key")}h.done()}else h.done();else u.promises[f].done("ignore key")})),h.onComplete((()=>{if("object"===m){const e={};j&&v?n.push(e):n[d]=e,s.push(t(y,e,s,a,N,c)),u.promises[f].done("object")}if("array"===m){const e=[];j&&v?n.push(e):n[d]=e,s.push(t(y,e,s,a,N,c)),u.promises[f].done("array")}}))})),u.onComplete((e=>f.done())),f.promise}export{o as default};

package/dist/walk-async.umd.js

@@ -1 +1 @@
-!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?module.exports=o(require("ask-for-promise")):"function"==typeof define&&define.amd?define(["ask-for-promise"],o):(e="undefined"!=typeof globalThis?globalThis:e||self).walkAsync=o(e.askForPromise)}(this,(function(e){"use strict";async function o(e,o,n){for await(const o of e)await o.next();n.done(o)}function n(e){return null==e||e.nodeType?"simple":e instanceof Array?"array":"object"==typeof e?"object":"simple"}async function*t(e,o,n,t,a,s){yield await r(e,o,n,t,a,...s)}function r(o,r,a,s,i,...c){let[l,d]=s,f=Object.keys(o),u=e(f),p=e();return f.forEach(((f,p)=>{let y=n(o[f]),$=o[f],m="simple"!==y&&null!=d,b=e(),k=e(),h=e(),j="array"===n(r),v=!isNaN(f),w=Symbol("ignore___");m?d({resolve:b.done,reject:()=>b.done(w),value:$,key:f,breadcrumbs:`${i}/${f}`},...c):b.done("$$cancel"),b.onComplete((e=>{if("$$cancel"===e&&o.hasOwnProperty($))k.done("$$noUpdates");else if("$$cancel"!==e&&($=e,y=n($)),$!=w)if("simple"===y){if(!l)return void k.done("$$noUpdates");l({resolve:k.done,reject:()=>k.done(w),value:$,key:f,breadcrumbs:`${i}/${f}`},...c)}else k.done("$$cancel");else u[p].done("ignore object")})),k.onComplete((e=>{if(e!=w)if("$$cancel"!==e){if("$$noUpdates"!==e&&($=e,y=n($)),"simple"===y){const e=function(e,o){return o instanceof Array&&!isNaN(e)}(f,r);return e?r.push($):r[f]=$,void u[p].done("key")}h.done()}else h.done();else u[p].done("ignore key")})),h.onComplete((()=>{if("object"===y){const e={};j&&v?r.push(e):r[f]=e,a.push(t($,e,a,s,`${i}/${f}`,c)),u[p].done("object")}if("array"===y){const e=[];j&&v?r.push(e):r[f]=e,a.push(t($,e,a,s,`${i}/${f}`,c)),u[p].done("array")}}))})),u.onComplete((e=>p.done())),p.promise}return function({data:t,objectCallback:a=null,keyCallback:s=null},...i){let c,l=n(t),d=[],f="root",u=[s,a],p=e();switch(l){case"array":c=[],r(t,c,d,u,f,...i).then((()=>o(d,c,p)));break;case"object":c={},r(t,c,d,u,f,...i).then((()=>{o(d,c,p)}));break;case"simple":p.done(t)}return p.promise}}));
+!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?module.exports=o(require("ask-for-promise")):"function"==typeof define&&define.amd?define(["ask-for-promise"],o):(e="undefined"!=typeof globalThis?globalThis:e||self).walkAsync=o(e.askForPromise)}(this,(function(e){"use strict";async function o(e,o,n){for await(const o of e)await o.next();n.done(o)}function n(e){return null==e||e.nodeType?"simple":e instanceof Array?"array":"object"==typeof e?"object":"simple"}async function*r(e,o,n,r,s,i){yield await t(e,o,n,r,s,...i)}function t(o,t,s,i,a,...c){let[l,d]=i,f=Object.keys(o),p=e(f),u=e();return f.forEach(((f,u)=>{let m=n(o[f]),y=o[f],b="simple"!==m&&null!=d,$=e(),k=e(),h=e(),j="array"===n(t),v=!isNaN(f),C=Symbol("ignore___"),g="root"===a&&"root"===f,w=g?"root":`${a}/${f}`;b?d({resolve:$.done,reject:()=>$.done(C),value:y,key:f,breadcrumbs:w},...c):$.done("$$cancel"),$.onComplete((e=>{if("$$cancel"!==e||l)if("$$cancel"!==e&&(y=e,m=n(y)),y!=C)if("simple"===m){if(!l)return void k.done("$$noUpdates");l({resolve:k.done,reject:()=>k.done(C),value:y,key:f,breadcrumbs:w},...c)}else k.done("$$cancel");else p.promises[u].done("ignore object");else k.done("$$noUpdates")})),k.onComplete((e=>{if(g)return s.push(r(y,t,s,i,"root",c)),void p.promises[u].done("root");if(e!=C)if("$$cancel"!==e){if("$$noUpdates"!==e&&(y=e,m=n(y)),"simple"===m){const e=function(e,o){return o instanceof Array&&!isNaN(e)}(f,t);return e?t.push(y):t[f]=y,void p.promises[u].done("key")}h.done()}else h.done();else p.promises[u].done("ignore key")})),h.onComplete((()=>{if("object"===m){const e={};j&&v?t.push(e):t[f]=e,s.push(r(y,e,s,i,w,c)),p.promises[u].done("object")}if("array"===m){const e=[];j&&v?t.push(e):t[f]=e,s.push(r(y,e,s,i,w,c)),p.promises[u].done("array")}}))})),p.onComplete((e=>u.done())),u.promise}return function({data:r,objectCallback:s=null,keyCallback:i=null},...a){let c,l=n(r),d=[],f="root",p=[i,s],u=e();switch(l){case"array":c=[],t({root:r},c,d,p,f,...a).then((()=>o(d,c,u)));break;case"object":c={},t({root:r},c,d,p,f,...a).then((()=>{o(d,c,u)}));break;case"simple":u.done(r)}return u.promise}}));

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@peter.naydenov/walk-async",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "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",
+  "types": "./types/main.d.ts",
   "exports": {
     ".": {
       "import": "./.dist/walk-async.esm.mjs",
@@ -17,7 +18,8 @@
   "scripts": {
     "test": "mocha test",
     "cover": "c8 mocha test",
-    "build": "rollup -c"
+    "build": "rollup -c",
+    "postbuild": "tsc -p tsconfig.json"
   },
   "repository": {
     "type": "git",
@@ -26,16 +28,17 @@
   "author": "Peter Naydenov",
   "license": "MIT",
   "dependencies": {
-    "ask-for-promise": "2.0.3"
+    "ask-for-promise": "3.0.1"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.1",
-    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-terser": "^0.4.4",
-    "c8": "^10.1.2",
+    "c8": "^10.1.3",
     "chai": "^5.1.2",
     "mocha": "^11.0.1",
-    "rollup": "^4.28.0"
+    "rollup": "^4.30.0",
+    "typescript": "^5.7.2"
   },
   "c8": {
     "include": [

package/src/main.js

@@ -16,8 +16,28 @@
 
 import askForPromise from "ask-for-promise"
 
+/**
+ * @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.
+ */
 function walk ({ 
                   data:origin
                 , objectCallback = null
@@ -31,7 +51,7 @@ function walk ({
         , cb = [ keyCallback, objectCallback ]
         , end = askForPromise ()
         ;
-        
+
     switch ( type ) {
             case 'array'  :
                                 result = []
@@ -124,7 +144,7 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
                         }
 
                     objectCallbackTask.onComplete ( res => {
-                                        if ( res === '$$cancel' && origin.hasOwnProperty(item) ) {   // deep copy, no callbacks
+                                        if ( res === '$$cancel' && !keyCallback ) {   // deep copy, no callbacks
                                                  keyCallbackTask.done ( '$$noUpdates' )
                                                  return
                                             }
@@ -133,7 +153,7 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
                                                 type = findType ( item )
                                             }
                                         if ( item == IGNORE     ) {  
-                                                executeCallback[i].done ( 'ignore object' )
+                                                executeCallback.promises[i].done ( 'ignore object' )
                                                 return
                                             }                                        
                                         if ( type === 'simple' ) {
@@ -157,11 +177,11 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
                     keyCallbackTask.onComplete ( value => {
                                         if ( isRoot ) {
                                                     extend.push ( generateList ( item, result, extend, cb, 'root', args ) )
-                                                    executeCallback[i].done ( 'root' )
+                                                    executeCallback.promises[i].done ( 'root' )
                                                     return
                                             }
                                         if ( value == IGNORE ) {  
-                                                    executeCallback[i].done ( 'ignore key' )
+                                                    executeCallback.promises[i].done ( 'ignore key' )
                                                     return
                                             }
                                         if ( value === '$$cancel' ) { 
@@ -170,15 +190,16 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
                                             }
                                         if ( value !== '$$noUpdates' ) {
                                                     item = value
-                                                    type = findType ( item )
+                                                    type = findType ( item )                                            
                                             }
                                         if ( type === 'simple' ) {
                                                     const canInsert = validateForInsertion ( k, result )
                                                     if ( canInsert )  result.push ( item )
                                                     else              result [k] = item
-                                                    executeCallback[i].done ('key')
+                                                    executeCallback.promises[i].done ('key')
                                                     return
                                             }
+                                            
                                         finishWithCallbacks.done ()
                         }) // keyCallbackTask complete
 
@@ -188,14 +209,14 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
                                                     if ( resultIsArray && keyNumber )   result.push ( newObject )
                                                     else                                result[k] = newObject
                                                     extend.push ( generateList( item, newObject, extend, cb, br, args )   )
-                                                    executeCallback[i].done ('object')
+                                                    executeCallback.promises[i].done ('object')
                                             }
                                         if ( type === 'array' ) {
                                                     const newArray = [];
                                                     if ( resultIsArray && keyNumber )   result.push ( newArray )
                                                     else                                result[k] = newArray
                                                     extend.push ( generateList( item, newArray, extend, cb, br, args )   )
-                                                    executeCallback[i].done ('array')
+                                                    executeCallback.promises[i].done ('array')
                                             }
                         })
             }) // forEach k

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "include": ["./src/**/*"],
+    "compilerOptions": {
+      "allowJs": true,
+      "declaration": true,
+      "emitDeclarationOnly": true,
+      "outDir": "types",
+      "declarationMap": true
+    }
+}

package/types/main.d.ts

@@ -0,0 +1,35 @@
+export default walk;
+export type Options = {
+    /**
+     * - The data structure to be copied.
+     */
+    data: any;
+    /**
+     * - 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/main.d.ts.map

@@ -0,0 +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"}