@duckduckgo/autoconsent 16.45.0 → 16.47.0

package/lib/encoding.ts

@@ -13,14 +13,7 @@ export type CompactRuleStep = {
 
 export type CompactCMPRuleStep = AutoConsentRuleStep & Partial<CompactRuleStep>;
 type CompactableRuleStepKey =
-    | 'exists'
-    | 'visible'
-    | 'waitForThenClick'
-    | 'click'
-    | 'waitFor'
-    | 'waitForVisible'
-    | 'hide'
-    | 'cookieContains';
+    'exists' | 'visible' | 'waitForThenClick' | 'click' | 'waitFor' | 'waitForVisible' | 'hide' | 'cookieContains';
 type CompactNullableBoolean = 0 | 1 | 2;
 
 export type CompactCMPRule = [

package/lib/heuristic-patterns.ts

@@ -7,7 +7,7 @@ export const DETECT_PATTERNS = [
     /only necessary cookies/gi, // "only necessary" is probably too broad
     /(?:by continuing.{0,100}cookie)|(?:cookie.{0,100}by continuing)/gi,
     /(?:by continuing.{0,100}privacy)|(?:privacy.{0,100}by continuing)/gi,
-    /we (?:use|serve)(?: optional)? cookies/gi,
+    /we (?:use|serve)(?: optional| essential)? cookies/gi,
     /we are using cookies/gi,
     /use of cookies/gi,
     /website uses cookies to enhance your browsing experience/gi,

package/lib/messages.ts

@@ -2,12 +2,7 @@ import { snippets } from './eval-snippets';
 import { Config, ConsentState, RuleBundle } from './types';
 
 export type BackgroundMessage =
-    | InitResponseMessage
-    | EvalResponseMessage
-    | OptOutMessage
-    | OptInMessage
-    | SelfTestMessage
-    | MeasurePerformanceMessage;
+    InitResponseMessage | EvalResponseMessage | OptOutMessage | OptInMessage | SelfTestMessage | MeasurePerformanceMessage;
 
 export type ContentScriptMessage =
     | InitMessage

package/lib/web.ts

@@ -274,10 +274,9 @@ export default class AutoConsent {
             }
         });
         // heuristic CMP is only run in the top frame and only if heuristic action is enabled and retries is odd
+        const heuristicEnabled = isTop && this.config.heuristicMode !== 'off';
         const heuristicRules =
-            isTop && this.config.heuristicMode !== 'off' && this.state.findCmpAttempts % 2 === 0
-                ? [new AutoConsentHeuristicCMP(this, this.config.heuristicMode)]
-                : [];
+            heuristicEnabled && this.state.findCmpAttempts % 2 === 0 ? [new AutoConsentHeuristicCMP(this, this.config.heuristicMode)] : [];
 
         const rulesPriorityStages: [string, AutoCMP[]][] = [
             ['site-specific', siteSpecificRules],
@@ -330,7 +329,9 @@ export default class AutoConsent {
             // We wait 500ms, and also for some kind of dom mutation to happen before
             // rerunning the findCmp check
             const waitFor: Promise<boolean>[] = [this.domActions.wait(500)];
-            if (this.state.findCmpAttempts > 1) {
+            // a skipped heuristic has not seen the current DOM yet, so the next attempt must not wait for another mutation
+            const heuristicSkipped = heuristicEnabled && heuristicRules.length === 0;
+            if (this.state.findCmpAttempts > 1 && !heuristicSkipped) {
                 waitFor.push(mutationObserver);
             }
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duckduckgo/autoconsent",
-  "version": "16.45.0",
+  "version": "16.47.0",
   "description": "",
   "types": "./dist/types/web.d.ts",
   "exports": {
@@ -42,7 +42,7 @@
   "author": "Sam Macbeth",
   "license": "MPL-2.0",
   "devDependencies": {
-    "@duckduckgo/eslint-config": "github:duckduckgo/eslint-config#v0.3.0",
+    "@duckduckgo/eslint-config": "github:duckduckgo/eslint-config#v0.3.1",
     "@esm-bundle/chai": "^4.3.4-fix.0",
     "@octokit/rest": "^22.0.1",
     "@playwright/test": "^1.63.0",
@@ -65,13 +65,13 @@
     "jsonc-parser": "^3.3.1",
     "markdown-it": "^15.0.2",
     "mocha": "^12.0.3",
-    "prettier": "3.8.3",
+    "prettier": "3.9.9",
     "randexp": "^0.5.3",
     "sinon": "^22.0.0",
     "ts-json-schema-generator": "^2.3.0",
     "ts-node": "^10.9.2",
     "tslib": "^2.4.0",
-    "typescript": "^5.1.6",
+    "typescript": "^6.0.3",
     "typescript-eslint": "^8.12.2",
     "web-ext": "^10.0.0"
   },
@@ -182,10 +182,10 @@
         "color": "#ededed"
       },
       {
-        "name": "code-update-needed",
+        "name": "needs-code-update",
         "description": "Changes the autoconsent library code, so consuming browsers need a version update",
         "releaseType": "none",
-        "color": "#fbca04"
+        "color": "#0b591c"
       }
     ],
     "plugins": [

package/playwright/runner.ts

@@ -28,6 +28,7 @@ type TestOptions = {
     mobile: boolean;
     expectPopupOpen: boolean;
     expectedRuns: number;
+    gpc: boolean;
 };
 const defaultOptions: TestOptions = {
     testOptOut: true,
@@ -38,6 +39,7 @@ const defaultOptions: TestOptions = {
     mobile: false,
     expectPopupOpen: true,
     expectedRuns: 1,
+    gpc: false,
 };
 
 const contentScript = fs.readFileSync(path.join(__dirname, '../dist/autoconsent.playwright.js'), 'utf8');
@@ -93,6 +95,9 @@ class TestRun {
             });
 
         await this.page.exposeBinding('autoconsentSendMessage', this.messageCallback.bind(this));
+        if (this.options.gpc) {
+            await this.enableGpc();
+        }
         await this.page.goto(this.url, { waitUntil: 'commit' });
 
         await this.injectContentScripts();
@@ -123,6 +128,14 @@ class TestRun {
         }
     }
 
+    // emulate a browser that sends the Global Privacy Control signal
+    async enableGpc() {
+        await this.page.setExtraHTTPHeaders({ 'Sec-GPC': '1' });
+        await this.page.addInitScript(() => {
+            Object.defineProperty(Navigator.prototype, 'globalPrivacyControl', { get: () => true, configurable: true });
+        });
+    }
+
     async injectContentScript(pageOrFrame: Page | Frame) {
         try {
             await pageOrFrame.evaluate(contentScript);

package/rules/autoconsent/controlgame.json

@@ -0,0 +1,12 @@
+{
+    "name": "controlgame",
+    "vendorUrl": "https://controlgame.com/",
+    "runContext": {
+        "urlPattern": "^https?://(www\\.)?controlgame\\.com/"
+    },
+    "detectCmp": [{ "exists": "[data-consent-button][data-value=accept_partial]" }],
+    "detectPopup": [{ "visible": "[data-consent-button][data-value=accept_partial]" }],
+    "optIn": [{ "waitForThenClick": "[data-consent-button][data-value=accept_all]", "retry": 10, "retryInterval": 500 }],
+    "optOut": [{ "waitForThenClick": "[data-consent-button][data-value=accept_partial]", "retry": 10, "retryInterval": 500 }],
+    "test": [{ "cookieContains": "advertisement:no" }]
+}

package/rules/autoconsent/cookieyes.json

@@ -39,7 +39,9 @@
                             "if": { "exists": ".cky-consent-container [data-cky-tag=settings-button]" },
                             "then": [
                                 { "click": ".cky-consent-container [data-cky-tag=settings-button]" },
-                                { "waitFor": ".cky-modal-open input[type=checkbox],.cky-consent-bar-expand input[type=checkbox]" },
+                                {
+                                    "waitFor": ".cky-modal-open input[type=checkbox],.cky-consent-bar-expand input[type=checkbox],.cky-modal-open [data-cky-tag=detail-save-button],.cky-consent-bar-expand [data-cky-tag=detail-save-button]"
+                                },
                                 {
                                     "click": ".cky-modal-open input[type=checkbox]:checked,.cky-consent-bar-expand input[type=checkbox]:checked",
                                     "all": true,

package/rules/autoconsent/cookiez.json

@@ -0,0 +1,9 @@
+{
+    "name": "cookiez",
+    "prehideSelectors": [".elementor-popup-modal:has(.cookiez-footer)"],
+    "detectCmp": [{ "exists": ".cookiez-footer [data-cookiez-action]" }],
+    "detectPopup": [{ "visible": ".cookiez-footer [data-cookiez-action=\"deny-all\"]" }],
+    "optIn": [{ "waitForThenClick": ".cookiez-footer [data-cookiez-action=\"accept-all\"]" }],
+    "optOut": [{ "waitForThenClick": ".cookiez-footer [data-cookiez-action=\"deny-all\"]" }],
+    "test": [{ "wait": 1000 }, { "cookieContains": "%22analytics%22%3Afalse" }]
+}

package/rules/autoconsent/cuvva.com.json

@@ -0,0 +1,55 @@
+{
+    "name": "cuvva.com",
+    "vendorUrl": "https://www.cuvva.com/",
+    "cosmetic": false,
+    "runContext": {
+        "urlPattern": "^https://(www\\.)?cuvva\\.com/"
+    },
+    "prehideSelectors": [],
+    "detectCmp": [
+        {
+            "exists": "#cuvva-app-injection-site button[data-testid=\"accept-cookies\"]"
+        }
+    ],
+    "detectPopup": [
+        {
+            "visible": "#cuvva-app-injection-site button[data-testid=\"accept-cookies\"]"
+        },
+        {
+            "cookieContains": "cuvva.app.website.cookie-policy.consent.v2=",
+            "negated": true
+        }
+    ],
+    "optIn": [
+        {
+            "waitForThenClick": "#cuvva-app-injection-site button[data-testid=\"accept-cookies\"]"
+        }
+    ],
+    "optOut": [
+        {
+            "waitForThenClick": "#cuvva-app-injection-site button[aria-label=\"Reject all\"]",
+            "retry": 10,
+            "retryInterval": 500
+        },
+        {
+            "wait": 500
+        },
+        {
+            "if": {
+                "visible": "#cuvva-app-injection-site button[aria-label=\"Reject all\"]"
+            },
+            "then": [
+                {
+                    "waitForThenClick": "#cuvva-app-injection-site button[aria-label=\"Reject all\"]",
+                    "retry": 10,
+                    "retryInterval": 500
+                }
+            ]
+        }
+    ],
+    "test": [
+        {
+            "cookieContains": "cuvva.app.website.cookie-policy.consent.v2={%22preferences%22:{%22functional%22:true%2C%22analytics%22:false%2C%22marketing%22:false"
+        }
+    ]
+}

package/rules/autoconsent/dalecarnegie.json

@@ -0,0 +1,44 @@
+{
+    "name": "dalecarnegie",
+    "vendorUrl": "https://www.dalecarnegie.com/",
+    "runContext": {
+        "urlPattern": "^https?://(\\w+\\.)?dalecarnegie\\.com/"
+    },
+    "prehideSelectors": [],
+    "detectCmp": [
+        {
+            "exists": "[class*=\"PrivacyBar_gdprAgreement\"] [class*=\"PrivacyBar_managePrefsBtn\"]"
+        }
+    ],
+    "detectPopup": [
+        {
+            "visible": "[class*=\"PrivacyBar_gdprAgreement\"]"
+        }
+    ],
+    "optIn": [
+        {
+            "waitForThenClick": "[class*=\"PrivacyBar_gdprAgreement\"] [class*=\"PrivacyBar_allowBtn\"]"
+        }
+    ],
+    "optOut": [
+        {
+            "waitForThenClick": "[class*=\"PrivacyBar_gdprAgreement\"] [class*=\"PrivacyBar_managePrefsBtn\"]"
+        },
+        {
+            "waitForVisible": "[class*=\"CookieManagementModal_confirmBtn\"]"
+        },
+        {
+            "click": "[class*=\"CookieManagementModal_dropdownHeader\"] [class*=\"SwitchButton_toggleSwitch\"] input:checked",
+            "all": true,
+            "optional": true
+        },
+        {
+            "click": "[class*=\"CookieManagementModal_confirmBtn\"]"
+        }
+    ],
+    "test": [
+        {
+            "cookieContains": "%22targeting%22:false"
+        }
+    ]
+}

package/rules/autoconsent/fanatics.json

@@ -0,0 +1,9 @@
+{
+    "name": "fanatics",
+    "prehideSelectors": [".aspire-banner.marketing-cookies-banner"],
+    "detectCmp": [{ "exists": ".aspire-banner.marketing-cookies-banner" }],
+    "detectPopup": [{ "visible": ".aspire-banner.marketing-cookies-banner" }],
+    "optOut": [{ "waitForThenClick": "[data-trk-id=\"reject-marketing-cookies\"]" }],
+    "optIn": [{ "waitForThenClick": "[data-trk-id=\"accept-marketing-cookies\"]" }],
+    "test": [{ "cookieContains": "mktck=false" }]
+}

package/rules/autoconsent/jpmorgan-chase.json

@@ -0,0 +1,10 @@
+{
+    "name": "jpmorgan-chase",
+    "vendorUrl": "https://www.jpmorganchase.com/",
+    "prehideSelectors": [".consent-banner:has(.consent-close-icon-wrapper)"],
+    "detectCmp": [{ "exists": ".consent-banner a.consent-close-icon-wrapper[data-pt-name=\"consent-closed\"]" }],
+    "detectPopup": [{ "visible": ".consent-banner a.consent-close-icon-wrapper[data-pt-name=\"consent-closed\"]" }],
+    "optIn": [{ "waitForThenClick": ".consent-banner a.consent-close-icon-wrapper[data-pt-name=\"consent-closed\"]" }],
+    "optOut": [{ "waitForThenClick": ".consent-banner a.consent-close-icon-wrapper[data-pt-name=\"consent-closed\"]" }],
+    "test": [{ "cookieContains": "cbc=true" }]
+}

package/rules/autoconsent/lego.json

@@ -0,0 +1,26 @@
+{
+    "name": "lego",
+    "runContext": {
+        "urlPattern": "^https?://(www\\.)?lego\\.com/"
+    },
+    "prehideSelectors": ["[class*=\"ConsentModal_consent-modal__modal-overlay\"]"],
+    "detectCmp": [{ "exists": "[data-test=\"cookie-necessary-button\"]" }],
+    "detectPopup": [{ "visible": "[data-test=\"cookie-necessary-button\"]" }],
+    "optOut": [
+        { "waitForThenClick": "[data-test=\"cookie-necessary-button\"]" },
+        {
+            "any": [{ "cookieContains": "AGE_GATE=" }, { "waitForVisible": "[data-test=\"age-gate-overlay\"]", "timeout": 1000 }],
+            "optional": true
+        },
+        {
+            "if": { "visible": "[data-test=\"age-gate-overlay\"]" },
+            "then": [
+                { "waitForVisible": "[data-test=\"age-gate-overlay\"]", "check": "none", "timeout": 30000 },
+                { "waitForThenClick": "[data-test=\"cookie-necessary-button\"]", "timeout": 5000 }
+            ],
+            "optional": true
+        }
+    ],
+    "optIn": [{ "waitForThenClick": "[data-test=\"cookie-accept-all\"]" }],
+    "test": [{ "cookieContains": "%22key%22%3A%22analytics%22%2C%22value%22%3Afalse" }]
+}

package/rules/autoconsent/privacy-area.json

@@ -0,0 +1,56 @@
+{
+    "name": "privacy-area",
+    "vendorUrl": "https://www.yccable.com/",
+    "cosmetic": false,
+    "prehideSelectors": [".privacyArea"],
+    "detectCmp": [
+        {
+            "exists": ".privacyArea .privacyTrigger.acceptAll"
+        },
+        {
+            "exists": "#modulePrivacy .privacyTrigger.acceptCustom"
+        }
+    ],
+    "detectPopup": [
+        {
+            "visible": ".privacyArea"
+        }
+    ],
+    "optIn": [
+        {
+            "waitForThenClick": ".privacyArea .privacyTrigger.acceptAll"
+        }
+    ],
+    "optOut": [
+        {
+            "if": {
+                "exists": ".privacyArea .privacyTrigger.rejectOptional"
+            },
+            "then": [
+                {
+                    "click": ".privacyArea .privacyTrigger.rejectOptional"
+                }
+            ],
+            "else": [
+                {
+                    "click": "#modulePrivacy input[type=checkbox]:checked",
+                    "all": true,
+                    "optional": true
+                },
+                {
+                    "click": "#modulePrivacy .privacyTrigger.acceptCustom"
+                }
+            ]
+        },
+        {
+            "waitForVisible": ".privacyArea",
+            "check": "none",
+            "timeout": 3000
+        }
+    ],
+    "test": [
+        {
+            "cookieContains": "privacy={\"necessary\":\"ok\"}"
+        }
+    ]
+}

package/rules/autoconsent/securiti-gpc-flyout.json

@@ -0,0 +1,22 @@
+{
+    "name": "securiti-gpc-flyout",
+    "prehideSelectors": [".f-cmp-flyout-wrapper .f-gpc-banner"],
+    "detectCmp": [{ "exists": ".f-cmp-flyout-wrapper .f-gpc-banner .f-banner-close-btn" }],
+    "detectPopup": [
+        { "visible": ".f-cmp-flyout-wrapper .f-gpc-banner" },
+        {
+            "comment": "some sites show the cookie banner next to the flyout; leave it to the cookieconsent rules",
+            "exists": ".cc-window",
+            "negated": true
+        }
+    ],
+    "optIn": [{ "waitForThenClick": ".f-gpc-banner .f-banner-close-btn", "retry": 2 }],
+    "optOut": [
+        {
+            "comment": "the close handler is attached shortly after the flyout is inserted",
+            "waitForThenClick": ".f-gpc-banner .f-banner-close-btn",
+            "retry": 2
+        }
+    ],
+    "test": [{ "visible": ".f-gpc-banner", "check": "none" }]
+}

package/rules/autoconsent/speciesplus.json

@@ -0,0 +1,10 @@
+{
+    "name": "speciesplus.net",
+    "runContext": { "urlPattern": "^https?://(www\\.)?speciesplus\\.net/" },
+    "prehideSelectors": ["#cookie-consent-message"],
+    "detectCmp": [{ "exists": "#cookie-consent-message #cookie-consent-reject" }],
+    "detectPopup": [{ "visible": "#cookie-consent-message" }],
+    "optIn": [{ "waitForThenClick": "#cookie-consent-accept" }],
+    "optOut": [{ "waitForThenClick": "#cookie-consent-reject" }, { "waitForVisible": "#cookie-consent-message", "check": "none" }],
+    "test": [{ "cookieContains": "cookieconsent_status=0" }]
+}

package/rules/autoconsent/squarespace-cookie-banner.json

@@ -18,7 +18,30 @@
     ],
     "optOut": [
         {
-            "waitForThenClick": ".cookie-banner-mount-point button.decline"
+            "if": {
+                "exists": ".cookie-banner-mount-point button.decline"
+            },
+            "then": [
+                {
+                    "waitForThenClick": ".cookie-banner-mount-point button.decline"
+                }
+            ],
+            "else": [
+                {
+                    "waitForThenClick": ".cookie-banner-mount-point button.manage"
+                },
+                {
+                    "waitForVisible": ".cookie-banner-manager .manage-cookies-overlay"
+                },
+                {
+                    "click": ".cookie-banner-manager .manage-cookies-overlay label.sqs-toggle--on input",
+                    "all": true,
+                    "optional": true
+                },
+                {
+                    "waitForThenClick": ".cookie-banner-manager .manage-cookies-overlay button.save"
+                }
+            ]
         }
     ],
     "test": [

package/rules/autoconsent/ziptozipmoving.json

@@ -0,0 +1,44 @@
+{
+    "name": "ziptozipmoving",
+    "vendorUrl": "https://ziptozipmoving.com/",
+    "runContext": {
+        "urlPattern": "^https://(www\\.)?ziptozipmoving\\.com/"
+    },
+    "prehideSelectors": [],
+    "detectCmp": [
+        {
+            "exists": ".cookies.main-class .customize-btn"
+        }
+    ],
+    "detectPopup": [
+        {
+            "visible": ".cookies.main-class .customize-btn"
+        }
+    ],
+    "optIn": [
+        {
+            "waitForThenClick": ".cookies.main-class .cookies-container .accept-btn"
+        }
+    ],
+    "optOut": [
+        {
+            "waitForThenClick": ".cookies.main-class .cookies-container .customize-btn"
+        },
+        {
+            "waitForVisible": ".cookies.main-class .cookies-hidden .el-switch"
+        },
+        {
+            "click": ".cookies-hidden .el-switch.is-checked:not(.is-disabled)",
+            "all": true,
+            "optional": true
+        },
+        {
+            "waitForThenClick": ".cookies.main-class .cookies-hidden .accept-btn"
+        }
+    ],
+    "test": [
+        {
+            "cookieContains": "validCookies=general--"
+        }
+    ]
+}