@duckduckgo/autoconsent 1.0.4 → 1.0.7

package/dist/autoconsent.cjs.js

@@ -2,6 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+const enableLogs = false; // change this to enable debug logs
+
 /* eslint-disable no-restricted-syntax,no-await-in-loop,no-underscore-dangle */
 async function waitFor(predicate, maxTimes, interval) {
     let result = await predicate();
@@ -17,7 +19,7 @@ async function waitFor(predicate, maxTimes, interval) {
 async function success(action) {
     const result = await action;
     if (!result) {
-        throw new Error(`Action failed: ${action}`);
+        throw new Error(`Action failed: ${action} ${result}`);
     }
     return result;
 }
@@ -181,7 +183,6 @@ class TabActions {
         this.id = tabId;
     }
     async elementExists(selector, frameId = 0) {
-        console.log(`check for  ${selector} in tab ${this.id}, frame ${frameId}`);
         return this.sendContentMessage(this.id, {
             type: "elemExists",
             selector
@@ -190,7 +191,6 @@ class TabActions {
         });
     }
     async clickElement(selector, frameId = 0) {
-        console.log(`click element ${selector} in tab ${this.id}`);
         return this.sendContentMessage(this.id, {
             type: "click",
             selector
@@ -199,7 +199,6 @@ class TabActions {
         });
     }
     async clickElements(selector, frameId = 0) {
-        console.log(`click elements ${selector} in tab ${this.id}`);
         return this.sendContentMessage(this.id, {
             type: "click",
             all: true,
@@ -242,10 +241,11 @@ class TabActions {
         }
         return false;
     }
-    async hideElements(selectors, frameId = 0) {
+    async hideElements(selectors, frameId = 0, method = 'display') {
         return this.sendContentMessage(this.id, {
             type: "hide",
-            selectors
+            selectors,
+            method,
         }, { frameId });
     }
     async undoHideElements(frameId = 0) {
@@ -261,7 +261,9 @@ class TabActions {
     }
     wait(ms) {
         return new Promise(resolve => {
-            setTimeout(() => resolve(true), ms);
+            setTimeout(() => {
+                resolve(true);
+            }, ms);
         });
     }
     matches(matcherConfig) {
@@ -645,9 +647,37 @@ async function evalAction(config) {
     });
 }
 
+// get or create a style container for CSS overrides
+function getStyleElementUtil() {
+    const styleOverrideElementId = "autoconsent-css-rules";
+    const styleSelector = `style#${styleOverrideElementId}`;
+    const existingElement = document.querySelector(styleSelector);
+    if (existingElement && existingElement instanceof HTMLStyleElement) {
+        return existingElement;
+    }
+    else {
+        const parent = document.head ||
+            document.getElementsByTagName("head")[0] ||
+            document.documentElement;
+        const css = document.createElement("style");
+        css.id = styleOverrideElementId;
+        parent.appendChild(css);
+        return css;
+    }
+}
+// hide elements with a CSS rule
+function hideElementsUtil(selectors, method) {
+    const hidingSnippet = method === 'display' ? `display: none` : `opacity: 0`;
+    const rule = `${selectors.join(",")} { ${hidingSnippet} !important; z-index: -1 !important; pointer-events: none !important; } `;
+    const styleEl = getStyleElementUtil();
+    if (styleEl instanceof HTMLStyleElement) {
+        styleEl.innerText += rule;
+        return selectors.length > 0;
+    }
+    return false;
+}
+
 let actionQueue = Promise.resolve(null);
-const styleOverrideElementId = "autoconsent-css-rules";
-const styleSelector = `style#${styleOverrideElementId}`;
 function handleMessage(message, debug = false) {
     if (message.type === "click") {
         const elem = document.querySelectorAll(message.selector);
@@ -671,8 +701,19 @@ function handleMessage(message, debug = false) {
         const elem = document.querySelectorAll(message.selector);
         const results = new Array(elem.length);
         elem.forEach((e, i) => {
-            results[i] = e.offsetParent !== null || window.getComputedStyle(e).display !== "none" || e.style?.display !== "none";
+            // check for display: none
+            results[i] = false;
+            if (e.offsetParent !== null) {
+                results[i] = true;
+            }
+            else {
+                const css = window.getComputedStyle(e);
+                if (css.position === 'fixed' && css.display !== "none") { // fixed elements may be visible even if the parent is not
+                    results[i] = true;
+                }
+            }
         });
+        debug && console.log("[visible?]", message.selector, elem, results);
         if (results.length === 0) {
             return false;
         }
@@ -687,6 +728,7 @@ function handleMessage(message, debug = false) {
     }
     else if (message.type === "getAttribute") {
         const elem = document.querySelector(message.selector);
+        debug && console.log("[getAttribute]", message.selector, elem);
         if (!elem) {
             return false;
         }
@@ -694,31 +736,16 @@ function handleMessage(message, debug = false) {
     }
     else if (message.type === "eval") {
         // TODO: chrome support
+        debug && console.log("about to [eval]", message.script); // this will not show in Webkit console
         const result = window.eval(message.script); // eslint-disable-line no-eval
-        debug && console.log("[eval]", message.script, result);
         return result;
     }
     else if (message.type === "hide") {
-        const parent = document.head ||
-            document.getElementsByTagName("head")[0] ||
-            document.documentElement;
-        const rule = `${message.selectors.join(",")} { display: none !important; z-index: -1 !important; } `;
-        const existingElement = document.querySelector(styleSelector);
-        debug && console.log("[hide]", message.selectors, !!existingElement);
-        if (existingElement && existingElement instanceof HTMLStyleElement) {
-            existingElement.innerText += rule;
-        }
-        else {
-            const css = document.createElement("style");
-            css.type = "text/css";
-            css.id = styleOverrideElementId;
-            css.appendChild(document.createTextNode(rule));
-            parent.appendChild(css);
-        }
-        return message.selectors.length > 0;
+        debug && console.log("[hide]", message.selectors);
+        return hideElementsUtil(message.selectors, message.method);
     }
     else if (message.type === "undohide") {
-        const existingElement = document.querySelector(styleSelector);
+        const existingElement = getStyleElementUtil();
         debug && console.log("[unhide]", !!existingElement);
         if (existingElement) {
             existingElement.remove();
@@ -727,9 +754,11 @@ function handleMessage(message, debug = false) {
     }
     else if (message.type === "matches") {
         const matched = matches(message.config);
+        debug && console.log("[matches?]", message.config.type, JSON.stringify(message.config), matched);
         return matched;
     }
     else if (message.type === "executeAction") {
+        debug && console.log("[executeAction]", message);
         actionQueue = actionQueue.then(() => executeAction(message.config, message.param));
         return true;
     }
@@ -758,10 +787,12 @@ class TabConsent {
     }
     async doOptOut() {
         try {
+            enableLogs && console.log(`doing opt out ${this.getCMPName()} in tab ${this.tab.id}`);
             this.optOutStatus = await this.rule.optOut(this.tab);
             return this.optOutStatus;
         }
         catch (e) {
+            console.error('error during opt out', e);
             this.optOutStatus = e;
             throw e;
         }
@@ -806,6 +837,7 @@ async function detectDialog(tab, retries, rules) {
             try {
                 if (await r.detectCmp(tab)) {
                     earlyReturn = true;
+                    enableLogs && console.log(`Found CMP in [${tab.id}]: ${r.name}`);
                     resolve(index);
                 }
             }
@@ -1146,12 +1178,47 @@ class Evidon extends AutoConsentBase {
     }
 }
 
+class Onetrust extends AutoConsentBase {
+    constructor() {
+        super("Onetrust");
+        this.prehideSelectors = ["#onetrust-banner-sdk,#onetrust-consent-sdk,.optanon-alert-box-wrapper,.onetrust-pc-dark-filter,.js-consent-banner"];
+    }
+    detectCmp(tab) {
+        return tab.elementExists("#onetrust-banner-sdk,.optanon-alert-box-wrapper");
+    }
+    detectPopup(tab) {
+        return tab.elementsAreVisible("#onetrust-banner-sdk,.optanon-alert-box-wrapper");
+    }
+    async optOut(tab) {
+        if (await tab.elementExists("#onetrust-pc-btn-handler")) { // "show purposes" button inside a popup
+            await success(tab.clickElement("#onetrust-pc-btn-handler"));
+        }
+        else { // otherwise look for a generic "show settings" button
+            await success(tab.clickElement(".ot-sdk-show-settings,button.js-cookie-settings"));
+        }
+        await success(tab.waitForElement("#onetrust-consent-sdk", 2000));
+        await success(tab.wait(1000));
+        await tab.clickElements("#onetrust-consent-sdk input.category-switch-handler:checked,.js-editor-toggle-state:checked"); // optional step
+        await success(tab.waitForThenClick(".save-preference-btn-handler,.js-consent-save", 1000));
+        // popup doesn't disappear immediately
+        await waitFor(async () => !(await tab.elementsAreVisible("#onetrust-banner-sdk")), 10, 500);
+        return true;
+    }
+    async optIn(tab) {
+        return tab.clickElement("onetrust-accept-btn-handler,js-accept-cookies");
+    }
+    async test(tab) {
+        return tab.eval("window.OnetrustActiveGroups.split(',').filter(s => s.length > 0).length <= 1");
+    }
+}
+
 const rules = [
     new TrustArc(),
     new Cookiebot(),
     new SourcePoint(),
     new ConsentManager(),
     new Evidon(),
+    new Onetrust(),
 ];
 function createAutoCMP(config) {
     return new AutoConsent(config);
@@ -1223,7 +1290,7 @@ async function prehideElements(tab, rules) {
         }
         return selectorList;
     }, globalHidden);
-    await tab.hideElements(selectors);
+    await tab.hideElements(selectors, undefined, 'opacity');
 }
 
 class AutoConsent$1 {

package/dist/autoconsent.esm.js

@@ -1,3 +1,5 @@
+const enableLogs = false; // change this to enable debug logs
+
 /* eslint-disable no-restricted-syntax,no-await-in-loop,no-underscore-dangle */
 async function waitFor(predicate, maxTimes, interval) {
     let result = await predicate();
@@ -13,7 +15,7 @@ async function waitFor(predicate, maxTimes, interval) {
 async function success(action) {
     const result = await action;
     if (!result) {
-        throw new Error(`Action failed: ${action}`);
+        throw new Error(`Action failed: ${action} ${result}`);
     }
     return result;
 }
@@ -177,7 +179,6 @@ class TabActions {
         this.id = tabId;
     }
     async elementExists(selector, frameId = 0) {
-        console.log(`check for  ${selector} in tab ${this.id}, frame ${frameId}`);
         return this.sendContentMessage(this.id, {
             type: "elemExists",
             selector
@@ -186,7 +187,6 @@ class TabActions {
         });
     }
     async clickElement(selector, frameId = 0) {
-        console.log(`click element ${selector} in tab ${this.id}`);
         return this.sendContentMessage(this.id, {
             type: "click",
             selector
@@ -195,7 +195,6 @@ class TabActions {
         });
     }
     async clickElements(selector, frameId = 0) {
-        console.log(`click elements ${selector} in tab ${this.id}`);
         return this.sendContentMessage(this.id, {
             type: "click",
             all: true,
@@ -238,10 +237,11 @@ class TabActions {
         }
         return false;
     }
-    async hideElements(selectors, frameId = 0) {
+    async hideElements(selectors, frameId = 0, method = 'display') {
         return this.sendContentMessage(this.id, {
             type: "hide",
-            selectors
+            selectors,
+            method,
         }, { frameId });
     }
     async undoHideElements(frameId = 0) {
@@ -257,7 +257,9 @@ class TabActions {
     }
     wait(ms) {
         return new Promise(resolve => {
-            setTimeout(() => resolve(true), ms);
+            setTimeout(() => {
+                resolve(true);
+            }, ms);
         });
     }
     matches(matcherConfig) {
@@ -641,9 +643,37 @@ async function evalAction(config) {
     });
 }
 
+// get or create a style container for CSS overrides
+function getStyleElementUtil() {
+    const styleOverrideElementId = "autoconsent-css-rules";
+    const styleSelector = `style#${styleOverrideElementId}`;
+    const existingElement = document.querySelector(styleSelector);
+    if (existingElement && existingElement instanceof HTMLStyleElement) {
+        return existingElement;
+    }
+    else {
+        const parent = document.head ||
+            document.getElementsByTagName("head")[0] ||
+            document.documentElement;
+        const css = document.createElement("style");
+        css.id = styleOverrideElementId;
+        parent.appendChild(css);
+        return css;
+    }
+}
+// hide elements with a CSS rule
+function hideElementsUtil(selectors, method) {
+    const hidingSnippet = method === 'display' ? `display: none` : `opacity: 0`;
+    const rule = `${selectors.join(",")} { ${hidingSnippet} !important; z-index: -1 !important; pointer-events: none !important; } `;
+    const styleEl = getStyleElementUtil();
+    if (styleEl instanceof HTMLStyleElement) {
+        styleEl.innerText += rule;
+        return selectors.length > 0;
+    }
+    return false;
+}
+
 let actionQueue = Promise.resolve(null);
-const styleOverrideElementId = "autoconsent-css-rules";
-const styleSelector = `style#${styleOverrideElementId}`;
 function handleMessage(message, debug = false) {
     if (message.type === "click") {
         const elem = document.querySelectorAll(message.selector);
@@ -667,8 +697,19 @@ function handleMessage(message, debug = false) {
         const elem = document.querySelectorAll(message.selector);
         const results = new Array(elem.length);
         elem.forEach((e, i) => {
-            results[i] = e.offsetParent !== null || window.getComputedStyle(e).display !== "none" || e.style?.display !== "none";
+            // check for display: none
+            results[i] = false;
+            if (e.offsetParent !== null) {
+                results[i] = true;
+            }
+            else {
+                const css = window.getComputedStyle(e);
+                if (css.position === 'fixed' && css.display !== "none") { // fixed elements may be visible even if the parent is not
+                    results[i] = true;
+                }
+            }
         });
+        debug && console.log("[visible?]", message.selector, elem, results);
         if (results.length === 0) {
             return false;
         }
@@ -683,6 +724,7 @@ function handleMessage(message, debug = false) {
     }
     else if (message.type === "getAttribute") {
         const elem = document.querySelector(message.selector);
+        debug && console.log("[getAttribute]", message.selector, elem);
         if (!elem) {
             return false;
         }
@@ -690,31 +732,16 @@ function handleMessage(message, debug = false) {
     }
     else if (message.type === "eval") {
         // TODO: chrome support
+        debug && console.log("about to [eval]", message.script); // this will not show in Webkit console
         const result = window.eval(message.script); // eslint-disable-line no-eval
-        debug && console.log("[eval]", message.script, result);
         return result;
     }
     else if (message.type === "hide") {
-        const parent = document.head ||
-            document.getElementsByTagName("head")[0] ||
-            document.documentElement;
-        const rule = `${message.selectors.join(",")} { display: none !important; z-index: -1 !important; } `;
-        const existingElement = document.querySelector(styleSelector);
-        debug && console.log("[hide]", message.selectors, !!existingElement);
-        if (existingElement && existingElement instanceof HTMLStyleElement) {
-            existingElement.innerText += rule;
-        }
-        else {
-            const css = document.createElement("style");
-            css.type = "text/css";
-            css.id = styleOverrideElementId;
-            css.appendChild(document.createTextNode(rule));
-            parent.appendChild(css);
-        }
-        return message.selectors.length > 0;
+        debug && console.log("[hide]", message.selectors);
+        return hideElementsUtil(message.selectors, message.method);
     }
     else if (message.type === "undohide") {
-        const existingElement = document.querySelector(styleSelector);
+        const existingElement = getStyleElementUtil();
         debug && console.log("[unhide]", !!existingElement);
         if (existingElement) {
             existingElement.remove();
@@ -723,9 +750,11 @@ function handleMessage(message, debug = false) {
     }
     else if (message.type === "matches") {
         const matched = matches(message.config);
+        debug && console.log("[matches?]", message.config.type, JSON.stringify(message.config), matched);
         return matched;
     }
     else if (message.type === "executeAction") {
+        debug && console.log("[executeAction]", message);
         actionQueue = actionQueue.then(() => executeAction(message.config, message.param));
         return true;
     }
@@ -754,10 +783,12 @@ class TabConsent {
     }
     async doOptOut() {
         try {
+            enableLogs && console.log(`doing opt out ${this.getCMPName()} in tab ${this.tab.id}`);
             this.optOutStatus = await this.rule.optOut(this.tab);
             return this.optOutStatus;
         }
         catch (e) {
+            console.error('error during opt out', e);
             this.optOutStatus = e;
             throw e;
         }
@@ -802,6 +833,7 @@ async function detectDialog(tab, retries, rules) {
             try {
                 if (await r.detectCmp(tab)) {
                     earlyReturn = true;
+                    enableLogs && console.log(`Found CMP in [${tab.id}]: ${r.name}`);
                     resolve(index);
                 }
             }
@@ -1142,12 +1174,47 @@ class Evidon extends AutoConsentBase {
     }
 }
 
+class Onetrust extends AutoConsentBase {
+    constructor() {
+        super("Onetrust");
+        this.prehideSelectors = ["#onetrust-banner-sdk,#onetrust-consent-sdk,.optanon-alert-box-wrapper,.onetrust-pc-dark-filter,.js-consent-banner"];
+    }
+    detectCmp(tab) {
+        return tab.elementExists("#onetrust-banner-sdk,.optanon-alert-box-wrapper");
+    }
+    detectPopup(tab) {
+        return tab.elementsAreVisible("#onetrust-banner-sdk,.optanon-alert-box-wrapper");
+    }
+    async optOut(tab) {
+        if (await tab.elementExists("#onetrust-pc-btn-handler")) { // "show purposes" button inside a popup
+            await success(tab.clickElement("#onetrust-pc-btn-handler"));
+        }
+        else { // otherwise look for a generic "show settings" button
+            await success(tab.clickElement(".ot-sdk-show-settings,button.js-cookie-settings"));
+        }
+        await success(tab.waitForElement("#onetrust-consent-sdk", 2000));
+        await success(tab.wait(1000));
+        await tab.clickElements("#onetrust-consent-sdk input.category-switch-handler:checked,.js-editor-toggle-state:checked"); // optional step
+        await success(tab.waitForThenClick(".save-preference-btn-handler,.js-consent-save", 1000));
+        // popup doesn't disappear immediately
+        await waitFor(async () => !(await tab.elementsAreVisible("#onetrust-banner-sdk")), 10, 500);
+        return true;
+    }
+    async optIn(tab) {
+        return tab.clickElement("onetrust-accept-btn-handler,js-accept-cookies");
+    }
+    async test(tab) {
+        return tab.eval("window.OnetrustActiveGroups.split(',').filter(s => s.length > 0).length <= 1");
+    }
+}
+
 const rules = [
     new TrustArc(),
     new Cookiebot(),
     new SourcePoint(),
     new ConsentManager(),
     new Evidon(),
+    new Onetrust(),
 ];
 function createAutoCMP(config) {
     return new AutoConsent(config);
@@ -1219,7 +1286,7 @@ async function prehideElements(tab, rules) {
         }
         return selectorList;
     }, globalHidden);
-    await tab.hideElements(selectors);
+    await tab.hideElements(selectors, undefined, 'opacity');
 }
 
 class AutoConsent$1 {