@blotoutio/edgetag-sdk-browser 1.72.0 → 1.74.0

package/index.js

@@ -1498,7 +1498,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "1.72.0" ,
+            sdkVersion: "1.74.0" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -1620,6 +1620,216 @@
         });
     };
 
+    const processData = (destination, data, providers, options) => {
+        saveKV(destination, data);
+        updateUserProperties(destination, data);
+        const providerPackages = getSetting(destination, 'browserPackages');
+        const configuredTags = getSetting(destination, 'channels');
+        const userId = getUserId$1(destination);
+        const requestCountry = getSetting(destination, 'geoCountry') || null;
+        const requestRegion = getSetting(destination, 'geoRegion') || null;
+        const isEURequest = getSetting(destination, 'isEURequest') || false;
+        const consentChannel = getConsent$1(destination);
+        const consentCategory = getConsentCategories(destination);
+        const consentSettings = getSetting(destination, 'consentSetting');
+        const userConsent = { consentChannel, consentCategory, consentSettings };
+        for (const pkg of providerPackages) {
+            if (!pkg || !pkg.user || !pkg.name) {
+                continue;
+            }
+            if (!configuredTags.has(pkg.name)) {
+                logger.log(`Provider ${pkg.name} is not in allow list`);
+                continue;
+            }
+            const variables = getProviderVariables(destination, pkg.name);
+            for (const variable of variables) {
+                if (!isProviderInstanceAllowed(providers, pkg.name, variable.tagName)) {
+                    logger.log(`Data not allowed for ${pkg.name} (${variable.tagName})`);
+                    continue;
+                }
+                if (!hasUserConsent(userConsent, pkg.name, variable.tagName)) {
+                    logger.log(`Consent is missing for ${pkg.name} (${variable.tagName})`);
+                    continue;
+                }
+                if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
+                    logger.log(`GEO request region does not match list, skipping`);
+                    continue;
+                }
+                pkg.user({
+                    userId,
+                    data,
+                    manifestVariables: variable.variableSet,
+                    destination,
+                });
+            }
+        }
+        postRequest(getDataURL(destination), { data, providers }, options).catch(logger.error);
+    };
+    const handleData = (data, providers, options) => {
+        if (!data || Object.keys(data).length === 0) {
+            logger.error('Provide data for data API.');
+            return;
+        }
+        if (options === null || options === void 0 ? void 0 : options.destination) {
+            processData(options.destination, data, providers, options);
+            return;
+        }
+        getInstances().forEach((destination) => {
+            processData(destination, data, providers, options);
+        });
+    };
+
+    const cacheKey = `${keyPrefix}Cache`;
+    const identity = (v) => v;
+    const saveDataToEdge = (destination, key, value, provider) => {
+        if (!value) {
+            return;
+        }
+        let updatedValue = value;
+        if (typeof value !== 'string') {
+            try {
+                updatedValue = JSON.stringify(value);
+            }
+            catch {
+                logger.log('Error stringify value.');
+                return;
+            }
+        }
+        handleData({ [`${provider}::${key}`]: updatedValue }, undefined, {
+            destination,
+        });
+    };
+    const handleCaptureQuery = (destination, provider, key, persistType, map) => {
+        try {
+            if (!window) {
+                return;
+            }
+        }
+        catch {
+            return;
+        }
+        const params = new URLSearchParams(getSearch(destination));
+        if (!params || !params.get(key)) {
+            return;
+        }
+        const data = (map !== null && map !== void 0 ? map : identity)(params.get(key));
+        if (!data) {
+            return;
+        }
+        if (persistType === 'edge') {
+            saveDataToEdge(destination, key, data, provider);
+            return;
+        }
+        saveDataPerKey(destination, persistType, provider, data, key);
+    };
+    const getFromCache = (destination, persistType, provider, key) => {
+        var _a;
+        const type = persistType === 'edge' ? 'local' : persistType;
+        const cache = getData$1(destination, type, cacheKey);
+        return (_a = cache[provider]) === null || _a === void 0 ? void 0 : _a[key];
+    };
+    const saveToCache = (destination, persistType, provider, key, value) => {
+        const type = persistType === 'edge' ? 'local' : persistType;
+        const cache = getData$1(destination, type, cacheKey);
+        if (!cache[provider]) {
+            cache[provider] = { [key]: value };
+        }
+        else {
+            cache[provider][key] = value;
+        }
+        saveData(destination, type, cache, cacheKey);
+    };
+    const handleCaptureStorage = (destination, provider, key, persistType, location, map, replay = false) => {
+        let data;
+        try {
+            switch (location) {
+                case 'cookie': {
+                    data = (map !== null && map !== void 0 ? map : identity)(getCookieValue(key));
+                    break;
+                }
+                case 'local': {
+                    data = (map !== null && map !== void 0 ? map : identity)(localStorage.getItem(key));
+                    break;
+                }
+                case 'session': {
+                    data = (map !== null && map !== void 0 ? map : identity)(sessionStorage.getItem(key));
+                }
+            }
+        }
+        catch {
+            return;
+        }
+        if (!data) {
+            return;
+        }
+        const cachedKey = `${getUserId$1(destination)}/${key}`;
+        const cachedValue = getFromCache(destination, persistType, provider, cachedKey);
+        if (persistType === 'edge' && cachedValue !== data) {
+            saveDataToEdge(destination, key, data, provider);
+            saveToCache(destination, persistType, provider, cachedKey, data);
+            return;
+        }
+        // A cache hit means this rule's value has not moved since it was last
+        // written, so a replay has nothing left to do: saveDataPerKey is a getItem +
+        // JSON.parse + JSON.stringify + setItem, per storage rule, per event, on
+        // every tag in the fleet that has one. The boot path always falls through, so
+        // the value is written at least once per page.
+        if (replay && cachedValue === data) {
+            return;
+        }
+        saveDataPerKey(destination, persistType, provider, data, key);
+        // Cached for every persist type, not just 'edge' — the guard above is what
+        // keeps a non-edge rule (trade-desk's uc_tcf) off the read/parse/write cycle
+        // on every event of the visit.
+        saveToCache(destination, persistType, provider, cachedKey, data);
+    };
+    const registry = new Map();
+    // A manifest pass is the authoritative provider set for the destination, and
+    // handleCapture only replaces the entry for the provider it is called with.
+    // Without this, a channel dropped from a later pass (SPA re-init, manifest
+    // refresh, channel removed) keeps replaying its storage rules for the rest of
+    // the page lifetime. handleManifest calls this once, before its provider loop.
+    const resetCaptures = (destination) => {
+        registry.delete(destination);
+    };
+    const handleCapture = (destination, provider, params, capture) => {
+        var _a;
+        const existing = ((_a = registry.get(destination)) !== null && _a !== void 0 ? _a : []).filter((registration) => registration.provider !== provider);
+        registry.set(destination, [...existing, { provider, params, capture }]);
+        params.forEach((param) => {
+            switch (param.type) {
+                case 'query': {
+                    handleCaptureQuery(destination, provider, param.key, param.persist, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
+                    break;
+                }
+                case 'storage': {
+                    handleCaptureStorage(destination, provider, param.key, param.persist, param.location, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
+                    break;
+                }
+            }
+        });
+    };
+    // A storage capture rule reads a slot the provider's own pixel may not have
+    // written yet: handleManifest calls handleCapture before pkg.init(), and
+    // Customers.ai's pixel is injected async, so on a first visit the read always
+    // loses. Re-read per event so a value that appears later is still captured for
+    // that pageview.
+    //
+    // Opt-in per rule (`replay: true`) and storage rules only, so a provider pays
+    // the per-event read only where a late-writing pixel makes the boot read
+    // unreliable.
+    const replayStorageCaptures = (destination) => {
+        var _a;
+        (_a = registry.get(destination)) === null || _a === void 0 ? void 0 : _a.forEach(({ provider, params, capture }) => {
+            params.forEach((param) => {
+                if (param.type !== 'storage' || !param.replay) {
+                    return;
+                }
+                handleCaptureStorage(destination, provider, param.key, param.persist, param.location, capture === null || capture === void 0 ? void 0 : capture.bind(null, param), true);
+            });
+        });
+    };
+
     const preparePayloadWithConversion = (payloadData, currencySettings) => {
         const currency = payloadData['currency'];
         if (!currency || !currencySettings) {
@@ -1943,6 +2153,9 @@
             });
             return;
         }
+        // Capture rules run once at boot, before the providers' own pixels load —
+        // see replayStorageCaptures.
+        replayStorageCaptures(destination);
         let eventId = data['eventId'];
         if (!eventId) {
             eventId = generateEventId(currentEventName);
@@ -2177,65 +2390,6 @@
         });
     };
 
