@duckduckgo/autoconsent 14.97.0 → 15.0.0

package/dist/autoconsent.playwright.js

@@ -407,6 +407,14 @@
     });
   }
 
+  // lib/types.ts
+  var PopupHandlingModes = {
+    None: -1,
+    Reject: 0,
+    Tier1: 1,
+    Tier2: 2
+  };
+
   // lib/random.ts
   function getRandomID() {
     if (crypto && typeof crypto.randomUUID !== "undefined") {
@@ -716,7 +724,8 @@
         waits: false
       },
       performanceLoggingEnabled: false,
-      heuristicPopupSearchTimeout: 100
+      heuristicPopupSearchTimeout: 100,
+      heuristicMode: PopupHandlingModes.Reject
     };
     const updatedConfig = copyObject(defaultConfig);
     for (const key of Object.keys(defaultConfig)) {
@@ -883,12 +892,17 @@
     /^\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",
@@ -1464,6 +1478,64 @@
     /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"]';
@@ -1482,48 +1554,61 @@
     }
     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();
@@ -1537,6 +1622,21 @@
     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) {
@@ -1982,7 +2082,7 @@
     }
   };
   var AutoConsentHeuristicCMP = class extends AutoConsentCMPBase {
-    constructor(autoconsentInstance) {
+    constructor(autoconsentInstance, mode = PopupHandlingModes.Reject) {
       super(autoconsentInstance);
       this.popups = [];
       this.name = "HEURISTIC";
@@ -1991,6 +2091,7 @@
         frame: false
         // do not run in iframes for security reasons
       };
+      this.mode = mode;
     }
     get hasSelfTest() {
       return true;
@@ -2004,25 +2105,33 @@
     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);
       }
@@ -2035,7 +2144,7 @@
       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);
@@ -3505,7 +3614,7 @@
           }
         }
       });
-      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/types/cmps/base.d.ts

@@ -1,4 +1,4 @@
-import { AutoCMP, DomActionsProvider, PopupData } from '../types';
+import { AutoCMP, DomActionsProvider, PopupData, PopupHandlingMode } from '../types';
 import { AutoConsentCMPRule, AutoConsentRuleStep, ElementSelector, HideMethod, RunContext, VisibilityCheck } from '../rules';
 import AutoConsent from '../web';
 import { snippets } from '../eval-snippets';
