@blotoutio/edgetag-sdk-browser 1.56.1 → 1.57.1

package/index.js

@@ -508,6 +508,74 @@
         ['US-VI', 'Virgin Islands, U.S.'],
     ]);
     new Set([...isoCountries.keys(), ...usStates.keys()]);
+    /**
+     * ISO 3166-1 alpha-2 codes for EU member states (as of 2024)
+     */
+    const EU_COUNTRY_CODES = new Set([
+        'AT', // Austria
+        'BE', // Belgium
+        'BG', // Bulgaria
+        'CY', // Cyprus
+        'CZ', // Czech Republic
+        'DE', // Germany
+        'DK', // Denmark
+        'EE', // Estonia
+        'ES', // Spain
+        'FI', // Finland
+        'FR', // France
+        'GR', // Greece
+        'HR', // Croatia
+        'HU', // Hungary
+        'IE', // Ireland
+        'IT', // Italy
+        'LT', // Lithuania
+        'LU', // Luxembourg
+        'LV', // Latvia
+        'MT', // Malta
+        'NL', // Netherlands
+        'PL', // Poland
+        'PT', // Portugal
+        'RO', // Romania
+        'SE', // Sweden
+        'SI', // Slovenia
+        'SK', // Slovakia
+    ]);
+    /**
+     * Returns true if the request originates from the EU or the UK (GB).
+     * Cloudflare's isEUCountry flag excludes the UK post-Brexit, so GB is
+     * checked explicitly alongside the EU member set.
+     *
+     * Fails closed: when the country cannot be resolved, the request is treated
+     * as EU/UK. This is the safe default for the compliance-sensitive Grey Switch
+     * (an unknown visitor may be in the EU/UK, so it must not slip through when
+     * the EU/UK toggle is off).
+     */
+    const isEuUkRegion = (country, isEURequest) => {
+        if (isEURequest) {
+            return true;
+        }
+        if (!country) {
+            return true;
+        }
+        const upper = country.toUpperCase();
+        return upper === 'GB' || EU_COUNTRY_CODES.has(upper);
+    };
+    /**
+     * Grey Switch fire rule, shared by the SDK and the CDN worker so both stay in
+     * sync. When Grey Switch is on, EdgeTag fires server-side events for
+     * non-consented users. The EU/UK toggle is off by default, which keeps EU/UK
+     * visitors on normal consent unless the merchant explicitly opts those regions
+     * in. Returns whether a server-side event should fire for a non-consented user.
+     */
+    const greySwitchAllowsServerEvent = ({ greySwitch, greySwitchEuUk, country, isEURequest, }) => {
+        if (!greySwitch) {
+            return false;
+        }
+        if (greySwitchEuUk) {
+            return true;
+        }
+        return !isEuUkRegion(country, isEURequest);
+    };
     const parseCache = new Map();
     const parseRegions = (regionString) => {
         const include = new Set();
@@ -1225,7 +1293,7 @@
                 time = perf.toFixed(4);
             }
         }
-        return `${encodeString(name)}-${generateUUID()}-${time}`;
+        return `${encodeString(name).replace(/[^a-zA-Z0-9]/g, '')}-${generateUUID()}-${time}`;
     };
 
     const getCookieValue = (key) => {
@@ -1408,6 +1476,11 @@
         }
     };
 
