@walkeros/web-destination-matomo 3.4.0-next-1776749829492

package/dist/examples/index.js

@@ -0,0 +1,310 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  env: () => env_exports,
+  step: () => step_exports
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  init: () => init,
+  push: () => push,
+  simulation: () => simulation
+});
+var init = {
+  window: {
+    _paq: void 0,
+    location: { href: "https://www.example.com/page" }
+  },
+  document: {
+    createElement: () => ({
+      type: "",
+      src: "",
+      async: false,
+      defer: false
+    }),
+    head: { appendChild: () => {
+    } }
+  }
+};
+var push = {
+  window: {
+    _paq: [],
+    location: { href: "https://www.example.com/page" }
+  },
+  document: {
+    createElement: () => ({
+      type: "",
+      src: "",
+      async: false,
+      defer: false
+    }),
+    head: { appendChild: () => {
+    } }
+  }
+};
+var simulation = [
+  "call:window._paq.push"
+  // Track _paq.push calls
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  customEvent: () => customEvent,
+  ecommerceCartUpdate: () => ecommerceCartUpdate,
+  ecommerceOrder: () => ecommerceOrder,
+  goalTracking: () => goalTracking,
+  init: () => init2,
+  pageView: () => pageView,
+  productDetailView: () => productDetailView,
+  siteSearch: () => siteSearch
+});
+var import_core = require("@walkeros/core");
+var init2 = {
+  in: {
+    loadScript: true,
+    settings: {
+      siteId: "1",
+      url: "https://analytics.example.com/"
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      ["setTrackerUrl", "https://analytics.example.com/matomo.php"]
+    ],
+    ["_paq.push", ["setSiteId", "1"]],
+    ["_paq.push", ["enableLinkTracking"]]
+  ]
+};
+var pageView = {
+  in: (0, import_core.getEvent)("page view", { timestamp: 1700000400 }),
+  mapping: {
+    data: "data.title"
+  },
+  out: [["_paq.push", ["trackPageView", "walkerOS documentation"]]]
+};
+var customEvent = {
+  in: (0, import_core.getEvent)("promotion visible", { timestamp: 1700000401 }),
+  mapping: {
+    name: "trackEvent",
+    settings: {
+      goalId: "goal_1"
+    },
+    data: {
+      set: ["data.name", "data.position"]
+    }
+  },
+  out: [
+    ["_paq.push", ["trackEvent", "Setting up tracking easily", "hero"]],
+    ["_paq.push", ["trackGoal", "goal_1", void 0]]
+  ]
+};
+var ecommerceOrder = {
+  in: (0, import_core.getEvent)("order complete", { timestamp: 1700000402 }),
+  mapping: {
+    name: "trackEcommerceOrder",
+    data: {
+      set: [
+        {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                sku: "data.id",
+                name: "data.name",
+                category: { value: "" },
+                price: "data.price",
+                quantity: { value: 1 }
+              }
+            }
+          ]
+        },
+        {
+          map: {
+            orderId: "data.id",
+            grandTotal: "data.total",
+            tax: "data.taxes",
+            shipping: "data.shipping"
+          }
+        }
+      ]
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      [
+        "trackEcommerceOrder",
+        [
+          {
+            sku: "ers",
+            name: "Everyday Ruck Snack",
+            category: "",
+            price: 420,
+            quantity: 1
+          },
+          {
+            sku: "cc",
+            name: "Cool Cap",
+            category: "",
+            price: 42,
+            quantity: 1
+          }
+        ],
+        {
+          orderId: "0rd3r1d",
+          grandTotal: 555,
+          tax: 73.76,
+          shipping: 5.22
+        }
+      ]
+    ]
+  ]
+};
+var ecommerceCartUpdate = {
+  in: (0, import_core.getEvent)("cart view", { timestamp: 1700000403 }),
+  mapping: {
+    name: "trackEcommerceCartUpdate",
+    data: {
+      set: [
+        {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                sku: "data.id",
+                name: "data.name",
+                category: { value: "" },
+                price: "data.price",
+                quantity: { value: 1 }
+              }
+            }
+          ]
+        },
+        "data.value"
+      ]
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      [
+        "trackEcommerceCartUpdate",
+        [
+          {
+            sku: "ers",
+            name: "Everyday Ruck Snack",
+            category: "",
+            price: 420,
+            quantity: 1
+          }
+        ],
+        840
+      ]
+    ]
+  ]
+};
+var productDetailView = {
+  in: (0, import_core.getEvent)("product view", { timestamp: 1700000404 }),
+  mapping: {
+    name: "ecommerceProductDetailView",
+    data: {
+      set: [
+        {
+          set: [
+            {
+              map: {
+                sku: "data.id",
+                name: "data.name",
+                price: "data.price",
+                quantity: { value: 1 }
+              }
+            }
+          ]
+        }
+      ]
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      [
+        "ecommerceProductDetailView",
+        [
+          {
+            sku: "ers",
+            name: "Everyday Ruck Snack",
+            price: 420,
+            quantity: 1
+          }
+        ]
+      ]
+    ]
+  ]
+};
+var siteSearch = {
+  in: (0, import_core.getEvent)("search submit", {
+    timestamp: 1700000405,
+    data: { query: "shoes", category: "products", resultsCount: 42 }
+  }),
+  mapping: {
+    name: "trackSiteSearch",
+    settings: {
+      siteSearch: true
+    },
+    data: {
+      set: ["data.query", "data.category", "data.resultsCount"]
+    }
+  },
+  out: [["_paq.push", ["trackSiteSearch", "shoes", "products", 42]]]
+};
+var goalTracking = {
+  in: (0, import_core.getEvent)("promotion visible", {
+    timestamp: 1700000406,
+    data: { name: "Setting up tracking easily", position: "hero", value: 50 }
+  }),
+  mapping: {
+    name: "trackEvent",
+    settings: {
+      goalId: "1",
+      goalValue: "data.value"
+    },
+    data: {
+      set: ["data.name"]
+    }
+  },
+  out: [
+    ["_paq.push", ["trackEvent", "Setting up tracking easily"]],
+    ["_paq.push", ["trackGoal", "1", 50]]
+  ]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});

