@blotoutio/edgetag-sdk-js 0.72.0 → 1.0.0

package/index.cjs.js

@@ -42,25 +42,6 @@ const hasUserConsent = (consent, provider, tagName) => {
     }
     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`.
@@ -564,6 +545,7 @@ const areEqual = (a, b) => {
 
 const tagStorage = 'edgeTag';
 const consentKey = 'consent';
+const consentCategoriesKey = 'consentCategories';
 const keyPrefix = `_worker`;
 const cookieKey = 'tag_user_id';
 const fallbackSessionKey = 'fallback_tag_user_id';
@@ -851,7 +833,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "0.72.0" ,
+        sdkVersion: "1.0.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -941,6 +923,13 @@ const getConsent$1 = (destination) => {
     }
     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 {
@@ -1180,37 +1169,42 @@ const handleData = (data, providers, options) => {
     });
 };
 
-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);
     }
@@ -1250,6 +1244,10 @@ const processConsent = (destination, consent, options) => {
                 executionContext,
                 session: null,
                 destination,
+                consentData: {
+                    consent,
+                    categories: { ...consentCategories, necessary: true },
+                },
             });
         }
     }
@@ -1270,9 +1268,17 @@ const processConsent = (destination, consent, options) => {
         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,
+        });
     }
 };
 
@@ -1454,6 +1460,10 @@ const handleManifest = (destination, response) => {
                     keyName,
                     executionContext,
                     destination,
+                    consentData: {
+                        consent: response.consent,
+                        categories: response.consentCategories,
+                    },
                 });
             }
         }
@@ -1497,7 +1507,11 @@ const handleInit = (preferences) => {
     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 });
@@ -1518,7 +1532,7 @@ const handleInit = (preferences) => {
             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) => {
@@ -1710,8 +1724,8 @@ const init = (preferences) => {
 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/index.mjs

@@ -40,25 +40,6 @@ const hasUserConsent = (consent, provider, tagName) => {
     }
     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`.
@@ -562,6 +543,7 @@ const areEqual = (a, b) => {
 
 const tagStorage = 'edgeTag';
 const consentKey = 'consent';
+const consentCategoriesKey = 'consentCategories';
 const keyPrefix = `_worker`;
 const cookieKey = 'tag_user_id';
 const fallbackSessionKey = 'fallback_tag_user_id';
@@ -849,7 +831,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "0.72.0" ,
+        sdkVersion: "1.0.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -939,6 +921,13 @@ const getConsent$1 = (destination) => {
     }
     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 {
@@ -1178,37 +1167,42 @@ const handleData = (data, providers, options) => {
     });
 };
 
-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);
     }
@@ -1248,6 +1242,10 @@ const processConsent = (destination, consent, options) => {
                 executionContext,
                 session: null,
                 destination,
+                consentData: {
+                    consent,
+                    categories: { ...consentCategories, necessary: true },
+                },
             });
         }
     }
@@ -1268,9 +1266,17 @@ const processConsent = (destination, consent, options) => {
         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,
+        });
     }
 };
 
@@ -1452,6 +1458,10 @@ const handleManifest = (destination, response) => {
                     keyName,
                     executionContext,
                     destination,
+                    consentData: {
+                        consent: response.consent,
+                        categories: response.consentCategories,
+                    },
                 });
             }
         }
@@ -1495,7 +1505,11 @@ const handleInit = (preferences) => {
     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 });
@@ -1516,7 +1530,7 @@ const handleInit = (preferences) => {
             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) => {
@@ -1708,8 +1722,8 @@ const init = (preferences) => {
 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/internal.d.ts

@@ -3,6 +3,7 @@ import {
   Library,
   ProvidersConfig,
   UserConsent,
+  UserConsentCategories,
 } from '@blotoutio/cdn/types'
 import { UserKey, Data, Manifest } from './index'
 
@@ -51,6 +52,7 @@ type InitResponse = {
   userId?: string
   storageId?: number
   consent: UserConsent
+  consentCategories: UserConsentCategories
   consentSetting: ConsentSetting
   isNewUser?: boolean
   session: {

package/package.json

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