@blotoutio/edgetag-sdk-browser 1.20.1 → 1.21.1

package/index.js

@@ -24,24 +24,42 @@
      * It should be used in conjunction with `UserConsent`, not `ProvidersConfig`.
      */
     const hasUserConsent = (consent, provider, tagName) => {
-        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)) {
-                if ('all' in providerSpecific && isBool(providerSpecific.all)) {
-                    allowed = providerSpecific.all;
+        var _a, _b;
+        let allowed = false;
+        if (isRecord(consent.consentChannel)) {
+            allowed = isBool(consent.consentChannel.all)
+                ? consent.consentChannel.all
+                : false;
+            if (provider in consent.consentChannel) {
+                const providerSpecific = consent.consentChannel[provider];
+                if (isBool(providerSpecific)) {
+                    allowed = providerSpecific;
                 }
-                if (tagName in providerSpecific && isBool(providerSpecific[tagName])) {
-                    allowed = providerSpecific[tagName];
+                else if (isRecord(providerSpecific)) {
+                    if ('all' in providerSpecific && isBool(providerSpecific.all)) {
+                        allowed = providerSpecific.all;
+                    }
+                    if (tagName in providerSpecific && isBool(providerSpecific[tagName])) {
+                        allowed = providerSpecific[tagName];
+                    }
                 }
             }
         }
+        if (allowed) {
+            return true;
+        }
+        if (isRecord(consent.consentCategory) &&
+            isRecord((_a = consent.consentSettings) === null || _a === void 0 ? void 0 : _a.channels)) {
+            allowed = isBool(consent.consentCategory.all)
+                ? consent.consentCategory.all
+                : false;
+            const category = (_b = Object.entries(consent.consentSettings.channels).find(([, value]) => {
+                return value.includes(provider);
+            })) === null || _b === void 0 ? void 0 : _b[0];
+            if (category && consent.consentCategory[category]) {
+                allowed = true;
+            }
+        }
         return allowed;
     };
     /**
@@ -502,6 +520,10 @@
             geoCountry: null,
             geoRegion: null,
             isEURequest: false,
+            consentSetting: {
+                enabled: false,
+                channels: {},
+            },
             ...options,
         };
     };
@@ -927,7 +949,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "1.20.1" ,
+            sdkVersion: "1.21.1" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -1133,7 +1155,10 @@
         const sessionId = getSetting(destination, 'sessionId');
         const userId = getUserId$1(destination);
         const providerData = {};
-        const consent = getConsent$1(destination);
+        const consentChannel = getConsent$1(destination);
+        const consentCategory = getConsentCategories(destination);
+        const consentSettings = getSetting(destination, 'consentSetting');
+        const userConsent = { consentChannel, consentCategory, consentSettings };
         if (skipZeroPurchaseEvent && isZeroPurchaseEvent({ eventName, data })) {
             return;
         }
@@ -1154,7 +1179,7 @@
                     logger.log(`Provider instance is not allowed (${pkg.name}: ${variable.tagName})`);
                     continue;
                 }
-                if (!hasUserConsent(consent, pkg.name, variable.tagName)) {
+                if (!hasUserConsent(userConsent, pkg.name, variable.tagName)) {
                     logger.log(`Consent is missing (${pkg.name}: ${variable.tagName})`);
                     continue;
                 }
@@ -1181,7 +1206,7 @@
             }
             providerData[pkg.name] = result;
         }
-        if (!hasAllowedManifestTags(configuredTags, consent, providers)) {
+        if (!hasAllowedManifestTags(configuredTags, userConsent, providers)) {
             return;
         }
         sendTag(destination, {
@@ -1219,10 +1244,13 @@
         const providerPackages = getSetting(destination, 'browserPackages');
         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;
+        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;
@@ -1237,7 +1265,7 @@
                     logger.log(`Data not allowed for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
-                if (!hasUserConsent(consent, pkg.name, variable.tagName)) {
+                if (!hasUserConsent(userConsent, pkg.name, variable.tagName)) {
                     logger.log(`Consent is missing for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
@@ -1313,6 +1341,7 @@
         const requestCountry = getSetting(destination, 'geoCountry') || null;
         const requestRegion = getSetting(destination, 'geoRegion') || null;
         const isEURequest = getSetting(destination, 'isEURequest') || false;
+        const consentSettings = getSetting(destination, 'consentSetting');
         /* Calling Init for all provider instances based on consent check */
         for (const pkg of providerPackages) {
             if (!pkg || !pkg.name || !pkg.init) {
@@ -1320,7 +1349,11 @@
             }
             const variables = getProviderVariables(destination, pkg.name);
             for (const variable of variables) {
-                const hasConsent = hasUserConsent(consent, pkg.name, variable.tagName);
+                const hasConsent = hasUserConsent({
+                    consentChannel: consent,
+                    consentCategory: consentCategories,
+                    consentSettings,
+                }, pkg.name, variable.tagName);
                 if (!hasConsent) {
                     continue;
                 }
@@ -1347,6 +1380,7 @@
                     consentData: {
                         consent,
                         categories: { ...consentCategories, necessary: true },
+                        consentSettings,
                     },
                 });
             }
@@ -1376,6 +1410,7 @@
                         ...consentCategories,
                         necessary: true,
                     },