-    const processData = (destination, data, providers, options) => {
-        saveKV(destination, data);
-        updateUserProperties(destination, data);
-        const providerPackages = getSetting(destination, 'browserPackages');
-        const configuredTags = getSetting(destination, 'channels');
-        const userId = getUserId$1(destination);
-        const requestCountry = getSetting(destination, 'geoCountry') || null;
-        const requestRegion = getSetting(destination, 'geoRegion') || null;
-        const isEURequest = getSetting(destination, 'isEURequest') || false;
-        const consentChannel = getConsent$1(destination);
-        const consentCategory = getConsentCategories(destination);
-        const consentSettings = getSetting(destination, 'consentSetting');
-        const userConsent = { consentChannel, consentCategory, consentSettings };
-        for (const pkg of providerPackages) {
-            if (!pkg || !pkg.user || !pkg.name) {
-                continue;
-            }
-            if (!configuredTags.has(pkg.name)) {
-                logger.log(`Provider ${pkg.name} is not in allow list`);
-                continue;
-            }
-            const variables = getProviderVariables(destination, pkg.name);
-            for (const variable of variables) {
-                if (!isProviderInstanceAllowed(providers, pkg.name, variable.tagName)) {
-                    logger.log(`Data not allowed for ${pkg.name} (${variable.tagName})`);
-                    continue;
-                }
-                if (!hasUserConsent(userConsent, pkg.name, variable.tagName)) {
-                    logger.log(`Consent is missing for ${pkg.name} (${variable.tagName})`);
-                    continue;
-                }
-                if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
-                    logger.log(`GEO request region does not match list, skipping`);
-                    continue;
-                }
-                pkg.user({
-                    userId,
-                    data,
-                    manifestVariables: variable.variableSet,
-                    destination,
-                });
-            }
-        }
-        postRequest(getDataURL(destination), { data, providers }, options).catch(logger.error);
-    };
-    const handleData = (data, providers, options) => {
-        if (!data || Object.keys(data).length === 0) {
-            logger.error('Provide data for data API.');
-            return;
-        }
-        if (options === null || options === void 0 ? void 0 : options.destination) {
-            processData(options.destination, data, providers, options);
-            return;
-        }
-        getInstances().forEach((destination) => {
-            processData(destination, data, providers, options);
-        });
-    };
-
     const handleConsent = (consent, consentCategories, options) => {
         if (options === null || options === void 0 ? void 0 : options.destination) {
             processConsent(options.destination, consent, consentCategories, options);
@@ -2400,113 +2554,6 @@
         return providersPackages;
     };
 
-    const cacheKey = `${keyPrefix}Cache`;
-    const identity = (v) => v;
-    const saveDataToEdge = (destination, key, value, provider) => {
-        if (!value) {
-            return;
-        }
-        let updatedValue = value;
-        if (typeof value !== 'string') {
-            try {
-                updatedValue = JSON.stringify(value);
-            }
-            catch {
-                logger.log('Error stringify value.');
-                return;
-            }
-        }
-        handleData({ [`${provider}::${key}`]: updatedValue }, undefined, {
-            destination,
-        });
-    };
-    const handleCaptureQuery = (destination, provider, key, persistType, map) => {
-        try {
-            if (!window) {
-                return;
-            }
-        }
-        catch {
-            return;
-        }
-        const params = new URLSearchParams(getSearch(destination));
-        if (!params || !params.get(key)) {
-            return;
-        }
-        const data = (map !== null && map !== void 0 ? map : identity)(params.get(key));
-        if (!data) {
-            return;
-        }
-        if (persistType === 'edge') {
-            saveDataToEdge(destination, key, data, provider);
-            return;
-        }
-        saveDataPerKey(destination, persistType, provider, data, key);
-    };
-    const getFromCache = (destination, persistType, provider, key) => {
-        var _a;
-        const type = persistType === 'edge' ? 'local' : persistType;
-        const cache = getData$1(destination, type, cacheKey);
-        return (_a = cache[provider]) === null || _a === void 0 ? void 0 : _a[key];
-    };
-    const saveToCache = (destination, persistType, provider, key, value) => {
-        const type = persistType === 'edge' ? 'local' : persistType;
-        const cache = getData$1(destination, type, cacheKey);
-        if (!cache[provider]) {
-            cache[provider] = { [key]: value };
-        }
-        else {
-            cache[provider][key] = value;
-        }
-        saveData(destination, type, cache, cacheKey);
-    };
-    const handleCaptureStorage = (destination, provider, key, persistType, location, map) => {
-        let data;
-        try {
-            switch (location) {
-                case 'cookie': {
-                    data = (map !== null && map !== void 0 ? map : identity)(getCookieValue(key));
-                    break;
-                }
-                case 'local': {
-                    data = (map !== null && map !== void 0 ? map : identity)(localStorage.getItem(key));
-                    break;
-                }
-                case 'session': {
-                    data = (map !== null && map !== void 0 ? map : identity)(sessionStorage.getItem(key));
-                }
-            }
-        }
-        catch {
-            return;
-        }
-        if (!data) {
-            return;
-        }
-        const cachedKey = `${getUserId$1(destination)}/${key}`;
-        const cachedValue = getFromCache(destination, persistType, provider, cachedKey);
-        if (persistType === 'edge' && cachedValue !== data) {
-            saveDataToEdge(destination, key, data, provider);
-            saveToCache(destination, persistType, provider, cachedKey, data);
-            return;
-        }
-        saveDataPerKey(destination, persistType, provider, data, key);
-    };
-    const handleCapture = (destination, provider, params, capture) => {
-        params.forEach((param) => {
-            switch (param.type) {
-                case 'query': {
-                    handleCaptureQuery(destination, provider, param.key, param.persist, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
-                    break;
-                }
-                case 'storage': {
-                    handleCaptureStorage(destination, provider, param.key, param.persist, param.location, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
-                    break;
-                }
-            }
-        });
-    };
-
     const keyName = `${keyPrefix}Store`;
     const handleManifest = (destination, response) => {
         const providerPackages = getSetting(destination, 'browserPackages');
@@ -2517,6 +2564,9 @@
         const consentCategory = getConsentCategories(destination);
         const consentSettings = getSetting(destination, 'consentSetting');
         const userConsent = { consentChannel, consentCategory, consentSettings };
+        // This manifest is the full provider set: drop the previous pass's capture
+        // registrations so a channel that is no longer in it stops replaying.
+        resetCaptures(destination);
         manifest.forEach((provider) => {
             addChannel(destination, provider.package, provider.tagName);
             const pkg = providerPackages.find((pkg) => pkg.name === provider.package);

package/package.json

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