@blotoutio/edgetag-sdk-browser 0.71.0 → 1.0.0

package/index.js

@@ -43,25 +43,6 @@
         }
         return allowed;
     };
-    /**
-     * This function validates user consent for a given provider type, not based on tagName.
-     */
-    const hasUserConsentForProvider = (consent, provider) => {
-        if (!isRecord(consent)) {
-            return false;
-        }
-        let allowed = isBool(consent.all) ? consent.all : false;
-        if (provider in consent) {
-            const providerSpecific = consent[provider];
-            if (isBool(providerSpecific)) {
-                allowed = providerSpecific;
-            }
-            else if (isRecord(providerSpecific)) {
-                return Object.keys(providerSpecific).some((instance) => providerSpecific[instance] === true);
-            }
-        }
-        return allowed;
-    };
     /**
      * This function validates provider allowance for a given provider and tag name.
      * It should not be used to validate `UserConsent`.
@@ -141,6 +122,283 @@
         return value === 0;
     };
 
+    /**
+     * ISO-3166 2-leter country codes and their names
+     * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+     */
+    const isoCountries = new Map([
+        ['AD', 'Andorra'],
+        ['AE', 'United Arab Emirates'],
+        ['AF', 'Afghanistan'],
+        ['AG', 'Antigua and Barbuda'],
+        ['AI', 'Anguilla'],
+        ['AL', 'Albania'],
+        ['AM', 'Armenia'],
+        ['AO', 'Angola'],
+        ['AQ', 'Antarctica'],
+        ['AR', 'Argentina'],
+        ['AS', 'American Samoa'],
+        ['AT', 'Austria'],
+        ['AU', 'Australia'],
+        ['AW', 'Aruba'],
+        ['AX', 'Åland Islands'],
+        ['AZ', 'Azerbaijan'],
+        ['BA', 'Bosnia and Herzegovina'],
+        ['BB', 'Barbados'],
+        ['BD', 'Bangladesh'],
+        ['BE', 'Belgium'],
+        ['BF', 'Burkina Faso'],
+        ['BG', 'Bulgaria'],
+        ['BH', 'Bahrain'],
+        ['BI', 'Burundi'],
+        ['BJ', 'Benin'],
+        ['BL', 'Saint Barthélemy'],
+        ['BM', 'Bermuda'],
+        ['BN', 'Brunei Darussalam'],
+        ['BO', 'Bolivia, Plurinational State of'],
+        ['BQ', 'Bonaire, Sint Eustatius and Saba'],
+        ['BR', 'Brazil'],
+        ['BS', 'Bahamas'],
+        ['BT', 'Bhutan'],
+        ['BV', 'Bouvet Island'],
+        ['BW', 'Botswana'],
+        ['BY', 'Belarus'],
+        ['BZ', 'Belize'],
+        ['CA', 'Canada'],
+        ['CC', 'Cocos (Keeling) Islands'],
+        ['CD', 'Congo, Democratic Republic of the'],
+        ['CF', 'Central African Republic'],
+        ['CG', 'Congo'],
+        ['CH', 'Switzerland'],
+        ['CI', "Côte d'Ivoire"],
+        ['CK', 'Cook Islands'],
+        ['CL', 'Chile'],
+        ['CM', 'Cameroon'],
+        ['CN', 'China'],
+        ['CO', 'Colombia'],
+        ['CR', 'Costa Rica'],
+        ['CU', 'Cuba'],
+        ['CV', 'Cabo Verde'],
+        ['CW', 'Curaçao'],
+        ['CX', 'Christmas Island'],
+        ['CY', 'Cyprus'],
+        ['CZ', 'Czechia'],
+        ['DE', 'Germany'],
+        ['DJ', 'Djibouti'],
+        ['DK', 'Denmark'],
+        ['DM', 'Dominica'],
+        ['DO', 'Dominican Republic'],
+        ['DZ', 'Algeria'],
+        ['EC', 'Ecuador'],
+        ['EE', 'Estonia'],
+        ['EG', 'Egypt'],
+        ['EH', 'Western Sahara'],
+        ['ER', 'Eritrea'],
+        ['ES', 'Spain'],
+        ['ET', 'Ethiopia'],
+        ['EU', 'European Union'],
+        ['FI', 'Finland'],
+        ['FJ', 'Fiji'],
+        ['FK', 'Falkland Islands (Malvinas)'],
+        ['FM', 'Micronesia, Federated States of'],
+        ['FO', 'Faroe Islands'],
+        ['FR', 'France'],
+        ['GA', 'Gabon'],
+        ['GB', 'United Kingdom of Great Britain and Northern Ireland'],
+        ['GD', 'Grenada'],
+        ['GE', 'Georgia'],
+        ['GF', 'French Guiana'],
+        ['GG', 'Guernsey'],
+        ['GH', 'Ghana'],
+        ['GI', 'Gibraltar'],
+        ['GL', 'Greenland'],
+        ['GM', 'Gambia'],
+        ['GN', 'Guinea'],
+        ['GP', 'Guadeloupe'],
+        ['GQ', 'Equatorial Guinea'],
+        ['GR', 'Greece'],
+        ['GS', 'South Georgia and the South Sandwich Islands'],
+        ['GT', 'Guatemala'],
+        ['GU', 'Guam'],
+        ['GW', 'Guinea-Bissau'],
+        ['GY', 'Guyana'],
+        ['HK', 'Hong Kong'],
+        ['HM', 'Heard Island and McDonald Islands'],
+        ['HN', 'Honduras'],
+        ['HR', 'Croatia'],
+        ['HT', 'Haiti'],
+        ['HU', 'Hungary'],
+        ['ID', 'Indonesia'],
+        ['IE', 'Ireland'],
+        ['IL', 'Israel'],
+        ['IM', 'Isle of Man'],
+        ['IN', 'India'],
+        ['IO', 'British Indian Ocean Territory'],
+        ['IQ', 'Iraq'],
+        ['IR', 'Iran, Islamic Republic of'],
+        ['IS', 'Iceland'],
+        ['IT', 'Italy'],
+        ['JE', 'Jersey'],
+        ['JM', 'Jamaica'],
+        ['JO', 'Jordan'],
+        ['JP', 'Japan'],
+        ['KE', 'Kenya'],
+        ['KG', 'Kyrgyzstan'],
+        ['KH', 'Cambodia'],
+        ['KI', 'Kiribati'],
+        ['KM', 'Comoros'],
+        ['KN', 'Saint Kitts and Nevis'],
+        ['KP', "Korea, Democratic People's Republic of"],
+        ['KR', 'Korea, Republic of'],
+        ['KW', 'Kuwait'],
+        ['KY', 'Cayman Islands'],
+        ['KZ', 'Kazakhstan'],
+        ['LA', "Lao People's Democratic Republic"],
+        ['LB', 'Lebanon'],
+        ['LC', 'Saint Lucia'],
+        ['LI', 'Liechtenstein'],
+        ['LK', 'Sri Lanka'],
+        ['LR', 'Liberia'],
+        ['LS', 'Lesotho'],
+        ['LT', 'Lithuania'],
+        ['LU', 'Luxembourg'],
+        ['LV', 'Latvia'],
+        ['LY', 'Libya'],
+        ['MA', 'Morocco'],
+        ['MC', 'Monaco'],
+        ['MD', 'Moldova, Republic of'],
+        ['ME', 'Montenegro'],
+        ['MF', 'Saint Martin (French part)'],
+        ['MG', 'Madagascar'],
+        ['MH', 'Marshall Islands'],
+        ['MK', 'North Macedonia'],
+        ['ML', 'Mali'],
+        ['MM', 'Myanmar'],
+        ['MN', 'Mongolia'],
+        ['MO', 'Macao'],
+        ['MP', 'Northern Mariana Islands'],
+        ['MQ', 'Martinique'],
+        ['MR', 'Mauritania'],
+        ['MS', 'Montserrat'],
+        ['MT', 'Malta'],
+        ['MU', 'Mauritius'],
+        ['MV', 'Maldives'],
+        ['MW', 'Malawi'],
+        ['MX', 'Mexico'],
+        ['MY', 'Malaysia'],
+        ['MZ', 'Mozambique'],
+        ['NA', 'Namibia'],
+        ['NC', 'New Caledonia'],
+        ['NE', 'Niger'],
+        ['NF', 'Norfolk Island'],
+        ['NG', 'Nigeria'],
+        ['NI', 'Nicaragua'],
+        ['NL', 'Netherlands, Kingdom of the'],
+        ['NO', 'Norway'],
+        ['NP', 'Nepal'],
+        ['NR', 'Nauru'],
+        ['NU', 'Niue'],
+        ['NZ', 'New Zealand'],
+        ['OM', 'Oman'],
+        ['PA', 'Panama'],
+        ['PE', 'Peru'],
+        ['PF', 'French Polynesia'],
+        ['PG', 'Papua New Guinea'],
+        ['PH', 'Philippines'],
+        ['PK', 'Pakistan'],
+        ['PL', 'Poland'],
+        ['PM', 'Saint Pierre and Miquelon'],
+        ['PN', 'Pitcairn'],
+        ['PR', 'Puerto Rico'],
+        ['PS', 'Palestine, State of'],
+        ['PT', 'Portugal'],
+        ['PW', 'Palau'],
+        ['PY', 'Paraguay'],
+        ['QA', 'Qatar'],
+        ['RE', 'Réunion'],
+        ['RO', 'Romania'],
+        ['RS', 'Serbia'],
+        ['RU', 'Russian Federation'],
+        ['RW', 'Rwanda'],
+        ['SA', 'Saudi Arabia'],
+        ['SB', 'Solomon Islands'],
+        ['SC', 'Seychelles'],
+        ['SD', 'Sudan'],
+        ['SE', 'Sweden'],
+        ['SG', 'Singapore'],
+        ['SH', 'Saint Helena, Ascension and Tristan da Cunha'],
+        ['SI', 'Slovenia'],
+        ['SJ', 'Svalbard and Jan Mayen'],
+        ['SK', 'Slovakia'],
+        ['SL', 'Sierra Leone'],
+        ['SM', 'San Marino'],
+        ['SN', 'Senegal'],
+        ['SO', 'Somalia'],
+        ['SR', 'Suriname'],
+        ['SS', 'South Sudan'],
+        ['ST', 'Sao Tome and Principe'],
+        ['SV', 'El Salvador'],
+        ['SX', 'Sint Maarten (Dutch part)'],
+        ['SY', 'Syrian Arab Republic'],
+        ['SZ', 'Eswatini'],
+        ['TC', 'Turks and Caicos Islands'],
+        ['TD', 'Chad'],
+        ['TF', 'French Southern Territories'],
+        ['TG', 'Togo'],
+        ['TH', 'Thailand'],
+        ['TJ', 'Tajikistan'],
+        ['TK', 'Tokelau'],
+        ['TL', 'Timor-Leste'],
+        ['TM', 'Turkmenistan'],
+        ['TN', 'Tunisia'],
+        ['TO', 'Tonga'],
+        ['TR', 'Türkiye'],
+        ['TT', 'Trinidad and Tobago'],
+        ['TV', 'Tuvalu'],
+        ['TW', 'Taiwan, Province of China'],
+        ['TZ', 'Tanzania, United Republic of'],
+        ['UA', 'Ukraine'],
+        ['UG', 'Uganda'],
+        ['UK', 'United Kingdom'],
+        ['UM', 'United States Minor Outlying Islands'],
+        ['US', 'United States of America'],
+        ['UY', 'Uruguay'],
+        ['UZ', 'Uzbekistan'],
+        ['VA', 'Holy See'],
+        ['VC', 'Saint Vincent and the Grenadines'],
+        ['VE', 'Venezuela, Bolivarian Republic of'],
+        ['VG', 'Virgin Islands (British)'],
+        ['VI', 'Virgin Islands (U.S.)'],
+        ['VN', 'Viet Nam'],
+        ['VU', 'Vanuatu'],
+        ['WF', 'Wallis and Futuna'],
+        ['WS', 'Samoa'],
+        ['YE', 'Yemen'],
+        ['YT', 'Mayotte'],
+        ['ZA', 'South Africa'],
+        ['ZM', 'Zambia'],
+        ['ZW', 'Zimbabwe'],
+    ]);
+    new Set(isoCountries.keys());
+    const parseCache = new Map();
+    const doesGeoRequestMatchList = (requestRegion, isEUCountry, geoRegions) => {
+        if (!requestRegion || !geoRegions) {
+            return true;
+        }
+        let parsedRegions = parseCache.get(geoRegions);
+        if (!parsedRegions) {
+            parsedRegions = new Set((geoRegions !== null && geoRegions !== void 0 ? geoRegions : '').split(','));
+            parseCache.set(geoRegions, parsedRegions);
+        }
+        if (parsedRegions.size == 0) {
+            return true;
+        }
+        if (isEUCountry && parsedRegions.has('EU')) {
+            return true;
+        }
+        return parsedRegions.has(requestRegion);
+    };
+
     // eslint-disable-next-line @nx/enforce-module-boundaries
     let edgeTagSettings;
     const initSettings = (destination, options) => {
@@ -153,6 +411,8 @@
             stubs: [],
             browserPackages: [],
             channels: new Map(),
+            geoRegion: null,
+            isEURequest: false,
             ...options,
         };
     };
