@blotoutio/edgetag-sdk-js 1.5.0 → 1.6.1

package/index.cjs.js

@@ -378,24 +378,111 @@ const isoCountries = new Map([
     ['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
@@ -410,6 +497,7 @@ const initSettings = (destination, options) => {
         stubs: [],
         browserPackages: [],
         channels: new Map(),
+        geoCountry: null,
         geoRegion: null,
         isEURequest: false,
         ...options,
@@ -833,7 +921,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "1.5.0" ,
+        sdkVersion: "1.6.1" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -1008,6 +1096,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
     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);
@@ -1037,7 +1126,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                 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;
             }
@@ -1122,6 +1211,7 @@ const processData = (destination, data, providers, options) => {
     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) {
@@ -1142,7 +1232,7 @@ const processData = (destination, data, providers, options) => {
                 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;
             }
@@ -1211,6 +1301,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
     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 */
@@ -1224,7 +1315,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
             if (!hasConsent) {
                 continue;
             }
-            if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+            if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
                 continue;
             }
             pkg.init({
@@ -1447,7 +1538,7 @@ const handleManifest = (destination, response) => {
             /* 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,
@@ -1551,6 +1642,7 @@ const handleInit = (preferences) => {
             storageId: result.storageId,
             currency: result.currency,
             skipZeroPurchaseEvent: result.skipZeroPurchaseEvent,
+            geoCountry: result.geoCountry,
             geoRegion: result.geoRegion,
             isEURequest: result.isEURequest,
         });
@@ -1585,6 +1677,7 @@ const processUser = (destination, key, value, providers, options) => {
     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) {
@@ -1605,7 +1698,7 @@ const processUser = (destination, key, value, providers, options) => {
                 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/index.mjs

@@ -376,24 +376,111 @@ const isoCountries = new Map([
     ['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
@@ -408,6 +495,7 @@ const initSettings = (destination, options) => {
         stubs: [],
         browserPackages: [],
         channels: new Map(),
+        geoCountry: null,
         geoRegion: null,
         isEURequest: false,
         ...options,
@@ -831,7 +919,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "1.5.0" ,
+        sdkVersion: "1.6.1" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -1006,6 +1094,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
     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);
@@ -1035,7 +1124,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                 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;
             }
@@ -1120,6 +1209,7 @@ const processData = (destination, data, providers, options) => {
     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) {
@@ -1140,7 +1230,7 @@ const processData = (destination, data, providers, options) => {
                 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;
             }
@@ -1209,6 +1299,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
     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 */
@@ -1222,7 +1313,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
             if (!hasConsent) {
                 continue;
             }
-            if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+            if (!doesGeoRequestMatchList(requestCountry, requestRegion, isEURequest, variable.geoRegions)) {
                 continue;
             }
             pkg.init({
@@ -1445,7 +1536,7 @@ const handleManifest = (destination, response) => {
             /* 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,
@@ -1549,6 +1640,7 @@ const handleInit = (preferences) => {
             storageId: result.storageId,
             currency: result.currency,
             skipZeroPurchaseEvent: result.skipZeroPurchaseEvent,
+            geoCountry: result.geoCountry,
             geoRegion: result.geoRegion,
             isEURequest: result.isEURequest,
         });
@@ -1583,6 +1675,7 @@ const processUser = (destination, key, value, providers, options) => {
     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) {
@@ -1603,7 +1696,7 @@ const processUser = (destination, key, value, providers, options) => {
                 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/internal.d.ts

@@ -63,6 +63,7 @@ type InitResponse = {
     rates: { from: string; to: string; value: number }[]
   }
   skipZeroPurchaseEvent?: boolean
+  geoCountry: string | null
   geoRegion: string | null
   isEURequest: boolean
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/edgetag-sdk-js",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "JS SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",