@blotoutio/edgetag-sdk-js 1.21.0 → 1.21.1

package/index.cjs.js

@@ -23,24 +23,42 @@ const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
  * 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;
 };
 /**
@@ -501,6 +519,10 @@ const initSettings = (destination, options) => {
         geoCountry: null,
         geoRegion: null,
         isEURequest: false,
+        consentSetting: {
+            enabled: false,
+            channels: {},
+        },
         ...options,
     };
 };
@@ -926,7 +948,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "1.21.0" ,
+        sdkVersion: "1.21.1" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -1132,7 +1154,10 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
     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;
     }
@@ -1153,7 +1178,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                 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;
             }
@@ -1180,7 +1205,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
         }
         providerData[pkg.name] = result;
     }
-    if (!hasAllowedManifestTags(configuredTags, consent, providers)) {
+    if (!hasAllowedManifestTags(configuredTags, userConsent, providers)) {
         return;
     }
     sendTag(destination, {
@@ -1218,10 +1243,13 @@ const processData = (destination, data, providers, options) => {
     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;
@@ -1236,7 +1264,7 @@ const processData = (destination, data, providers, options) => {
                 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;
             }
@@ -1312,6 +1340,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
     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) {
@@ -1319,7 +1348,11 @@ const processConsent = (destination, consent, consentCategories, options) => {
         }
         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;
             }
@@ -1346,6 +1379,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
                 consentData: {
                     consent,
                     categories: { ...consentCategories, necessary: true },
+                    consentSettings,
                 },
             });
         }
@@ -1375,6 +1409,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
                     ...consentCategories,
                     necessary: true,
                 },
+                consentSettings,
             },
             variables,
         });
@@ -1529,6 +1564,10 @@ const handleManifest = (destination, response) => {
     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);
@@ -1543,8 +1582,7 @@ const handleManifest = (destination, response) => {
             });
         }
         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({
@@ -1562,6 +1600,7 @@ const handleManifest = (destination, response) => {
                     consentData: {
                         consent: response.consent,
                         categories: response.consentCategories,
+                        consentSettings: response.consentSetting,
                     },
                 });
             }
@@ -1690,6 +1729,7 @@ const handleInit = (preferences) => {
             geoCountry: result.geoCountry,
             geoRegion: result.geoRegion,
             isEURequest: result.isEURequest,
+            consentSetting: result.consentSetting,
         });
         if (result.storageId != null) {
             savePerKey(preferences.edgeURL, 'local', tagStorage, result.storageId, storageIdKey);
@@ -1722,11 +1762,14 @@ const processUser = (destination, key, value, providers, options) => {
     });
     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;
@@ -1741,7 +1784,7 @@ const processUser = (destination, key, value, providers, options) => {
                 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;
             }
@@ -1864,8 +1907,8 @@ const init = (preferences) => {
 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/index.mjs

@@ -21,24 +21,42 @@ const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
  * 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;
 };
 /**
@@ -499,6 +517,10 @@ const initSettings = (destination, options) => {
         geoCountry: null,
         geoRegion: null,
         isEURequest: false,
+        consentSetting: {
+            enabled: false,
+            channels: {},
+        },
         ...options,
     };
 };
@@ -924,7 +946,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "1.21.0" ,
+        sdkVersion: "1.21.1" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -1130,7 +1152,10 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
     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;
     }
@@ -1151,7 +1176,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                 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;
             }
@@ -1178,7 +1203,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
         }
         providerData[pkg.name] = result;
     }
-    if (!hasAllowedManifestTags(configuredTags, consent, providers)) {
+    if (!hasAllowedManifestTags(configuredTags, userConsent, providers)) {
         return;
     }
     sendTag(destination, {
@@ -1216,10 +1241,13 @@ const processData = (destination, data, providers, options) => {
     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;
@@ -1234,7 +1262,7 @@ const processData = (destination, data, providers, options) => {
                 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;
             }
@@ -1310,6 +1338,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
     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) {
@@ -1317,7 +1346,11 @@ const processConsent = (destination, consent, consentCategories, options) => {
         }
         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;
             }
@@ -1344,6 +1377,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
                 consentData: {
                     consent,
                     categories: { ...consentCategories, necessary: true },
+                    consentSettings,
                 },
             });
         }
@@ -1373,6 +1407,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
                     ...consentCategories,
                     necessary: true,
                 },
+                consentSettings,
             },
             variables,
         });
@@ -1527,6 +1562,10 @@ const handleManifest = (destination, response) => {
     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);
@@ -1541,8 +1580,7 @@ const handleManifest = (destination, response) => {
             });
         }
         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({
@@ -1560,6 +1598,7 @@ const handleManifest = (destination, response) => {
                     consentData: {
                         consent: response.consent,
                         categories: response.consentCategories,
+                        consentSettings: response.consentSetting,
                     },
                 });
             }
@@ -1688,6 +1727,7 @@ const handleInit = (preferences) => {
             geoCountry: result.geoCountry,
             geoRegion: result.geoRegion,
             isEURequest: result.isEURequest,
+            consentSetting: result.consentSetting,
         });
         if (result.storageId != null) {
             savePerKey(preferences.edgeURL, 'local', tagStorage, result.storageId, storageIdKey);
@@ -1720,11 +1760,14 @@ const processUser = (destination, key, value, providers, options) => {
     });
     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;
@@ -1739,7 +1782,7 @@ const processUser = (destination, key, value, providers, options) => {
                 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;
             }
@@ -1862,8 +1905,8 @@ const init = (preferences) => {
 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/internal.d.ts

@@ -21,7 +21,8 @@ type TagPayload = {
 }
 
 type ConsentPayload = {
-  consentString: UserConsent
+  consentString: UserConsent | null
+  consentCategories: UserConsentCategories
 }
 
 type UserPayload = {

package/package.json

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