@open-wa/driver-puppeteer 5.0.0-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,113 @@
+import { ConnectOptions, DisposableHandle, DriverCapabilities, IBrowser, IDriver, IDriverContext, IElementHandle, IFrame, IPage, LaunchOptions, NavigationWaitUntil, PageEventHandler, WaitForFunctionOptions } from "@open-wa/driver-interface";
+import { Browser, CDPSession, ElementHandle, Page } from "puppeteer";
+
+//#region src/PuppeteerDriver.d.ts
+declare class PuppeteerDriver implements IDriver {
+  readonly name: "puppeteer";
+  version?: string;
+  readonly capabilities: DriverCapabilities;
+  private puppeteer;
+  private ctx?;
+  constructor();
+  init(ctx?: IDriverContext): Promise<void>;
+  launch(options?: LaunchOptions): Promise<IBrowser>;
+  connect(options: ConnectOptions): Promise<IBrowser>;
+  unwrap(): any;
+  has<C extends string>(cap: C): boolean;
+  require<C extends string>(cap: C): void;
+}
+//#endregion
+//#region src/PuppeteerBrowser.d.ts
+declare class PuppeteerBrowser implements IBrowser {
+  private browser;
+  private capabilities;
+  readonly name: "puppeteer";
+  constructor(browser: Browser, capabilities: DriverCapabilities);
+  newPage(options?: {
+    clearFirstPage?: boolean;
+  }): Promise<IPage>;
+  pages(): Promise<IPage[]>;
+  close(): Promise<void>;
+  isConnected(): boolean;
+  versionString(): Promise<string>;
+  unwrap(): Browser;
+}
+//#endregion
+//#region src/PuppeteerPage.d.ts
+declare class PuppeteerPage implements IPage {
+  private page;
+  private capabilities;
+  readonly name: "puppeteer";
+  private readonly listenerWrappers;
+  constructor(page: Page, capabilities: DriverCapabilities);
+  goto(url: string, options?: {
+    waitUntil?: NavigationWaitUntil;
+    timeoutMs?: number;
+  }): Promise<void>;
+  url(): string;
+  reload(): Promise<void>;
+  mainFrame(): IFrame;
+  evaluateOnNewDocument<Arg, Ret>(fn: (arg: Arg) => Ret | Promise<Ret>, arg: Arg): Promise<void>;
+  evaluate<Arg, Ret>(fn: (arg: Arg) => Ret | Promise<Ret>, arg: Arg): Promise<Ret>;
+  evaluateScript<Ret = unknown>(script: string): Promise<Ret>;
+  addInitScript(script: string): Promise<DisposableHandle>;
+  setViewport(viewport: {
+    width: number;
+    height: number;
+  }): Promise<void>;
+  setUserAgent(ua: string): Promise<void>;
+  setRequestInterception(enabled: boolean): Promise<void>;
+  waitForSelector(selector: string, options?: {
+    timeoutMs?: number;
+  }): Promise<IElementHandle | null>;
+  waitForFunction<Arg>(script: string, options?: WaitForFunctionOptions): Promise<void>;
+  waitForFunction<Arg>(fn: (arg: Arg) => boolean, arg: Arg, options?: WaitForFunctionOptions): Promise<void>;
+  $(selector: string): Promise<IElementHandle | null>;
+  $$(selector: string): Promise<IElementHandle[]>;
+  click(selector: string): Promise<void>;
+  type(selector: string, text: string, options?: {
+    delayMs?: number;
+  }): Promise<void>;
+  screenshot(options?: {
+    type?: 'png' | 'jpeg';
+    fullPage?: boolean;
+  }): Promise<Uint8Array>;
+  exposeFunction(name: string, fn: (...args: any[]) => any): Promise<void>;
+  on<K extends string>(event: K, handler: ((...args: any[]) => void | Promise<void>) | PageEventHandler<any>): DisposableHandle;
+  off<K extends string>(event: K, handler: ((...args: any[]) => void | Promise<void>) | PageEventHandler<any>): void;
+  close(): Promise<void>;
+  isClosed(): boolean;
+  has<C extends string>(cap: C): boolean;
+  require<C extends string>(cap: C): void;
+  cdp(): Promise<CDPSession>;
+  setBypassServiceWorker(bypass: boolean): Promise<void>;
+  pdf(options?: {
+    path?: string;
+    format?: string;
+  }): Promise<Uint8Array>;
+  startTracing(options?: {
+    path?: string;
+    screenshots?: boolean;
+  }): Promise<void>;
+  stopTracing(): Promise<Uint8Array>;
+  unwrap(): Page;
+  private getWrapperSet;
+  private removeWrappedListener;
+  private getInitScriptIdentifier;
+  private wrapEventPayload;
+}
+//#endregion
+//#region src/PuppeteerElementHandle.d.ts
+declare class PuppeteerElementHandle implements IElementHandle {
+  private element;
+  constructor(element: ElementHandle);
+  click(): Promise<void>;
+  type(text: string): Promise<void>;
+  getAttribute(name: string): Promise<string | null>;
+  textContent(): Promise<string | null>;
+  dispose(): Promise<void>;
+  unwrap(): ElementHandle;
+}
+//#endregion
+export { PuppeteerBrowser, PuppeteerDriver, PuppeteerElementHandle, PuppeteerPage };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/PuppeteerDriver.ts","../src/PuppeteerBrowser.ts","../src/PuppeteerPage.ts","../src/PuppeteerElementHandle.ts"],"mappings":";;;;cAGa,eAAA,YAA2B,OAAA;EAAA,SAC3B,IAAA;EACT,OAAA;EAAA,SACS,YAAA,EAAc,kBAAA;EAAA,QAEf,SAAA;EAAA,QACA,GAAA;;EAgBF,IAAA,CAAK,GAAA,GAAM,cAAA,GAAiB,OAAA;EAgB5B,MAAA,CAAO,OAAA,GAAU,aAAA,GAAgB,OAAA,CAAQ,QAAA;EAoBzC,OAAA,CAAQ,OAAA,EAAS,cAAA,GAAiB,OAAA,CAAQ,QAAA;EAWhD,MAAA,CAAA;EAIA,GAAA,kBAAA,CAAsB,GAAA,EAAK,CAAA;EAI3B,OAAA,kBAAA,CAA0B,GAAA,EAAK,CAAA;AAAA;;;cC5EtB,gBAAA,YAA4B,QAAA;EAAA,QAIzB,OAAA;EAAA,QACA,YAAA;EAAA,SAJH,IAAA;cAGG,OAAA,EAAS,OAAA,EACT,YAAA,EAAc,kBAAA;EAGpB,OAAA,CAAQ,OAAA;IACV,cAAA;EAAA,IACA,OAAA,CAAQ,KAAA;EAWN,KAAA,CAAA,GAAS,OAAA,CAAQ,KAAA;EAKjB,KAAA,CAAA,GAAS,OAAA;EAIf,WAAA,CAAA;EAIM,aAAA,CAAA,GAAiB,OAAA;EAIvB,MAAA,CAAA,GAAU,OAAA;AAAA;;;cCwHD,aAAA,YAAyB,KAAA;EAAA,QAKtB,IAAA;EAAA,QACA,YAAA;EAAA,SALH,IAAA;EAAA,iBACQ,gBAAA;cAGL,IAAA,EAAM,IAAA,EACN,YAAA,EAAc,kBAAA;EAGpB,IAAA,CAAK,GAAA,UAAa,OAAA;IAAY,SAAA,GAAY,mBAAA;IAAqB,SAAA;EAAA,IAAuB,OAAA;EAO5F,GAAA,CAAA;EAIM,MAAA,CAAA,GAAU,OAAA;EAIhB,SAAA,CAAA,GAAa,MAAA;EAIP,qBAAA,UAAA,CACF,EAAA,GAAK,GAAA,EAAK,GAAA,KAAQ,GAAA,GAAM,OAAA,CAAQ,GAAA,GAChC,GAAA,EAAK,GAAA,GACN,OAAA;EAIG,QAAA,UAAA,CAAmB,EAAA,GAAK,GAAA,EAAK,GAAA,KAAQ,GAAA,GAAM,OAAA,CAAQ,GAAA,GAAM,GAAA,EAAK,GAAA,GAAM,OAAA,CAAQ,GAAA;EAS5E,cAAA,eAAA,CAA8B,MAAA,WAAiB,OAAA,CAAQ,GAAA;EAQvD,aAAA,CAAc,MAAA,WAAiB,OAAA,CAAQ,gBAAA;EAiBvC,WAAA,CAAY,QAAA;IAAY,KAAA;IAAe,MAAA;EAAA,IAAmB,OAAA;EAI1D,YAAA,CAAa,EAAA,WAAa,OAAA;EAI1B,sBAAA,CAAuB,OAAA,YAAmB,OAAA;EAK1C,eAAA,CAAgB,QAAA,UAAkB,OAAA;IAAY,SAAA;EAAA,IAAuB,OAAA,CAAQ,cAAA;EAY7E,eAAA,KAAA,CAAqB,MAAA,UAAgB,OAAA,GAAU,sBAAA,GAAyB,OAAA;EACxE,eAAA,KAAA,CAAqB,EAAA,GAAK,GAAA,EAAK,GAAA,cAAiB,GAAA,EAAK,GAAA,EAAK,OAAA,GAAU,sBAAA,GAAyB,OAAA;EAoC7F,CAAA,CAAE,QAAA,WAAmB,OAAA,CAAQ,cAAA;EAK7B,EAAA,CAAG,QAAA,WAAmB,OAAA,CAAQ,cAAA;EAK9B,KAAA,CAAM,QAAA,WAAmB,OAAA;EAIzB,IAAA,CAAK,QAAA,UAAkB,IAAA,UAAc,OAAA;IAAY,OAAA;EAAA,IAAqB,OAAA;EAItE,UAAA,CAAW,OAAA;IAAY,IAAA;IAAuB,QAAA;EAAA,IAAuB,OAAA,CAAQ,UAAA;EAK7E,cAAA,CAAe,IAAA,UAAc,EAAA,MAAQ,IAAA,kBAAsB,OAAA;EAIjE,EAAA,kBAAA,CAAqB,KAAA,EAAO,CAAA,EAAG,OAAA,OAAc,IAAA,mBAAuB,OAAA,UAAiB,gBAAA,QAAwB,gBAAA;EAiB7G,GAAA,kBAAA,CAAsB,KAAA,EAAO,CAAA,EAAG,OAAA,OAAc,IAAA,mBAAuB,OAAA,UAAiB,gBAAA;EAchF,KAAA,CAAA,GAAS,OAAA;EAIf,QAAA,CAAA;EAIA,GAAA,kBAAA,CAAsB,GAAA,EAAK,CAAA;EAI3B,OAAA,kBAAA,CAA0B,GAAA,EAAK,CAAA;EAUzB,GAAA,CAAA,GAAO,OAAA,CAAQ,UAAA;EAKf,sBAAA,CAAuB,MAAA,YAAkB,OAAA;EAKzC,GAAA,CAAI,OAAA;IAAY,IAAA;IAAe,MAAA;EAAA,IAAoB,OAAA,CAAQ,UAAA;EAM3D,YAAA,CAAa,OAAA;IAAY,IAAA;IAAe,WAAA;EAAA,IAA0B,OAAA;EAKlE,WAAA,CAAA,GAAe,OAAA,CAAQ,UAAA;EAM7B,MAAA,CAAA,GAAU,IAAA;EAAA,QAIF,aAAA;EAAA,QAgBA,qBAAA;EAAA,QAkBA,uBAAA;EAAA,QAcA,gBAAA;AAAA;;;cCjcC,sBAAA,YAAkC,cAAA;EAAA,QACvB,OAAA;cAAA,OAAA,EAAS,aAAA;EAEvB,KAAA,CAAA,GAAS,OAAA;EAIT,IAAA,CAAK,IAAA,WAAe,OAAA;EAIpB,YAAA,CAAa,IAAA,WAAe,OAAA;EAK5B,WAAA,CAAA,GAAe,OAAA;EAKf,OAAA,CAAA,GAAW,OAAA;EAIjB,MAAA,CAAA,GAAU,aAAA;AAAA"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@open-wa/driver-puppeteer",
+  "version": "5.0.0-alpha.0",
+  "description": "Puppeteer driver implementation for open-wa",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.cjs",
+      "types": "./dist/index.d.cts"
+    }
+  },
+  "dependencies": {
+    "puppeteer": "^24.40.0",
+    "puppeteer-extra": "^3.3.6",
+    "@open-wa/driver-interface": "5.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "typescript": "^6.0.3",
+    "vitest": "4.1.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/open-wa/wa-automate-nodejs.git"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format cjs",
+    "dev": "tsdown src/index.ts --format cjs --watch",
+    "lint": "oxlint src",
+    "test": "vitest run"
+  }
+}