+                    consentSettings,
                 },
                 variables,
             });
@@ -1530,6 +1565,10 @@
         const userId = getUserId$1(destination);
         const executionContext = new Map();
         const manifest = response.result;
+        const consentChannel = getConsent$1(destination);
+        const consentCategory = getConsentCategories(destination);
+        const consentSettings = getSetting(destination, 'consentSetting');
+        const userConsent = { consentChannel, consentCategory, consentSettings };
         manifest.forEach((provider) => {
             addChannel(destination, provider.package, provider.tagName);
             const pkg = providerPackages.find((pkg) => pkg.name === provider.package);
@@ -1544,8 +1583,7 @@
                 });
             }
             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);
+                const hasConsent = hasUserConsent(userConsent, pkg.name, provider.tagName);
                 if (hasConsent &&
                     doesGeoRequestMatchList(response.geoCountry, response.geoRegion, response.isEURequest, provider.geoRegions)) {
                     pkg.init({
@@ -1563,6 +1601,7 @@
                         consentData: {
                             consent: response.consent,
                             categories: response.consentCategories,
+                            consentSettings: response.consentSetting,
                         },
                     });
                 }
@@ -1691,6 +1730,7 @@
                 geoCountry: result.geoCountry,
                 geoRegion: result.geoRegion,
                 isEURequest: result.isEURequest,
+                consentSetting: result.consentSetting,
             });
             if (result.storageId != null) {
                 savePerKey(preferences.edgeURL, 'local', tagStorage, result.storageId, storageIdKey);
@@ -1723,11 +1763,14 @@
         });
         const providerPackages = getSetting(destination, 'browserPackages');
         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;
+        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.name || !pkg.user) {
                 continue;
@@ -1742,7 +1785,7 @@
                     logger.log(`User not allowed for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
-                if (!hasUserConsent(consent, pkg.name, variable.tagName)) {
+                if (!hasUserConsent(userConsent, pkg.name, variable.tagName)) {
                     logger.log(`User do not have consent for ${pkg.name} (${variable.tagName})`);
                     continue;
                 }
@@ -1865,8 +1908,8 @@
     const tag = (name, data, providers, options) => {
         handleTag(name, data, providers, options);
     };
-    const consent = (value, consentCategories, options) => {
-        handleConsent(value, consentCategories, options);
+    const consent = (consentChannels, consentCategories, options) => {
+        handleConsent(consentChannels, 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": "1.20.1",
+  "version": "1.21.1",
   "description": "Browser SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",