@duckduckgo/autoconsent 14.68.0 → 14.69.0

package/dist/autoconsent.cjs.js

@@ -1575,6 +1575,15 @@ function collectPotentialPopups(isFramed) {
   }
   return potentialPopups;
 }
+function isDialogLikeElement(node) {
+  if (node.tagName === "DIALOG" && node.hasAttribute("open")) {
+    return true;
+  }
+  if (node.getAttribute("role") === "dialog" || node.getAttribute("aria-modal") === "true") {
+    return true;
+  }
+  return false;
+}
 function getPopupLikeElements() {
   const walker = document.createTreeWalker(
     document.documentElement,
@@ -1585,9 +1594,14 @@ function getPopupLikeElements() {
         if (node.tagName === "BODY") {
           return NodeFilter.FILTER_SKIP;
         }
-        const cssPosition = window.getComputedStyle(node).position;
-        if ((cssPosition === "fixed" || cssPosition === "sticky") && isElementVisible(node)) {
-          return NodeFilter.FILTER_ACCEPT;
+        if (isElementVisible(node)) {
+          const cssPosition = window.getComputedStyle(node).position;
+          if (cssPosition === "fixed" || cssPosition === "sticky") {
+            return NodeFilter.FILTER_ACCEPT;
+          }
+          if (isDialogLikeElement(node)) {
+            return NodeFilter.FILTER_ACCEPT;
+          }
         }
         return NodeFilter.FILTER_SKIP;
       }

package/dist/autoconsent.esm.js

@@ -1545,6 +1545,15 @@ function collectPotentialPopups(isFramed) {
   }
   return potentialPopups;
 }
+function isDialogLikeElement(node) {
+  if (node.tagName === "DIALOG" && node.hasAttribute("open")) {
+    return true;
+  }
+  if (node.getAttribute("role") === "dialog" || node.getAttribute("aria-modal") === "true") {
+    return true;
+  }
+  return false;
+}
 function getPopupLikeElements() {
   const walker = document.createTreeWalker(
     document.documentElement,
@@ -1555,9 +1564,14 @@ function getPopupLikeElements() {
         if (node.tagName === "BODY") {
           return NodeFilter.FILTER_SKIP;
         }
-        const cssPosition = window.getComputedStyle(node).position;
-        if ((cssPosition === "fixed" || cssPosition === "sticky") && isElementVisible(node)) {
-          return NodeFilter.FILTER_ACCEPT;
+        if (isElementVisible(node)) {
+          const cssPosition = window.getComputedStyle(node).position;
+          if (cssPosition === "fixed" || cssPosition === "sticky") {
+            return NodeFilter.FILTER_ACCEPT;
+          }
+          if (isDialogLikeElement(node)) {
+            return NodeFilter.FILTER_ACCEPT;
+          }
         }
         return NodeFilter.FILTER_SKIP;
       }

package/dist/autoconsent.extra.cjs.js

@@ -12397,6 +12397,15 @@ function collectPotentialPopups(isFramed) {
   }
   return potentialPopups;
 }
+function isDialogLikeElement(node) {
+  if (node.tagName === "DIALOG" && node.hasAttribute("open")) {
+    return true;
+  }
+  if (node.getAttribute("role") === "dialog" || node.getAttribute("aria-modal") === "true") {
+    return true;
+  }
+  return false;
+}
 function getPopupLikeElements() {
   const walker = document.createTreeWalker(
     document.documentElement,
@@ -12407,9 +12416,14 @@ function getPopupLikeElements() {
         if (node.tagName === "BODY") {
           return NodeFilter.FILTER_SKIP;
         }
-        const cssPosition = window.getComputedStyle(node).position;
-        if ((cssPosition === "fixed" || cssPosition === "sticky") && isElementVisible(node)) {
-          return NodeFilter.FILTER_ACCEPT;
+        if (isElementVisible(node)) {
+          const cssPosition = window.getComputedStyle(node).position;
+          if (cssPosition === "fixed" || cssPosition === "sticky") {
+            return NodeFilter.FILTER_ACCEPT;
+          }
+          if (isDialogLikeElement(node)) {
+            return NodeFilter.FILTER_ACCEPT;
+          }
         }
         return NodeFilter.FILTER_SKIP;
       }

package/dist/autoconsent.extra.esm.js

@@ -12331,6 +12331,15 @@ function collectPotentialPopups(isFramed) {
   }
   return potentialPopups;
 }
+function isDialogLikeElement(node) {
+  if (node.tagName === "DIALOG" && node.hasAttribute("open")) {
+    return true;
+  }
+  if (node.getAttribute("role") === "dialog" || node.getAttribute("aria-modal") === "true") {
+    return true;
+  }
+  return false;
+}
 function getPopupLikeElements() {
   const walker = document.createTreeWalker(
     document.documentElement,
@@ -12341,9 +12350,14 @@ function getPopupLikeElements() {
         if (node.tagName === "BODY") {
           return NodeFilter.FILTER_SKIP;
         }
-        const cssPosition = window.getComputedStyle(node).position;
-        if ((cssPosition === "fixed" || cssPosition === "sticky") && isElementVisible(node)) {
-          return NodeFilter.FILTER_ACCEPT;
+        if (isElementVisible(node)) {
+          const cssPosition = window.getComputedStyle(node).position;
+          if (cssPosition === "fixed" || cssPosition === "sticky") {
+            return NodeFilter.FILTER_ACCEPT;
+          }
+          if (isDialogLikeElement(node)) {
+            return NodeFilter.FILTER_ACCEPT;
+          }
         }
         return NodeFilter.FILTER_SKIP;
       }

package/dist/autoconsent.playwright.js

@@ -1547,6 +1547,15 @@
     }
     return potentialPopups;
   }
+  function isDialogLikeElement(node) {
+    if (node.tagName === "DIALOG" && node.hasAttribute("open")) {
+      return true;
+    }
+    if (node.getAttribute("role") === "dialog" || node.getAttribute("aria-modal") === "true") {
+      return true;
+    }
+    return false;
+  }
   function getPopupLikeElements() {
     const walker = document.createTreeWalker(
       document.documentElement,
@@ -1557,9 +1566,14 @@
           if (node.tagName === "BODY") {
             return NodeFilter.FILTER_SKIP;
           }
-          const cssPosition = window.getComputedStyle(node).position;
-          if ((cssPosition === "fixed" || cssPosition === "sticky") && isElementVisible(node)) {
-            return NodeFilter.FILTER_ACCEPT;
+          if (isElementVisible(node)) {
+            const cssPosition = window.getComputedStyle(node).position;
+            if (cssPosition === "fixed" || cssPosition === "sticky") {
+              return NodeFilter.FILTER_ACCEPT;
+            }
+            if (isDialogLikeElement(node)) {
+              return NodeFilter.FILTER_ACCEPT;
+            }
           }
           return NodeFilter.FILTER_SKIP;
         }

package/dist/types/heuristics.d.ts

@@ -10,6 +10,7 @@ export declare function classifyButtons(buttons: ButtonData[]): {
 };
 export declare function isRejectButton(buttonText: string, rejectPatterns?: (string | RegExp)[], neverMatchPatterns?: RegExp[]): boolean;
 export declare function cleanButtonText(buttonText: string): string;
+export declare function isDialogLikeElement(node: HTMLElement): boolean;
 /**
  * Serialize all actionable buttons on the page
  */

package/docs/rule-syntax.md

@@ -22,9 +22,14 @@ Both JSON and class implementations have the following components:
    * `frame` - boolean, set to `true` if the rule should be executed in nested frames (default: `false`)
    * `urlPattern` - string, specifies a regular expression that should match the page URL (default: empty)
  * (optional) `test` - a list of actions to verify a successful opt-out. This is currently only used in Playwright tests.
+ * (optional) `minimumRuleStepVersion` - the minimum rule step version needed to execute this rule. Defaults to `1`. See [Rule Step Versioning](#rule-step-versioning).
 
 
-`detectCMP`, `detectPopup`, `optOut`, `optIn`, and `test` are defined as a set of checks or actions on the page. In the JSON syntax this is a list of `AutoConsentRuleStep` objects. For `detect` checks, we return true for the check if all steps return true. For opt in and out, we execute actions in order, exiting if one fails. The following checks/actions are supported:
+`detectCMP`, `detectPopup`, `optOut`, `optIn`, and `test` are defined as a set of checks or actions on the page. In the JSON syntax this is a list of `AutoConsentRuleStep` objects. For `detect` checks, we return true for the check if all steps return true. For opt in and out, we execute actions in order, exiting if one fails.
+
+**Important:** Do not use `wait` steps in `detectCmp` or `detectPopup` arrays. Detection must be fast and non-blocking -- the engine already retries detection automatically with its own timing. Adding `wait` steps to detection slows down detection of other rules.
+
+The following checks/actions are supported:
 
 ## Element selectors
 
@@ -240,3 +245,29 @@ new AutoConsent({
 ## Context filters
 
 By default, rules will be executed in all top-level documents. Some rules are designed for specific contexts (e.g. only nested iframes, or only specific URLs). This can be configured in `runContext` field (see [runContext](#rule-syntax-reference) above).
+
+## Rule Step Versioning
+
+New step types are occasionally added to the autoconsent engine (e.g. `removeClass`, `setStyle`, `addStyle` were added in version 2). Because rules can be shipped to clients independently of app releases, a rule that uses a newer step type could end up on a client that doesn't support it yet.
+
+The `minimumRuleStepVersion` field solves this: clients compare the rule's declared version against their own supported version (`SUPPORTED_RULE_STEP_VERSION` in `lib/rules.ts`) and silently skip rules they cannot execute.
+
+### Version history
+
+| Version | Step types added |
+|---------|-----------------|
+| 1 | All original step types (`exists`, `visible`, `waitFor`, `waitForVisible`, `click`, `waitForThenClick`, `wait`, `hide`, `if`/`then`/`else`, `any`, `eval`, `cookieContains`, `negated`) |
+| 2 | `removeClass`, `setStyle`, `addStyle` |
+
+### When to set it
+
+- If a rule only uses version-1 step types, omit the field (defaults to `1`).
+- If a rule uses `removeClass`, `setStyle`, or `addStyle`, set `"minimumRuleStepVersion": 2`.
+- When a future version introduces new step types, any rule using them must set `minimumRuleStepVersion` to the corresponding version number.
+
+### Adding new step types
+
+When introducing a new step type:
+1. Bump `SUPPORTED_RULE_STEP_VERSION` in `lib/rules.ts` and add a comment describing what was added.
+2. Add the new step type definition to the `AutoConsentRuleStep` union in the same file.
+3. Any rule using the new step type must set `minimumRuleStepVersion` to the new version number.

package/lib/heuristics.ts

@@ -126,6 +126,16 @@ function collectPotentialPopups(isFramed: boolean): PopupData[] {
     return potentialPopups;
 }
 
+export function isDialogLikeElement(node: HTMLElement): boolean {
+    if (node.tagName === 'DIALOG' && node.hasAttribute('open')) {
+        return true;
+    }
+    if (node.getAttribute('role') === 'dialog' || node.getAttribute('aria-modal') === 'true') {
+        return true;
+    }
+    return false;
+}
+
 /**
  * Heuristic to get all elements that look like "popups"
  * TODO: this heuristic is too strict, not all popups are actually sticky/fixed
@@ -139,9 +149,14 @@ function getPopupLikeElements(): HTMLElement[] {
                 if (node.tagName === 'BODY') {
                     return NodeFilter.FILTER_SKIP;
                 }
-                const cssPosition = window.getComputedStyle(node).position;
-                if ((cssPosition === 'fixed' || cssPosition === 'sticky') && isElementVisible(node)) {
-                    return NodeFilter.FILTER_ACCEPT;
+                if (isElementVisible(node)) {
+                    const cssPosition = window.getComputedStyle(node).position;
+                    if (cssPosition === 'fixed' || cssPosition === 'sticky') {
+                        return NodeFilter.FILTER_ACCEPT;
+                    }
+                    if (isDialogLikeElement(node)) {
+                        return NodeFilter.FILTER_ACCEPT;
+                    }
                 }
                 return NodeFilter.FILTER_SKIP;
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duckduckgo/autoconsent",
-  "version": "14.68.0",
+  "version": "14.69.0",
   "description": "",
   "types": "./dist/types/web.d.ts",
   "exports": {