@duckduckgo/autoconsent 14.97.0 → 15.0.0

package/dist/autoconsent.cjs.js

@@ -435,6 +435,14 @@ async function evalAction(config) {
   });
 }
 
+// lib/types.ts
+var PopupHandlingModes = {
+  None: -1,
+  Reject: 0,
+  Tier1: 1,
+  Tier2: 2
+};
+
 // lib/random.ts
 function getRandomID() {
   if (crypto && typeof crypto.randomUUID !== "undefined") {
@@ -744,7 +752,8 @@ function normalizeConfig(providedConfig) {
       waits: false
     },
     performanceLoggingEnabled: false,
-    heuristicPopupSearchTimeout: 100
+    heuristicPopupSearchTimeout: 100,
+    heuristicMode: PopupHandlingModes.Reject
   };
   const updatedConfig = copyObject(defaultConfig);
   for (const key of Object.keys(defaultConfig)) {
@@ -911,12 +920,17 @@ var REJECT_PATTERNS_ENGLISH = [
   /^\s*(use|accept|allow|continue\s+with)?\s*only\s*(strictly)?\s*(necessary|essentials?|required)?\s*(cookies)?\s*$/is,
   // e.g. "do not sell or share my personal information", "do not sell my personal information"
   // often used in CCPA
-  /^\s*do\s+not\s+sell(\s+or\s+share)?\s*my\s*personal\s*information\s*$/is,
+  /^\s*do\s+not\s+sell(\s+or\s+share)?\s*my\s*personal\s*info(rmation)?\s*$/is,
   "allow selection",
-  "disagree and close"
+  "disagree and close",
   // These are impactful, but look error-prone
+  // // e.g. "disagree"
+  /^(i)?\s*disagree\s*(and\s+close)?$/i,
   // // e.g. "i do not agree"
   // /^\s*(i\s+)?do\s+not\s+agree\s*$/i,
+  "no",
+  /^no,? thanks$/is,
+  /^opt[ -]out$/is
 ];
 var REJECT_PATTERNS_DUTCH = [
   "weigeren",
@@ -1492,6 +1506,64 @@ var NEVER_MATCH_PATTERNS = [
   /sostienici/is,
   /suscribir/is
 ];
+var SETTINGS_PATTERNS = [
+  "settings",
+  "preferences",
+  /customi(s|z)e/is,
+  "show details",
+  "more options",
+  /(manage|configure) (my|your) (preferences|choices|cookies)/is,
+  "manage choices",
+  /(cookie )?preference center/is,
+  "change settings",
+  "configure",
+  "change my preferences",
+  "cookie manager",
+  "cookie preference",
+  "let me choose",
+  "cookieconsent preferences",
+  /privacy choices/is,
+  /(privacy|cookie|custom) settings/is,
+  /cookies? (settings|preferences|setting)/is,
+  /(manage|customize|customise|opt-out|edit).*(cookies|preferences|settings|options)/is,
+  "cookie consent options",
+  "privacy controls",
+  "show purposes",
+  // German
+  "einstellungen"
+];
+var ACCEPT_PATTERNS = [
+  /^(accept|allow)( all)?( cookies)?$/is,
+  /i (accept|allow)( all)?/is,
+  "yes",
+  /^(i )?agree$/is,
+  "continue with all",
+  "accept and continue",
+  /accept all above/is,
+  /^(accept|agree) and close/is,
+  "accept continue",
+  "agree proceed",
+  "allow and continue",
+  "close and accept",
+  /accept all$/is,
+  "im ok with that",
+  "accept optional cookies",
+  /^alle (cookies )?akzeptieren$/is
+];
+var ACKNOWLEDGE_PATTERNS = [
+  "ok",
+  "close",
+  "continue",
+  "x",
+  /^got it!?$/,
+  "i understand",
+  "dismiss",
+  "okay",
+  "acknowledge",
+  /^close (banner|cookie notification)$/is,
+  /understood$/is,
+  "confirm my choices"
+];
 
 // lib/heuristics.ts
 var BUTTON_LIKE_ELEMENT_SELECTOR = 'button, input[type="button"], input[type="submit"], a, [role="button"], [class*="button"]';
@@ -1510,48 +1582,61 @@ function checkHeuristicPatterns(allText, detectPatterns = DETECT_PATTERNS) {
   }
   return { patterns, snippets: snippets2 };
 }
-function getActionablePopups(timeout = POPUP_SEARCH_MAX_TIME) {
+function getActionablePopups(mode = PopupHandlingModes.Reject, timeout = POPUP_SEARCH_MAX_TIME) {
   const popups = getPotentialPopups(timeout);
   const result = popups.reduce((acc, popup) => {
     const popupText = popup.text?.trim();
     if (popupText) {
       const { patterns } = checkHeuristicPatterns(popupText);
       if (patterns.length > 0) {
-        const { rejectButtons, otherButtons } = classifyButtons(popup.buttons);
-        if (rejectButtons.length > 0) {
-          acc.push({
-            ...popup,
-            rejectButtons,
-            otherButtons
-          });
-        }
+        classifyButtons(popup.buttons);
+        popup.regexClassification = classifyPopup(popup.buttons);
+        acc.push({
+          ...popup
+        });
       }
     }
     return acc;
   }, []);
-  return result;
+  return result.filter(
+    (popup) => popup.regexClassification !== void 0 && popup.regexClassification !== PopupHandlingModes.None && popup.regexClassification <= mode
+  ).sort((a, b) => (a.regexClassification ?? 0) - (b.regexClassification ?? 0));
 }
 function classifyButtons(buttons) {
-  const rejectButtons = [];
-  const otherButtons = [];
   for (const button of buttons) {
-    if (isRejectButton(button.text)) {
-      rejectButtons.push(button);
-    } else {
-      otherButtons.push(button);
-    }
+    button.regexClassification = classifyButtonTextRegex(button.text);
   }
-  return {
-    rejectButtons,
-    otherButtons
-  };
 }
-function isRejectButton(buttonText, rejectPatterns = REJECT_PATTERNS, neverMatchPatterns = NEVER_MATCH_PATTERNS) {
+function classifyPopup(buttons) {
+  const { reject, settings, accept, acknowledge } = buttons.reduce(
+    (acc, button) => {
+      if (button.regexClassification && button.regexClassification !== "other") {
+        acc[button.regexClassification]++;
+      }
+      return acc;
+    },
+    { reject: 0, settings: 0, accept: 0, acknowledge: 0 }
+  );
+  if (reject > 0) {
+    return PopupHandlingModes.Reject;
+  }
+  if (settings > 0) {
+    return PopupHandlingModes.None;
+  }
+  if (acknowledge > 0) {
+    return PopupHandlingModes.Tier1;
+  }
+  if (accept > 0) {
+    return accept === 1 ? PopupHandlingModes.Tier2 : PopupHandlingModes.None;
+  }
+  return PopupHandlingModes.None;
+}
+function testButtonMatches(buttonText, matchPatterns, neverMatchPatterns) {
   if (!buttonText) {
     return false;
   }
   const cleanedButtonText = cleanButtonText(buttonText);
-  return !neverMatchPatterns.some((p) => p.test(cleanedButtonText)) && rejectPatterns.some((p) => p instanceof RegExp && p.test(cleanedButtonText) || p === cleanedButtonText);
+  return !neverMatchPatterns.some((p) => p instanceof RegExp && p.test(cleanedButtonText) || p === cleanedButtonText) && matchPatterns.some((p) => p instanceof RegExp && p.test(cleanedButtonText) || p === cleanedButtonText);
 }
 function cleanButtonText(buttonText) {
   let result = buttonText.toLowerCase();
@@ -1565,6 +1650,21 @@ function cleanButtonText(buttonText) {
   result = result.trim();
   return result;
 }
+function classifyButtonTextRegex(buttonText) {
+  if (testButtonMatches(buttonText, REJECT_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "reject";
+  }
+  if (testButtonMatches(buttonText, SETTINGS_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "settings";
+  }
+  if (testButtonMatches(buttonText, ACCEPT_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "accept";
+  }
+  if (testButtonMatches(buttonText, ACKNOWLEDGE_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "acknowledge";
+  }
+  return "other";
+}
 function getPotentialPopups(timeout = POPUP_SEARCH_MAX_TIME) {
   const isFramed = !isTopFrame();
   if (isFramed && window.parent && window.parent !== window.top) {
@@ -2010,7 +2110,7 @@ var AutoConsentCMP = class extends AutoConsentCMPBase {
   }
 };
 var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
-  constructor(autoconsentInstance) {
+  constructor(autoconsentInstance, mode = PopupHandlingModes.Reject) {
     super(autoconsentInstance);
     this.popups = [];
     this.name = "HEURISTIC";
@@ -2019,6 +2119,7 @@ var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
       frame: false
       // do not run in iframes for security reasons
     };
+    this.mode = mode;
   }
   get hasSelfTest() {
     return true;
@@ -2032,25 +2133,33 @@ var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
   async detectCmp() {
     await new Promise((resolve) => setTimeout(resolve, 0));
     this.autoconsent.config.performanceLoggingEnabled && performance.mark("heuristicDetectorStart");
-    this.popups = getActionablePopups(this.autoconsent.config.heuristicPopupSearchTimeout);
+    this.popups = getActionablePopups(this.mode, this.autoconsent.config.heuristicPopupSearchTimeout);
     this.autoconsent.config.performanceLoggingEnabled && performance.mark("heuristicDetectorEnd");
     this.autoconsent.config.performanceLoggingEnabled && performance.measure("heuristicDetector", "heuristicDetectorStart", "heuristicDetectorEnd");
     if (this.popups.length > 0) {
+      this.name = `HEURISTIC-TIER${this.popups[0].regexClassification}`;
       return Promise.resolve(true);
     }
     return Promise.resolve(false);
   }
   async detectPopup() {
     if (this.popups.length > 0) {
-      if (this.popups.length > 1 || this.popups[0].rejectButtons && this.popups[0].rejectButtons.length > 1) {
-        this.autoconsent.config.logs.errors && console.warn("Heuristic found multiple reject buttons");
+      if (this.popups.length > 1) {
+        this.autoconsent.config.logs.errors && console.warn("Heuristic found multiple popups");
       }
       return true;
     }
     return false;
   }
+  getTargetButton() {
+    const popup = this.popups[0];
+    const level = popup.regexClassification;
+    const buttons = popup.buttons;
+    const targetButtonType = level === PopupHandlingModes.Reject ? "reject" : level === PopupHandlingModes.Tier1 ? "acknowledge" : "accept";
+    return buttons.find((button) => button.regexClassification === targetButtonType);
+  }
   optOut() {
-    const button = this.popups[0]?.rejectButtons?.[0];
+    const button = this.getTargetButton();
     if (button) {
       return this.clickElement(button.element);
     }
@@ -2063,7 +2172,7 @@ var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
     throw new Error("Not Implemented");
   }
   async test() {
-    const button = this.popups[0].rejectButtons?.[0];
+    const button = this.getTargetButton();
     if (button) {
       await this.wait(500);
       return !isElementVisible(button.element);
@@ -3765,7 +3874,7 @@ var AutoConsent = class {
         }
       }
     });
-    const heuristicRules = isTop && this.config.enableHeuristicAction && this.state.findCmpAttempts % 2 === 0 ? [new AutoConsentHeuristicCMP(this)] : [];
+    const heuristicRules = isTop && this.config.enableHeuristicAction && this.state.findCmpAttempts % 2 === 0 ? [new AutoConsentHeuristicCMP(this, this.config.heuristicMode)] : [];
     const rulesPriorityStages = [
       ["site-specific", siteSpecificRules],
       ["generic", genericRules],

package/dist/autoconsent.esm.js

@@ -405,6 +405,14 @@ async function evalAction(config) {
   });
 }
 
+// lib/types.ts
+var PopupHandlingModes = {
+  None: -1,
+  Reject: 0,
+  Tier1: 1,
+  Tier2: 2
+};
+
 // lib/random.ts
 function getRandomID() {
   if (crypto && typeof crypto.randomUUID !== "undefined") {
@@ -714,7 +722,8 @@ function normalizeConfig(providedConfig) {
       waits: false
     },
     performanceLoggingEnabled: false,
-    heuristicPopupSearchTimeout: 100
+    heuristicPopupSearchTimeout: 100,
+    heuristicMode: PopupHandlingModes.Reject
   };
   const updatedConfig = copyObject(defaultConfig);
   for (const key of Object.keys(defaultConfig)) {
@@ -881,12 +890,17 @@ var REJECT_PATTERNS_ENGLISH = [
   /^\s*(use|accept|allow|continue\s+with)?\s*only\s*(strictly)?\s*(necessary|essentials?|required)?\s*(cookies)?\s*$/is,
   // e.g. "do not sell or share my personal information", "do not sell my personal information"
   // often used in CCPA
-  /^\s*do\s+not\s+sell(\s+or\s+share)?\s*my\s*personal\s*information\s*$/is,
+  /^\s*do\s+not\s+sell(\s+or\s+share)?\s*my\s*personal\s*info(rmation)?\s*$/is,
   "allow selection",
-  "disagree and close"
+  "disagree and close",
   // These are impactful, but look error-prone
+  // // e.g. "disagree"
+  /^(i)?\s*disagree\s*(and\s+close)?$/i,
   // // e.g. "i do not agree"
   // /^\s*(i\s+)?do\s+not\s+agree\s*$/i,
+  "no",
+  /^no,? thanks$/is,
+  /^opt[ -]out$/is
 ];
 var REJECT_PATTERNS_DUTCH = [
   "weigeren",
@@ -1462,6 +1476,64 @@ var NEVER_MATCH_PATTERNS = [
   /sostienici/is,
   /suscribir/is
 ];
+var SETTINGS_PATTERNS = [
+  "settings",
+  "preferences",
+  /customi(s|z)e/is,
+  "show details",
+  "more options",
+  /(manage|configure) (my|your) (preferences|choices|cookies)/is,
+  "manage choices",
+  /(cookie )?preference center/is,
+  "change settings",
+  "configure",
+  "change my preferences",
+  "cookie manager",
+  "cookie preference",
+  "let me choose",
+  "cookieconsent preferences",
+  /privacy choices/is,
+  /(privacy|cookie|custom) settings/is,
+  /cookies? (settings|preferences|setting)/is,
+  /(manage|customize|customise|opt-out|edit).*(cookies|preferences|settings|options)/is,
+  "cookie consent options",
+  "privacy controls",
+  "show purposes",
+  // German
+  "einstellungen"
+];
+var ACCEPT_PATTERNS = [
+  /^(accept|allow)( all)?( cookies)?$/is,
+  /i (accept|allow)( all)?/is,
+  "yes",
+  /^(i )?agree$/is,
+  "continue with all",
+  "accept and continue",
+  /accept all above/is,
+  /^(accept|agree) and close/is,
+  "accept continue",
+  "agree proceed",
+  "allow and continue",
+  "close and accept",
+  /accept all$/is,
+  "im ok with that",
+  "accept optional cookies",
+  /^alle (cookies )?akzeptieren$/is
+];
+var ACKNOWLEDGE_PATTERNS = [
+  "ok",
+  "close",
+  "continue",
+  "x",
+  /^got it!?$/,
+  "i understand",
+  "dismiss",
+  "okay",
+  "acknowledge",
+  /^close (banner|cookie notification)$/is,
+  /understood$/is,
+  "confirm my choices"
+];
 
 // lib/heuristics.ts
 var BUTTON_LIKE_ELEMENT_SELECTOR = 'button, input[type="button"], input[type="submit"], a, [role="button"], [class*="button"]';
@@ -1480,48 +1552,61 @@ function checkHeuristicPatterns(allText, detectPatterns = DETECT_PATTERNS) {
   }
   return { patterns, snippets: snippets2 };
 }
-function getActionablePopups(timeout = POPUP_SEARCH_MAX_TIME) {
+function getActionablePopups(mode = PopupHandlingModes.Reject, timeout = POPUP_SEARCH_MAX_TIME) {
   const popups = getPotentialPopups(timeout);
   const result = popups.reduce((acc, popup) => {
     const popupText = popup.text?.trim();
     if (popupText) {
       const { patterns } = checkHeuristicPatterns(popupText);
       if (patterns.length > 0) {
-        const { rejectButtons, otherButtons } = classifyButtons(popup.buttons);
-        if (rejectButtons.length > 0) {
-          acc.push({
-            ...popup,
-            rejectButtons,
-            otherButtons
-          });
-        }
+        classifyButtons(popup.buttons);
+        popup.regexClassification = classifyPopup(popup.buttons);
+        acc.push({
+          ...popup
+        });
       }
     }
     return acc;
   }, []);
-  return result;
+  return result.filter(
+    (popup) => popup.regexClassification !== void 0 && popup.regexClassification !== PopupHandlingModes.None && popup.regexClassification <= mode
+  ).sort((a, b) => (a.regexClassification ?? 0) - (b.regexClassification ?? 0));
 }
 function classifyButtons(buttons) {
-  const rejectButtons = [];
-  const otherButtons = [];
   for (const button of buttons) {
-    if (isRejectButton(button.text)) {
-      rejectButtons.push(button);
-    } else {
-      otherButtons.push(button);
-    }
+    button.regexClassification = classifyButtonTextRegex(button.text);
   }
-  return {
-    rejectButtons,
-    otherButtons
-  };
 }
-function isRejectButton(buttonText, rejectPatterns = REJECT_PATTERNS, neverMatchPatterns = NEVER_MATCH_PATTERNS) {
+function classifyPopup(buttons) {
+  const { reject, settings, accept, acknowledge } = buttons.reduce(
+    (acc, button) => {
+      if (button.regexClassification && button.regexClassification !== "other") {
+        acc[button.regexClassification]++;
+      }
+      return acc;
+    },
+    { reject: 0, settings: 0, accept: 0, acknowledge: 0 }
+  );
+  if (reject > 0) {
+    return PopupHandlingModes.Reject;
+  }
+  if (settings > 0) {
+    return PopupHandlingModes.None;
+  }
+  if (acknowledge > 0) {
+    return PopupHandlingModes.Tier1;
+  }
+  if (accept > 0) {
+    return accept === 1 ? PopupHandlingModes.Tier2 : PopupHandlingModes.None;
+  }
+  return PopupHandlingModes.None;
+}
+function testButtonMatches(buttonText, matchPatterns, neverMatchPatterns) {
   if (!buttonText) {
     return false;
   }
   const cleanedButtonText = cleanButtonText(buttonText);
-  return !neverMatchPatterns.some((p) => p.test(cleanedButtonText)) && rejectPatterns.some((p) => p instanceof RegExp && p.test(cleanedButtonText) || p === cleanedButtonText);
+  return !neverMatchPatterns.some((p) => p instanceof RegExp && p.test(cleanedButtonText) || p === cleanedButtonText) && matchPatterns.some((p) => p instanceof RegExp && p.test(cleanedButtonText) || p === cleanedButtonText);
 }
 function cleanButtonText(buttonText) {
   let result = buttonText.toLowerCase();
@@ -1535,6 +1620,21 @@ function cleanButtonText(buttonText) {
   result = result.trim();
   return result;
 }
+function classifyButtonTextRegex(buttonText) {
+  if (testButtonMatches(buttonText, REJECT_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "reject";
+  }
+  if (testButtonMatches(buttonText, SETTINGS_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "settings";
+  }
+  if (testButtonMatches(buttonText, ACCEPT_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "accept";
+  }
+  if (testButtonMatches(buttonText, ACKNOWLEDGE_PATTERNS, NEVER_MATCH_PATTERNS)) {
+    return "acknowledge";
+  }
+  return "other";
+}
 function getPotentialPopups(timeout = POPUP_SEARCH_MAX_TIME) {
   const isFramed = !isTopFrame();
   if (isFramed && window.parent && window.parent !== window.top) {
@@ -1980,7 +2080,7 @@ var AutoConsentCMP = class extends AutoConsentCMPBase {
   }
 };
 var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
-  constructor(autoconsentInstance) {
+  constructor(autoconsentInstance, mode = PopupHandlingModes.Reject) {
     super(autoconsentInstance);
     this.popups = [];
     this.name = "HEURISTIC";
@@ -1989,6 +2089,7 @@ var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
       frame: false
       // do not run in iframes for security reasons
     };
+    this.mode = mode;
   }
   get hasSelfTest() {
     return true;
@@ -2002,25 +2103,33 @@ var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
   async detectCmp() {
     await new Promise((resolve) => setTimeout(resolve, 0));
     this.autoconsent.config.performanceLoggingEnabled && performance.mark("heuristicDetectorStart");
-    this.popups = getActionablePopups(this.autoconsent.config.heuristicPopupSearchTimeout);
+    this.popups = getActionablePopups(this.mode, this.autoconsent.config.heuristicPopupSearchTimeout);
     this.autoconsent.config.performanceLoggingEnabled && performance.mark("heuristicDetectorEnd");
     this.autoconsent.config.performanceLoggingEnabled && performance.measure("heuristicDetector", "heuristicDetectorStart", "heuristicDetectorEnd");
     if (this.popups.length > 0) {
+      this.name = `HEURISTIC-TIER${this.popups[0].regexClassification}`;
       return Promise.resolve(true);
     }
     return Promise.resolve(false);
   }
   async detectPopup() {
     if (this.popups.length > 0) {
-      if (this.popups.length > 1 || this.popups[0].rejectButtons && this.popups[0].rejectButtons.length > 1) {
-        this.autoconsent.config.logs.errors && console.warn("Heuristic found multiple reject buttons");
+      if (this.popups.length > 1) {
+        this.autoconsent.config.logs.errors && console.warn("Heuristic found multiple popups");
       }
       return true;
     }
     return false;
   }
+  getTargetButton() {
+    const popup = this.popups[0];
+    const level = popup.regexClassification;
+    const buttons = popup.buttons;
+    const targetButtonType = level === PopupHandlingModes.Reject ? "reject" : level === PopupHandlingModes.Tier1 ? "acknowledge" : "accept";
+    return buttons.find((button) => button.regexClassification === targetButtonType);
+  }
   optOut() {
-    const button = this.popups[0]?.rejectButtons?.[0];
+    const button = this.getTargetButton();
     if (button) {
       return this.clickElement(button.element);
     }
@@ -2033,7 +2142,7 @@ var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
     throw new Error("Not Implemented");
   }
   async test() {
-    const button = this.popups[0].rejectButtons?.[0];
+    const button = this.getTargetButton();
     if (button) {
       await this.wait(500);
       return !isElementVisible(button.element);
@@ -3735,7 +3844,7 @@ var AutoConsent = class {
         }
       }
     });
-    const heuristicRules = isTop && this.config.enableHeuristicAction && this.state.findCmpAttempts % 2 === 0 ? [new AutoConsentHeuristicCMP(this)] : [];
+    const heuristicRules = isTop && this.config.enableHeuristicAction && this.state.findCmpAttempts % 2 === 0 ? [new AutoConsentHeuristicCMP(this, this.config.heuristicMode)] : [];
     const rulesPriorityStages = [
       ["site-specific", siteSpecificRules],
       ["generic", genericRules],