@walkeros/cli 4.9.0-next-1793283841805 → 4.9.0

package/dist/examples/customers/README.md

@@ -17,5 +17,5 @@ needs the variables the setup in `flow-complete.md` exports (`GCP_SA`,
 `FINGERPRINT_SALT`, `EMAIL_SALT`, `META_ACCESS_TOKEN`).
 
 In production the store is swapped for a real one, e.g.
-`@walkeros/server-store-sheets` or a GCS store; the `loadUser` step does not
-change.
+`@walkeros/server-store-sheets`, a GCS store, or `@walkeros/server-store-api`
+for your CRM's API; the `loadUser` step does not change.

package/dist/examples/flow-complete.json

@@ -241,25 +241,25 @@
         "bundle": {
           "packages": {
             "@walkeros/collector": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/web-source-cmp-usercentrics": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/web-source-session": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/web-source-datalayer": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/web-source-browser": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/web-destination-gtag": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/web-destination-api": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             }
           },
           "env": {
@@ -1778,40 +1778,40 @@
         "bundle": {
           "packages": {
             "@walkeros/collector": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-source-express": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/transformer-ga4": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/transformer-validate": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-transformer-bot": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-transformer-fingerprint": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-transformer-file": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-store-fs": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-destination-gcp": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-destination-meta": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-destination-piwikpro": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-destination-datamanager": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             }
           }
         }
@@ -1881,6 +1881,10 @@
                 {
                   "path": "/walker.js",
                   "methods": ["GET"]
+                },
+                {
+                  "path": "/demo/products/:id",
+                  "methods": ["GET"]
                 }
               ],
               "cors": {
@@ -1942,6 +1946,14 @@
                   "value": "/g/collect"
                 },
                 "stop": true
+              },
+              {
+                "match": {
+                  "key": "ingest.path",
+                  "operator": "prefix",
+                  "value": "/demo/products/"
+                },
+                "next": "productApi"
               }
             ]
           },
