@duckduckgo/autoconsent 15.0.0 → 16.0.0

package/lib/web.ts

@@ -1,5 +1,4 @@
 import { MessageSender, AutoCMP, RuleBundle, Config, ConsentState } from './types';
-import { ConsentOMaticCMP, ConsentOMaticConfig } from './cmps/consentomatic';
 import { AutoConsentCMPRule, SUPPORTED_RULE_STEP_VERSION } from './rules';
 import { BackgroundMessage, InitMessage } from './messages';
 import { evalState, resolveEval } from './eval-handler';
@@ -8,7 +7,6 @@ import { dynamicCMPs } from './cmps/all';
 import { AutoConsentCMP, AutoConsentHeuristicCMP } from './cmps/base';
 import { DomActions } from './dom-actions';
 import { isTopFrame, normalizeConfig, scheduleWhenIdle } from './utils';
-import { FiltersEngine } from '@ghostery/adblocker';
 import { checkHeuristicPatterns } from './heuristics';
 import { decodeRules } from './encoding';
 
@@ -36,8 +34,6 @@ export default class AutoConsent {
     #config?: Config;
     foundCmp?: AutoCMP;
     state: ConsentState = {
-        cosmeticFiltersOn: false,
-        filterListReported: false,
         lifecycle: 'loading',
         prehideOn: false,
         findCmpAttempts: 0,
@@ -51,9 +47,7 @@ export default class AutoConsent {
         endTime: 0,
     };
     domActions: DomActions;
-    filtersEngine?: FiltersEngine;
     sendContentMessage: MessageSender;
-    protected cosmeticStyleSheet?: CSSStyleSheet;
     protected focusedElement?: HTMLElement;
 
     constructor(sendContentMessage: MessageSender, config: Partial<Config> | null = null, declarativeRules: RuleBundle | null = null) {
@@ -100,9 +94,6 @@ export default class AutoConsent {
             this.parseDeclarativeRules(declarativeRules);
         }
 
-        if (config.enableFilterList) {
-            this.initializeFilterList();
-        }
         this.rules = filterCMPs(this.rules, normalizedConfig);
 
         if (this.shouldPrehide) {
@@ -131,10 +122,6 @@ export default class AutoConsent {
         this.updateState({ lifecycle: 'initialized' });
     }
 
-    initializeFilterList() {
-        // no-op by default
-    }
-
     get shouldPrehide() {
         return this.config.enablePrehide && !this.config.visualTest;
     }
@@ -167,11 +154,6 @@ export default class AutoConsent {
     parseDeclarativeRules(declarativeRules: RuleBundle) {
         const perfEnabled = this.#config?.performanceLoggingEnabled;
         perfEnabled && performance.mark('parseDeclarativeRulesStart');
-        if (declarativeRules.consentomatic) {
-            for (const [name, rule] of Object.entries(declarativeRules.consentomatic)) {
-                this.addConsentomaticCMP(name, rule);
-            }
-        }
 
         if (declarativeRules.autoconsent) {
             declarativeRules.autoconsent.forEach((ruleset) => {
@@ -198,10 +180,6 @@ export default class AutoConsent {
         }
     }
 
-    addConsentomaticCMP(name: string, config: ConsentOMaticConfig) {
-        this.rules.push(new ConsentOMaticCMP(`com_${name}`, config));
-    }
-
     // start the detection process, possibly with a delay
     start() {
         scheduleWhenIdle(() => this._start());
@@ -222,7 +200,8 @@ export default class AutoConsent {
                 this.undoPrehide();
             }
 
-            return this.filterListFallback();
+            this.updateState({ lifecycle: 'nothingDetected' });
+            return false;
         }
 
         this.updateState({ lifecycle: 'cmpDetected' });
@@ -296,7 +275,7 @@ 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 heuristicRules =
-            isTop && this.config.enableHeuristicAction && this.state.findCmpAttempts % 2 === 0
+            isTop && this.config.heuristicMode !== 'off' && this.state.findCmpAttempts % 2 === 0
                 ? [new AutoConsentHeuristicCMP(this, this.config.heuristicMode)]
                 : [];
 
@@ -436,11 +415,6 @@ export default class AutoConsent {
             // prehide might have timeouted by this time, apply it again
             this.prehideElements();
         }
-        if (this.state.cosmeticFiltersOn) {
-            // cancel cosmetic filters if we have a rule for this popup
-            this.undoCosmetics();
-        }
-
         this.foundCmp = cmp;
 
         if (this.config.autoAction === 'optOut') {
@@ -631,30 +605,6 @@ export default class AutoConsent {
         this.domActions.undoPrehide();
     }
 
-    undoCosmetics() {
-        // no-op by default
-    }
-
-    reportFilterlist() {
-        this.sendContentMessage({
-            type: 'cmpDetected',
-            url: location.href,
-            cmp: 'filterList',
-        });
-        this.sendContentMessage({
-            type: 'popupFound',
-            cmp: 'filterList',
-            url: location.href,
-        });
-        this.updateState({ filterListReported: true });
-    }
-
-    filterListFallback() {
-        // no-op by default
-        this.updateState({ lifecycle: 'nothingDetected' });
-        return false;
-    }
-
     updateState(change: Partial<ConsentState>) {
         Object.assign(this.state, change);
         this.sendContentMessage({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duckduckgo/autoconsent",
-  "version": "15.0.0",
+  "version": "16.0.0",
   "description": "",
   "types": "./dist/types/web.d.ts",
   "exports": {
@@ -9,13 +9,7 @@
       "import": "./dist/autoconsent.esm.js",
       "require": "./dist/autoconsent.cjs.js"
     },
-    "./extra": {
-      "types": "./dist/types/web-extra.d.ts",
-      "import": "./dist/autoconsent.extra.esm.js",
-      "require": "./dist/autoconsent.extra.cjs.js"
-    },
     "./rules/rules.json": "./rules/rules.json",
-    "./rules/consentomatic.json": "./rules/consentomatic.json",
     "./rules/compact-rules.json": "./rules/compact-rules.json"
   },
   "directories": {
@@ -27,7 +21,7 @@
     "lint-fix": "eslint . --fix && prettier . --write && npm run rule-syntax-check",
     "bundle": "./build.sh",
     "rule-syntax-check": "node scripts/validate-json-rules.js",
-    "watch": "npm run prepublish && chokidar \"lib\" \"addon\" \"rules/autoconsent\" \"rules/generated\" \"rules/filterlist.txt\" --ignore 'lib/filterlist-engine.ts' -c \"npm run prepublish\"",
+    "watch": "npm run prepublish && chokidar \"lib\" \"addon\" \"rules/autoconsent\" \"rules/generated\" -c \"npm run prepublish\"",
     "create-rule": "node rules/create-rule.mjs",
     "test": "playwright test",
     "test:webkit": "playwright test --project webkit",
@@ -35,14 +29,10 @@
     "test:chrome": "playwright test --project chrome",
     "test:lib": "web-test-runner",
     "test:sample": "playwright test tests/_sample-test.spec.ts --project webkit",
-    "fetch-easylist": "scripts/fetch-easylist.sh",
-    "rebuild-filterlist": "node scripts/rebuild-filterlist.mjs",
-    "update-easylist": "npm run fetch-easylist && npm run rebuild-filterlist",
-    "compile-filterlist": "node scripts/compile-filterlist.mjs",
     "build-rules": "ts-node rules/build.ts",
     "version": "node update_version.js && git add addon/manifest.*.json",
     "vendor-copy": "mkdir -p addon/vendor && cp node_modules/mocha/mocha.* addon/vendor/ && cp node_modules/chai/chai.js addon/vendor/",
-    "prepublish": "npm run compile-filterlist && npm run build-rules && npm run bundle",
+    "prepublish": "npm run build-rules && npm run bundle",
     "launch:firefox": "web-ext run -s dist/addon-firefox",
     "release": "auto shipit",
     "get-text-for-xpath": "ts-node scripts/get-text-for-xpath.ts",
@@ -68,7 +58,6 @@
     "bulma": "^1.0.2",
     "chai": "^6.0.1",
     "chokidar-cli": "^3.0.0",
-    "csv-parse": "^6.0.0",
     "esbuild": "^0.28.0",
     "eslint": "^10.0.3",
     "globals": "^17.4.0",
@@ -92,8 +81,6 @@
     ]
   },
   "dependencies": {
-    "@ghostery/adblocker": "^2.0.4",
-    "@ghostery/adblocker-content": "^2.0.4",
-    "tldts-experimental": "^7.0.4"
+    "tldts-experimental": "^7.4.3"
   }
 }

package/playwright/content.ts

@@ -1,7 +1,6 @@
 import AutoConsent from '../lib/web';
 import { BackgroundMessage } from '../lib/messages';
 import { MessageSender, RuleBundle } from '../lib/types';
-import { consentomatic } from '../rules/consentomatic.json';
 
 declare global {
     interface Window {
@@ -11,7 +10,7 @@ declare global {
 }
 
 if (!window.autoconsentReceiveMessage) {
-    const consent = new AutoConsent(window.autoconsentSendMessage, null, <RuleBundle>{ autoconsent: [], consentomatic });
+    const consent = new AutoConsent(window.autoconsentSendMessage, null, <RuleBundle>{ autoconsent: [] });
 
     window.autoconsentReceiveMessage = (message: BackgroundMessage) => {
         return Promise.resolve(consent.receiveMessageCallback(message));

package/readme.md

@@ -11,14 +11,13 @@ Autoconsent is meant to be used in browser apps and extensions. [DuckDuckGo brow
 To integrate Autoconsent, you'll need to instantiate the main `AutoConsent` class in a content script (running in isolated page context), and implement some configuration hooks in a background script. See [this document](docs/api.md) for more details on internal APIs and data flows.
 
 ```javascript
-import AutoConsent from '@duckduckgo/autoconsent'; // or '@duckduckgo/autoconsent/extra' for the version with filterlists
+import AutoConsent from '@duckduckgo/autoconsent';
 import { autoconsent } from '@duckduckgo/autoconsent/rules/rules.json';
-import { consentomatic } from '@duckduckgo/autoconsent/rules/consentomatic.json'
 
 const autoconsent = new AutoConsent(
     chrome.runtime.sendMessage, // provide a callback to send messages to the background script
     null, // optionally provide a config object here if you don't want to implement a background script
-    { autoconsent, consentomatic },
+    { autoconsent },
 );
 
 // connect the message receiver callback to handle messages from the background script
@@ -76,13 +75,11 @@ that are installed on multiple sites. Each CMP ruleset defines:
  * Steps to specify an 'opt-in' or 'opt-out' consent for the CMP.
  * Optionally, a test if the consent was correctly applied.
 
-There are currently three ways of implementing a CMP:
+There are currently two ways of implementing a CMP:
 
  1. As a [JSON ruleset](./rules/autoconsent/), intepreted by the `AutoConsent` class.
  1. As a class implementing the `AutoCMP` interface. This enables more complex logic than the linear AutoConsent
  rulesets allow.
- 3. As a [Consent-O-Matic](https://github.com/cavi-au/Consent-O-Matic) rule. The `ConsentOMaticCMP` class implements
- compability with rules written for the Consent-O-Matic extension.
 
 For more details on rule types, see [Rule Syntax Reference](docs/rule-syntax.md).
 

package/rules/autoconsent/dreamlab-cmp.json

@@ -0,0 +1,13 @@
+{
+    "name": "dreamlab-cmp",
+    "vendorUrl": "https://cmp.dreamlab.pl/",
+    "prehideSelectors": [".cmp-popup_popup"],
+    "detectCmp": [{ "exists": ".cmp-app_gdpr" }],
+    "detectPopup": [{ "visible": ".cmp-popup_popup" }],
+    "optIn": [{ "waitForThenClick": ".cmp-popup_popup .cmp-intro_acceptAll" }],
+    "optOut": [
+        { "waitForThenClick": ".cmp-popup_popup .cmp-intro_rejectAll" },
+        { "waitForThenClick": ".cmp-popup_popup .cmp-details_rejectAll" }
+    ],
+    "test": [{ "cookieContains": "lpubconsent=" }]
+}

package/rules/build.ts

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 import fs from 'fs';
 import path from 'path';
-import https from 'https';
 import { encodeRules, deduplicateRules } from '../lib/encoding';
 import { AutoConsentCMPRule } from '../lib/rules';
+import { buildRuleIndex } from './rule-index-builder';
 
 export const rulesDir = __dirname;
 
@@ -28,30 +28,9 @@ export async function buildAutoconsentRules(): Promise<AutoConsentCMPRule[]> {
     return deduplicateRules([...normalRules, ...generatedRules]);
 }
 
-export async function buildConsentOMaticRules() {
-    // fetch ConsentOMatic rule set and merge with our custom rules
-    const consentOMaticCommit = '7d7fd2bd6bf2b662350b0eaeca74db6eba155efe';
-    const consentOMaticUrl = `https://raw.githubusercontent.com/cavi-au/Consent-O-Matic/${consentOMaticCommit}/Rules.json`;
-    const consentOMaticInclude = ['oil', 'optanon', 'quantcast2', 'springer', 'wordpressgdpr'];
-    const comRules: Record<string, object> = {};
-    const allComRules: Record<string, object> = await new Promise((resolve) => {
-        https.get(consentOMaticUrl, (res) => {
-            res.setEncoding('utf-8');
-            let content = '';
-            res.on('data', (data) => (content += data));
-            res.on('end', () => resolve(JSON.parse(content)));
-        });
-    });
-    consentOMaticInclude.forEach((name) => {
-        comRules[name] = allComRules[name];
-    });
-    return comRules;
-}
-
 (async () => {
     const stringify = (rules: object) => JSON.stringify(rules);
     const autoconsent = await buildAutoconsentRules();
-    const consentomatic = await buildConsentOMaticRules();
 
     const compactRulesPath = path.join(rulesDir, 'compact-rules.json');
     let existingCompactRules = null;
@@ -60,7 +39,9 @@ export async function buildConsentOMaticRules() {
     }
 
     fs.writeFile(path.join(rulesDir, 'rules.json'), stringify({ autoconsent }), () => console.log('Written rules.json'));
-    fs.writeFile(path.join(rulesDir, 'consentomatic.json'), stringify({ consentomatic }), () => console.log('Written consentomatic.json'));
+    fs.writeFile(path.join(rulesDir, 'rule-index.json'), stringify(buildRuleIndex(autoconsent)), () =>
+        console.log('Written rule-index.json'),
+    );
     fs.writeFile(compactRulesPath, stringify(encodeRules(autoconsent, existingCompactRules)), () =>
         console.log('Written compact-rules.json'),
     );