@walkeros/cli 0.4.0 → 0.4.2

package/examples/README.md

@@ -229,44 +229,57 @@ Browser → destinationAPI (POST /collect) → sourceExpress → destinationData
 
 ### Flow Configuration Structure
 
+Flow configs use the `Flow.Setup` format:
+
 ```json
 {
-  "flow": {
-    "platform": "web" | "server",
-    "sources": {
-      "<source_name>": {
-        "code": "<imported_function_name>",
-        "config": { "settings": { /* source config */ } }
-      }
-    },
-    "destinations": {
-      "<destination_name>": {
-        "code": "<imported_function_name>",
-        "config": {
-          "settings": { /* destination config */ },
-          "mapping": { /* event mappings */ }
+  "version": 1,
+  "flows": {
+    "default": {
+      "web": {},
+      "packages": {
+        "<package_name>": { "imports": ["<function_name>"] }
+      },
+      "sources": {
+        "<source_name>": {
+          "code": "<imported_function_name>",
+          "config": {
+            "settings": {
+              /* source config */
+            }
+          }
+        }
+      },
+      "destinations": {
+        "<destination_name>": {
+          "code": "<imported_function_name>",
+          "config": {
+            "settings": {
+              /* destination config */
+            },
+            "mapping": {
+              /* event mappings */
+            }
+          }
+        }
+      },
+      "collector": {
+        "run": true,
+        "globals": {
+          /* global properties */
         }
       }
-    },
-    "collector": {
-      "run": true,
-      "globals": { /* global properties */ }
     }
-  },
-  "build": {
-    "packages": {
-      "<package_name>": {
-        "version": "latest",
-        "imports": ["<function_name>"]
-      }
-    },
-    "code": "// Optional custom code\n",
-    "template": "templates/base.hbs",
-    "output": "./dist/bundle.js"
   }
 }
 ```
 
+**Key points:**
+
+- Platform via `web: {}` or `server: {}` key (not `platform: "web"`)
+- Output path is convention-based: `./dist/walker.js` (web) or
+  `./dist/bundle.mjs` (server)
+
 ### Available Sources
 
 **Web**:

package/examples/event.json

@@ -5,7 +5,7 @@
     "total": 299.99,
     "currency": "USD",
     "tax": 24.99,