package/src/PuppeteerBrowser.ts

@@ -0,0 +1,46 @@
+import { IBrowser, IPage, DriverCapabilities } from '@open-wa/driver-interface';
+import type { Browser } from 'puppeteer';
+import { PuppeteerPage } from './PuppeteerPage';
+
+export class PuppeteerBrowser implements IBrowser {
+    readonly name = 'puppeteer' as const;
+
+    constructor(
+        private browser: Browser,
+        private capabilities: DriverCapabilities
+    ) { }
+
+    async newPage(options?: {
+        clearFirstPage?: boolean
+    }): Promise<IPage> {
+        const page = await this.browser.newPage();
+        if (options?.clearFirstPage) {
+            const pages = await this.browser.pages();
+            if (pages.length > 0) {
+                await pages[0].close();
+            }
+        }
+        return new PuppeteerPage(page, this.capabilities);
+    }
+
+    async pages(): Promise<IPage[]> {
+        const pages = await this.browser.pages();
+        return pages.map(p => new PuppeteerPage(p, this.capabilities));
+    }
+
+    async close(): Promise<void> {
+        await this.browser.close();
+    }
+
+    isConnected(): boolean {
+        return this.browser.isConnected();
+    }
+
+    async versionString(): Promise<string> {
+        return await this.browser.version();
+    }
+
+    unwrap(): Browser {
+        return this.browser;
+    }
+}