@@ -62,12 +62,14 @@ export declare class AutoConsentCMP extends AutoConsentCMPBase {
 }
 export declare class AutoConsentHeuristicCMP extends AutoConsentCMPBase {
     popups: PopupData[];
-    constructor(autoconsentInstance: AutoConsent);
+    mode: PopupHandlingMode;
+    constructor(autoconsentInstance: AutoConsent, mode?: PopupHandlingMode);
     get hasSelfTest(): boolean;
     get isIntermediate(): boolean;
     get isCosmetic(): boolean;
     detectCmp(): Promise<boolean>;
     detectPopup(): Promise<boolean>;
+    getTargetButton(): import("../types").ButtonData | undefined;
     optOut(): Promise<boolean>;
     optIn(): Promise<boolean>;
     openCmp(): Promise<boolean>;

package/dist/types/heuristic-patterns.d.ts

@@ -4,3 +4,6 @@ export declare const DETECT_PATTERNS: RegExp[];
  */
 export declare const REJECT_PATTERNS: (string | RegExp)[];
 export declare const NEVER_MATCH_PATTERNS: RegExp[];
+export declare const SETTINGS_PATTERNS: (string | RegExp)[];
+export declare const ACCEPT_PATTERNS: (string | RegExp)[];
+export declare const ACKNOWLEDGE_PATTERNS: (string | RegExp)[];

package/dist/types/heuristics.d.ts

@@ -1,15 +1,12 @@
-import { ButtonData, PopupData } from './types';
+import { ButtonData, ButtonRegexClassification, PopupData, PopupHandlingMode } from './types';
 export declare function checkHeuristicPatterns(allText: string, detectPatterns?: RegExp[]): {
     patterns: string[];
     snippets: string[];
 };
-export declare function getActionablePopups(timeout?: number): PopupData[];
-export declare function classifyButtons(buttons: ButtonData[]): {
-    rejectButtons: ButtonData[];
-    otherButtons: ButtonData[];
-};
-export declare function isRejectButton(buttonText: string, rejectPatterns?: (string | RegExp)[], neverMatchPatterns?: RegExp[]): boolean;
+export declare function getActionablePopups(mode?: PopupHandlingMode, timeout?: number): PopupData[];
+export declare function classifyButtons(buttons: ButtonData[]): void;
 export declare function cleanButtonText(buttonText: string): string;
+export declare function classifyButtonTextRegex(buttonText: string): ButtonRegexClassification;
 export declare function isDialogLikeElement(node: HTMLElement): boolean;
 /**
  * Serialize all actionable buttons on the page

package/dist/types/types.d.ts

@@ -74,6 +74,7 @@ export type Config = {
     };
     performanceLoggingEnabled: boolean;
     heuristicPopupSearchTimeout: number;
+    heuristicMode: PopupHandlingMode;
 };
 export type LifecycleState = 'loading' | 'initialized' | 'waitingForInitResponse' | 'started' | 'nothingDetected' | 'cosmeticFiltersDetected' | 'cmpDetected' | 'openPopupDetected' | 'runningOptOut' | 'runningOptIn' | 'optOutSucceeded' | 'optOutFailed' | 'optInSucceeded' | 'optInFailed' | 'done';
 export type ConsentState = {
@@ -92,14 +93,29 @@ export type ConsentState = {
     endTime: number;
     performance?: Record<string, number[]>;
 };
+export type ButtonRegexClassification = 'reject' | 'settings' | 'accept' | 'acknowledge' | 'other';
 export interface ButtonData {
     text: string;
     element: HTMLElement;
+    regexClassification?: ButtonRegexClassification;
 }
 export interface PopupData {
     text: string;
     element: HTMLElement;
     buttons: ButtonData[];
-    rejectButtons?: ButtonData[];
-    otherButtons?: ButtonData[];
+    regexClassification?: PopupHandlingMode;
 }
+/**
+ * Controls the behavior of the heuristic popup detection.
+ *  - Reject: Will click the reject button on a popup if it exists.
+ *  - Tier1: Will also click the acknowledge button on a popup if it exists, and no Reject button exists.
+ *  - Tier2: Will also click the accept button on a popup if it exists, and no Reject or Acknowledge button exists.
+ *  - None: Disabled
+ */
+export declare const PopupHandlingModes: {
+    readonly None: -1;
+    readonly Reject: 0;
+    readonly Tier1: 1;
+    readonly Tier2: 2;
+};
+export type PopupHandlingMode = (typeof PopupHandlingModes)[keyof typeof PopupHandlingModes];

package/lib/cmps/base.ts

@@ -1,4 +1,4 @@
-import { AutoCMP, DomActionsProvider, PopupData } from '../types';
+import { AutoCMP, DomActionsProvider, PopupData, PopupHandlingMode, PopupHandlingModes } from '../types';
 import { AutoConsentCMPRule, AutoConsentRuleStep, ElementSelector, HideMethod, RunContext, VisibilityCheck } from '../rules';
 import { requestEval } from '../eval-handler';
 import AutoConsent from '../web';
@@ -419,14 +419,16 @@ export class AutoConsentCMP extends AutoConsentCMPBase {
 
 export class AutoConsentHeuristicCMP extends AutoConsentCMPBase {
     popups: PopupData[] = [];
+    mode: PopupHandlingMode;
 
-    constructor(autoconsentInstance: AutoConsent) {
+    constructor(autoconsentInstance: AutoConsent, mode: PopupHandlingMode = PopupHandlingModes.Reject) {
         super(autoconsentInstance);
         this.name = 'HEURISTIC';
         this.runContext = {
             main: true,
             frame: false, // do not run in iframes for security reasons
         } as RunContext;
+        this.mode = mode;
     }
 
     get hasSelfTest(): boolean {
@@ -445,11 +447,13 @@ export class AutoConsentHeuristicCMP extends AutoConsentCMPBase {
         // wait for one tick to deprioritize heavy DOM operations
         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);
@@ -457,17 +461,26 @@ export class AutoConsentHeuristicCMP extends AutoConsentCMPBase {
 
     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(): Promise<boolean> {
         // use only the first found popup candidate
-        const button = this.popups[0]?.rejectButtons?.[0];
+        const button = this.getTargetButton();
         if (button) {
             return this.clickElement(button.element);
         }
@@ -483,7 +496,7 @@ export class AutoConsentHeuristicCMP extends AutoConsentCMPBase {
     }
 
     async test(): Promise<boolean> {
-        const button = this.popups[0].rejectButtons?.[0];
+        const button = this.getTargetButton();
         if (button) {
             await this.wait(500);
             return !isElementVisible(button.element);

package/lib/heuristic-patterns.ts

@@ -115,14 +115,19 @@ const REJECT_PATTERNS_ENGLISH = [
 
     // 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',
 
     // 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,
 ];
 
 const REJECT_PATTERNS_DUTCH = [
@@ -715,3 +720,65 @@ export const NEVER_MATCH_PATTERNS = [
     /sostienici/is,
     /suscribir/is,
 ];
+
+export const 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',
+];
+
+export const 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,
+];
+
+export const ACKNOWLEDGE_PATTERNS = [
+    'ok',
+    'close',
+    'continue',
+    'x',
+    /^got it!?$/,
+    'i understand',
+    'dismiss',
+    'okay',
+    'acknowledge',
+    /^close (banner|cookie notification)$/is,
+    /understood$/is,
+    'confirm my choices',
+];