@blotoutio/edgetag-sdk-browser 1.4.0 → 1.6.0

package/index.js

@@ -379,24 +379,111 @@
         ['ZM', 'Zambia'],
         ['ZW', 'Zimbabwe'],
     ]);
-    new Set(isoCountries.keys());
+    /**
+     * ISO-3166 US state ISO codes
+     * @see https://en.wikipedia.org/wiki/ISO_3166-2:US
+     * */
+    const usStates = new Map([
+        ['US-AL', 'Alabama'],
+        ['US-AK', 'Alaska'],
+        ['US-AZ', 'Arizona'],
+        ['US-AR', 'Arkansas'],
+        ['US-CA', 'California'],
+        ['US-CO', 'Colorado'],
+        ['US-CT', 'Connecticut'],
+        ['US-DE', 'Delaware'],
+        ['US-FL', 'Florida'],
+        ['US-GA', 'Georgia'],
+        ['US-HI', 'Hawaii'],
+        ['US-ID', 'Idaho'],
+        ['US-IL', 'Illinois'],
+        ['US-IN', 'Indiana'],
+        ['US-IA', 'Iowa'],
+        ['US-KS', 'Kansas'],
+        ['US-KY', 'Kentucky'],
+        ['US-LA', 'Louisiana'],
+        ['US-ME', 'Maine'],
+        ['US-MD', 'Maryland'],
+        ['US-MA', 'Massachusetts'],
+        ['US-MI', 'Michigan'],
+        ['US-MN', 'Minnesota'],
+        ['US-MS', 'Mississippi'],
+        ['US-MO', 'Missouri'],
+        ['US-MT', 'Montana'],
+        ['US-NE', 'Nebraska'],
+        ['US-NV', 'Nevada'],
+        ['US-NH', 'New Hampshire'],
+        ['US-NJ', 'New Jersey'],
+        ['US-NM', 'New Mexico'],
+        ['US-NY', 'New York'],
+        ['US-NC', 'North Carolina'],
+        ['US-ND', 'North Dakota'],
+        ['US-OH', 'Ohio'],
+        ['US-OK', 'Oklahoma'],
+        ['US-OR', 'Oregon'],
+        ['US-PA', 'Pennsylvania'],
+        ['US-RI', 'Rhode Island'],
+        ['US-SC', 'South Carolina'],
+        ['US-SD', 'South Dakota'],
+        ['US-TN', 'Tennessee'],
+        ['US-TX', 'Texas'],
+        ['US-UT', 'Utah'],
+        ['US-VT', 'Vermont'],
+        ['US-VA', 'Virginia'],
+        ['US-WA', 'Washington'],
+        ['US-WV', 'West Virginia'],
+        ['US-WI', 'Wisconsin'],
+        ['US-WY', 'Wyoming'],
+        ['US-DC', 'District of Columbia'],
+        ['US-AS', 'American Samoa'],
+        ['US-GU', 'Guam'],
+        ['US-MP', 'Northern Mariana Islands'],
+        ['US-PR', 'Puerto Rico'],
+        ['US-UM', 'United States Minor Outlying Islands'],
+        ['US-VI', 'Virgin Islands, U.S.'],
+    ]);
+    new Set([...isoCountries.keys(), ...usStates.keys()]);
     const parseCache = new Map();