@@ -191,6 +451,7 @@
             .filter((pkg) => pkg.package === packageId)
             .map((pkg) => ({
             tagName: pkg.tagName,
+            geoRegions: pkg.geoRegions || null,
             variableSet: pkg.variables || {},
         })) || []);
     };
@@ -285,6 +546,7 @@
 
     const tagStorage = 'edgeTag';
     const consentKey = 'consent';
+    const consentCategoriesKey = 'consentCategories';
     const keyPrefix = `_worker`;
     const cookieKey = 'tag_user_id';
     const fallbackSessionKey = 'fallback_tag_user_id';
@@ -572,7 +834,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "0.71.0" ,
+            sdkVersion: "1.0.0" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -662,6 +924,13 @@
         }
         return getSetting(destination, 'consent');
     };
+    const getConsentCategories = (destination) => {
+        const storageConsentCategories = getDataPerKey(destination, 'local', tagStorage, consentCategoriesKey);
+        if (storageConsentCategories) {
+            return storageConsentCategories;
+        }
+        return getSetting(destination, 'consentCategories');
+    };
 
     const processStubs = (destination) => {
         try {
@@ -740,6 +1009,8 @@
         const providerPackages = getSetting(destination, 'browserPackages');
         const configuredTags = getSetting(destination, 'channels');
         const skipZeroPurchaseEvent = getSetting(destination, 'skipZeroPurchaseEvent') || false;
+        const requestRegion = getSetting(destination, 'geoRegion') || null;
+        const isEURequest = getSetting(destination, 'isEURequest') || false;
         const userId = getUserId$1(destination);
         const providerData = {};
         const consent = getConsent$1(destination);
@@ -767,6 +1038,10 @@
                     logger.log(`Consent is missing (${pkg.name}: ${variable.tagName})`);
                     continue;
                 }
+                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                    logger.log('GEO request region does not match the filter, skiping');
+                    continue;
+                }
                 const payload = ((_a = conversion === null || conversion === void 0 ? void 0 : conversion.providers) === null || _a === void 0 ? void 0 : _a.length) === 0 ||
                     ((_b = conversion === null || conversion === void 0 ? void 0 : conversion.providers) === null || _b === void 0 ? void 0 : _b.includes(pkg.name))
                     ? conversion.payload