package/dist/examples/index.mjs

@@ -0,0 +1,288 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  init: () => init,
+  push: () => push,
+  simulation: () => simulation
+});
+var init = {
+  window: {
+    _paq: void 0,
+    location: { href: "https://www.example.com/page" }
+  },
+  document: {
+    createElement: () => ({
+      type: "",
+      src: "",
+      async: false,
+      defer: false
+    }),
+    head: { appendChild: () => {
+    } }
+  }
+};
+var push = {
+  window: {
+    _paq: [],
+    location: { href: "https://www.example.com/page" }
+  },
+  document: {
+    createElement: () => ({
+      type: "",
+      src: "",
+      async: false,
+      defer: false
+    }),
+    head: { appendChild: () => {
+    } }
+  }
+};
+var simulation = [
+  "call:window._paq.push"
+  // Track _paq.push calls
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  customEvent: () => customEvent,
+  ecommerceCartUpdate: () => ecommerceCartUpdate,
+  ecommerceOrder: () => ecommerceOrder,
+  goalTracking: () => goalTracking,
+  init: () => init2,
+  pageView: () => pageView,
+  productDetailView: () => productDetailView,
+  siteSearch: () => siteSearch
+});
+import { getEvent, isObject } from "@walkeros/core";
+var init2 = {
+  in: {
+    loadScript: true,
+    settings: {
+      siteId: "1",
+      url: "https://analytics.example.com/"
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      ["setTrackerUrl", "https://analytics.example.com/matomo.php"]
+    ],
+    ["_paq.push", ["setSiteId", "1"]],
+    ["_paq.push", ["enableLinkTracking"]]
+  ]
+};
+var pageView = {
+  in: getEvent("page view", { timestamp: 1700000400 }),
+  mapping: {
+    data: "data.title"
+  },
+  out: [["_paq.push", ["trackPageView", "walkerOS documentation"]]]
+};
+var customEvent = {
+  in: getEvent("promotion visible", { timestamp: 1700000401 }),
+  mapping: {
+    name: "trackEvent",
+    settings: {
+      goalId: "goal_1"
+    },
+    data: {
+      set: ["data.name", "data.position"]
+    }
+  },
+  out: [
+    ["_paq.push", ["trackEvent", "Setting up tracking easily", "hero"]],
+    ["_paq.push", ["trackGoal", "goal_1", void 0]]
+  ]
+};
+var ecommerceOrder = {
+  in: getEvent("order complete", { timestamp: 1700000402 }),
+  mapping: {
+    name: "trackEcommerceOrder",
+    data: {
+      set: [
+        {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                sku: "data.id",
+                name: "data.name",
+                category: { value: "" },
+                price: "data.price",
+                quantity: { value: 1 }
+              }
+            }
+          ]
+        },
+        {
+          map: {
+            orderId: "data.id",
+            grandTotal: "data.total",
+            tax: "data.taxes",
+            shipping: "data.shipping"
+          }
+        }
+      ]
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      [
+        "trackEcommerceOrder",
+        [
+          {
+            sku: "ers",
+            name: "Everyday Ruck Snack",
+            category: "",
+            price: 420,
+            quantity: 1
+          },
+          {
+            sku: "cc",
+            name: "Cool Cap",
+            category: "",
+            price: 42,
+            quantity: 1
+          }
+        ],
+        {
+          orderId: "0rd3r1d",
+          grandTotal: 555,
+          tax: 73.76,
+          shipping: 5.22
+        }
+      ]
+    ]
+  ]
+};
+var ecommerceCartUpdate = {
+  in: getEvent("cart view", { timestamp: 1700000403 }),
+  mapping: {
+    name: "trackEcommerceCartUpdate",
+    data: {
+      set: [
+        {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                sku: "data.id",
+                name: "data.name",
+                category: { value: "" },
+                price: "data.price",
+                quantity: { value: 1 }
+              }
+            }
+          ]
+        },
+        "data.value"
+      ]
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      [
+        "trackEcommerceCartUpdate",
+        [
+          {
+            sku: "ers",
+            name: "Everyday Ruck Snack",
+            category: "",
+            price: 420,
+            quantity: 1
+          }
+        ],
+        840
+      ]
+    ]
+  ]
+};
+var productDetailView = {
+  in: getEvent("product view", { timestamp: 1700000404 }),
+  mapping: {
+    name: "ecommerceProductDetailView",
+    data: {
+      set: [
+        {
+          set: [
+            {
+              map: {
+                sku: "data.id",
+                name: "data.name",
+                price: "data.price",
+                quantity: { value: 1 }
+              }
+            }
+          ]
+        }
+      ]
+    }
+  },
+  out: [
+    [
+      "_paq.push",
+      [
+        "ecommerceProductDetailView",
+        [
+          {
+            sku: "ers",
+            name: "Everyday Ruck Snack",
+            price: 420,
+            quantity: 1
+          }
+        ]
+      ]
+    ]
+  ]
+};
+var siteSearch = {
+  in: getEvent("search submit", {
+    timestamp: 1700000405,
+    data: { query: "shoes", category: "products", resultsCount: 42 }
+  }),
+  mapping: {
+    name: "trackSiteSearch",
+    settings: {
+      siteSearch: true
+    },
+    data: {
+      set: ["data.query", "data.category", "data.resultsCount"]
+    }
+  },
+  out: [["_paq.push", ["trackSiteSearch", "shoes", "products", 42]]]
+};
+var goalTracking = {
+  in: getEvent("promotion visible", {
+    timestamp: 1700000406,
+    data: { name: "Setting up tracking easily", position: "hero", value: 50 }
+  }),
+  mapping: {
+    name: "trackEvent",
+    settings: {
+      goalId: "1",
+      goalValue: "data.value"
+    },
+    data: {
+      set: ["data.name"]
+    }
+  },
+  out: [
+    ["_paq.push", ["trackEvent", "Setting up tracking easily"]],
+    ["_paq.push", ["trackGoal", "1", 50]]
+  ]
+};
+export {
+  env_exports as env,
+  step_exports as step
+};

