@duckduckgo/autoconsent 16.63.0 → 17.0.0

package/dist/autoconsent.cjs.js

@@ -187,6 +187,7 @@ function normalizeConfig(providedConfig) {
     },
     performanceLoggingEnabled: false,
     heuristicPopupSearchTimeout: 100,
+    enableHeuristicHitTest: false,
     heuristicMode: "off"
     // heuristic disabled by default
   };
@@ -1362,28 +1363,70 @@ function classifyButtonTextRegex(buttonText) {
 // lib/heuristics.ts
 var BUTTON_LIKE_ELEMENT_SELECTOR = 'button, input[type="button"], input[type="submit"], a, [role="button"], [class*="button"]';
 var POPUP_SEARCH_MAX_TIME = 100;
-function getActionablePopups(mode = "reject", timeout = POPUP_SEARCH_MAX_TIME) {
-  const acceptedLevels = mode === "tier2" ? ["reject", "tier1", "tier2"] : mode === "tier1" ? ["reject", "tier1"] : ["reject"];
-  const popups = getPotentialPopups(timeout).filter((popup) => {
-    const popupText = popup.text?.trim();
-    if (!popupText || isExcludedPopup(popupText) || !hasHeuristicPatterns(popupText)) {
-      return false;
-    }
-    popup.regexClassification = classifyPopup(popup.buttons);
-    return popup.regexClassification !== void 0 && acceptedLevels.includes(popup.regexClassification);
-  });
-  return popups.sort((a, b) => (a.regexClassification ?? "") > (b.regexClassification ?? "") ? 1 : -1);
+var ACCEPTED_LEVELS = {
+  off: [],
+  reject: ["reject"],
+  tier1: ["reject", "tier1"],
+  tier2: ["reject", "tier1", "tier2"]
+};
+function getActionablePopups(mode = "reject", timeout = POPUP_SEARCH_MAX_TIME, hitTest = false) {
+  const acceptedLevels = ACCEPTED_LEVELS[mode];
+  const isActionable = (popup) => acceptedLevels.includes(popup.regexClassification) && isConsentPopup(popup);
+  const popups = searchPopups(timeout, hitTest, DEFAULT_HIT_TEST_GRID, true).filter(isActionable);
+  return popups.sort((a, b) => classificationRank(a) - classificationRank(b));
 }
-function getPotentialPopups(timeout = POPUP_SEARCH_MAX_TIME) {
+function searchPopups(timeout, hitTest, hitTestGrid, stopOnReject = false) {
   if (!isTopFrame()) {
-    if (window.parent && window.parent !== window.top) {
-      return [];
-    }
-    const frameElement = getFramePopupElement(document);
-    const popup = frameElement && toPopupData(frameElement);
-    return popup ? [popup] : [];
+    return getFramePopups();
   }
   const deadline = performance.now() + timeout;
+  const hitTestPopups = hitTest ? findPopupsByHitTest(deadline, hitTestGrid) : [];
+  if (stopOnReject && hitTestPopups.some((p) => p.regexClassification === "reject" && isConsentPopup(p))) {
+    return hitTestPopups;
+  }
+  const walkPopups = collectPositionedPopups(deadline);
+  return [...walkPopups, ...mergeWalkOverlaps(hitTestPopups, walkPopups)];
+}
+var consentPopups = /* @__PURE__ */ new WeakMap();
+function classificationRank(popup) {
+  return ACCEPTED_LEVELS.tier2.indexOf(popup.regexClassification);
+}
+function isConsentPopup(popup) {
+  if (!ACCEPTED_LEVELS.tier2.includes(popup.regexClassification)) {
+    return false;
+  }
+  let result = consentPopups.get(popup);
+  if (result === void 0) {
+    const popupText = popup.text.trim();
+    result = !!popupText && !isExcludedPopup(popupText) && hasHeuristicPatterns(popupText);
+    consentPopups.set(popup, result);
+  }
+  return result;
+}
+function mergeWalkOverlaps(hitTestPopups, walkPopups) {
+  return hitTestPopups.filter((h) => {
+    const hitIsConsent = isConsentPopup(h);
+    const absorbs = (p) => !hitIsConsent || isConsentPopup(p) && classificationRank(p) <= classificationRank(h);
+    const walkPopup = walkPopups.find((p) => composedOverlaps(p.element, h.element) && absorbs(p));
+    if (walkPopup) {
+      (walkPopup.hitPoints ??= []).push(...h.hitPoints ?? []);
+    }
+    return !walkPopup;
+  });
+}
+function getFramePopups() {
+  if (window.parent && window.parent !== window.top) {
+    return [];
+  }
+  const frameElement = getFramePopupElement(document);
+  const popup = frameElement && toPopupData(frameElement);
+  if (!popup) {
+    return [];
+  }
+  popup.source = "frame";
+  return [popup];
+}
+function collectPositionedPopups(deadline) {
   const { elements, shadowHosts } = getPopupLikeElements(deadline);
   const potentialPopups = [];
   const expanded = [];
@@ -1399,17 +1442,86 @@ function getPotentialPopups(timeout = POPUP_SEARCH_MAX_TIME) {
     if (root !== popup) {
       expanded.push(root.element);
     }
+    root.source = "walk";
     potentialPopups.push(root);
   }
   return potentialPopups.filter((p) => !expanded.some((root) => root !== p.element && composedContains(root, p.element)));
 }
+var DEFAULT_HIT_TEST_GRID = {
+  columns: [0.1, 0.5, 0.9],
+  // banners sit along the top and bottom edges and modals in the middle; rows 150px in added almost nothing in crawls
+  edgeRows: [30, 90]
+};
+function findPopupsByHitTest(deadline, grid) {
+  const climbed = /* @__PURE__ */ new Map();
+  const found = [];
+  const toPopup = (el) => el.querySelector(TEXT_ENTRY_SELECTOR) ? null : toPopupRoot(el);
+  for (const [x, y] of getHitTestPoints(grid)) {
+    if (performance.now() > deadline) {
+      return found;
+    }
+    const path = [];
+    let reached = null;
+    const shouldStop = (el) => {
+      if (climbed.has(el)) {
+        reached = climbed.get(el) ?? null;
+        return true;
+      }
+      const overlapped = found.find((p) => composedOverlaps(p.element, el));
+      if (overlapped) {
+        reached = composedContains(overlapped.element, el) ? overlapped : null;
+        return true;
+      }
+      path.push(el);
+      return false;
+    };
+    const hit = closestHTMLElement(deepElementFromPoint(x, y));
+    const popup = climbToPopup(hit, MAX_HIT_TEST_CLIMB_DEPTH, toPopup, shouldStop);
+    if (popup) {
+      popup.source = "hitTest";
+      found.push(popup);
+      reached = popup;
+    }
+    for (const el of path) {
+      climbed.set(el, reached);
+    }
+    if (reached) {
+      (reached.hitPoints ??= []).push([x, y]);
+    }
+  }
+  return found;
+}
+function getHitTestPoints(grid) {
+  const { innerWidth: width, innerHeight: height } = window;
+  const rows = [...grid.edgeRows, height / 2, ...grid.edgeRows.map((y) => height - y)].map((y) => Math.round(y));
+  const ys = [...new Set(rows)].filter((y) => y >= 0 && y < height);
+  return ys.flatMap((y) => grid.columns.map((column) => [Math.round(column * width), y]));
+}
+var TEXT_ENTRY_SELECTOR = 'textarea, input:not([type]), input[type="text"], input[type="email"], input[type="password"], input[type="search"], input[type="tel"], input[type="number"], input[type="url"]';
+function deepElementFromPoint(x, y) {
+  let el = document.elementFromPoint(x, y);
+  while (el?.shadowRoot) {
+    const inner = el.shadowRoot.elementFromPoint(x, y);
+    if (!inner || inner === el) {
+      break;
+    }
+    el = inner;
+  }
+  return el;
+}
+function closestHTMLElement(el) {
+  while (el && !(el instanceof HTMLElement)) {
+    el = el.parentElement;
+  }
+  return el;
+}
 function toPopupData(el, shadowHosts, text = getElementText(el)) {
   if (!text) {
     return null;
   }
   const buttons = getButtonData(el, shadowHosts);
   classifyButtons(buttons);
-  return { text, element: el, buttons };
+  return { text, element: el, buttons, regexClassification: classifyPopup(buttons) };
 }
 function hasPopupButtons(text, buttons) {
   return !isOnlyButtonText(text, buttons) && buttons.some((b) => b.regexClassification !== "other");
@@ -1421,26 +1533,34 @@ function isOnlyButtonText(text, buttons) {
   }
   return rest.replace(/\s+/g, "").length < 10;
 }
+function toPopupRoot(el, shadowHosts) {
+  const text = getElementText(el);
+  if (!text || !hasHeuristicPatterns(text)) {
+    return null;
+  }
+  const popup = toPopupData(el, shadowHosts, text);
+  return popup && hasPopupButtons(text, popup.buttons) ? popup : null;
+}
 var MAX_FRAGMENT_EXPANSION_DEPTH = 6;
+var MAX_HIT_TEST_CLIMB_DEPTH = 8;
+function climbToPopup(el, maxDepth, toPopup, shouldStop) {
+  for (let depth = 0; el && depth < maxDepth; depth++, el = getComposedParent(el)) {
+    if (shouldStop?.(el) || el === document.body || el === document.documentElement || el.getBoundingClientRect().height > window.innerHeight) {
+      return null;
+    }
+    const popup = toPopup(el);
+    if (popup) {
+      return popup;
+    }
+  }
+  return null;
+}
 function expandPopupFragment(popup, shadowHosts) {
   if (hasHeuristicPatterns(popup.text) && hasPopupButtons(popup.text, popup.buttons)) {
     return popup;
   }
-  let el = getComposedParent(popup.element);
-  for (let depth = 0; el && depth < MAX_FRAGMENT_EXPANSION_DEPTH; depth++, el = getComposedParent(el)) {
-    if (el === document.body || el === document.documentElement || el.getBoundingClientRect().height > window.innerHeight) {
-      break;
-    }
-    const text = getElementText(el);
-    if (!text || !hasHeuristicPatterns(text)) {
-      continue;
-    }
-    const root = toPopupData(el, shadowHosts, text);
-    if (root && hasPopupButtons(text, root.buttons)) {
-      return root;
-    }
-  }
-  return popup;
+  const parent = getComposedParent(popup.element);
+  return climbToPopup(parent, MAX_FRAGMENT_EXPANSION_DEPTH, (el) => toPopupRoot(el, shadowHosts)) ?? popup;
 }
 function getComposedParent(el) {
   if (el.parentElement) {
@@ -1471,6 +1591,9 @@ function getElementText(el) {
 function isRenderedTextElement(el) {
   return el instanceof HTMLElement && !["STYLE", "SCRIPT", "TEMPLATE", "NOSCRIPT", "LINK", "SLOT"].includes(el.tagName) && window.getComputedStyle(el).display !== "none";
 }
+function composedOverlaps(a, b) {
+  return composedContains(a, b) || composedContains(b, a);
+}
 function composedContains(container, node) {
   if (container.contains(node)) {
     return true;
@@ -1962,7 +2085,11 @@ 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.mode, this.autoconsent.config.heuristicPopupSearchTimeout);
+    this.popups = getActionablePopups(
+      this.mode,
+      this.autoconsent.config.heuristicPopupSearchTimeout,
+      this.autoconsent.config.enableHeuristicHitTest
+    );
     this.autoconsent.config.performanceLoggingEnabled && performance.mark("heuristicDetectorEnd");
     this.autoconsent.config.performanceLoggingEnabled && performance.measure("heuristicDetector", "heuristicDetectorStart", "heuristicDetectorEnd");
     if (this.popups.length > 0) {

package/dist/autoconsent.esm.js

@@ -157,6 +157,7 @@ function normalizeConfig(providedConfig) {
     },
     performanceLoggingEnabled: false,
     heuristicPopupSearchTimeout: 100,
+    enableHeuristicHitTest: false,
     heuristicMode: "off"
     // heuristic disabled by default
   };
@@ -1332,28 +1333,70 @@ function classifyButtonTextRegex(buttonText) {
 // lib/heuristics.ts
 var BUTTON_LIKE_ELEMENT_SELECTOR = 'button, input[type="button"], input[type="submit"], a, [role="button"], [class*="button"]';
 var POPUP_SEARCH_MAX_TIME = 100;
-function getActionablePopups(mode = "reject", timeout = POPUP_SEARCH_MAX_TIME) {
-  const acceptedLevels = mode === "tier2" ? ["reject", "tier1", "tier2"] : mode === "tier1" ? ["reject", "tier1"] : ["reject"];
-  const popups = getPotentialPopups(timeout).filter((popup) => {
-    const popupText = popup.text?.trim();
-    if (!popupText || isExcludedPopup(popupText) || !hasHeuristicPatterns(popupText)) {
-      return false;
-    }
-    popup.regexClassification = classifyPopup(popup.buttons);
-    return popup.regexClassification !== void 0 && acceptedLevels.includes(popup.regexClassification);
-  });
-  return popups.sort((a, b) => (a.regexClassification ?? "") > (b.regexClassification ?? "") ? 1 : -1);
+var ACCEPTED_LEVELS = {
+  off: [],
+  reject: ["reject"],
+  tier1: ["reject", "tier1"],
+  tier2: ["reject", "tier1", "tier2"]
+};
+function getActionablePopups(mode = "reject", timeout = POPUP_SEARCH_MAX_TIME, hitTest = false) {
+  const acceptedLevels = ACCEPTED_LEVELS[mode];
+  const isActionable = (popup) => acceptedLevels.includes(popup.regexClassification) && isConsentPopup(popup);
+  const popups = searchPopups(timeout, hitTest, DEFAULT_HIT_TEST_GRID, true).filter(isActionable);
+  return popups.sort((a, b) => classificationRank(a) - classificationRank(b));
 }
-function getPotentialPopups(timeout = POPUP_SEARCH_MAX_TIME) {
+function searchPopups(timeout, hitTest, hitTestGrid, stopOnReject = false) {
   if (!isTopFrame()) {
-    if (window.parent && window.parent !== window.top) {
-      return [];
-    }
-    const frameElement = getFramePopupElement(document);
-    const popup = frameElement && toPopupData(frameElement);
-    return popup ? [popup] : [];
+    return getFramePopups();
   }
   const deadline = performance.now() + timeout;
+  const hitTestPopups = hitTest ? findPopupsByHitTest(deadline, hitTestGrid) : [];
+  if (stopOnReject && hitTestPopups.some((p) => p.regexClassification === "reject" && isConsentPopup(p))) {
+    return hitTestPopups;
+  }
+  const walkPopups = collectPositionedPopups(deadline);
+  return [...walkPopups, ...mergeWalkOverlaps(hitTestPopups, walkPopups)];
+}
+var consentPopups = /* @__PURE__ */ new WeakMap();
+function classificationRank(popup) {
+  return ACCEPTED_LEVELS.tier2.indexOf(popup.regexClassification);
+}
+function isConsentPopup(popup) {
+  if (!ACCEPTED_LEVELS.tier2.includes(popup.regexClassification)) {
+    return false;
+  }
+  let result = consentPopups.get(popup);
+  if (result === void 0) {
+    const popupText = popup.text.trim();
+    result = !!popupText && !isExcludedPopup(popupText) && hasHeuristicPatterns(popupText);
+    consentPopups.set(popup, result);
+  }
+  return result;
+}
+function mergeWalkOverlaps(hitTestPopups, walkPopups) {
+  return hitTestPopups.filter((h) => {
+    const hitIsConsent = isConsentPopup(h);
+    const absorbs = (p) => !hitIsConsent || isConsentPopup(p) && classificationRank(p) <= classificationRank(h);
+    const walkPopup = walkPopups.find((p) => composedOverlaps(p.element, h.element) && absorbs(p));
+    if (walkPopup) {
+      (walkPopup.hitPoints ??= []).push(...h.hitPoints ?? []);
+    }
+    return !walkPopup;
+  });
+}
+function getFramePopups() {
+  if (window.parent && window.parent !== window.top) {
+    return [];
+  }
+  const frameElement = getFramePopupElement(document);
+  const popup = frameElement && toPopupData(frameElement);
+  if (!popup) {
+    return [];
+  }
+  popup.source = "frame";
+  return [popup];
+}
+function collectPositionedPopups(deadline) {
   const { elements, shadowHosts } = getPopupLikeElements(deadline);
   const potentialPopups = [];
   const expanded = [];
@@ -1369,17 +1412,86 @@ function getPotentialPopups(timeout = POPUP_SEARCH_MAX_TIME) {
     if (root !== popup) {
       expanded.push(root.element);
     }
+    root.source = "walk";
     potentialPopups.push(root);
   }
   return potentialPopups.filter((p) => !expanded.some((root) => root !== p.element && composedContains(root, p.element)));
 }
+var DEFAULT_HIT_TEST_GRID = {
+  columns: [0.1, 0.5, 0.9],
+  // banners sit along the top and bottom edges and modals in the middle; rows 150px in added almost nothing in crawls
+  edgeRows: [30, 90]
+};
+function findPopupsByHitTest(deadline, grid) {
+  const climbed = /* @__PURE__ */ new Map();
+  const found = [];
+  const toPopup = (el) => el.querySelector(TEXT_ENTRY_SELECTOR) ? null : toPopupRoot(el);
+  for (const [x, y] of getHitTestPoints(grid)) {
+    if (performance.now() > deadline) {
+      return found;
+    }
+    const path = [];
+    let reached = null;
+    const shouldStop = (el) => {
+      if (climbed.has(el)) {
+        reached = climbed.get(el) ?? null;
+        return true;
+      }
+      const overlapped = found.find((p) => composedOverlaps(p.element, el));
+      if (overlapped) {
+        reached = composedContains(overlapped.element, el) ? overlapped : null;
+        return true;
+      }
+      path.push(el);
+      return false;
+    };
+    const hit = closestHTMLElement(deepElementFromPoint(x, y));
+    const popup = climbToPopup(hit, MAX_HIT_TEST_CLIMB_DEPTH, toPopup, shouldStop);
+    if (popup) {
+      popup.source = "hitTest";
+      found.push(popup);
+      reached = popup;
+    }
+    for (const el of path) {
+      climbed.set(el, reached);
+    }
+    if (reached) {
+      (reached.hitPoints ??= []).push([x, y]);
+    }
+  }
+  return found;
+}
+function getHitTestPoints(grid) {
+  const { innerWidth: width, innerHeight: height } = window;
+  const rows = [...grid.edgeRows, height / 2, ...grid.edgeRows.map((y) => height - y)].map((y) => Math.round(y));
+  const ys = [...new Set(rows)].filter((y) => y >= 0 && y < height);
+  return ys.flatMap((y) => grid.columns.map((column) => [Math.round(column * width), y]));
+}
+var TEXT_ENTRY_SELECTOR = 'textarea, input:not([type]), input[type="text"], input[type="email"], input[type="password"], input[type="search"], input[type="tel"], input[type="number"], input[type="url"]';
+function deepElementFromPoint(x, y) {
+  let el = document.elementFromPoint(x, y);
+  while (el?.shadowRoot) {
+    const inner = el.shadowRoot.elementFromPoint(x, y);
+    if (!inner || inner === el) {
+      break;
+    }
+    el = inner;
+  }
+  return el;
+}
+function closestHTMLElement(el) {
+  while (el && !(el instanceof HTMLElement)) {
+    el = el.parentElement;
+  }
+  return el;
+}
 function toPopupData(el, shadowHosts, text = getElementText(el)) {
   if (!text) {
     return null;
   }
   const buttons = getButtonData(el, shadowHosts);
   classifyButtons(buttons);
-  return { text, element: el, buttons };
+  return { text, element: el, buttons, regexClassification: classifyPopup(buttons) };
 }
 function hasPopupButtons(text, buttons) {
   return !isOnlyButtonText(text, buttons) && buttons.some((b) => b.regexClassification !== "other");
@@ -1391,26 +1503,34 @@ function isOnlyButtonText(text, buttons) {
   }
   return rest.replace(/\s+/g, "").length < 10;
 }
+function toPopupRoot(el, shadowHosts) {
+  const text = getElementText(el);
+  if (!text || !hasHeuristicPatterns(text)) {
+    return null;
+  }
+  const popup = toPopupData(el, shadowHosts, text);
+  return popup && hasPopupButtons(text, popup.buttons) ? popup : null;
+}
 var MAX_FRAGMENT_EXPANSION_DEPTH = 6;
+var MAX_HIT_TEST_CLIMB_DEPTH = 8;
+function climbToPopup(el, maxDepth, toPopup, shouldStop) {
+  for (let depth = 0; el && depth < maxDepth; depth++, el = getComposedParent(el)) {
+    if (shouldStop?.(el) || el === document.body || el === document.documentElement || el.getBoundingClientRect().height > window.innerHeight) {
+      return null;
+    }
+    const popup = toPopup(el);
+    if (popup) {
+      return popup;
+    }
+  }
+  return null;
+}
 function expandPopupFragment(popup, shadowHosts) {
   if (hasHeuristicPatterns(popup.text) && hasPopupButtons(popup.text, popup.buttons)) {
     return popup;
   }
-  let el = getComposedParent(popup.element);
-  for (let depth = 0; el && depth < MAX_FRAGMENT_EXPANSION_DEPTH; depth++, el = getComposedParent(el)) {
-    if (el === document.body || el === document.documentElement || el.getBoundingClientRect().height > window.innerHeight) {
-      break;
-    }
-    const text = getElementText(el);
-    if (!text || !hasHeuristicPatterns(text)) {
-      continue;
-    }
-    const root = toPopupData(el, shadowHosts, text);
-    if (root && hasPopupButtons(text, root.buttons)) {
-      return root;
-    }
-  }
-  return popup;
+  const parent = getComposedParent(popup.element);
+  return climbToPopup(parent, MAX_FRAGMENT_EXPANSION_DEPTH, (el) => toPopupRoot(el, shadowHosts)) ?? popup;
 }
 function getComposedParent(el) {
   if (el.parentElement) {
@@ -1441,6 +1561,9 @@ function getElementText(el) {
 function isRenderedTextElement(el) {
   return el instanceof HTMLElement && !["STYLE", "SCRIPT", "TEMPLATE", "NOSCRIPT", "LINK", "SLOT"].includes(el.tagName) && window.getComputedStyle(el).display !== "none";
 }
+function composedOverlaps(a, b) {
+  return composedContains(a, b) || composedContains(b, a);
+}
 function composedContains(container, node) {
   if (container.contains(node)) {
     return true;
@@ -1932,7 +2055,11 @@ 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.mode, this.autoconsent.config.heuristicPopupSearchTimeout);
+    this.popups = getActionablePopups(
+      this.mode,
+      this.autoconsent.config.heuristicPopupSearchTimeout,
+      this.autoconsent.config.enableHeuristicHitTest
+    );
     this.autoconsent.config.performanceLoggingEnabled && performance.mark("heuristicDetectorEnd");
     this.autoconsent.config.performanceLoggingEnabled && performance.measure("heuristicDetector", "heuristicDetectorStart", "heuristicDetectorEnd");
     if (this.popups.length > 0) {