+    const getIsNewCustomerFlag = async (getData) => {
+        const { isNewCustomer } = await new Promise((resolve) => getData(['isNewCustomer'], resolve));
+        return isNewCustomer ? isNewCustomer === 'true' : undefined;
+    };
+
     const getUserId$1 = (destination) => {
         const userId = getSetting(destination, 'userId');
         if (userId) {
@@ -1466,7 +1539,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "1.56.1" ,
+            sdkVersion: "1.57.1" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -1669,6 +1742,7 @@
         const payload = baseParams['payload'];
         let currentEventName = payload['eventName'];
         let currentData = payload['data'];
+        let currentProviders = baseParams['providers'];
         let skip = false;
         for (const plugin of plugins) {
             const hook = plugin.rules[hookName];
@@ -1694,6 +1768,9 @@
                 if ((_b = result === null || result === void 0 ? void 0 : result.payload) === null || _b === void 0 ? void 0 : _b.data) {
                     currentData = result.payload.data;
                 }
+                if ((result === null || result === void 0 ? void 0 : result.providers) !== undefined) {
+                    currentProviders = result.providers;
+                }
                 if (result === null || result === void 0 ? void 0 : result.additionalEvents) {
                     for (const evt of result.additionalEvents) {
                         handleTag(evt.eventName, evt.data, undefined, undefined);
@@ -1707,6 +1784,7 @@
         return {
             eventName: currentEventName,
             data: currentData,
+            providers: currentProviders,
             skip,
         };
     };
@@ -1737,6 +1815,15 @@
         const consentCategory = getConsentCategories(destination);
         const consentSettings = getSetting(destination, 'consentSetting');
         const userConsent = { consentChannel, consentCategory, consentSettings };
+        // Grey Switch: when enabled, still send the event to the server for
+        // non-consented users. Browser pixels remain gated by hasUserConsent below,
+        // so nothing fires client-side.
+        const greySwitchAllows = greySwitchAllowsServerEvent({
+            greySwitch: getSetting(destination, 'greySwitch') || false,
+            greySwitchEuUk: getSetting(destination, 'greySwitchEuUk') || false,
+            country: requestCountry,
+            isEURequest,
+        });
         const ip = getSetting(destination, 'ip') || null;
         const userProperties = getSetting(destination, 'userProperties');
         if (skipZeroPurchaseEvent && isZeroPurchaseEvent({ eventName, data })) {
@@ -1757,23 +1844,29 @@
                 providers = rulesResult.updatedProviders;
             }
             const plugins = getPlugins(destination);
+            const pluginSettings = {
+                userId,
+                sessionId,
+                geoCountry: requestCountry,
+                geoRegion: requestRegion,
+                isEURequest,
+                ip,
+                consent: consentChannel,
+                consentCategories: consentCategory,
+                userProperties,
+            };
+            const pluginContext = getStandardPayload(destination);
+            const pluginUtilities = {
+                getIsNewCustomerFlag: () => getIsNewCustomerFlag(processGetData.bind(null, destination)),
+            };
             if (plugins.length > 0) {
-                const pluginSettings = {
-                    userId,
-                    sessionId,
-                    geoCountry: requestCountry,
-                    geoRegion: requestRegion,
-                    isEURequest,
-                    ip,
-                    consent: consentChannel,
-                    consentCategories: consentCategory,
-                    userProperties,
-                };
-                const baseParams = {
+                const rootResult = await runPluginHook(plugins, 'tagRoot', {
                     payload: { eventName: currentEventName, data, eventId },
+                    context: pluginContext,
+                    providers,
                     settings: pluginSettings,
-                };
-                const rootResult = await runPluginHook(plugins, 'tagRoot', baseParams);
+                    utilities: pluginUtilities,
+                });
                 if (rootResult.skip) {
                     sendTag(destination, {
                         configuratorProcessed: true,
@@ -1786,6 +1879,10 @@
                     });
                     return;
                 }
+                if (rootResult.providers !== undefined) {
+                    // eslint-disable-next-line no-param-reassign
+                    providers = rootResult.providers;
+                }
                 currentEventName = rootResult.eventName;
                 // eslint-disable-next-line no-param-reassign
                 data = rootResult.data;
@@ -1809,18 +1906,10 @@
                                 data: channelData,
                                 eventId,
                             },
-                            settings: {
-                                userId,
-                                sessionId,
-                                geoCountry: requestCountry,
-                                geoRegion: requestRegion,
-                                isEURequest,
-                                ip,
-                                consent: consentChannel,
-                                consentCategories: consentCategory,
-                                userProperties,
-                            },
+                            context: pluginContext,
+                            settings: pluginSettings,
                             providerId: pkg.name,
+                            utilities: pluginUtilities,
                         });
                         if (channelResult.skip)
                             continue;
@@ -1852,18 +1941,10 @@
                                     data: instanceData,
                                     eventId,
                                 },
-                                settings: {
-                                    userId,
-                                    sessionId,
-                                    geoCountry: requestCountry,
-                                    geoRegion: requestRegion,
-                                    isEURequest,
-                                    ip,
-                                    consent: consentChannel,
-                                    consentCategories: consentCategory,
-                                    userProperties,
-                                },
+                                context: pluginContext,
+                                settings: pluginSettings,
                                 providerId: pkg.name,
+                                utilities: pluginUtilities,
                             });
                             if (instanceResult.skip)
                                 continue;
@@ -1899,7 +1980,8 @@
             else {
                 logger.log('Browser events skipped by event rules, sending tag to server only');
             }
-            if (!hasAllowedManifestTags(configuredTags, userConsent, providers)) {
+            if (!hasAllowedManifestTags(configuredTags, userConsent, providers) &&
+                !greySwitchAllows) {
                 return;
             }
             sendTag(destination, {
@@ -2470,6 +2552,8 @@
                 storageId: result.storageId,
                 currency: result.currency,
                 skipZeroPurchaseEvent: result.skipZeroPurchaseEvent,
+                greySwitch: result.greySwitch,
+                greySwitchEuUk: result.greySwitchEuUk,
                 geoCountry: result.geoCountry,
                 geoRegion: result.geoRegion,
                 isEURequest: result.isEURequest,

package/package.json

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