@duckduckgo/autoconsent 14.71.0 → 14.72.0

package/docs/puppeteer.md

@@ -8,27 +8,50 @@ Autoconsent can be used with [Puppeteer](https://pptr.dev) via the bundled `dist
 Puppeteer's `page.exposeFunction` and `page.evaluateOnNewDocument` bridge the gap.
 
 ```javascript
-const puppeteer = require('puppeteer')
-const path = require('path')
-const fs = require('fs')
+import puppeteer from 'puppeteer'
+import fs from 'fs'
+import { dirname, resolve } from 'path'
+import { fileURLToPath } from 'url'
 
 const autoconsentScript = fs.readFileSync(
-  path.resolve(
-    path.dirname(require.resolve('@duckduckgo/autoconsent')),
+  resolve(
+    dirname(fileURLToPath(import.meta.resolve('@duckduckgo/autoconsent'))),
     'autoconsent.playwright.js'
   ),
   'utf8'
 )
 
-// See https://github.com/duckduckgo/autoconsent/blob/main/api.md
+// Load the rule bundles shipped with the package
+const rules = JSON.parse(
+  fs.readFileSync(
+    fileURLToPath(import.meta.resolve('@duckduckgo/autoconsent/rules/rules.json')),
+    'utf8'
+  )
+)
+
+// See https://github.com/duckduckgo/autoconsent/blob/main/docs/api.md
 const autoconsentConfig = {
   enabled: true,
   autoAction: 'optOut',
+  disabledCmps: [],
   enablePrehide: true,
   enableCosmeticRules: true,
   enableGeneratedRules: true,
-  enableHeuristicAction: true,
   detectRetries: 20,
+  isMainWorld: false,
+  prehideTimeout: 2000,
+  enableFilterList: false,
+  enableHeuristicDetection: true,
+  enableHeuristicAction: true,
+  logs: {
+    lifecycle: false,
+    rulesteps: false,
+    detectionsteps: false,
+    evals: false,
+    errors: true,
+    messages: false,
+    waits: false,
+  },
 }
 
 const sendMessage = (page, message) =>
@@ -44,13 +67,39 @@ async function setupAutoconsent(page) {
   await page.exposeFunction('autoconsentSendMessage', async message => {
     if (!message || typeof message !== 'object') return
 
-    if (message.type === 'init') {
-      return sendMessage(page, { type: 'initResp', config: autoconsentConfig })
-    }
+    switch (message.type) {
+      case 'init':
+        return sendMessage(page, {
+          type: 'initResp',
+          config: autoconsentConfig,
+          rules, // must include rules or no CMPs will be detected
+        })
+
+      case 'eval': {
+        const result = await page.evaluate(message.code)
+        return sendMessage(page, {
+          type: 'evalResp',
+          id: message.id,
+          result,
+        })
+      }
 
-    if (message.type === 'eval') {
-      const result = await page.evaluate(message.code)
-      return sendMessage(page, { type: 'evalResp', id: message.id, result })
+      // informational messages — log or act on as needed
+      case 'cmpDetected':
+        console.log(`CMP detected: ${message.cmp}`)
+        break
+      case 'popupFound':
+        console.log(`Popup found: ${message.cmp}`)
+        break
+      case 'optOutResult':
+        console.log(`Opt-out result: ${message.result}`)
+        break
+      case 'autoconsentDone':
+        console.log(`Autoconsent done: ${message.cmp}`)
+        break
+      case 'autoconsentError':
+        console.error(`Autoconsent error:`, message.details)
+        break
     }
   })
 
@@ -77,6 +126,31 @@ async function setupAutoconsent(page) {
 
 1. **`page.exposeFunction`** binds `window.autoconsentSendMessage` in the page, giving the content script a way to call back into Node.
 2. **`page.evaluateOnNewDocument`** injects the content script so it runs before any page JavaScript, enabling early CMP detection and prehiding.
-3. When the content script starts, it sends an `init` message. The Node-side handler replies with `initResp` containing the config, which triggers CMP detection and automatic opt-out.
-4. `eval` messages are handled by running `page.evaluate(message.code)` in the main world, matching how the [Playwright test runner](./playwright/runner.ts) handles them.
+3. When the content script starts, it sends an `init` message. The Node-side handler replies with `initResp` containing both the config **and the rule bundles**, which triggers CMP detection and automatic opt-out.
+4. `eval` messages are handled by running `page.evaluate(message.code)` in the main world, matching how the [Playwright test runner](../playwright/runner.ts) handles them.
 5. A post-navigation `page.evaluate(autoconsentScript)` re-triggers the script on the current document, covering cases where the page loaded before the `evaluateOnNewDocument` hook was set up.
+
+## Config reference
+
+See the full `Config` type in [`lib/types.ts`](../lib/types.ts) and the [API documentation](./api.md) for details on all available options.
+
+Key options:
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `enabled` | boolean | — | Master switch for autoconsent |
+| `autoAction` | `'optOut' \| 'optIn' \| null` | — | Action to perform automatically when a popup is found |
+| `enablePrehide` | boolean | — | Inject CSS early to prevent popup flicker |
+| `enableCosmeticRules` | boolean | — | Enable rules that hide popups via CSS |
+| `enableGeneratedRules` | boolean | — | Include auto-generated rules |
+| `detectRetries` | number | — | How many times to retry CMP detection |
+| `enableFilterList` | boolean | — | Enable ABP/uBO cosmetic filter support (requires the `/extra` build) |
+
+## Rules
+
+The `initResp` message **must** include a `rules` object. Without rules, no CMPs will be detected. The package ships pre-built rule bundles:
+
+- `@duckduckgo/autoconsent/rules/rules.json` — full rules (includes `autoconsent` and `consentomatic` arrays)
+- `@duckduckgo/autoconsent/rules/compact-rules.json` — compact encoding for opt-out only (smaller payload)
+
+Load either file and pass it as the `rules` field in the `initResp` message.

package/package.json

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

package/rules/autoconsent/cookieconsent2.json

@@ -23,7 +23,9 @@
     ],
     "optOut": [
         {
-            "waitForThenClick": "#s-rall-bn"
+            "if": { "exists": "#s-rall-bn" },
+            "then": [{ "waitForThenClick": "#s-rall-bn" }],
+            "else": [{ "waitForThenClick": "#c-s-bn" }, { "waitForThenClick": "#s-sv-bn" }]
         }
     ],
     "test": [