package/dist/index.browser.js

@@ -0,0 +1 @@
+"use strict";var Destination=(()=>{var e=Object.defineProperty,t=Object.getOwnPropertyDescriptor,n=Object.getOwnPropertyNames,o=Object.prototype.hasOwnProperty,i={};((t,n)=>{for(var o in n)e(t,o,{get:n[o],enumerable:!0})})(i,{DestinationMatomo:()=>g,default:()=>h,destinationMatomo:()=>O});var r=Object.defineProperty;((e,t)=>{for(var n in t)r(e,n,{get:t[n],enumerable:!0})})({},{Level:()=>s});var a,s=((a=s||{})[a.ERROR=0]="ERROR",a[a.WARN=1]="WARN",a[a.INFO=2]="INFO",a[a.DEBUG=3]="DEBUG",a);function c(e){return Array.isArray(e)}function u(e){return void 0!==e}function l(e){return"object"==typeof e&&null!==e&&!c(e)&&"[object Object]"===Object.prototype.toString.call(e)}function f(e){return"string"==typeof e}function d(e,t="",n){const o=t.split(".");let i=e;for(let e=0;e<o.length;e++){const t=o[e];if("*"===t&&c(i)){const t=o.slice(e+1).join("."),r=[];for(const e of i){const o=d(e,t,n);r.push(o)}return r}if(i=i instanceof Object?i[t]:void 0,void 0===i)break}return u(i)?i:n}function m(e){return function(e){return"boolean"==typeof e}(e)||f(e)||function(e){return"number"==typeof e&&!Number.isNaN(e)}(e)||!u(e)||c(e)&&e.every(m)||l(e)&&Object.values(e).every(m)}function p(e){return m(e)?e:void 0}function b(e,t,n){return async function(...o){try{return await e(...o)}catch(e){if(!t)return;return await t(e)}finally{await(null==n?void 0:n())}}}async function v(e,t={},n={}){var o;if(!u(e))return;const i=l(e)&&e.consent||n.consent||(null==(o=n.collector)?void 0:o.consent),r=c(t)?t:[t];for(const t of r){const o=await b(w)(e,t,{...n,consent:i});if(u(o))return o}}async function w(e,t,n={}){const{collector:o,consent:i}=n;return(c(t)?t:[t]).reduce(async(t,r)=>{const a=await t;if(a)return a;const s=f(r)?{key:r}:r;if(!Object.keys(s).length)return;const{condition:l,consent:m,fn:y,key:g,loop:O,map:j,set:h,validate:k,value:D}=s;if(l&&!await b(l)(e,r,o))return;if(m&&!function(e,t={},n={}){const o={...t,...n},i={};let r=!e||0===Object.keys(e).length;return Object.keys(o).forEach(t=>{o[t]&&(i[t]=!0,e&&e[t]&&(r=!0))}),!!r&&i}(m,i))return D;let I=u(D)?D:e;if(y&&(I=await b(y)(e,r,n)),g&&(I=d(e,g,D)),O){const[t,o]=O,i="this"===t?[e]:await v(e,t,n);c(i)&&(I=(await Promise.all(i.map(e=>v(e,o,n)))).filter(u))}else j?I=await Object.entries(j).reduce(async(t,[o,i])=>{const r=await t,a=await v(e,i,n);return u(a)&&(r[o]=a),r},Promise.resolve({})):h&&(I=await Promise.all(h.map(t=>w(e,t,n))));k&&!await b(k)(I)&&(I=void 0);const N=p(I);return u(N)?N:p(D)},Promise.resolve(void 0))}function y(e){return{window:"undefined"!=typeof window?window:globalThis.window,document:"undefined"!=typeof document?document:globalThis.document,...e}}var g={},O={type:"matomo",config:{},init({config:e,env:t,logger:n}){const{window:o}=y(t),i=o,{settings:r,loadScript:a}=e,{siteId:s,url:c}=r||{};s||n.throw("Config settings siteId missing"),c||n.throw("Config settings url missing"),i._paq=i._paq||[];const u=i._paq.push.bind(i._paq);if(a&&(!function(e,t){const{document:n}=y(t),o=n,i=o.createElement("script");i.type="text/javascript",i.src=e+"matomo.js",i.async=!0,i.defer=!0,o.head.appendChild(i)}(c,t),u(["setTrackerUrl",c+"matomo.php"]),u(["setSiteId",s])),(null==r?void 0:r.disableCookies)&&u(["disableCookies"]),!1!==(null==r?void 0:r.enableLinkTracking)&&u(["enableLinkTracking"]),(null==r?void 0:r.enableHeartBeatTimer)&&u(["enableHeartBeatTimer",r.enableHeartBeatTimer]),null==r?void 0:r.customDimensions)for(const[e,t]of Object.entries(r.customDimensions))u(["setCustomDimension",Number(e),t])},async push(e,{rule:t={},data:n,env:o}){const{window:i}=y(o),r=i,a=r._paq.push.bind(r._paq),s=t.settings||{};if("page view"===e.name&&!t.settings)return void a(["trackPageView",await v(e,"data.title")]);const u=c(n)?n:[n];if(s.siteSearch)a(["trackSiteSearch",...u]);else if(s.contentImpression)a(["trackContentImpression",...u]);else if(s.contentInteraction)a(["trackContentInteraction",...u]);else{if(s.customDimensions)for(const[t,n]of Object.entries(s.customDimensions)){const o=await v(e,n);void 0!==o&&a(["setCustomDimension",Number(t),o])}if(a([e.name,...u]),s.goalId){const t=s.goalValue?await v(e,s.goalValue):void 0;a(["trackGoal",s.goalId,t])}}}};var j,h=O;return j=i,((i,r,a,s)=>{if(r&&"object"==typeof r||"function"==typeof r)for(let c of n(r))o.call(i,c)||c===a||e(i,c,{get:()=>r[c],enumerable:!(s=t(r,c))||s.enumerable});return i})(e({},"__esModule",{value:!0}),j)})();

