@blotoutio/providers-google-analytics-4-sdk 0.72.0 → 1.0.0

package/index.cjs.js

@@ -3,6 +3,40 @@
 const packageName = 'googleAnalytics4';
 const tagManagerUrl = 'https://www.googletagmanager.com/gtag/js';
 
+const isBool = (v) => typeof v == 'boolean';
+const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
+/**
+ * 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;
+};
+const isCategoryConsented = (consentCategories, category) => {
+    if (!consentCategories)
+        return false;
+    let allowed = isBool(consentCategories.all) ? consentCategories.all : false;
+    if (category in consentCategories) {
+        const categorySpecific = consentCategories[category];
+        if (isBool(categorySpecific)) {
+            allowed = categorySpecific;
+        }
+    }
+    return allowed;
+};
+
 const upsert = (map, key, update, createDefault) => {
     const currentValue = map.has(key)
         ? map.get(key)
@@ -304,7 +338,30 @@ const isoCountries = new Map([
 new Set(isoCountries.keys());
 
 // eslint-disable-next-line @nx/enforce-module-boundaries
-const initGA4 = (ID, executionContext) => {
+const getGoogleConsentFromCategories = (categories) => {
+    const advertisingConsent = isCategoryConsented(categories, 'advertising');
+    const analyticsConsent = isCategoryConsented(categories, 'analytics');
+    return {
+        analytics_storage: analyticsConsent ? 'granted' : 'denied',
+        ad_storage: advertisingConsent ? 'granted' : 'denied',
+        ad_user_data: advertisingConsent ? 'granted' : 'denied',
+        ad_personalization: advertisingConsent ? 'granted' : 'denied',
+    };
+};
+// TODO: once categories becomes a stable field, we need to remove this and start using categories data for google consent mode.
+const getGoogleConsentFromChannels = (consent) => {
+    const gadsConsent = hasUserConsentForProvider(consent, 'googleAdsClicks');
+    const ga4Consent = hasUserConsentForProvider(consent, 'googleAnalytics4');
+    return {
+        analytics_storage: ga4Consent ? 'granted' : 'denied',
+        ad_storage: gadsConsent ? 'granted' : 'denied',
+        ad_user_data: gadsConsent ? 'granted' : 'denied',
+        ad_personalization: gadsConsent ? 'granted' : 'denied',
+    };
+};
+
+// eslint-disable-next-line @nx/enforce-module-boundaries
+const initGA4 = (ID, advancedConsentMode, consentData, executionContext) => {
     var _a;
     window.dataLayer = window.dataLayer || [];
     window.gtag = function gtag() {
@@ -318,14 +375,15 @@ const initGA4 = (ID, executionContext) => {
             break;
         }
     }
+    const data = advancedConsentMode === '1'
+        ? getGoogleConsentFromCategories(consentData.categories)
+        : getGoogleConsentFromChannels(consentData.consent);
     if (isConsentInitialised) {
-        window.gtag('consent', 'update', {
-            analytics_storage: 'granted',
-        });
+        window.gtag('consent', 'update', data);
     }
     else {
         window.gtag('consent', 'default', {
-            analytics_storage: 'granted',
+            ...data,
             functional_storage: 'granted',
             personalization_storage: 'granted',
             security_storage: 'granted',
@@ -343,7 +401,7 @@ const initGA4 = (ID, executionContext) => {
         script.parentNode.insertBefore(element, script);
     }
 };
-const init = ({ manifest, userId, executionContext }) => {
+const init = ({ manifest, userId, executionContext, consentData, }) => {
     if (!window ||
         !manifest.variables ||
         !manifest.variables['measurementId'] ||
@@ -352,7 +410,7 @@ const init = ({ manifest, userId, executionContext }) => {
     }
     if (!window.google_tag_manager ||
         !window.google_tag_manager[manifest.variables['measurementId']]) {
-        initGA4(manifest.variables['measurementId'], executionContext);
+        initGA4(manifest.variables['measurementId'], manifest.variables['advancedConsentMode'], consentData, executionContext);
     }
     if (window.gtag) {
         window.gtag('config', manifest.variables['measurementId'], {
@@ -613,16 +671,20 @@ const tag = ({ data, eventName, manifestVariables, eventId }) => {
     }
     return {
         loaded: isLoaded,
-        sdkVersion: "0.72.0" ,
+        sdkVersion: "1.0.0" ,
     };
 };
 
-const consent = ({ hasConsent }) => {
+const consent = ({ consentData, variables }) => {
     if (!(window === null || window === void 0 ? void 0 : window.gtag)) {
         return;
     }
+    const isAdvancedConsentModeEnabled = variables.some((variable) => { var _a; return ((_a = variable.variableSet) === null || _a === void 0 ? void 0 : _a['advancedConsentMode']) === '1'; });
+    const data = isAdvancedConsentModeEnabled
+        ? getGoogleConsentFromCategories(consentData.categories)
+        : getGoogleConsentFromChannels(consentData.consent);
     window.gtag('consent', 'update', {
-        analytics_storage: hasConsent ? 'granted' : 'denied',
+        ...data,
         functional_storage: 'granted',
         personalization_storage: 'granted',
         security_storage: 'granted',

package/index.js

@@ -4,6 +4,40 @@ var ProvidersGoogleAnalytics4Sdk = (function () {
     const packageName = 'googleAnalytics4';
     const tagManagerUrl = 'https://www.googletagmanager.com/gtag/js';
 
+    const isBool = (v) => typeof v == 'boolean';
+    const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
+    /**
+     * 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;
+    };
+    const isCategoryConsented = (consentCategories, category) => {
+        if (!consentCategories)
+            return false;
+        let allowed = isBool(consentCategories.all) ? consentCategories.all : false;
+        if (category in consentCategories) {
+            const categorySpecific = consentCategories[category];
+            if (isBool(categorySpecific)) {
+                allowed = categorySpecific;
+            }
+        }
+        return allowed;
+    };
+
     const upsert = (map, key, update, createDefault) => {
         const currentValue = map.has(key)
             ? map.get(key)
@@ -305,7 +339,30 @@ var ProvidersGoogleAnalytics4Sdk = (function () {
     new Set(isoCountries.keys());
 
     // eslint-disable-next-line @nx/enforce-module-boundaries
-    const initGA4 = (ID, executionContext) => {
+    const getGoogleConsentFromCategories = (categories) => {
+        const advertisingConsent = isCategoryConsented(categories, 'advertising');
+        const analyticsConsent = isCategoryConsented(categories, 'analytics');
+        return {
+            analytics_storage: analyticsConsent ? 'granted' : 'denied',
+            ad_storage: advertisingConsent ? 'granted' : 'denied',
+            ad_user_data: advertisingConsent ? 'granted' : 'denied',
+            ad_personalization: advertisingConsent ? 'granted' : 'denied',
+        };
+    };
+    // TODO: once categories becomes a stable field, we need to remove this and start using categories data for google consent mode.
+    const getGoogleConsentFromChannels = (consent) => {
+        const gadsConsent = hasUserConsentForProvider(consent, 'googleAdsClicks');
+        const ga4Consent = hasUserConsentForProvider(consent, 'googleAnalytics4');
+        return {
+            analytics_storage: ga4Consent ? 'granted' : 'denied',
+            ad_storage: gadsConsent ? 'granted' : 'denied',
+            ad_user_data: gadsConsent ? 'granted' : 'denied',
+            ad_personalization: gadsConsent ? 'granted' : 'denied',
+        };
+    };
+
+    // eslint-disable-next-line @nx/enforce-module-boundaries
+    const initGA4 = (ID, advancedConsentMode, consentData, executionContext) => {
         var _a;
         window.dataLayer = window.dataLayer || [];
         window.gtag = function gtag() {
@@ -319,14 +376,15 @@ var ProvidersGoogleAnalytics4Sdk = (function () {
                 break;
             }
         }
+        const data = advancedConsentMode === '1'
+            ? getGoogleConsentFromCategories(consentData.categories)
+            : getGoogleConsentFromChannels(consentData.consent);
         if (isConsentInitialised) {
-            window.gtag('consent', 'update', {
-                analytics_storage: 'granted',
-            });
+            window.gtag('consent', 'update', data);
         }
         else {
             window.gtag('consent', 'default', {
-                analytics_storage: 'granted',
+                ...data,
                 functional_storage: 'granted',
                 personalization_storage: 'granted',
                 security_storage: 'granted',
@@ -344,7 +402,7 @@ var ProvidersGoogleAnalytics4Sdk = (function () {
             script.parentNode.insertBefore(element, script);
         }
     };
-    const init = ({ manifest, userId, executionContext }) => {
+    const init = ({ manifest, userId, executionContext, consentData, }) => {
         if (!window ||
             !manifest.variables ||
             !manifest.variables['measurementId'] ||
@@ -353,7 +411,7 @@ var ProvidersGoogleAnalytics4Sdk = (function () {
         }
         if (!window.google_tag_manager ||
             !window.google_tag_manager[manifest.variables['measurementId']]) {
-            initGA4(manifest.variables['measurementId'], executionContext);
+            initGA4(manifest.variables['measurementId'], manifest.variables['advancedConsentMode'], consentData, executionContext);
         }
         if (window.gtag) {
             window.gtag('config', manifest.variables['measurementId'], {
@@ -614,16 +672,20 @@ var ProvidersGoogleAnalytics4Sdk = (function () {
         }
         return {
             loaded: isLoaded,
-            sdkVersion: "0.72.0" ,
+            sdkVersion: "1.0.0" ,
         };
     };
 
-    const consent = ({ hasConsent }) => {
+    const consent = ({ consentData, variables }) => {
         if (!(window === null || window === void 0 ? void 0 : window.gtag)) {
             return;
         }
+        const isAdvancedConsentModeEnabled = variables.some((variable) => { var _a; return ((_a = variable.variableSet) === null || _a === void 0 ? void 0 : _a['advancedConsentMode']) === '1'; });
+        const data = isAdvancedConsentModeEnabled
+            ? getGoogleConsentFromCategories(consentData.categories)
+            : getGoogleConsentFromChannels(consentData.consent);
         window.gtag('consent', 'update', {
-            analytics_storage: hasConsent ? 'granted' : 'denied',
+            ...data,
             functional_storage: 'granted',
             personalization_storage: 'granted',
             security_storage: 'granted',

package/index.mjs

@@ -1,6 +1,40 @@
 const packageName = 'googleAnalytics4';
 const tagManagerUrl = 'https://www.googletagmanager.com/gtag/js';
 
+const isBool = (v) => typeof v == 'boolean';
+const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
+/**
+ * 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;
+};
+const isCategoryConsented = (consentCategories, category) => {
+    if (!consentCategories)
+        return false;
+    let allowed = isBool(consentCategories.all) ? consentCategories.all : false;
+    if (category in consentCategories) {
+        const categorySpecific = consentCategories[category];
+        if (isBool(categorySpecific)) {
+            allowed = categorySpecific;
+        }
+    }
+    return allowed;
+};
+
 const upsert = (map, key, update, createDefault) => {
     const currentValue = map.has(key)
         ? map.get(key)
@@ -302,7 +336,30 @@ const isoCountries = new Map([
 new Set(isoCountries.keys());
 
 // eslint-disable-next-line @nx/enforce-module-boundaries
-const initGA4 = (ID, executionContext) => {
+const getGoogleConsentFromCategories = (categories) => {
+    const advertisingConsent = isCategoryConsented(categories, 'advertising');
+    const analyticsConsent = isCategoryConsented(categories, 'analytics');
+    return {
+        analytics_storage: analyticsConsent ? 'granted' : 'denied',
+        ad_storage: advertisingConsent ? 'granted' : 'denied',
+        ad_user_data: advertisingConsent ? 'granted' : 'denied',
+        ad_personalization: advertisingConsent ? 'granted' : 'denied',
+    };
+};
+// TODO: once categories becomes a stable field, we need to remove this and start using categories data for google consent mode.
+const getGoogleConsentFromChannels = (consent) => {
+    const gadsConsent = hasUserConsentForProvider(consent, 'googleAdsClicks');
+    const ga4Consent = hasUserConsentForProvider(consent, 'googleAnalytics4');
+    return {
+        analytics_storage: ga4Consent ? 'granted' : 'denied',
+        ad_storage: gadsConsent ? 'granted' : 'denied',
+        ad_user_data: gadsConsent ? 'granted' : 'denied',
+        ad_personalization: gadsConsent ? 'granted' : 'denied',
+    };
+};
+
+// eslint-disable-next-line @nx/enforce-module-boundaries
+const initGA4 = (ID, advancedConsentMode, consentData, executionContext) => {
     var _a;
     window.dataLayer = window.dataLayer || [];
     window.gtag = function gtag() {
@@ -316,14 +373,15 @@ const initGA4 = (ID, executionContext) => {
             break;
         }
     }
+    const data = advancedConsentMode === '1'
+        ? getGoogleConsentFromCategories(consentData.categories)
+        : getGoogleConsentFromChannels(consentData.consent);
     if (isConsentInitialised) {
-        window.gtag('consent', 'update', {
-            analytics_storage: 'granted',
-        });
+        window.gtag('consent', 'update', data);
     }
     else {
         window.gtag('consent', 'default', {
-            analytics_storage: 'granted',
+            ...data,
             functional_storage: 'granted',
             personalization_storage: 'granted',
             security_storage: 'granted',
@@ -341,7 +399,7 @@ const initGA4 = (ID, executionContext) => {
         script.parentNode.insertBefore(element, script);
     }
 };
-const init = ({ manifest, userId, executionContext }) => {
+const init = ({ manifest, userId, executionContext, consentData, }) => {
     if (!window ||
         !manifest.variables ||
         !manifest.variables['measurementId'] ||
@@ -350,7 +408,7 @@ const init = ({ manifest, userId, executionContext }) => {
     }
     if (!window.google_tag_manager ||
         !window.google_tag_manager[manifest.variables['measurementId']]) {
-        initGA4(manifest.variables['measurementId'], executionContext);
+        initGA4(manifest.variables['measurementId'], manifest.variables['advancedConsentMode'], consentData, executionContext);
     }
     if (window.gtag) {
         window.gtag('config', manifest.variables['measurementId'], {
@@ -611,16 +669,20 @@ const tag = ({ data, eventName, manifestVariables, eventId }) => {
     }
     return {
         loaded: isLoaded,
-        sdkVersion: "0.72.0" ,
+        sdkVersion: "1.0.0" ,
     };
 };
 
-const consent = ({ hasConsent }) => {
+const consent = ({ consentData, variables }) => {
     if (!(window === null || window === void 0 ? void 0 : window.gtag)) {
         return;
     }
+    const isAdvancedConsentModeEnabled = variables.some((variable) => { var _a; return ((_a = variable.variableSet) === null || _a === void 0 ? void 0 : _a['advancedConsentMode']) === '1'; });
+    const data = isAdvancedConsentModeEnabled
+        ? getGoogleConsentFromCategories(consentData.categories)
+        : getGoogleConsentFromChannels(consentData.consent);
     window.gtag('consent', 'update', {
-        analytics_storage: hasConsent ? 'granted' : 'denied',
+        ...data,
         functional_storage: 'granted',
         personalization_storage: 'granted',
         security_storage: 'granted',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/providers-google-analytics-4-sdk",
-  "version": "0.72.0",
+  "version": "1.0.0",
   "description": "Google Analytics 4 Browser SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",