@@ -2412,6 +2424,7 @@
           },
           "config": {
             "settings": {
+              "prefix": "/",
               "headers": {
                 "Cache-Control": "public, max-age=300",
                 "Cross-Origin-Resource-Policy": "same-site"
@@ -2422,6 +2435,23 @@
             "stop": true
           }
         },
+        "productApi": {
+          "package": "@walkeros/server-transformer-file",
+          "env": {
+            "store": "$store.assets"
+          },
+          "config": {
+            "settings": {
+              "prefix": "/demo/",
+              "headers": {
+                "Content-Type": "application/json; charset=utf-8"
+              }
+            }
+          },
+          "next": {
+            "stop": true
+          }
+        },
         "dedup": {
           "cache": {
             "stop": true,
@@ -4852,13 +4882,13 @@
         "bundle": {
           "packages": {
             "@walkeros/collector": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-source-gcp": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             },
             "@walkeros/server-destination-gcp": {
-              "version": "4.9.0-next-1793283841805"
+              "version": "4.9.0"
             }
           }
         }

package/dist/examples/flow-complete.md

@@ -39,8 +39,8 @@ web      usercentrics, session, dataLayer, browser
            -> collector.next: opt-out stop, pageGroup
            -> ga4 (to Google, main property)  gtm (dataLayer)  collect (to server)
 
-server   express /collect  /g/collect  /walker.js
-           before: one [ G-SUBSITE hit -> ga4Decode -> ga4Consent | *.js -> file (stop) | other /g/collect (stop) ]
+server   express /collect  /g/collect  /walker.js  /demo/products/:id
+           before: one [ G-SUBSITE hit -> ga4Decode -> ga4Consent | *.js -> file (stop) | other /g/collect (stop) | /demo/products/ -> productApi (stop) ]
            next: opt-out stop, dedup
            -> collector.next: fingerprint, bot, not impression -> enrich [ loadUser, sessionSave, sessionLoad, validate ]
            -> pubsub (every event, email pseudonymized)
@@ -140,13 +140,14 @@ walkeros push packages/cli/examples/flow-complete.json -f web -e '{"name":"page
 ## server-entry: A first-party endpoint, and a GA4 migration path
 
 - **Purpose:** one express source answers the browser (`/collect`), GA4 hits of
-  a sub-site (`/g/collect`) and script requests (`/walker.js`).
+  a sub-site (`/g/collect`), script requests (`/walker.js`) and product lookups
+  (`/demo/products/:id`).
 - **Features:**
   - `server-url` at `/flows/server/config/url`: The full collect endpoint, local
     by default, SERVER_URL in production.
   - `express-paths` at `/flows/server/sources/express/config/settings/paths`:
     One route per job, each with its own methods: /collect, /g/collect,
-    /walker.js.
+    /walker.js, /demo/products/:id.
   - `express-cors` at `/flows/server/sources/express/config/settings/cors`: CORS
     response headers for the shop origin; express adds X-Content-Type-Options
     itself.
@@ -740,6 +741,15 @@ walkeros push packages/cli/examples/flow-complete.json -f server -e '{"name":"pa
     first party from the server flow.
   - `file-headers` at `/flows/server/transformers/file/config/settings/headers`:
     Default response headers for served files: caching and resource policy.
+  - `file-prefix` at `/flows/server/transformers/file/config/settings/prefix`:
+    prefix / makes the step own every script request: a missing walker.js
+    answers 404 instead of the tracking pixel.
+  - `products-case` at `/flows/server/sources/express/before/one/3`: The last
+    case sends product lookups (/demo/products/<id>) to productApi.
+  - `product-api` at `/flows/server/transformers/productApi`: A lookup route:
+    GET /demo/products/<id> answers the product as JSON from the assets store
+    (prefix /demo/ is stripped to the key products/<id>; headers sets the JSON
+    Content-Type), 404 for an unknown id, and never becomes an event.
   - `gclid-to-ads` at
     `/flows/server/destinations/datamanager/config/mapping/order/complete/data/map/gclid`:
     The gclid saved at session start reaches Google Ads with the purchase.
@@ -752,12 +762,27 @@ walkeros push packages/cli/examples/flow-complete.json -f server -e '{"name":"pa
   (`packages/cli/examples/customers`, one JSON record per customer id), outside
   root `include`, so no customer data ships in a bundle. `basePath` is relative
   to the working directory, so `CUSTOMERS_DIR` holds it as an absolute path (the
-  setup block at the top exports it). In production a Sheets or GCS store takes
-  its place; `loadUser` does not change.
+  setup block at the top exports it). In production a Sheets or GCS store, or
+  `@walkeros/server-store-api` for your CRM's API, takes its place; `loadUser`
+  does not change.
 - **walker.js first party:** the `file` transformer answers `GET /walker.js`
   from the `assets` store with `settings.headers` (`Cache-Control`,
   `Cross-Origin-Resource-Policy`) and ends with `next: { stop: true }`. Express
-  `settings.cors` adds the CORS headers.
+  `settings.cors` adds the CORS headers. With `prefix: "/"` the step owns every
+  script request: a missing `walker.js` answers 404 with
+  `Cache-Control: no-store` instead of the tracking pixel.
+- **A lookup route:** `productApi` is a second `file` step on the same `assets`
+  store. `GET /demo/products/SKU-1` answers 200 with the product as JSON
+  (`shared/products/SKU-1`; `settings.headers` sets the JSON `Content-Type`,
+  since the step serves bytes as stored), an unknown id answers 404 with
+  `Cache-Control: no-store`, and `next: { stop: true }` keeps every lookup from
+  becoming an event. A failing store read answers 503 and is logged at ERROR.
+
+```bash
+curl -i http://localhost:8080/demo/products/SKU-1
+curl -i http://localhost:8080/demo/products/SKU-9
+```
+
 - **Why `X-Content-Type-Options: nosniff` is not in the file:** express sets it
   on every response itself.
 - The `file` example is proven over HTTP in the integration test; its simulation

package/dist/examples/index.d.ts

@@ -1700,6 +1700,30 @@ declare const teaching: {
             page: string;
         }[];
     };
+    'file-prefix': {
+        pointer: string;
+        chapter: "state-stores";
+        level: "intermediate";
+        useCases: "script-serving"[];
+        note: string;
+        docs: never[];
+    };
+    'products-case': {
+        pointer: string;
+        chapter: "state-stores";
+        level: "intermediate";
+        useCases: never[];
+        note: string;
+        docs: never[];
+    };
+    'product-api': {
+        pointer: string;
+        chapter: "state-stores";
+        level: "intermediate";
+        useCases: never[];
+        note: string;
+        docs: never[];
+    };
     'gclid-to-ads': {
         pointer: string;
         chapter: "state-stores";

package/dist/examples/index.js

@@ -264,25 +264,25 @@ var flow_complete_default = {
         bundle: {
           packages: {
             "@walkeros/collector": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/web-source-cmp-usercentrics": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/web-source-session": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/web-source-datalayer": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/web-source-browser": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/web-destination-gtag": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/web-destination-api": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             }
           },
           env: {
@@ -1801,40 +1801,40 @@ var flow_complete_default = {
         bundle: {
           packages: {
             "@walkeros/collector": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-source-express": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/transformer-ga4": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/transformer-validate": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-transformer-bot": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-transformer-fingerprint": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-transformer-file": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-store-fs": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-destination-gcp": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-destination-meta": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-destination-piwikpro": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-destination-datamanager": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             }
           }
         }
@@ -1904,6 +1904,10 @@ var flow_complete_default = {
                 {
                   path: "/walker.js",
                   methods: ["GET"]
+                },
+                {
+                  path: "/demo/products/:id",
+                  methods: ["GET"]
                 }
               ],
               cors: {
@@ -1965,6 +1969,14 @@ var flow_complete_default = {
                   value: "/g/collect"
                 },
                 stop: true
+              },
+              {
+                match: {
+                  key: "ingest.path",
+                  operator: "prefix",
+                  value: "/demo/products/"
+                },
+                next: "productApi"
               }
             ]
           },
@@ -2435,6 +2447,7 @@ var flow_complete_default = {
           },
           config: {
             settings: {
+              prefix: "/",
               headers: {
                 "Cache-Control": "public, max-age=300",
                 "Cross-Origin-Resource-Policy": "same-site"
@@ -2445,6 +2458,23 @@ var flow_complete_default = {
             stop: true
           }
         },
+        productApi: {
+          package: "@walkeros/server-transformer-file",
+          env: {
+            store: "$store.assets"
+          },
+          config: {
+            settings: {
+              prefix: "/demo/",
+              headers: {
+                "Content-Type": "application/json; charset=utf-8"
+              }
+            }
+          },
+          next: {
+            stop: true
+          }
+        },
         dedup: {
           cache: {
             stop: true,
@@ -4875,13 +4905,13 @@ var flow_complete_default = {
         bundle: {
           packages: {
             "@walkeros/collector": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-source-gcp": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             },
             "@walkeros/server-destination-gcp": {
-              version: "4.9.0-next-1793283841805"
+              version: "4.9.0"
             }
           }
         }
@@ -5395,7 +5425,7 @@ var teaching = {
     chapter: "server-entry",
     level: "beginner",
     useCases: ["script-serving", "ga4-migration"],
-    note: "One route per job, each with its own methods: /collect, /g/collect, /walker.js.",
+    note: "One route per job, each with its own methods: /collect, /g/collect, /walker.js, /demo/products/:id.",
     docs: [],
     example: { step: "express", name: "postCollect" }
   },
@@ -6540,6 +6570,30 @@ var teaching = {
     note: "Default response headers for served files: caching and resource policy.",
     docs: [{ page: "transformers/file" }]
   },
+  "file-prefix": {
+    pointer: "/flows/server/transformers/file/config/settings/prefix",
+    chapter: "state-stores",
+    level: "intermediate",
+    useCases: ["script-serving"],
+    note: "prefix / makes the step own every script request: a missing walker.js answers 404 instead of the tracking pixel.",
+    docs: []
+  },
+  "products-case": {
+    pointer: "/flows/server/sources/express/before/one/3",
+    chapter: "state-stores",
+    level: "intermediate",
+    useCases: [],
+    note: "The last case sends product lookups (/demo/products/<id>) to productApi.",
+    docs: []
+  },
+  "product-api": {
+    pointer: "/flows/server/transformers/productApi",
+    chapter: "state-stores",
+    level: "intermediate",
+    useCases: [],
+    note: "A lookup route: GET /demo/products/<id> answers the product as JSON from the assets store (prefix /demo/ is stripped to the key products/<id>; headers sets the JSON Content-Type), 404 for an unknown id, and never becomes an event.",
+    docs: []
+  },
   "gclid-to-ads": {
     pointer: "/flows/server/destinations/datamanager/config/mapping/order/complete/data/map/gclid",
     chapter: "state-stores",
@@ -7039,7 +7093,7 @@ var flowCompleteCoverage = {
     batch: "rule-batch",
     condition: "rule-condition",
     consent: {
-      excluded: "rule consent is not enforced yet; destination consent is the gate in this file"
+      excluded: "destination consent is the gate in this file; the consent guide shows a rule's consent"
     },
     settings: "rule-settings",
     data: "rule-data",