@peter.naydenov/walk-async 1.3.1 → 2.0.1

package/dist/walk-async.cjs

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

package/dist/walk-async.esm.mjs

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

package/dist/walk-async.umd.js

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

package/package.json

@@ -1,11 +1,23 @@
 {
   "name": "@peter.naydenov/walk-async",
-  "version": "1.3.1",
+  "version": "2.0.1",
   "description": "Deep copy with fine control during the process. Can be used also as a deep forEach function",
-  "main": "src/main.js",
+  "main": ".dist/walk-async.umd.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./.dist/walk-async.esm.mjs",
+      "require": "./.dist/walk-async.cjs",
+      "default": "./dist/walk-async.umd.js"
+    },
+    "./package.json": "./package.json",
+    "./dist/*": "./dist/*",
+    "./src/*": "./src/*"
+  },
   "scripts": {
     "test": "mocha test",
-    "cover": "nyc mocha test"
+    "cover": "c8 mocha test",
+    "build": "rollup -c"
   },
   "repository": {
     "type": "git",
@@ -14,14 +26,18 @@
   "author": "Peter Naydenov",
   "license": "MIT",
   "dependencies": {
-    "ask-for-promise": "1.4.0"
+    "ask-for-promise": "2.0.3"
   },
   "devDependencies": {
-    "chai": "^4.3.10",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "c8": "^9.1.0",
+    "chai": "^5.0.3",
     "mocha": "^10.2.0",
-    "nyc": "^15.1.0"
+    "rollup": "^4.9.6"
   },
-  "nyc": {
+  "c8": {
     "include": [
       "src/**/*.js"
     ],

package/rollup.config.js

@@ -0,0 +1,41 @@
+import resolve    from '@rollup/plugin-node-resolve'
+import commonjs   from '@rollup/plugin-commonjs'
+import terser     from '@rollup/plugin-terser';
+
+
+export default [
+	// browser-friendly UMD build
+	{
+		input: 'src/main.js',
+		output: {
+			name: 'walkAsync',
+			file: 'dist/walk-async.umd.js',
+			format: 'umd',
+            globals: {
+                        'ask-for-promise': 'askForPromise'
+                    }
+		},
+        external : [ 'ask-for-promise' ],
+		plugins: [
+			resolve(), // so Rollup can find `ms`
+			commonjs() // so Rollup can convert `ms` to an ES module
+			, terser()
+		]
+	},
+
+	// CommonJS (for Node) and ES module (for bundlers) build.
+	// (We could have three entries in the configuration array
+	// instead of two, but it's quicker to generate multiple
+	// builds from a single configuration where possible, using
+	// an array for the `output` option, where we can specify
+	// `file` and `format` for each target)
+	{
+		input: 'src/main.js',
+		external: ['ask-for-promise'],
+		output: [
+			{ file: 'dist/walk-async.cjs'    , format: 'cjs' },
+			{ file: 'dist/walk-async.esm.mjs', format: 'es' }
+		],
+		plugins: [ terser() ]
+	}
+];

package/src/main.js

@@ -9,12 +9,12 @@
  * 
  *     History notes:
  *        - Walk-async was born on September 18th, 2022
+ *        - Converted to ES module on January 1st, 2024
  * 
  */
 
 
-
-const askForPromise = require("ask-for-promise");
+import askForPromise from "ask-for-promise"
 
 
 
@@ -198,6 +198,6 @@ function copyObject ( origin, result, extend, cb, breadcrumbs, ...args ) {
 
 
 
-module.exports = walk
+export default walk
 
 

package/test/01-deepCopy.test.js

@@ -1,118 +0,0 @@
-"use strict"
-
-const
-      chai = require ( 'chai' )
-    , expect = chai.expect
-    , walk = require ( '../src/main.js' )
-    ;
-
-
-describe ( 'Walk-async -> Deep copy', () => {
-
-    it ( 'Copy a primitive value', () => {
-                let x = 12;
-                walk ({data:x})
-                    .then ( r => {
-                                x = 64
-                                expect ( r ).to.be.equal ( 12 )
-                                expect ( r !== x )
-                          })
-        }) // it copy a primitives
-
-
-
-    it ( 'Copy array of strings', () => {
-                let x = [ 'one', 'two', 'three' ];
-                walk ({data:x})
-                    .then ( r => {
-                              x.push ( 'four' )
-                              expect ( r ).to.have.length ( 3 )
-                        })
-        }) // it copy array of strings
-
-
-
-    it ( 'Copy a single level deep object', () => {
-                let 
-                    x = { name:'Peter', age: 47 }
-                  , z = x
-                  ;                   
-                walk ( {data:x})
-                    .then ( r => {
-                            x.test = 'hello'
-                            expect ( r ).to.not.have.property ( 'test' )
-                            expect ( z ).to.have.property ( 'test' )
-                      })                  
-        }) // it copy a single level deep object
-
-
-
-    it ( 'Copy a mixed structure', () => {
-                let 
-                    x = {
-                              ls   : [ 1,2,3 ]
-                            , name : 'Peter'
-                            , props : {
-                                          eyeColor: 'blue'
-                                        , age     : 47
-                                        , height  : 176
-                                        , sizes : [12,33,12,21]
-                                    }
-                            }
-                  ;
-                walk ( x )
-                    .then ( r => {
-                                r.props.sizes.push ( 66 )
-                                x.props.sizes[0] = 222222
-                                x.props.test = 'hello'
-
-                                expect ( x.props.sizes ).to.have.length ( 4 )
-                                expect ( r.props.sizes ).to.have.length ( 5 )
-                                expect ( x.props.sizes[0] !== r.props.sizes[0])
-                
-                                expect ( r.props ).to.not.have.property ( 'test' )
-                          })
-        }) // it Copy a mixed structure
-
-    it ( 'Data property has value "null"', done => {
-          // Fix: Deep copy process is losing object properties that are equal to 'null'
-          const x = { name : null };
-          walk ({data:x}).then ( r => {
-                    expect ( r ).to.have.property ( 'name' )
-                    expect ( r.name ).to.be.equal ( null )
-                    done ()
-                })
-    }) // it Data property has value null
-
-
-
-    it ( 'html nodes - copy by reference', done => {
-        const data = {
-                      name : 'Peter'
-                    , pretendHTML : { nodeType: 1 }
-                };
-        walk ({ data })
-            .then ( r => {
-                    r.pretendHTML.something = 'hello'
-                    expect ( data.pretendHTML.something ).to.be.equal ( 'hello' )   // Recognize html nodes and keep them as a reference
-                    done ()
-            })
-    }) // html nodes - copy by reference
-
-
-
-  it ( 'Functions type - copy by reference', () => {
-            const data = {
-                          name : 'Peter'
-                        , func : () => 12
-                    };
-                    
-            walk ({ data })
-                .then ( r => {  
-                            expect ( r.func() ).to.be.equal ( 12 )
-                    })
-    }) // it Functions type - copy by reference
-  
-}) // describe
-
-

package/test/02-keyCallback.test.js

@@ -1,269 +0,0 @@
-"use strict"
-
-const
-      chai = require ( 'chai' )
-    , expect = chai.expect
-    , walk = require ( '../src/main.js' )
-    ;
-
-
-describe ( 'Walk-async -> keyCallback function', () => {
-
-    it ( 'Hide a property', () => {
-                let 
-                    x = {
-                              ls   : [ 1,2,3 ]
-                            , name : 'Peter'
-                            , props : {
-                                          eyeColor: 'blue'
-                                        , age     : 47
-                                        , height  : 176
-                                        , sizes : [12,33,12,21]
-                                    }
-                            }
-                  ;
-                walk ({
-                          data : x
-                        , keyCallback : ({
-                                            key : k
-                                          , value
-                                          , resolve
-                                          , reject
-                                        }) => {
-                                              if ( k === 'name' )   reject ()
-                                              else                  resolve ( value )
-                                        }
-                        })
-                  .then ( r => {
-                                        expect ( r ).to.not.have.property ( 'name' )
-                        })
-       })  // it Hide a property
-
-
-
-    it ( 'Provide a structure. Hide values approaches', () => {
-                let 
-                    x = {
-                              ls   : [ 1,2,3 ]
-                            , name : 'Peter'
-                            , props : {
-                                          eyeColor: 'blue'
-                                        , age     : 47
-                                        , height  : 176
-                                        , sizes : [12,33,12,21]
-                                    }
-                            };
-                walk ({
-                          data:x
-                        , keyCallback : ({ resolve, reject, breadcrumbs }) => {
-                                              const hasSizes = breadcrumbs.includes('root/props/sizes');
-                                              if ( hasSizes )   reject ()
-                                              else              resolve ( 'xxx' )
-                                          }
-                      })
-                  .then ( r => {
-                              expect ( r.name       ).to.be.equal ( 'xxx' )
-                              expect ( r.props.age  ).to.be.equal ( 'xxx' )
-                              expect ( r.props.sizes.length ).to.be.equal ( 0 )
-                        })
-      })   // it Provide a structure
-
-
-      it ( 'No properties. Just structures', () => {
-                  let 
-                    x = {
-                              ls   : [ 1,2,3 ]
-                            , name : 'Peter'
-                            , props : {
-                                          eyeColor: 'blue'
-                                        , age     : 47
-                                        , height  : 176
-                                        , sizes : [12,33,12,21]
-                                    }
-                            };
-                  walk ({
-                             data : x
-                           , keyCallback : ({reject}) => reject () 
-                        })
-                    .then ( r => {
-                                    expect ( r ).to.have.property ( 'ls' )
-                                    expect ( r ).to.have.property ( 'props' )
-                                    expect ( r.props ).to.have.property ( 'sizes' )
-                  
-                                    expect ( r       ).to.not.have.property ( 'name' )
-                                    expect ( r.props ).to.not.have.property ( 'age' )
-                  
-                                    expect ( r.ls.length ).to.be.equal  ( 0 )
-                                    expect ( r.props.sizes.length ).to.be.equal ( 0 )
-                          })
-      }) // it No properties
-
-
-      it ( 'Convert primitive property to object', () => {
-                let 
-                      x = [ 'peter', 'ivan', 'petkan', 'rosica' ]
-                    , data = {
-                              "ivan"   : { name: 'Ivan', age: 45, gender: 'male' }
-                            , "petkan" : { name: 'Petkan', age: 32, gender: 'male' }
-                            , "rosica" : { name: "Rosica", age: 75, gender: 'female'}
-                        }
-                    ;
-                function keyCallback ({ value, resolve, reject }) {
-                                const person= data[value];
-                                if ( person ) {  
-                                        if ( person.age > 33 ) resolve ( person )
-                                        else                   reject ()
-                                        return
-                                    }
-                                else                 resolve ( value )
-                    }
-                walk ({
-                              data : x
-                            , keyCallback
-                        })
-                    .then ( r => {
-                            expect ( r.length ).to.be.equal ( 3 )   // ignore 'petkan'
-                            expect ( r[0] ).to.be.equal ( 'Peter' ) // no description for Peter available
-                            expect ( r[1]['name']).to.be.equal ( 'Ivan' )
-                            expect ( r[2]['name']).to.be.equal ( 'Rosica' )
-                        })
-      }) // it Convert primitive property to object
-
-
-
-      it ( 'Properties of the array object', () => {
-                let data = [ 'peter', 'ivan' ];
-                data.group = 'work'
-
-                function keyCallback ({value, resolve }) {
-                            resolve ( value )
-                    }
-
-                walk ({ data, keyCallback })
-                  .then ( r => {
-                                expect ( r.length ).to.be.equal ( 2 )
-                                expect ( r.group ).to.be.equal ( 'work' )
-                        })
-      }) // it Properties of the array
-
-
-
-      it ( 'Set a value to NULL', done => {
-                let
-                    x = {
-                              ls   : [ 1,2,3 ]
-                            , name : 'Peter'
-                            , props : {
-                                          eyeColor: null   // Use callback and return this exact value
-                                        , age     : 47
-                                        , height  : 176
-                                        , sizes : [12,33,12,21]
-                                    }
-                            };
-
-                function checkNull ({ value, resolve }) {
-                            resolve (value) 
-                    } // checkNull func.
-
-                walk ({ data:x, keyCallback:checkNull })
-                    .then ( r => {
-                            expect ( r.props.eyeColor ).to.be.equal ( null )
-                            done ()
-                        })
-        }) // it set a value to NULL
-
-
-
-        it ( 'Set a value to undefined', done => {
-                    let
-                        x = {
-                                  ls   : [ 1,2,3 ]
-                                , name : 'Peter'
-                                , props : {
-                                              eyeColor: undefined   // Use callback and return this exact value
-                                            , age     : 47
-                                            , height  : 176
-                                            , sizes : [12,33,12,21]
-                                        }
-                                };
-
-                    function checkNull ({ value, resolve }) {
-                                resolve(value)
-                        } // checkNull func.
-
-                    walk ({ data:x, keyCallback:checkNull })
-                      .then ( r => {
-                                expect ( r.props.eyeColor ).to.be.equal ( undefined )
-                                done ()
-                            })
-          }) // it Set a value to undefined
-        
-
-        it ( 'Copy a function', done => {
-                    let
-                        x = {
-                                  ls   : [ 1,2,3 ]
-                                , name : 'Peter'
-                                , props : {
-                                              eyeColor: undefined   // Use callback and return this exact value
-                                            , age     : function age () { return 47 } 
-                                            , height  : 176
-                                            , sizes : [12,33,12,21]
-                                        }
-                                };
-
-                    function checkNull ({ value, resolve }) {
-                                resolve ( value ) 
-                        } // checkNull func.
-
-                    walk ({ data:x, keyCallback:checkNull })
-                        .then ( r => {
-                                expect ( r.props.age() ).to.be.equal ( 47 )
-                                done ()
-                            })
-            }) // it Copy a function
-
-
-
-        it ( 'Extract collections', done => {
-                    let
-                        x = {
-                                  ls   : [ 1,2,3 ]
-                                , name : 'Peter'
-                                , props : {
-                                              eyeColor: undefined   // Use callback and return this exact value
-                                            , age     : function age () { return 47 } 
-                                            , height  : 176
-                                            , sizes : [12,33,12,21]
-                                        }
-                                }
-                      , fnList = []
-                      , propsCollection = {}
-                      ;
-
-                    function valueFn ({ key, value, resolve }, fn, p ) {
-                                const isFn = (typeof value === 'function');
-                                if ( isFn )   fn.push ( value )
-                                
-                                if ( ['name','eyeColor', 'age'].includes(key) )   p[key] = isFn ? value() : value
-                                resolve ( value ) 
-                        } // valueFn func.
-
-                    walk ({ data:x, keyCallback:valueFn }, fnList, propsCollection )
-                        .then ( r => {
-                                expect ( r.props.age() ).to.be.equal ( 47 )
-                                expect ( fnList.length ).to.be.equal ( 1 )
-                                expect ( r.props ).to.have.property ( 'eyeColor' )
-
-                                expect ( propsCollection ).to.have.property ( 'name' )
-                                expect ( propsCollection ).to.have.property ( 'eyeColor' )
-                                expect ( propsCollection ).to.have.property ( 'age' )
-                                expect ( propsCollection.age ).to.be.equal ( 47 )
-
-                                done ()
-                            })
-            }) // it Copy a function
-      
-}) // describe
-
-