package/dist/index.d.mts

@@ -0,0 +1,78 @@
+import { Destination as Destination$1, Mapping as Mapping$1 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare global {
+    interface Window {
+        _paq?: Array<unknown>;
+    }
+}
+interface Settings {
+    /** Matomo Site ID (required). */
+    siteId: string;
+    /** Base URL of Matomo instance, e.g. https://analytics.example.com/ (required). */
+    url: string;
+    /** Disable all tracking cookies for cookie-free analytics. */
+    disableCookies?: boolean;
+    /** Enable automatic outlink and download tracking. Default: true. */
+    enableLinkTracking?: boolean;
+    /** Enable heart beat timer with interval in seconds for accurate time-on-page. */
+    enableHeartBeatTimer?: number;
+    /** Custom dimensions applied to all events. Keys are dimension IDs, values are property paths. */
+    customDimensions?: Record<string, string>;
+}
+type InitSettings = Partial<Settings>;
+interface Mapping {
+    /** Goal ID to track a conversion alongside this event. */
+    goalId?: string;
+    /** Property path for goal revenue value (e.g. data.revenue). */
+    goalValue?: string;
+    /** Track as internal site search via trackSiteSearch. */
+    siteSearch?: boolean;
+    /** Track as content impression via trackContentImpression. */
+    contentImpression?: boolean;
+    /** Track as content interaction via trackContentInteraction. */
+    contentInteraction?: boolean;
+    /** Per-event custom dimensions. Keys are dimension IDs, values are property paths. */
+    customDimensions?: Record<string, string>;
+}
+interface Env extends DestinationWeb.Env {
+    window: {
+        _paq: Array<unknown>;
+        location?: {
+            href?: string;
+        };
+    };
+    document: {
+        createElement: (tagName: string) => {
+            type: string;
+            src: string;
+            async?: boolean;
+            defer?: boolean;
+        };
+        head: {
+            appendChild: (node: unknown) => void;
+        };
+    };
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+type Destination = DestinationWeb.Destination<Types>;
+type Config = DestinationWeb.Config<Types>;
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+
+type index_Config = Config;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_Destination as Destination, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_Rule as Rule, index_Rules as Rules, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationMatomo: Destination;
+
+export { index as DestinationMatomo, destinationMatomo as default, destinationMatomo };