@@ -848,6 +1123,8 @@
         const configuredTags = getSetting(destination, 'channels');
         const userId = getUserId$1(destination);
         const consent = getConsent$1(destination);
+        const requestRegion = getSetting(destination, 'geoRegion') || null;
+        const isEURequest = getSetting(destination, 'isEURequest') || false;
         for (const pkg of providerPackages) {
             if (!pkg || !pkg.user || !pkg.name) {
                 continue;
@@ -866,6 +1143,10 @@
                     logger.log(`Consent is missing for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
+                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                    logger.log(`GEO request region does not match list, skipping`);
+                    continue;
+                }
                 pkg.user({
                     userId,
                     data,
@@ -889,43 +1170,50 @@
         });
     };
 
-    const handleConsent = (consent, options) => {
+    const handleConsent = (consent, consentCategories, options) => {
         if (options === null || options === void 0 ? void 0 : options.destination) {
-            processConsent(options.destination, consent, options);
+            processConsent(options.destination, consent, consentCategories, options);
             return;
         }
         getInstances().forEach((destination) => {
-            processConsent(destination, consent, options);
+            processConsent(destination, consent, consentCategories, options);
         });
     };
-    const saveConsent = (destination, consent) => {
+    const saveConsent = (destination, consent, consentCategories) => {
         setSetting(destination, {
             consent,
+            consentCategories,
         });
         savePerKey(destination, 'local', tagStorage, consent, consentKey);
+        savePerKey(destination, 'local', tagStorage, consentCategories, consentCategoriesKey);
     };
-    const processConsent = (destination, consent, options) => {
+    const processConsent = (destination, consent, consentCategories, options) => {
         const existingConsent = getConsent$1(destination);
-        if (areEqual(existingConsent, consent)) {
+        const existingConsentCategories = getConsentCategories(destination);
+        if (areEqual(existingConsent, consent) &&
+            areEqual(existingConsentCategories, consentCategories)) {
             return;
         }
         if (!getSetting(destination, 'initialized')) {
             addStub(destination, {
                 name: 'consent',
-                arguments: [consent, options],
+                arguments: [consent, consentCategories, options],
             });
             return;
         }
         const payload = {
             consentString: consent,
+            consentCategories: { ...consentCategories, necessary: true },
         };
-        saveConsent(destination, consent);
+        saveConsent(destination, consent, consentCategories);
         if (!(options === null || options === void 0 ? void 0 : options.localSave)) {
             postRequest(getConsentURL(destination), payload).catch(logger.error);
         }
         const userId = getUserId$1(destination);
         const providerPackages = getSetting(destination, 'browserPackages');
         const executionContext = new Map();
+        const requestRegion = getSetting(destination, 'geoRegion') || null;
+        const isEURequest = getSetting(destination, 'isEURequest') || false;
         /* Calling Init for all provider instances based on consent check */
         for (const pkg of providerPackages) {
             if (!pkg || !pkg.name || !pkg.init) {
@@ -937,6 +1225,9 @@
                 if (!hasConsent) {
                     continue;
                 }
+                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                    continue;
+                }
                 pkg.init({
                     userId,
                     isNewUser: false,
@@ -945,6 +1236,7 @@
                         tagName: variable.tagName,
                         variables: variable.variableSet,
                         package: pkg.name,
+                        geoRegions: variable.geoRegions,
                     },
                     sendTag: sendTag.bind(null, destination),
                     sendEdgeData: processData.bind(null, destination),
@@ -953,6 +1245,10 @@
                     executionContext,
                     session: null,
                     destination,
+                    consentData: {
+                        consent,
+                        categories: { ...consentCategories, necessary: true },
+                    },
                 });
             }
         }
@@ -973,9 +1269,17 @@
             if (!pkg || !pkg.name || !pkg.consent) {
                 continue;
             }
-            /* Returns True if any one instance of given provider has consent */
-            const hasConsent = hasUserConsentForProvider(consent, pkg.name);
-            pkg.consent({ hasConsent });
+            const variables = getProviderVariables(destination, pkg.name);
+            pkg.consent({
+                consentData: {
+                    consent,
+                    categories: {
+                        ...consentCategories,
+                        necessary: true,
+                    },
+                },
+                variables,
+            });
         }
     };
 
@@ -1143,7 +1447,8 @@
             if (pkg && pkg.name && pkg.init) {
                 /* 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) {
+                if (hasConsent &&
+                    doesGeoRequestMatchList(response.geoRegion, response.isEURequest, provider.geoRegions)) {
                     pkg.init({
                         userId,
                         isNewUser: !!response.isNewUser,
@@ -1156,6 +1461,10 @@
                         keyName,
                         executionContext,
                         destination,
+                        consentData: {
+                            consent: response.consent,
+                            categories: response.consentCategories,
+                        },
                     });
                 }
             }
@@ -1199,7 +1508,11 @@
         const url = new URL(getInitURL(preferences.edgeURL));
         if (preferences.disableConsentCheck) {
             url.searchParams.set('consentDisabled', 'true');
-            saveConsent(preferences.edgeURL, { all: true });
+            saveConsent(preferences.edgeURL, {
+                all: true,
+            }, {
+                all: true,
+            });
         }
         if (preferences.userId) {
             setSetting(preferences.edgeURL, { userId: preferences.userId });
@@ -1220,7 +1533,7 @@
                 return;
             }
             if (result.isNewUser && result.consent) {
-                saveConsent(preferences.edgeURL, result.consent);
+                saveConsent(preferences.edgeURL, result.consent, result.consentCategories);
             }
             const providers = {};
             (_a = result.result) === null || _a === void 0 ? void 0 : _a.forEach((pkg) => {
@@ -1239,6 +1552,8 @@
                 storageId: result.storageId,
                 currency: result.currency,
                 skipZeroPurchaseEvent: result.skipZeroPurchaseEvent,
+                geoRegion: result.geoRegion,
+                isEURequest: result.isEURequest,
             });
             if (result.storageId != null) {
                 savePerKey(preferences.edgeURL, 'local', tagStorage, result.storageId, storageIdKey);
@@ -1271,6 +1586,8 @@
         const configuredTags = getSetting(destination, 'channels');
         const consent = getConsent$1(destination);
         const userId = getUserId$1(destination);
+        const requestRegion = getSetting(destination, 'geoRegion') || null;
+        const isEURequest = getSetting(destination, 'isEURequest') || false;
         for (const pkg of providerPackages) {
             if (!pkg || !pkg.name || !pkg.user) {
                 continue;
@@ -1289,6 +1606,10 @@
                     logger.log(`User do not have consent for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
+                if (!doesGeoRequestMatchList(requestRegion, isEURequest, variable.geoRegions)) {
+                    logger.log(`GEO request region does not match list, skipping`);
+                    continue;
+                }
                 pkg.user({
                     userId,
                     data: { [key]: value },
@@ -1404,8 +1725,8 @@
     const tag = (name, data, providers, options) => {
         handleTag(name, data, providers, options);
     };
-    const consent = (value, options) => {
-        handleConsent(value, options);
+    const consent = (value, consentCategories, options) => {
+        handleConsent(value, consentCategories, options);
     };
     const user = (key, value, providers, options) => {
         handleUser(key, value, providers, options);

package/package.json

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