@walkeros/web-destination-gtag 2.0.0 → 2.1.0

package/dist/examples/index.d.mts

@@ -1,5 +1,5 @@
-import { Mapping as Mapping$1 } from '@walkeros/core';
 import { DestinationWeb } from '@walkeros/web-core';
+import { Flow } from '@walkeros/core';
 
 declare global {
     interface Window {
@@ -24,21 +24,6 @@ interface Env extends DestinationWeb.Env {
         };
     };
 }
-interface AdsMapping {
-    label?: string;
-}
-interface Mapping {
-    ga4?: GA4Mapping;
-    ads?: AdsMapping;
-    gtm?: GTMMapping;
-}
-interface GA4Mapping {
-    include?: Include;
-}
-interface GTMMapping {
-}
-type Rule = Mapping$1.Rule<Mapping>;
-type Include = Array<'all' | 'context' | 'data' | 'event' | 'globals' | 'source' | 'user' | 'version'>;
 
 declare const init: Env | undefined;
 declare const push: Env;
@@ -51,39 +36,15 @@ declare namespace env {
   export { env_init as init, env_push as push, env_simulation as simulation };
 }
 
-declare function ga4Purchase$1(): unknown[];
-declare function ga4AddToCart$1(): unknown[];
-declare function adsConversion$1(): unknown[];
-declare function gtmEvent(): Record<string, unknown>;
-
-declare const events_gtmEvent: typeof gtmEvent;
-declare namespace events {
-  export { adsConversion$1 as adsConversion, ga4AddToCart$1 as ga4AddToCart, ga4Purchase$1 as ga4Purchase, events_gtmEvent as gtmEvent };
-}
-
-declare const ga4Purchase: Rule;
-declare const ga4AddToCart: Rule;
-declare const adsConversion: Rule;
-declare const gtmProductView: Rule;
-declare const combinedPurchase: Rule;
-declare const config: {
-    order: {
-        complete: Rule;
-    };
-    product: {
-        add: Rule;
-        view: Rule;
-    };
-};
+declare const purchase: Flow.StepExample;
+declare const addToCart: Flow.StepExample;
+declare const pageView: Flow.StepExample;
 