package/src/PuppeteerDriver.ts

@@ -0,0 +1,91 @@
+import { IDriver, IBrowser, LaunchOptions, ConnectOptions, IDriverContext, DriverCapabilities } from '@open-wa/driver-interface';
+import { PuppeteerBrowser } from './PuppeteerBrowser';
+
+export class PuppeteerDriver implements IDriver {
+    readonly name = 'puppeteer' as const;
+    version?: string;
+    readonly capabilities: DriverCapabilities;
+    
+    private puppeteer: any;
+    private ctx?: IDriverContext;
+    
+    constructor() {
+        this.capabilities = {
+            cdp: { supported: true },
+            requestInterception: { supported: true },
+            serviceWorkerBypass: { supported: true },
+            stealth: { supported: true, notes: 'Via puppeteer-extra plugins' },
+            pdf: { supported: true },
+            tracing: { supported: true, notes: 'Basic tracing support' },
+            persistentContext: { supported: true },
+            browserExtensions: { supported: true },
+            exposeBinding: { supported: true },
+        };
+    }
+    
+    async init(ctx?: IDriverContext): Promise<void> {
+        this.ctx = ctx;
+        
+        const pExtra = await import('puppeteer-extra');
+        this.puppeteer = pExtra.default ?? pExtra;
+        
+        try {
+            const { createRequire } = await import('node:module');
+            const _require = createRequire(__filename);
+            const pkg = _require('puppeteer/package.json');
+            this.version = pkg.version;
+        } catch {}
+        
+        this.ctx?.logger?.info('PuppeteerDriver initialized', { version: this.version });
+    }
+    
+    async launch(options?: LaunchOptions): Promise<IBrowser> {
+        if (!this.puppeteer) await this.init();
+        
+        const browser = await this.puppeteer.launch({
+            headless: options?.headless ?? true,
+            executablePath: options?.executablePath,
+            args: options?.args || [],
+            defaultViewport: options?.defaultViewport,
+            userDataDir: options?.userDataDir,
+            timeout: options?.timeoutMs,
+        });
+        
+        try {
+            const browserVersion = await browser.version();
+            this.ctx?.logger?.info('Browser executable version', { version: browserVersion });
+        } catch {}
+
+        return new PuppeteerBrowser(browser, this.capabilities);
+    }
+    
+    async connect(options: ConnectOptions): Promise<IBrowser> {
+        if (!this.puppeteer) await this.init();
+        
+        const browser = await this.puppeteer.connect({
+            browserWSEndpoint: options.wsEndpoint,
+            timeout: options?.timeoutMs,
+        });
+        
+        return new PuppeteerBrowser(browser, this.capabilities);
+    }
+    
+    unwrap(): any {
+        return this.puppeteer;
+    }
+    
+    has<C extends string>(cap: C): boolean {
+        return (this.capabilities as any)[cap]?.supported === true;
+    }
+    
+    require<C extends string>(cap: C): void {
+        if (!this.has(cap)) {
+            const capability = (this.capabilities as any)[cap];
+            throw new Error(
+                `Driver '${this.name}' does not support capability '${cap}'${
+                    capability?.reason ? `: ${capability.reason}` : ''
+                }`
+            );
+        }
+    }
+}

package/src/PuppeteerElementHandle.ts

@@ -0,0 +1,32 @@
+import { IElementHandle } from '@open-wa/driver-interface';
+import type { ElementHandle } from 'puppeteer';
+
+export class PuppeteerElementHandle implements IElementHandle {
+    constructor(private element: ElementHandle) {}
+    
+    async click(): Promise<void> {
+        await this.element.click();
+    }
+    
+    async type(text: string): Promise<void> {
+        await this.element.type(text);
+    }
+    
+    async getAttribute(name: string): Promise<string | null> {
+        const value = await this.element.evaluate((el, attr) => el.getAttribute(attr), name);
+        return value;
+    }
+    
+    async textContent(): Promise<string | null> {
+        const text = await this.element.evaluate(el => el.textContent);
+        return text;
+    }
+    
+    async dispose(): Promise<void> {
+        await this.element.dispose();
+    }
+    
+    unwrap(): ElementHandle {
+        return this.element;
+    }
+}