@blotoutio/edgetag-sdk-browser 0.72.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`.
@@ -565,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';
@@ -852,7 +834,7 @@
             referrer: getReferrer(destination),
             search: getSearch(destination),
             locale: getLocale(),
-            sdkVersion: "0.72.0" ,
+            sdkVersion: "1.0.0" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -942,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 {
@@ -1181,37 +1170,42 @@
         });
     };
 
-    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);
         }
@@ -1251,6 +1245,10 @@
                     executionContext,
                     session: null,
                     destination,
+                    consentData: {
+                        consent,
+                        categories: { ...consentCategories, necessary: true },
+                    },
                 });
             }
         }
@@ -1271,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,
+            });
         }
     };
 
@@ -1455,6 +1461,10 @@
                         keyName,
                         executionContext,
                         destination,
+                        consentData: {
+                            consent: response.consent,
+                            categories: response.consentCategories,
+                        },
                     });
                 }
             }
@@ -1498,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 });
@@ -1519,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) => {
@@ -1711,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.72.0",
+  "version": "1.0.0",
   "description": "Browser SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",