-declare const mapping_adsConversion: typeof adsConversion;
-declare const mapping_combinedPurchase: typeof combinedPurchase;
-declare const mapping_config: typeof config;
-declare const mapping_ga4AddToCart: typeof ga4AddToCart;
-declare const mapping_ga4Purchase: typeof ga4Purchase;
-declare const mapping_gtmProductView: typeof gtmProductView;
-declare namespace mapping {
-  export { mapping_adsConversion as adsConversion, mapping_combinedPurchase as combinedPurchase, mapping_config as config, mapping_ga4AddToCart as ga4AddToCart, mapping_ga4Purchase as ga4Purchase, mapping_gtmProductView as gtmProductView };
+declare const step_addToCart: typeof addToCart;
+declare const step_pageView: typeof pageView;
+declare const step_purchase: typeof purchase;
+declare namespace step {
+  export { step_addToCart as addToCart, step_pageView as pageView, step_purchase as purchase };
 }
 
-export { env, events, mapping };
+export { env, step };

package/dist/examples/index.d.ts

@@ -1,5 +1,5 @@
-import { Mapping as Mapping$1 } from '@walkeros/core';
 import { DestinationWeb } from '@walkeros/web-core';
+import { Flow } from '@walkeros/core';
 
 declare global {
     interface Window {
@@ -24,21 +24,6 @@ interface Env extends DestinationWeb.Env {
         };
     };
 }
-interface AdsMapping {
-    label?: string;
-}
-interface Mapping {
-    ga4?: GA4Mapping;
-    ads?: AdsMapping;
-    gtm?: GTMMapping;
-}
-interface GA4Mapping {
-    include?: Include;
-}
-interface GTMMapping {
-}
-type Rule = Mapping$1.Rule<Mapping>;
-type Include = Array<'all' | 'context' | 'data' | 'event' | 'globals' | 'source' | 'user' | 'version'>;
 
 declare const init: Env | undefined;
 declare const push: Env;
@@ -51,39 +36,15 @@ declare namespace env {
   export { env_init as init, env_push as push, env_simulation as simulation };
 }
 
-declare function ga4Purchase$1(): unknown[];
-declare function ga4AddToCart$1(): unknown[];
-declare function adsConversion$1(): unknown[];
-declare function gtmEvent(): Record<string, unknown>;
-
-declare const events_gtmEvent: typeof gtmEvent;
-declare namespace events {
-  export { adsConversion$1 as adsConversion, ga4AddToCart$1 as ga4AddToCart, ga4Purchase$1 as ga4Purchase, events_gtmEvent as gtmEvent };
-}
-
-declare const ga4Purchase: Rule;
-declare const ga4AddToCart: Rule;
-declare const adsConversion: Rule;
-declare const gtmProductView: Rule;
-declare const combinedPurchase: Rule;
-declare const config: {
-    order: {
-        complete: Rule;
-    };
-    product: {
-        add: Rule;
-        view: Rule;
-    };
-};
+declare const purchase: Flow.StepExample;
+declare const addToCart: Flow.StepExample;
+declare const pageView: Flow.StepExample;
 
-declare const mapping_adsConversion: typeof adsConversion;
-declare const mapping_combinedPurchase: typeof combinedPurchase;
-declare const mapping_config: typeof config;
-declare const mapping_ga4AddToCart: typeof ga4AddToCart;
-declare const mapping_ga4Purchase: typeof ga4Purchase;
-declare const mapping_gtmProductView: typeof gtmProductView;
-declare namespace mapping {
-  export { mapping_adsConversion as adsConversion, mapping_combinedPurchase as combinedPurchase, mapping_config as config, mapping_ga4AddToCart as ga4AddToCart, mapping_ga4Purchase as ga4Purchase, mapping_gtmProductView as gtmProductView };
+declare const step_addToCart: typeof addToCart;
+declare const step_pageView: typeof pageView;
+declare const step_purchase: typeof purchase;
+declare namespace step {
+  export { step_addToCart as addToCart, step_pageView as pageView, step_purchase as purchase };
 }
 
-export { env, events, mapping };
+export { env, step };

package/dist/examples/index.js

@@ -21,8 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var examples_exports = {};
 __export(examples_exports, {
   env: () => env_exports,
-  events: () => events_exports,
-  mapping: () => mapping_exports
+  step: () => step_exports
 });
 module.exports = __toCommonJS(examples_exports);
 
@@ -76,253 +75,146 @@ var simulation = [
   // Track gtag function calls
 ];
 
-// src/examples/events.ts
-var events_exports = {};
-__export(events_exports, {
-  adsConversion: () => adsConversion,
-  ga4AddToCart: () => ga4AddToCart,
-  ga4Purchase: () => ga4Purchase,
-  gtmEvent: () => gtmEvent
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  addToCart: () => addToCart,
+  pageView: () => pageView,
+  purchase: () => purchase
 });
 
 // ../../../core/dist/index.mjs
-var e = Object.defineProperty;
-var c = {};
-((t, n) => {
-  for (var o in n) e(t, o, { get: n[o], enumerable: true });
-})(c, { Level: () => u });
-var u = ((e2) => (e2[e2.ERROR = 0] = "ERROR", e2[e2.INFO = 1] = "INFO", e2[e2.DEBUG = 2] = "DEBUG", e2))(u || {});
-var A = { merge: true, shallow: true, extend: true };
-function P(e2, t = {}, n = {}) {
-  n = { ...A, ...n };
-  const o = Object.entries(t).reduce((t2, [o2, r]) => {
-    const i = e2[o2];
-    return n.merge && Array.isArray(i) && Array.isArray(r) ? t2[o2] = r.reduce((e3, t3) => e3.includes(t3) ? e3 : [...e3, t3], [...i]) : (n.extend || o2 in e2) && (t2[o2] = r), t2;
+var t = Object.defineProperty;
+var a = {};
+((e, n) => {
+  for (var o in n) t(e, o, { get: n[o], enumerable: true });
+})(a, { Level: () => u });
+var u = ((t2) => (t2[t2.ERROR = 0] = "ERROR", t2[t2.WARN = 1] = "WARN", t2[t2.INFO = 2] = "INFO", t2[t2.DEBUG = 3] = "DEBUG", t2))(u || {});
+var D = { merge: true, shallow: true, extend: true };
+function H(t2, e = {}, n = {}) {
+  n = { ...D, ...n };
+  const o = Object.entries(e).reduce((e2, [o2, r]) => {
+    const i = t2[o2];
+    return n.merge && Array.isArray(i) && Array.isArray(r) ? e2[o2] = r.reduce((t3, e3) => t3.includes(e3) ? t3 : [...t3, e3], [...i]) : (n.extend || o2 in t2) && (e2[o2] = r), e2;
   }, {});
-  return n.shallow ? { ...e2, ...o } : (Object.assign(e2, o), e2);
+  return n.shallow ? { ...t2, ...o } : (Object.assign(t2, o), t2);
 }
-function _(e2) {
-  return Array.isArray(e2);
+function W(t2) {
+  return Array.isArray(t2);
 }
-function D(e2) {
-  return "object" == typeof e2 && null !== e2 && !_(e2) && "[object Object]" === Object.prototype.toString.call(e2);
+function Z(t2) {
+  return "object" == typeof t2 && null !== t2 && !W(t2) && "[object Object]" === Object.prototype.toString.call(t2);
 }
-function Z(e2 = {}) {
+function nt(t2 = {}) {
   var _a;
-  const t = e2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = e2.group || "gr0up", o = e2.count || 1, r = P({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${t}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: t, timing: 3.14, group: n, count: o, version: { source: "2.0.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, e2, { merge: false });
-  if (e2.name) {
-    const [t2, n2] = (_a = e2.name.split(" ")) != null ? _a : [];
-    t2 && n2 && (r.entity = t2, r.action = n2);
+  const e = t2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = t2.group || "gr0up", o = t2.count || 1, r = H({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${e}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: e, timing: 3.14, group: n, count: o, version: { source: "2.0.1", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, t2, { merge: false });
+  if (t2.name) {
+    const [e2, n2] = (_a = t2.name.split(" ")) != null ? _a : [];
+    e2 && n2 && (r.entity = e2, r.action = n2);
   }
   return r;
 }
-function q(e2 = "entity action", t = {}) {
-  const n = t.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), o = { data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 } }, r = { data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 } };
-  return Z({ ...{ "cart view": { data: { currency: "EUR", value: 2 * o.data.price }, context: { shopping: ["cart", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", data: { ...o.data, quantity: 2 }, context: { shopping: ["cart", 0] }, nested: [] }], trigger: "load" }, "checkout view": { data: { step: "payment", currency: "EUR", value: o.data.price + r.data.price }, context: { shopping: ["checkout", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", ...o, context: { shopping: ["checkout", 0] }, nested: [] }, { entity: "product", ...r, context: { shopping: ["checkout", 0] }, nested: [] }], trigger: "load" }, "order complete": { data: { id: "0rd3r1d", currency: "EUR", shipping: 5.22, taxes: 73.76, total: 555 }, context: { shopping: ["complete", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", ...o, context: { shopping: ["complete", 0] }, nested: [] }, { entity: "product", ...r, context: { shopping: ["complete", 0] }, nested: [] }, { entity: "gift", data: { name: "Surprise" }, context: { shopping: ["complete", 0] }, nested: [] }], trigger: "load" }, "page view": { data: { domain: "www.example.com", title: "walkerOS documentation", referrer: "https://www.walkeros.io/", search: "?foo=bar", hash: "#hash", id: "/docs/" }, globals: { pagegroup: "docs" }, trigger: "load" }, "product add": { ...o, context: { shopping: ["intent", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "click" }, "product view": { ...o, context: { shopping: ["detail", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "load" }, "product visible": { data: { ...o.data, position: 3, promo: true }, context: { shopping: ["discover", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "load" }, "promotion visible": { data: { name: "Setting up tracking easily", position: "hero" }, context: { ab_test: ["engagement", 0] }, globals: { pagegroup: "homepage" }, trigger: "visible" }, "session start": { data: { id: "s3ss10n", start: n, isNew: true, count: 1, runs: 1, isStart: true, storage: true, referrer: "", device: "c00k13" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n", hash: "h4sh", address: "street number", email: "user@example.com", phone: "+49 123 456 789", userAgent: "Mozilla...", browser: "Chrome", browserVersion: "90", deviceType: "desktop", language: "de-DE", country: "DE", region: "HH", city: "Hamburg", zip: "20354", timezone: "Berlin", os: "walkerOS", osVersion: "1.0", screenSize: "1337x420", ip: "127.0.0.0", internal: true, custom: "value" } } }[e2], ...t, name: e2 });
+function ot(t2 = "entity action", e = {}) {
+  const n = e.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), o = { data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 } }, r = { data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 } };
+  return nt({ ...{ "cart view": { data: { currency: "EUR", value: 2 * o.data.price }, context: { shopping: ["cart", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", data: { ...o.data, quantity: 2 }, context: { shopping: ["cart", 0] }, nested: [] }], trigger: "load" }, "checkout view": { data: { step: "payment", currency: "EUR", value: o.data.price + r.data.price }, context: { shopping: ["checkout", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", ...o, context: { shopping: ["checkout", 0] }, nested: [] }, { entity: "product", ...r, context: { shopping: ["checkout", 0] }, nested: [] }], trigger: "load" }, "order complete": { data: { id: "0rd3r1d", currency: "EUR", shipping: 5.22, taxes: 73.76, total: 555 }, context: { shopping: ["complete", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", ...o, context: { shopping: ["complete", 0] }, nested: [] }, { entity: "product", ...r, context: { shopping: ["complete", 0] }, nested: [] }, { entity: "gift", data: { name: "Surprise" }, context: { shopping: ["complete", 0] }, nested: [] }], trigger: "load" }, "page view": { data: { domain: "www.example.com", title: "walkerOS documentation", referrer: "https://www.walkeros.io/", search: "?foo=bar", hash: "#hash", id: "/docs/" }, globals: { pagegroup: "docs" }, trigger: "load" }, "product add": { ...o, context: { shopping: ["intent", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "click" }, "product view": { ...o, context: { shopping: ["detail", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "load" }, "product visible": { data: { ...o.data, position: 3, promo: true }, context: { shopping: ["discover", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "load" }, "promotion visible": { data: { name: "Setting up tracking easily", position: "hero" }, context: { ab_test: ["engagement", 0] }, globals: { pagegroup: "homepage" }, trigger: "visible" }, "session start": { data: { id: "s3ss10n", start: n, isNew: true, count: 1, runs: 1, isStart: true, storage: true, referrer: "", device: "c00k13" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n", hash: "h4sh", address: "street number", email: "user@example.com", phone: "+49 123 456 789", userAgent: "Mozilla...", browser: "Chrome", browserVersion: "90", deviceType: "desktop", language: "de-DE", country: "DE", region: "HH", city: "Hamburg", zip: "20354", timezone: "Berlin", os: "walkerOS", osVersion: "1.0", screenSize: "1337x420", ip: "127.0.0.0", internal: true, custom: "value" } } }[t2], ...e, name: t2 });
 }
 
-// src/examples/events.ts
-function ga4Purchase() {
-  const event = q("order complete");
-  return [
-    "event",
-    "purchase",
-    {
-      transaction_id: event.data.id,
-      value: event.data.total,
-      tax: event.data.taxes,
-      shipping: event.data.shipping,
-      currency: "EUR",
-      items: event.nested.filter((item) => item.entity === "product").map((item) => ({
-        item_id: item.data.id,
-        item_name: item.data.name,
-        quantity: 1
-      })),
-      send_to: "G-XXXXXX-1"
+// src/examples/step.ts
+var purchase = {
+  in: ot("order complete", { timestamp: 1700000100 }),
+  mapping: {
+    name: "purchase",
+    settings: {
+      ga4: {
+        include: ["data", "context"]
+      }
+    },
+    data: {
+      map: {
+        transaction_id: "data.id",
+        value: "data.total",
+        tax: "data.taxes",
+        shipping: "data.shipping",
+        currency: { key: "data.currency", value: "EUR" },
+        items: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => Z(entity) && entity.entity === "product",
+              map: {
+                item_id: "data.id",
+                item_name: "data.name",
+                quantity: { key: "data.quantity", value: 1 }
+              }
+            }
+          ]
+        }
+      }
     }
-  ];
-}
-function ga4AddToCart() {
-  const event = q("product add");
-  return [
+  },
+  out: [
     "event",
-    "add_to_cart",
+    "purchase",
     {
+      transaction_id: "0rd3r1d",
+      value: 555,
+      tax: 73.76,
+      shipping: 5.22,
       currency: "EUR",
-      value: event.data.price,
       items: [
-        {
-          item_id: event.data.id,
-          item_variant: event.data.color,
-          quantity: 1
-        }
+        { item_id: "ers", item_name: "Everyday Ruck Snack", quantity: 1 },
+        { item_id: "cc", item_name: "Cool Cap", quantity: 1 }
       ],
       send_to: "G-XXXXXX-1"
     }
-  ];
-}
-function adsConversion() {
-  const event = q("order complete");
-  return [
-    "event",
-    "conversion",
-    {
-      send_to: "AW-XXXXXXXXX/CONVERSION_LABEL",
-      currency: "EUR",
-      value: event.data.total,
-      transaction_id: event.data.id
-    }
-  ];
-}
-function gtmEvent() {
-  const event = q("product view");
-  return {
-    event: "product_view",
-    product_id: event.data.id,
-    product_name: event.data.name,
-    product_category: event.data.category,
-    value: event.data.price,
-    currency: "EUR"
-  };
-}
-
-// src/examples/mapping.ts
-var mapping_exports = {};
-__export(mapping_exports, {
-  adsConversion: () => adsConversion2,
-  combinedPurchase: () => combinedPurchase,
-  config: () => config,
-  ga4AddToCart: () => ga4AddToCart2,
-  ga4Purchase: () => ga4Purchase2,
-  gtmProductView: () => gtmProductView
-});
-var ga4Purchase2 = {
-  name: "purchase",
-  settings: {
-    ga4: {
-      include: ["data", "context"]
-    }
-  },
-  data: {
-    map: {
-      transaction_id: "data.id",
-      value: "data.total",
-      tax: "data.taxes",
-      shipping: "data.shipping",
-      currency: { key: "data.currency", value: "EUR" },
-      items: {
-        loop: [
-          "nested",
-          {
-            condition: (entity) => D(entity) && entity.entity === "product",
-            map: {
-              item_id: "data.id",
-              item_name: "data.name",
-              quantity: { key: "data.quantity", value: 1 }
-            }
-          }
-        ]
-      }
-    }
-  }
+  ]
 };
-var ga4AddToCart2 = {
-  name: "add_to_cart",
-  settings: {
-    ga4: {
-      include: ["data"]
-    }
-  },
-  data: {
-    map: {
-      currency: { value: "EUR", key: "data.currency" },
-      value: "data.price",
-      items: {
-        loop: [
-          "this",
-          {
-            map: {
-              item_id: "data.id",
-              item_variant: "data.color",
-              quantity: { value: 1, key: "data.quantity" }
-            }
-          }
-        ]
+var addToCart = {
+  in: ot("product add", { timestamp: 1700000101 }),
+  mapping: {
+    name: "add_to_cart",
+    settings: {
+      ga4: {
+        include: ["data"]
       }
-    }
-  }
-};
-var adsConversion2 = {
-  name: "CONVERSION_LABEL",
-  // This becomes the conversion label
-  settings: {
-    ads: {}
-  },
-  data: {
-    map: {
-      value: "data.total",
-      currency: { value: "EUR", key: "data.currency" },
-      transaction_id: "data.id"
-    }
-  }
-};
-var gtmProductView = {
-  name: "product_view",
-  settings: {
-    gtm: {}
-  },
-  data: {
-    map: {
-      product_id: "data.id",
-      product_name: "data.name",
-      product_category: "data.category",
-      value: "data.price",
-      currency: { value: "EUR", key: "data.currency" }
-    }
-  }
-};
-var combinedPurchase = {
-  name: "purchase",
-  // GA4 event name
-  settings: {
-    ga4: {
-      include: ["data"]
     },
-    ads: {},
-    // Will use 'purchase' as conversion label for ads
-    gtm: {}
-  },
-  data: {
-    map: {
-      transaction_id: "data.id",
-      value: "data.total",
-      currency: { value: "EUR", key: "data.currency" },
-      items: {
-        loop: [
-          "nested",
-          {
-            condition: (entity) => D(entity) && entity.entity === "product",
-            map: {
-              item_id: "data.id",
-              item_name: "data.name",
-              quantity: { value: 1, key: "data.quantity" }
+    data: {
+      map: {
+        currency: { value: "EUR", key: "data.currency" },
+        value: "data.price",
+        items: {
+          loop: [
+            "this",
+            {
+              map: {
+                item_id: "data.id",
+                item_variant: "data.color",
+                quantity: { value: 1, key: "data.quantity" }
+              }
             }
-          }
-        ]
+          ]
+        }
       }
     }
-  }
+  },
+  out: [
+    "event",
+    "add_to_cart",
+    {
+      currency: "EUR",
+      value: 420,
+      items: [{ item_id: "ers", item_variant: "black", quantity: 1 }],
+      send_to: "G-XXXXXX-1"
+    }
+  ]
 };
-var config = {
-  order: { complete: combinedPurchase },
-  product: {
-    add: ga4AddToCart2,
-    view: gtmProductView
-  }
+var pageView = {
+  in: ot("page view", { timestamp: 1700000102 }),
+  mapping: void 0,
+  out: ["event", "page_view", { send_to: "G-XXXXXX-1" }]
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   env,
-  events,
-  mapping
+  step
 });