@duckduckgo/autoconsent 3.0.4 → 4.1.0

package/lib/cmps/consentomatic.ts

@@ -21,6 +21,7 @@ export class ConsentOMaticCMP implements AutoCMP {
   methods = new Map<string, any>();
   hasSelfTest: boolean;
   runContext: RunContext = defaultRunContext;
+  isCosmetic = false;
 
   constructor(public name: string, public config: ConsentOMaticConfig) {
     config.methods.forEach(methodConfig => {

package/lib/cmps/conversant.ts

@@ -18,6 +18,10 @@ export default class Conversant extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     return elementExists(".cmp-root .cmp-receptacle");
   }

package/lib/cmps/cookiebot.ts

@@ -17,6 +17,10 @@ export default class Cookiebot extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     return elementExists('#CybotCookiebotDialogBodyLevelButtonPreferences');
   }

package/lib/cmps/evidon.ts

@@ -15,6 +15,10 @@ export default class Evidon extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     return elementExists("#_evidon_banner");
   }

package/lib/cmps/klaro.ts

@@ -18,6 +18,10 @@ export default class Klaro extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     if (elementExists('.klaro > .cookie-modal')) {
       this.settingsOpen = true;

package/lib/cmps/onetrust.ts

@@ -18,6 +18,10 @@ export default class Onetrust extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     return elementExists("#onetrust-banner-sdk");
   }

package/lib/cmps/sourcepoint-frame.ts

@@ -5,9 +5,10 @@ import { waitFor } from "../utils";
 import AutoConsentCMPBase from "./base";
 
 export default class SourcePoint extends AutoConsentCMPBase {
-  prehideSelectors = ["div[id^='sp_message_container_'],.message-overlay"]
+  prehideSelectors = ["div[id^='sp_message_container_'],.message-overlay",'#sp_privacy_manager_container']
 
-  ccpaMode = false;
+  ccpaNotice = false;
+  ccpaPopup = false;
 
   runContext: RunContext = {
     main: false,
@@ -26,10 +27,18 @@ export default class SourcePoint extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     const url = new URL(location.href);
     if (url.searchParams.has('message_id') && url.hostname === 'ccpa-notice.sp-prod.net') {
-      this.ccpaMode = true;
+      this.ccpaNotice = true;
+      return true;
+    }
+    if (url.hostname === 'ccpa-pm.sp-prod.net') {
+      this.ccpaPopup = true;
       return true;
     }
     return (url.pathname === '/index.html' || url.pathname === '/privacy-manager/index.html')
@@ -37,6 +46,12 @@ export default class SourcePoint extends AutoConsentCMPBase {
   }
 
   async detectPopup() {
+    if (this.ccpaNotice) {
+      return true;
+    }
+    if (this.ccpaPopup) {
+      return await waitForElement('.priv-save-btn', 2000);
+    }
     // check for the paywall button, and bail if it exists to prevent broken opt out
     await waitForElement(".sp_choice_type_11,.sp_choice_type_12,.sp_choice_type_13,.sp_choice_type_ACCEPT_ALL", 2000);
     return !elementExists('.sp_choice_type_9');
@@ -55,10 +70,23 @@ export default class SourcePoint extends AutoConsentCMPBase {
   }
 
   isManagerOpen() {
-    return (new URL(location.href)).pathname === "/privacy-manager/index.html";
+    return location.pathname === "/privacy-manager/index.html";
   }
 
   async optOut() {
+    if (this.ccpaPopup) {
+      // toggles with 2 buttons
+      const toggles = document.querySelectorAll('.priv-purpose-container .sp-switch-arrow-block a.neutral.on .right') as NodeListOf<HTMLElement>;
+      for (const t of toggles) {
+        click([t]);
+      }
+      // switch toggles
+      const switches = document.querySelectorAll('.priv-purpose-container .sp-switch-arrow-block a.switch-bg.on') as NodeListOf<HTMLElement>;
+      for (const t of switches) {
+        click([t]);
+      }
+      return click('.priv-save-btn');
+    }
     if (!this.isManagerOpen()) {
       const actionable = await waitForElement('.sp_choice_type_12,.sp_choice_type_13');
       if (!actionable) {
@@ -72,7 +100,7 @@ export default class SourcePoint extends AutoConsentCMPBase {
       click(".sp_choice_type_12");
       // the page may navigate at this point but that's okay
       await waitFor(
-        () => location.pathname === "/privacy-manager/index.html",
+        () => this.isManagerOpen(),
         200,
         100
       );
@@ -102,7 +130,7 @@ export default class SourcePoint extends AutoConsentCMPBase {
     } catch (e) {
       enableLogs && console.warn(e);
     }
-    click('.sp_choice_type_SAVE_AND_EXIT');
-    return true;
+    // TODO: race condition: the popup disappears very quickly, so the background script may not receive a success report.
+    return click('.sp_choice_type_SAVE_AND_EXIT');
   }
 }

package/lib/cmps/tiktok.ts

@@ -21,6 +21,10 @@ export default class Tiktok extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   getShadowRoot() {
     const container = document.querySelector('tiktok-cookie-banner');
     if (!container) {

package/lib/cmps/trustarc-frame.ts

@@ -22,6 +22,10 @@ export default class TrustArcFrame extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     return true;
   }

package/lib/cmps/trustarc-top.ts

@@ -41,6 +41,10 @@ export default class TrustArcTop extends AutoConsentCMPBase {
     return !this._shortcutButton;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     const result = elementExists(`${cookieSettingsButton},${bannerContainer}`);
     if (result) {

package/lib/cmps/uniconsent.ts

@@ -18,6 +18,10 @@ export default class Uniconsent extends AutoConsentCMPBase {
     return false;
   }
 
+  get isCosmetic(): boolean {
+    return false;
+  }
+
   async detectCmp() {
     return elementExists(".unic .unic-box,.unic .unic-bar");
   }

package/lib/consentomatic/index.ts

@@ -28,7 +28,7 @@ export async function executeAction(config: any, param?: any): Promise<boolean |
     case "slide":
       return slideAction(config);
     case "close":
-      return closeAction(config);
+      return closeAction();
     case "wait":
       return waitAction(config);
     case "eval":
@@ -57,7 +57,7 @@ async function clickAction(config: any) {
 }
 
 async function listAction(config: any, param: any) {
-  for (let action of config.actions) {
+  for (const action of config.actions) {
     await executeAction(action, param);
   }
 }
@@ -141,8 +141,8 @@ async function slideAction(config: any) {
   const result = Tools.find(config);
   const dragResult = Tools.find(config.dragTarget);
   if (result.target) {
-    let targetBounds = result.target.getBoundingClientRect();
-    let dragTargetBounds = dragResult.target.getBoundingClientRect();
+    const targetBounds = result.target.getBoundingClientRect();
+    const dragTargetBounds = dragResult.target.getBoundingClientRect();
 
     let yDiff = dragTargetBounds.top - targetBounds.top;
     let xDiff = dragTargetBounds.left - targetBounds.left;
@@ -154,12 +154,12 @@ async function slideAction(config: any) {
       yDiff = 0;
     }
 
-    let screenX = window.screenX + targetBounds.left + targetBounds.width / 2.0;
-    let screenY = window.screenY + targetBounds.top + targetBounds.height / 2.0;
-    let clientX = targetBounds.left + targetBounds.width / 2.0;
-    let clientY = targetBounds.top + targetBounds.height / 2.0;
+    const screenX = window.screenX + targetBounds.left + targetBounds.width / 2.0;
+    const screenY = window.screenY + targetBounds.top + targetBounds.height / 2.0;
+    const clientX = targetBounds.left + targetBounds.width / 2.0;
+    const clientY = targetBounds.top + targetBounds.height / 2.0;
 
-    let mouseDown = document.createEvent("MouseEvents");
+    const mouseDown = document.createEvent("MouseEvents");
     mouseDown.initMouseEvent(
       "mousedown",
       true,
@@ -177,7 +177,7 @@ async function slideAction(config: any) {
       0,
       result.target
     );
-    let mouseMove = document.createEvent("MouseEvents");
+    const mouseMove = document.createEvent("MouseEvents");
     mouseMove.initMouseEvent(
       "mousemove",
       true,
@@ -195,7 +195,7 @@ async function slideAction(config: any) {
       0,
       result.target
     );
-    let mouseUp = document.createEvent("MouseEvents");
+    const mouseUp = document.createEvent("MouseEvents");
     mouseUp.initMouseEvent(
       "mouseup",
       true,
@@ -225,7 +225,7 @@ async function waitAction(config: any) {
   await waitTimeout(config.waitTime);
 }
 
-async function closeAction(config: any) {
+async function closeAction() {
   window.close();
 }
 

package/lib/consentomatic/tools.ts

@@ -28,12 +28,12 @@ export default class Tools {
 
     if (options.textFilter != null) {
       possibleTargets = possibleTargets.filter(possibleTarget => {
-        let textContent = possibleTarget.textContent.toLowerCase();
+        const textContent = possibleTarget.textContent.toLowerCase();
 
         if (Array.isArray(options.textFilter)) {
           let foundText = false;
 
-          for (let text of options.textFilter) {
+          for (const text of options.textFilter) {
             if (textContent.indexOf(text.toLowerCase()) !== -1) {
               foundText = true;
               break;
@@ -49,12 +49,12 @@ export default class Tools {
 
     if (options.styleFilters != null) {
       possibleTargets = possibleTargets.filter(possibleTarget => {
-        let styles = window.getComputedStyle(possibleTarget);
+        const styles = window.getComputedStyle(possibleTarget);
 
         let keep = true;
 
-        for (let styleFilter of options.styleFilters) {
-          let option = styles[styleFilter.option];
+        for (const styleFilter of options.styleFilters) {
+          const option = styles[styleFilter.option];
 
           if (styleFilter.negated) {
             keep = keep && option !== styleFilter.value;
@@ -80,7 +80,7 @@ export default class Tools {
     }
 
     if (options.iframeFilter != null) {
-      possibleTargets = possibleTargets.filter(possibleTarget => {
+      possibleTargets = possibleTargets.filter((/* possibleTarget */) => {
         if (options.iframeFilter) {
           //We should be inside an iframe
           return window.location !== window.parent.location;
@@ -93,9 +93,9 @@ export default class Tools {
 
     if (options.childFilter != null) {
       possibleTargets = possibleTargets.filter(possibleTarget => {
-        let oldBase = Tools.base;
+        const oldBase = Tools.base;
         Tools.setBase(possibleTarget);
-        let childResults = Tools.find(options.childFilter);
+        const childResults = Tools.find(options.childFilter);
         Tools.setBase(oldBase);
         return childResults.target != null;
       });
@@ -118,13 +118,13 @@ export default class Tools {
   }
 
   static find(options: any, multiple = false) {
-    let results: any[] = [];
+    const results: any[] = [];
     if (options.parent != null) {
-      let parent = Tools.findElement(options.parent, null, multiple);
+      const parent = Tools.findElement(options.parent, null, multiple);
       if (parent != null) {
         if (parent instanceof Array) {
           parent.forEach(p => {
-            let targets = Tools.findElement(options.target, p, multiple);
+            const targets = Tools.findElement(options.target, p, multiple);
             if (targets instanceof Array) {
               targets.forEach(target => {
                 results.push({
@@ -142,7 +142,7 @@ export default class Tools {
 
           return results;
         } else {
-          let targets = Tools.findElement(options.target, parent, multiple);
+          const targets = Tools.findElement(options.target, parent, multiple);
           if (targets instanceof Array) {
             targets.forEach(target => {
               results.push({
@@ -159,7 +159,7 @@ export default class Tools {
         }
       }
     } else {
-      let targets = Tools.findElement(options.target, null, multiple);
+      const targets = Tools.findElement(options.target, null, multiple);
       if (targets instanceof Array) {
         targets.forEach(target => {
           results.push({

package/lib/eval-handler.ts

@@ -1,4 +1,5 @@
 import { ContentScriptMessage } from "./messages";
+import { getRandomID } from "./random";
 
 class Deferred<T> {
   id: string;
@@ -30,12 +31,7 @@ export const evalState: EvalState = {
 }
 
 export function requestEval(code: string): Promise<boolean> {
-  let id;
-  if (crypto && typeof crypto.randomUUID !== 'undefined') {
-    id = crypto.randomUUID();
-  } else {
-    id = Math.random().toString();
-  }
+  const id = getRandomID();
   evalState.sendContentMessage({
     type: 'eval',
     id,

package/lib/messages.ts

@@ -1,14 +1,14 @@
-import { Config, RuleBundle } from "./types";
+import { Config, ConsentState, RuleBundle } from "./types";
 
 export type BackgroundMessage =
-  InitResponseMessage
+  | InitResponseMessage
   | EvalResponseMessage
   | OptOutMessage
   | OptInMessage
-  | SelfTestMessage;
+  | SelfTestMessage
 
 export type ContentScriptMessage =
-  InitMessage
+  | InitMessage
   | EvalMessage
   | DetectedMessage
   | FoundMessage
@@ -16,7 +16,16 @@ export type ContentScriptMessage =
   | OptInResultMessage
   | SelfTestResultMessage
   | DoneMessage
-  | ErrorMessage;
+  | ErrorMessage
+  | ReportMessage;
+
+export type BackgroundDevtoolsMessage =
+  | DevtoolsAuditMessage
+  | InstanceTerminatedMessage
+  | InitResponseMessage;
+
+export type DevtoolsMessage =
+  | DevtoolsInitMessage;
 
 export type InitMessage = {
   type: "init";
@@ -33,13 +42,13 @@ export type DetectedMessage = {
   type: "cmpDetected";
   cmp: string;
   url: string;
-}
+};
 
 export type FoundMessage = {
   type: "popupFound";
   cmp: string;
   url: string;
-}
+};
 
 export type OptOutResultMessage = {
   type: "optOutResult";
@@ -67,34 +76,56 @@ export type SelfTestResultMessage = {
 export type DoneMessage = {
   type: "autoconsentDone";
   cmp: string;
+  isCosmetic: boolean;
   url: string;
-}
+};
 
 export type ErrorMessage = {
   type: "autoconsentError";
   details: any;
-}
+};
 
 export type InitResponseMessage = {
   type: "initResp";
   rules: RuleBundle;
   config: Config;
-}
+};
 
 export type EvalResponseMessage = {
   type: "evalResp";
   id: string;
   result: any;
-}
+};
 
 export type OptOutMessage = {
   type: "optOut";
-}
+};
 
 export type OptInMessage = {
   type: "optIn";
-}
+};
 
 export type SelfTestMessage = {
   type: "selfTest";
+};
+
+export type ReportMessage = {
+  type: "report";
+  instanceId: string; // A unique identifier for the frame.
+  url: string; // Current frame URL
+  mainFrame: boolean; // `true` iff this frame is the top frame.
+  state: ConsentState;
+};
+
+export type DevtoolsAuditMessage = ReportMessage & { tabId: number, frameId: number }
+
+export type InstanceTerminatedMessage = {
+  type: 'instanceTerminated';
+  tabId: number;
+  instanceId: string;
+}
+
+export type DevtoolsInitMessage = {
+  type: 'init';
+  tabId: number;
 }

package/lib/random.ts

@@ -0,0 +1,6 @@
+export function getRandomID() {
+  if (crypto && typeof crypto.randomUUID !== "undefined") {
+    return crypto.randomUUID();
+  }
+  return Math.random().toString();
+}

package/lib/rule-executors.ts

@@ -10,9 +10,14 @@ export function doEval(expr: string): Promise<boolean> {
   });
 }
 
-export function click(selector: string, all = false): boolean {
-  const elem = document.querySelectorAll<HTMLElement>(selector);
-  enableLogs && console.log("[click]", selector, all, elem);
+export function click(selectorOrElements: string | HTMLElement[], all = false): boolean {
+  let elem: HTMLElement[] = [];
+  if (typeof selectorOrElements === 'string') {
+    elem = Array.from(document.querySelectorAll<HTMLElement>(selectorOrElements));
+  } else {
+    elem = selectorOrElements;
+  }
+  enableLogs && console.log("[click]", selectorOrElements, all, elem);
   if (elem.length > 0) {
     if (all) {
       elem.forEach((e) => e.click());

package/lib/rules.ts

@@ -2,7 +2,8 @@ export type AutoConsentCMPRule = {
   name: string
   prehideSelectors?: string[]
   runContext?: RunContext,
-  intermediate?: boolean
+  intermediate?: boolean,
+  cosmetic?: boolean,
   detectCmp: AutoConsentRuleStep[]
   detectPopup: AutoConsentRuleStep[]
   optOut: AutoConsentRuleStep[]

package/lib/types.ts

@@ -8,6 +8,7 @@ export interface AutoCMP {
   name: string
   hasSelfTest: boolean
   isIntermediate: boolean;
+  isCosmetic: boolean;
   prehideSelectors?: string[];
   runContext: RunContext;
   checkRunContext(): boolean;
@@ -31,5 +32,31 @@ export type Config = {
   autoAction: AutoAction;
   disabledCmps: string[];
   enablePrehide: boolean;
+  enableCosmeticRules: boolean;
   detectRetries: number;
 }
+
+export type LifecycleState = 'loading' |
+'initialized' |
+'waitingForInitResponse' |
+'started' |
+'nothingDetected' |
+'cmpDetected' |
+'openPopupDetected' |
+'runningOptOut' |
+'runningOptIn' |
+'optOutSucceeded' |
+'optOutFailed' |
+'optInSucceeded' |
+'optInFailed' |
+'done';
+
+export type ConsentState = {
+  lifecycle: LifecycleState; // What point in the autoconsent lifecycle this script is at.
+  prehideOn: boolean; // If the script is currently hiding preHide elements.
+  findCmpAttempts: number; // Number of times we tried to find CMPs in this frame.
+  detectedCmps: string[]; // Names of CMP rules where `detectCmp` returned true.
+  detectedPopups: string[]; // Names of CMP rules where `detectPopup` returned true.
+  selfTest: boolean; // null if no self test was run, otherwise it holds the result of the self test.
+}
+