-    "shipping": 15.00
+    "shipping": 15.0
   },
   "user": {
     "id": "user_abc123",

package/examples/flow-order-complete.json

@@ -1,68 +1,68 @@
 {
-  "flow": {
-    "platform": "web",
-    "destinations": {
-      "demo": {
-        "code": "destinationDemo",
-        "config": {
-          "consent": {
-            "marketing": true
-          },
-          "settings": {
-            "name": "Order Complete with Consent Demo",
-            "values": ["name", "data", "user", "source", "consent"]
-          },
-          "mapping": {
-            "order": {
-              "complete": {
-                "name": "purchase",
-                "data": {
-                  "map": {
-                    "transaction_id": "data.id",
-                    "value": "data.total",
-                    "currency": "data.currency",
-                    "tax": "data.tax",
-                    "shipping": "data.shipping",
-                    "email": {
-                      "key": "user.email",
-                      "consent": {
-                        "marketing": true
-                      }
-                    },
-                    "gclid": {
-                      "key": "user.gclid",
-                      "consent": {
-                        "marketing": true
-                      }
-                    },
-                    "source_url": "source.id"
+  "version": 1,
+  "flows": {
+    "default": {
+      "web": {},
+      "packages": {
+        "@walkeros/collector": {
+          "version": "latest",
+          "imports": ["startFlow"]
+        },
+        "@walkeros/destination-demo": {
+          "version": "latest",
+          "imports": ["destinationDemo"]
+        }
+      },
+      "destinations": {
+        "demo": {
+          "code": "destinationDemo",
+          "config": {
+            "consent": {
+              "marketing": true
+            },
+            "settings": {
+              "name": "Order Complete with Consent Demo",
+              "values": ["name", "data", "user", "source", "consent"]
+            },
+            "mapping": {
+              "order": {
+                "complete": {
+                  "name": "purchase",
+                  "data": {
+                    "map": {
+                      "transaction_id": "data.id",
+                      "value": "data.total",
+                      "currency": "data.currency",
+                      "tax": "data.tax",
+                      "shipping": "data.shipping",
+                      "email": {
+                        "key": "user.email",
+                        "consent": {
+                          "marketing": true
+                        }
+                      },
+                      "gclid": {
+                        "key": "user.gclid",
+                        "consent": {
+                          "marketing": true
+                        }
+                      },
+                      "source_url": "source.id"
+                    }
                   }
                 }
               }
             }
           }
         }
-      }
-    },
-    "collector": {
-      "run": true,
-      "globals": {
-        "environment": "production",
-        "version": "1.0.0"
-      }
-    }
-  },
-  "build": {
-    "packages": {
-      "@walkeros/collector": {
-        "version": "latest",
-        "imports": ["startFlow"]
       },
-      "@walkeros/destination-demo": {
-        "version": "latest",
-        "imports": ["destinationDemo"]
+      "collector": {
+        "run": true,
+        "globals": {
+          "environment": "production",
+          "version": "1.0.0"
+        }
       }
-    },
-    "output": "flow-order-complete.js"
+    }
   }
 }

package/examples/flow-simple.json

@@ -1,32 +1,32 @@
 {
-  "flow": {
-    "platform": "web",
-    "destinations": {
-      "demo": {
-        "code": "destinationDemo",
-        "config": {
-          "settings": {
-            "name": "Simple Demo",
-            "values": ["name", "data", "user", "consent"]
+  "version": 1,
+  "flows": {
+    "default": {
+      "web": {},
+      "packages": {
+        "@walkeros/collector": {
+          "version": "latest",
+          "imports": ["startFlow"]
+        },
+        "@walkeros/destination-demo": {
+          "version": "latest",
+          "imports": ["destinationDemo"]
+        }
+      },
+      "destinations": {
+        "demo": {
+          "code": "destinationDemo",
+          "config": {
+            "settings": {
+              "name": "Simple Demo",
+              "values": ["name", "data", "user", "consent"]
+            }
           }
         }
-      }
-    },
-    "collector": {
-      "run": true
-    }
-  },
-  "build": {
-    "packages": {
-      "@walkeros/collector": {
-        "version": "latest",
-        "imports": ["startFlow"]
       },
-      "@walkeros/destination-demo": {
-        "version": "latest",
-        "imports": ["destinationDemo"]
+      "collector": {
+        "run": true
       }
-    },
-    "output": "flow-simple.js"
+    }
   }
 }

package/examples/flow.json

@@ -1,82 +1,82 @@
 {
-  "flow": {
-    "platform": "web",
-    "destinations": {
-      "ga4": {
-        "code": "destinationGtag",
-        "config": {
-          "consent": {
-            "marketing": true
-          },
-          "settings": {
-            "ga4": {
-              "measurementId": "G-XXXXXXXXXX"
-            }
-          },
-          "mapping": {
-            "order": {
-              "complete": {
-                "name": "purchase",
-                "data": {
-                  "map": {
-                    "transaction_id": "data.id",
-                    "value": "data.total",
-                    "currency": "data.currency",
-                    "tax": "data.tax",
-                    "shipping": "data.shipping",
-                    "email": {
-                      "key": "user.email",
-                      "consent": {
-                        "marketing": true
-                      }
-                    },
-                    "gclid": {
-                      "key": "user.gclid",
-                      "consent": {
-                        "marketing": true
-                      }
-                    },
-                    "source_url": "source.id"
+  "version": 1,
+  "flows": {
+    "default": {
+      "web": {},
+      "packages": {
+        "@walkeros/collector": {
+          "version": "latest",
+          "imports": ["startFlow"]
+        },
+        "@walkeros/web-destination-gtag": {
+          "version": "latest",
+          "imports": ["destinationGtag"]
+        },
+        "@walkeros/destination-demo": {
+          "version": "latest",
+          "imports": ["destinationDemo"]
+        }
+      },
+      "destinations": {
+        "ga4": {
+          "package": "@walkeros/web-destination-gtag",
+          "config": {
+            "consent": {
+              "marketing": true
+            },
+            "settings": {
+              "ga4": {
+                "measurementId": "G-XXXXXXXXXX"
+              }
+            },
+            "mapping": {
+              "order": {
+                "complete": {
+                  "name": "purchase",
+                  "data": {
+                    "map": {
+                      "transaction_id": "data.id",
+                      "value": "data.total",
+                      "currency": "data.currency",
+                      "tax": "data.tax",
+                      "shipping": "data.shipping",
+                      "email": {
+                        "key": "user.email",
+                        "consent": {
+                          "marketing": true
+                        }
+                      },
+                      "gclid": {
+                        "key": "user.gclid",
+                        "consent": {
+                          "marketing": true
+                        }
+                      },
+                      "source_url": "source.id"
+                    }
                   }
                 }
               }
             }
           }
+        },
+        "demo": {
+          "package": "@walkeros/destination-demo",
+          "config": {
+            "settings": {
+              "name": "Order Complete Demo",
+              "values": ["name", "data", "user", "source", "consent"]
+            }
+          }
         }
       },
-      "demo": {
-        "code": "destinationDemo",
-        "config": {
-          "settings": {
-            "name": "Order Complete Demo",
-            "values": ["name", "data", "user", "source", "consent"]
-          }
+      "collector": {
+        "run": true,
+        "globals": {
+          "environment": "production",
+          "version": "1.0.0"
         }
       }
-    },
-    "collector": {
-      "run": true,
-      "globals": {
-        "environment": "production",
-        "version": "1.0.0"
-      }
     }
-  },
-  "build": {
-    "packages": {
-      "@walkeros/collector": {
-        "version": "latest",
-        "imports": ["startFlow"]
-      },
-      "@walkeros/web-destination-gtag": {
-        "version": "latest",
-        "imports": ["destinationGtag"]
-      },
-      "@walkeros/destination-demo": {
-        "version": "latest",
-        "imports": ["destinationDemo"]
-      }
-    },
-    "output": "flow.js"
   }
 }

package/examples/server-collect.json

@@ -1,53 +1,60 @@
 {
-  "flow": {
-    "platform": "server",
-    "sources": {
-      "http": {
-        "code": "sourceExpress",
-        "config": {
-          "settings": {
-            "path": "/collect",
-            "port": 8080,
-            "cors": true,
-            "healthCheck": true
-          }
+  "version": 1,
+  "flows": {
+    "default": {
+      "server": {},
+      "packages": {
+        "@walkeros/collector": {
+          "version": "latest",
+          "imports": ["startFlow"]
+        },
+        "@walkeros/server-source-express": {
+          "version": "latest",
+          "imports": ["sourceExpress"]
+        },
+        "@walkeros/destination-demo": {
+          "version": "latest",
+          "imports": ["destinationDemo"]
         }
-      }
-    },
-    "destinations": {
-      "demo": {
-        "code": "destinationDemo",
-        "config": {
-          "settings": {
-            "name": "Server Collection Demo",
-            "values": ["name", "data", "context", "user", "nested", "timestamp"]
+      },
+      "sources": {
+        "http": {
+          "package": "@walkeros/server-source-express",
+          "config": {
+            "settings": {
+              "path": "/collect",
+              "port": 8080,
+              "cors": true,
+              "healthCheck": true
+            }
           }
         }
-      }
-    },
-    "collector": {
-      "run": true,
-      "globals": {
-        "environment": "test",
-        "version": "1.0.0"
-      }
-    }
-  },
-  "build": {
-    "packages": {
-      "@walkeros/collector": {
-        "version": "latest",
-        "imports": ["startFlow"]
       },
-      "@walkeros/server-source-express": {
-        "version": "latest",
-        "imports": ["sourceExpress"]
+      "destinations": {
+        "demo": {
+          "package": "@walkeros/destination-demo",
+          "config": {
+            "settings": {
+              "name": "Server Collection Demo",
+              "values": [
+                "name",
+                "data",
+                "context",
+                "user",
+                "nested",
+                "timestamp"
+              ]
+            }
+          }
+        }
       },
-      "@walkeros/destination-demo": {
-        "version": "latest",
-        "imports": ["destinationDemo"]
+      "collector": {
+        "run": true,
+        "globals": {
+          "environment": "test",
+          "version": "1.0.0"
+        }
       }
-    },
-    "output": "server-collect.mjs"
+    }
   }
 }