@duckduckgo/autoconsent 15.1.0 → 16.0.0

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,7 +1,6 @@
 #!/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';
@@ -29,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;
@@ -61,8 +39,7 @@ 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, consentomatic)), () =>
+    fs.writeFile(path.join(rulesDir, 'rule-index.json'), stringify(buildRuleIndex(autoconsent)), () =>
         console.log('Written rule-index.json'),
     );
     fs.writeFile(compactRulesPath, stringify(encodeRules(autoconsent, existingCompactRules)), () =>