@blotoutio/edgetag-sdk-browser 1.53.1 → 1.54.0

package/index.js

@@ -98,6 +98,40 @@
         return map.set(key, update(currentValue));
     };
 
+    /**
+     * Known ad-network click ID query parameters and the human-readable provider
+     * label each one maps to. Used by the CDN worker to resolve `inSessionTouch`
+     * and by the analytics API to classify paid-media touch sessions.
+     *
+     * Keep this list in sync with `defaultParams` in queryParams.ts when new
+     * click ID providers are added.
+     */
+    const CLICK_IDS = [
+        { param: 'fbclid', label: 'Facebook' }, // Facebook Ads
+        { param: 'gclid', label: 'Google' }, // Google Ads (click)
+        { param: 'gbraid', label: 'Google' }, // Google Ads (iOS app)
+        { param: 'wbraid', label: 'Google' }, // Google Ads (iOS web)
+        { param: 'msclkid', label: 'Bing' }, // Microsoft Bing Ads
+        { param: 'ttclid', label: 'TikTok' }, // TikTok Ads
+        { param: 'ScCid', label: 'Snapchat' }, // Snapchat Ads
+        { param: 'epik', label: 'Pinterest' }, // Pinterest Ads
+        { param: 'li_fat_id', label: 'LinkedIn' }, // LinkedIn Ads
+        { param: 'twclid', label: 'Twitter' }, // X (Twitter) Ads
+        { param: 'rdt_cid', label: 'Reddit' }, // Reddit Ads
+        { param: 'aleid', label: 'AppLovin' }, // AppLovin
+        { param: 'tabclid', label: 'Taboola' }, // Taboola
+        { param: 'obclid', label: 'Outbrain' }, // Outbrain
+        { param: 'trybe', label: 'Trybe' }, // Trybe
+        { param: '_kx', label: 'Klaviyo' }, // Klaviyo email campaigns
+        { param: 'mc_eid', label: 'Mailchimp' }, // Mailchimp email campaigns
+        { param: 'ttd_id', label: 'The Trade Desk' }, // The Trade Desk programmatic
+        { param: 'evsclid', label: 'EvoSearch' }, // EvoSearch
+        { param: 'li_did', label: 'Live Intent' }, // LiveIntent device-level ad
+        { param: '_raclid', label: 'Rumble' }, // Rumble Ads
+        { param: 'ref_id', label: 'StackAdapt' }, // StackAdapt programmatic
+        { param: 'duel_a', label: 'Duel' }, // Duel referral/advocacy
+    ];
+
     const expand = (str) => str.split(',').flatMap((entry) => {
         if (!entry.includes('-')) {
             return entry;
@@ -829,6 +863,127 @@
      */
     const jsonClone = (json) => tryParse(JSON.stringify(json), undefined);
 
+    /**
+     * Exact utm_source normalization (lowercase key → canonical name).
+     *
+     * Use exact match when the key is short, generic, or must not accidentally
+     * absorb variant spellings (e.g. "impact" must not match "impact_radius").
+     *
+     * Ordering: Paid (search/social → ad networks → affiliates) →
+     *           Organic (AI/discovery) → Retention (email → SMS → push → post-purchase)
+     */
+    const UTM_SOURCE_EXACT = {
+        // ── Paid – Search & Social ────────────────────────────────────────────────
+        google: 'Google',
+        adwords: 'Google',
+        youtube: 'Google',
+        yt: 'Google',
+        meta: 'Facebook',
+        facebook: 'Facebook',
+        instagram: 'Facebook',
+        ig: 'Facebook',
+        igshopping: 'Facebook',
+        threads: 'Facebook',
+        twitter: 'Twitter',
+        snapchat: 'Snapchat',
+        pinterest: 'Pinterest',
+        bing: 'Bing',
+        microsoft: 'Bing',
+        tiktok: 'TikTok',
+        // ── Paid – Ad Networks ───────────────────────────────────────────────────
+        rtbhouse: 'RTB House',
+        applovin: 'AppLovin',
+        ttd: 'The Trade Desk',
+        amazondsp: 'Amazon DSP',
+        axon: 'Axon',
+        duel: 'Duel',
+        // ── Paid – Affiliates ────────────────────────────────────────────────────
+        awin: 'Awin',
+        'affiliate-cj': 'CJ Affiliate',
+        impact: 'Impact',
+        rakuten: 'Rakuten',
+        superfiliate: 'Superfiliate',
+        // ── Organic – AI & Discovery ─────────────────────────────────────────────
+        perplexity: 'Perplexity',
+        chatgpt: 'ChatGPT',
+        'chatgpt.com': 'ChatGPT',
+        openai: 'ChatGPT',
+        'copilot.com': 'Microsoft Copilot',
+        copilot: 'Microsoft Copilot',
+        applenews: 'Apple News',
+        whatsapp: 'WhatsApp',
+        podcast: 'Podcast',
+        // ── Retention – Email ────────────────────────────────────────────────────
+        mailchimp: 'Mailchimp',
+        omnisend: 'Omnisend',
+        iterable: 'Iterable',
+        listrak: 'Listrak',
+        sailthru: 'Sailthru',
+        // ── Retention – Push ─────────────────────────────────────────────────────
+        pushowl: 'PushOwl',
+        // ── Retention – Post-purchase / Payment ──────────────────────────────────
+        narvar: 'Narvar',
+        shop_app: 'Shop App',
+        salesforce: 'Salesforce',
+        yotpo: 'Yotpo',
+    };
+    /**
+     * Partial utm_source normalization (startsWith prefix check, lowercase).
+     *
+     * Checked after exact match so short exact keys (e.g. "ig", "yt") win first.
+     */
+    const UTM_SOURCE_PARTIAL = [
+        // ── Paid – Social ─────────────────────────────────────────────────────────
+        { prefix: 'tiktok', name: 'TikTok' },
+        // ── Paid – Ad Networks ───────────────────────────────────────────────────
+        { prefix: 'criteo', name: 'Criteo' },
+        // ── Retention – Email ────────────────────────────────────────────────────
+        { prefix: 'klaviyo', name: 'Klaviyo' },
+        // ── Retention – SMS ──────────────────────────────────────────────────────
+        { prefix: 'attentive', name: 'Attentive' },
+        { prefix: 'postscript', name: 'Postscript' },
+        // ── Retention – Post-purchase / Payment ──────────────────────────────────
+        { prefix: 'afterpay', name: 'Afterpay' },
+        { prefix: 'klarna', name: 'Klarna' },
+    ];
+    const ORGANIC_SEARCH_ENGINES = [
+        { match: 'google', name: 'Google' },
+        { match: 'bing', name: 'Bing' },
+        { match: 'yahoo', name: 'Yahoo' },
+        { match: 'duckduckgo', name: 'DuckDuckGo' },
+        { match: 'baidu', name: 'Baidu' },
+        { match: 'yandex', name: 'Yandex' },
+        { match: 'brave', name: 'Brave' },
+    ];
+    const KNOWN_REFERRAL_PLATFORMS = [
+        { match: 'facebook', name: 'Facebook' },
+        { match: 'instagram', name: 'Facebook' },
+        { match: 'twitter', name: 'Twitter' },
+        { match: 'x.com', name: 'Twitter' },
+        { match: 'tiktok', name: 'TikTok' },
+        { match: 'pinterest', name: 'Pinterest' },
+        { match: 'linkedin', name: 'LinkedIn' },
+        { match: 'youtube', name: 'YouTube' },
+        { match: 'chatgpt', name: 'ChatGPT' },
+        { match: 'claude', name: 'Claude' },
+        { match: 'perplexity', name: 'Perplexity' },
+        { match: 'shop.app', name: 'Shop App' },
+        { match: 'amazon', name: 'Amazon' },
+        { match: 'attentive', name: 'Attentive' },
+    ];
+    const OFFLINE_TOUCH = 'Blotout_Offline';
+    new Set([
+        ...CLICK_IDS.map((c) => c.label),
+        ...Object.values(UTM_SOURCE_EXACT),
+        ...UTM_SOURCE_PARTIAL.map((e) => e.name),
+        ...ORGANIC_SEARCH_ENGINES.map((e) => `Organic Search - ${e.name}`),
+        ...KNOWN_REFERRAL_PLATFORMS.map((e) => `Referral - ${e.name}`),
+        'Referral - Other',
+        'Direct Traffic',
+        'Other',
+        OFFLINE_TOUCH,
+    ]);
+
     // eslint-disable-next-line @nx/enforce-module-boundaries
     const getGlobalSettings = () => {
         var _a;
@@ -1311,7 +1466,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "1.53.1" ,
+            sdkVersion: "1.54.0" ,
             ...(payload || {}),
         };
         let storage = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/edgetag-sdk-browser",
-  "version": "1.53.1",
+  "version": "1.54.0",
   "description": "Browser SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",