-    const doesGeoRequestMatchList = (requestRegion, isEUCountry, geoRegions) => {
-        if (!requestRegion || !geoRegions) {
+    const parseRegions = (regionString) => {
+        const include = new Set();
+        const exclude = new Set();
+        if (regionString) {
+            const [a = '', b = ''] = regionString.split('|');
+            for (const item of a.split(',')) {
+                if (item) {
+                    include.add(item);
+                }
+            }
+            for (const item of b.split(',')) {
+                if (item) {
+                    exclude.add(item);
+                }
+            }
+        }
+        return { include, exclude };
+    };
+    const doesGeoRequestMatchList = (requestCountry, requestRegion, isEUCountry, geoRegions) => {
+        if (!requestCountry || !geoRegions) {
             return true;
         }
-        let parsedRegions = parseCache.get(geoRegions);
-        if (!parsedRegions) {
-            parsedRegions = new Set((geoRegions !== null && geoRegions !== void 0 ? geoRegions : '').split(','));
-            parseCache.set(geoRegions, parsedRegions);
+        let parsed = parseCache.get(geoRegions);
+        if (!parsed) {
+            parsed = parseRegions(geoRegions);
+            parseCache.set(geoRegions, parsed);
         }
-        if (parsedRegions.size == 0) {
-            return true;
+        const entries = [requestCountry, `${requestCountry}-${requestRegion}`];
+        if (isEUCountry) {
+            entries.push('EU');
         }
-        if (isEUCountry && parsedRegions.has('EU')) {
-            return true;
+        if (parsed.include.size &&
+            entries.every((entry) => !parsed.include.has(entry))) {
+            return false;
         }
-        return parsedRegions.has(requestRegion);
+        if (parsed.exclude.size &&
+            entries.some((entry) => parsed.exclude.has(entry))) {
+            return false;
+        }
+        return true;
     };
 
     // eslint-disable-next-line @nx/enforce-module-boundaries
@@ -411,6 +498,7 @@
             stubs: [],
             browserPackages: [],
             channels: new Map(),
+            geoCountry: null,
             geoRegion: null,
             isEURequest: false,
             ...options,
@@ -834,7 +922,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "1.4.0" ,
+            sdkVersion: "1.6.0" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -1009,6 +1097,7 @@
         const providerPackages = getSetting(destination, 'browserPackages');
         const configuredTags = getSetting(destination, 'channels');
         const skipZeroPurchaseEvent = getSetting(destination, 'skipZeroPurchaseEvent') || false;
+        const requestCountry = getSetting(destination, 'geoCountry') || null;
         const requestRegion = getSetting(destination, 'geoRegion') || null;
         const isEURequest = getSetting(destination, 'isEURequest') || false;
         const userId = getUserId$1(destination);
@@ -1038,7 +1127,7 @@
                     logger.log(`Consent is missing (${pkg.name}: ${variable.tagName})`);
                     continue;
                 }
-                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
                     logger.log('GEO request region does not match the filter, skiping');
                     continue;
                 }
@@ -1123,6 +1212,7 @@
         const configuredTags = getSetting(destination, 'channels');
         const userId = getUserId$1(destination);
         const consent = getConsent$1(destination);
+        const requestCountry = getSetting(destination, 'geoCountry') || null;
         const requestRegion = getSetting(destination, 'geoRegion') || null;
         const isEURequest = getSetting(destination, 'isEURequest') || false;
         for (const pkg of providerPackages) {
@@ -1143,7 +1233,7 @@
                     logger.log(`Consent is missing for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
-                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
                     logger.log(`GEO request region does not match list, skipping`);
                     continue;
                 }
@@ -1212,6 +1302,7 @@
         const userId = getUserId$1(destination);
         const providerPackages = getSetting(destination, 'browserPackages');
         const executionContext = new Map();
+        const requestCountry = getSetting(destination, 'geoCountry') || null;
         const requestRegion = getSetting(destination, 'geoRegion') || null;
         const isEURequest = getSetting(destination, 'isEURequest') || false;
         /* Calling Init for all provider instances based on consent check */
@@ -1225,7 +1316,7 @@
                 if (!hasConsent) {
                     continue;
                 }
-                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
                     continue;
                 }
                 pkg.init({
@@ -1448,7 +1539,7 @@
                 /* this defines if the consent is given for a specific instance of a provider */
                 const hasConsent = hasUserConsent(getSetting(destination, 'consent'), pkg.name, provider.tagName);
                 if (hasConsent &&
-                    doesGeoRequestMatchList(response.geoRegion, response.isEURequest, provider.geoRegions)) {
+                    doesGeoRequestMatchList(response.geoCountry, response.geoRegion, response.isEURequest, provider.geoRegions)) {
                     pkg.init({
                         userId,
                         isNewUser: !!response.isNewUser,
@@ -1552,6 +1643,7 @@
                 storageId: result.storageId,
                 currency: result.currency,
                 skipZeroPurchaseEvent: result.skipZeroPurchaseEvent,
+                geoCountry: result.geoCountry,
                 geoRegion: result.geoRegion,
                 isEURequest: result.isEURequest,
             });
@@ -1586,6 +1678,7 @@
         const configuredTags = getSetting(destination, 'channels');
         const consent = getConsent$1(destination);
         const userId = getUserId$1(destination);
+        const requestCountry = getSetting(destination, 'geoCountry') || null;
         const requestRegion = getSetting(destination, 'geoRegion') || null;
         const isEURequest = getSetting(destination, 'isEURequest') || false;
         for (const pkg of providerPackages) {
@@ -1606,7 +1699,7 @@
                     logger.log(`User do not have consent for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
-                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
                     logger.log(`GEO request region does not match list, skipping`);
                     continue;
                 }

package/package.json

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