@letsscrapedata/controller 0.0.6 → 0.0.8

package/dist/index.cjs

@@ -233,9 +233,15 @@ var PlaywrightElement = class _PlaywrightElement {
     return text3 ? text3 : "";
   }
   async click(options = {}) {
-    const { button, clickCount: count, delay, position: offset } = options;
+    const { button, clickCount: count, delay, position: offset, clickType = "click" } = options;
     const actOptions = { button, count, delay, offset };
-    await this.#locator.click(actOptions);
+    if (clickType === "click") {
+      await this.#locator.click(actOptions);
+    } else if (clickType === "evaluate") {
+      await this.#locator.evaluate(async (ev) => await ev.click());
+    } else {
+      (0, import_utils.unreachable)(clickType);
+    }
     return true;
   }
   async focus() {
@@ -321,6 +327,7 @@ var PlaywrightPage = class extends import_node_events.default {
   #pageId;
   #resquestInterceptionOptions;
   #responseInterceptionOptions;
+  #client;
   #hasValidUrl(page) {
     const url = page.url();
     return url.toLowerCase().startsWith("http");
@@ -532,6 +539,7 @@ var PlaywrightPage = class extends import_node_events.default {
     this.#pageId = `page${browserIdx}-${browserContextIdx}-${pageIdx}`;
     this.#resquestInterceptionOptions = [];
     this.#responseInterceptionOptions = [];
+    this.#client = null;
     this.#addPageOn();
   }
   async bringToFront() {
@@ -787,6 +795,24 @@ var PlaywrightPage = class extends import_node_events.default {
     );
     return true;
   }
+  async sendCDPMessage(method, params = null, detach = true) {
+    if (!this.#client) {
+      const origContext = this.browserContext()._origBrowserContext();
+      if (!origContext) {
+        throw new Error(`Invalid playwright browserContext`);
+      }
+      this.#client = origContext.newCDPSession(this.#page);
+    }
+    if (!this.#client) {
+      throw new Error("No valid CDP session to send message");
+    }
+    const response = params ? await this.#client.send(method, params) : await this.#client.send(method);
+    if (detach) {
+      await this.#client.detach();
+      this.#client = null;
+    }
+    return response;
+  }
   async setCookies(cookies) {
     if (!this.#page) {
       throw new Error("No valid page");
@@ -1650,9 +1676,16 @@ var PuppeteerElement = class _PuppeteerElement {
     return text3 ? text3 : "";
   }
   async click(options = {}) {
-    const { button, clickCount: count, delay, position: offset } = options;
+    const { button, clickCount: count, delay, position: offset, clickType = "click" } = options;
     const actOptions = { button, count, delay, offset };
-    await this.#$ele.click(actOptions);
+    if (clickType === "click") {
+      await this.#$ele.click(actOptions);
+    } else if (clickType === "evaluate") {
+      await this.#frame.evaluate(async (ev) => await ev.click(), this.#$ele);
+      await this.#$ele.click(actOptions);
+    } else {
+      (0, import_utils5.unreachable)(clickType);
+    }
     return true;
   }
   async focus() {
@@ -1756,6 +1789,7 @@ var PuppeteerPage = class extends import_node_events4.default {
   #pageId;
   #requestInterceptionNum;
   #responseInterceptionNum;
+  #client;
   #hasValidUrl(page) {
     const url = page.url();
     return url.toLowerCase().startsWith("http");
@@ -1952,6 +1986,7 @@ var PuppeteerPage = class extends import_node_events4.default {
     this.#pageId = `page${browserIdx}-${browserContextIdx}-${pageIdx}`;
     this.#requestInterceptionNum = 0;
     this.#responseInterceptionNum = 0;
+    this.#client = null;
     this.#addPageOn();
   }
   async bringToFront() {
@@ -2210,6 +2245,23 @@ var PuppeteerPage = class extends import_node_events4.default {
     );
     return true;
   }
+  async sendCDPMessage(method, params = null, detach = true) {
+    if (!this.#page) {
+      throw new Error("No valid page");
+    }
+    if (!this.#client) {
+      this.#client = await this.#page.createCDPSession();
+    }
+    if (!this.#client) {
+      throw new Error("No valid CDP session to send message");
+    }
+    const response = params ? await this.#client.send(method, params) : await this.#client.send(method);
+    if (detach) {
+      await this.#client.detach();
+      this.#client = null;
+    }
+    return response;
+  }
   async setCookies(cookies) {
     if (!this.#page) {
       throw new Error("No valid page");
@@ -16999,6 +17051,9 @@ var CheerioPage = class extends import_node_events7.default {
   async scrollTo() {
     throw new Error("Not supported in CheerioElement.");
   }
+  async sendCDPMessage() {
+    throw new Error("Method not implemented.");
+  }
   async setCookies() {
     throw new Error("Not supported in CheerioPage.");
   }

package/dist/index.d.cts

@@ -222,6 +222,7 @@ interface PageExtInPuppeteer extends Page$1 {
 interface PageExtInPlaywright extends Page {
     pageInfo?: PageInfo;
 }
+type MouseClickType = "click" | "evaluate";
 interface MouseClickOptions {
     /**
      * Which button will be pressed.
@@ -252,6 +253,10 @@ interface MouseClickOptions {
      * * puppeteer: not supported, ignored
      */
     modifiers?: Array<"Alt" | "Control" | "Meta" | "Shift">;
+    /**
+     * @default click
+     */
+    clickType?: MouseClickType;
 }
 interface SelectOptions {
     /**
@@ -801,6 +806,14 @@ interface LsdPage extends EventEmitter {
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
+    /**
+     *
+     * Send a CDP message over the current(not detached) or new CDP session
+     * @param method protocol method name
+     * @param params default null(ignored), method parameters
+     * @param detach default true, whether to detach the CDPSession from target
+     */
+    sendCDPMessage(method: string, params?: object | null, detach?: boolean): Promise<object>;
     setCookies(cookies: CookieItem[]): Promise<boolean>;
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
     /**
@@ -992,6 +1005,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
+    sendCDPMessage(method: string, params?: object | null, detach?: boolean): Promise<object>;
     setCookies(cookies: CookieItem[]): Promise<boolean>;
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
     setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
@@ -1099,6 +1113,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
+    sendCDPMessage(method: string, params?: object | null, detach?: boolean): Promise<object>;
     setCookies(cookies: CookieItem[]): Promise<boolean>;
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
     setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
@@ -1170,6 +1185,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
     screenshot(): Promise<Buffer>;
     scrollBy(): Promise<boolean>;
     scrollTo(): Promise<boolean>;
+    sendCDPMessage(): Promise<object>;
     setCookies(): Promise<boolean>;
     setExtraHTTPHeaders(): Promise<boolean>;
     setLocalStroage(): Promise<boolean>;
@@ -1211,4 +1227,4 @@ declare class CheerioElement implements LsdElement {
     scrollIntoView(): Promise<boolean>;
 }
 
-export { type AllBrowser, type AllBrowserContext, type AllFrame, type AllPage, type AllResponse, type BrowserControllerOptions, type BrowserControllerType, type BrowserCreationMethod, type BrowserManager, CheerioElement, type CheerioNode, CheerioPage, type CookieItem, type GotoOptions, type IframeOption, type InputOptions, type KeyInput, type KeyPressOptions, type LocalStorageItem, type LocalStorageOrigin, type LowerCasePaperFormat, type LsdBrowser, type LsdBrowserContext, type LsdBrowserContextOptions, type LsdBrowserController, type LsdBrowserType, type LsdConnectOptions, type LsdElement, type LsdLaunchOptions, type LsdPage, type MouseClickOptions, type NavigationWaitUntil, type PDFMargin, type PDFOptions, type PageEvent, type PageExtInPlaywright, type PageExtInPuppeteer, type PageInfo, type PageOpenType, type PageStatus, type PaperFormat, PlaywrightBrowser, PlaywrightBrowserContext, PlaywrightElement, PlaywrightPage, type Proxy, PuppeteerBrowser, PuppeteerBrowserContext, PuppeteerElement, PuppeteerPage, type RequestInterceptionAction, type RequestInterceptionOption, type RequestMatch, type RequestMethod, type RequestResourceType, type ResponseHandler, type ResponseHandlerOptions, type ResponseInterceptionItem, type ResponseInterceptionOption, type ResponseMatch, type ScreenshotOptions, type SelectOptions, type StateData, type UpdatablePageInfo, type ViewportSize, type WaitElementOptions, type WaitElementState, type WaitNavigationOptions, defaultProxy };
+export { type AllBrowser, type AllBrowserContext, type AllFrame, type AllPage, type AllResponse, type BrowserControllerOptions, type BrowserControllerType, type BrowserCreationMethod, type BrowserManager, CheerioElement, type CheerioNode, CheerioPage, type CookieItem, type GotoOptions, type IframeOption, type InputOptions, type KeyInput, type KeyPressOptions, type LocalStorageItem, type LocalStorageOrigin, type LowerCasePaperFormat, type LsdBrowser, type LsdBrowserContext, type LsdBrowserContextOptions, type LsdBrowserController, type LsdBrowserType, type LsdConnectOptions, type LsdElement, type LsdLaunchOptions, type LsdPage, type MouseClickOptions, type MouseClickType, type NavigationWaitUntil, type PDFMargin, type PDFOptions, type PageEvent, type PageExtInPlaywright, type PageExtInPuppeteer, type PageInfo, type PageOpenType, type PageStatus, type PaperFormat, PlaywrightBrowser, PlaywrightBrowserContext, PlaywrightElement, PlaywrightPage, type Proxy, PuppeteerBrowser, PuppeteerBrowserContext, PuppeteerElement, PuppeteerPage, type RequestInterceptionAction, type RequestInterceptionOption, type RequestMatch, type RequestMethod, type RequestResourceType, type ResponseHandler, type ResponseHandlerOptions, type ResponseInterceptionItem, type ResponseInterceptionOption, type ResponseMatch, type ScreenshotOptions, type SelectOptions, type StateData, type UpdatablePageInfo, type ViewportSize, type WaitElementOptions, type WaitElementState, type WaitNavigationOptions, defaultProxy };

package/dist/index.d.ts

@@ -222,6 +222,7 @@ interface PageExtInPuppeteer extends Page$1 {
 interface PageExtInPlaywright extends Page {
     pageInfo?: PageInfo;
 }
+type MouseClickType = "click" | "evaluate";
 interface MouseClickOptions {
     /**
      * Which button will be pressed.
@@ -252,6 +253,10 @@ interface MouseClickOptions {
      * * puppeteer: not supported, ignored
      */
     modifiers?: Array<"Alt" | "Control" | "Meta" | "Shift">;
+    /**
+     * @default click
+     */
+    clickType?: MouseClickType;
 }
 interface SelectOptions {
     /**
@@ -801,6 +806,14 @@ interface LsdPage extends EventEmitter {
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
+    /**
+     *
+     * Send a CDP message over the current(not detached) or new CDP session
+     * @param method protocol method name
+     * @param params default null(ignored), method parameters
+     * @param detach default true, whether to detach the CDPSession from target
+     */
+    sendCDPMessage(method: string, params?: object | null, detach?: boolean): Promise<object>;
     setCookies(cookies: CookieItem[]): Promise<boolean>;
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
     /**
@@ -992,6 +1005,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
+    sendCDPMessage(method: string, params?: object | null, detach?: boolean): Promise<object>;
     setCookies(cookies: CookieItem[]): Promise<boolean>;
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
     setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
@@ -1099,6 +1113,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
+    sendCDPMessage(method: string, params?: object | null, detach?: boolean): Promise<object>;
     setCookies(cookies: CookieItem[]): Promise<boolean>;
     setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
     setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
@@ -1170,6 +1185,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
     screenshot(): Promise<Buffer>;
     scrollBy(): Promise<boolean>;
     scrollTo(): Promise<boolean>;
+    sendCDPMessage(): Promise<object>;
     setCookies(): Promise<boolean>;
     setExtraHTTPHeaders(): Promise<boolean>;
     setLocalStroage(): Promise<boolean>;
@@ -1211,4 +1227,4 @@ declare class CheerioElement implements LsdElement {
     scrollIntoView(): Promise<boolean>;
 }
 
-export { type AllBrowser, type AllBrowserContext, type AllFrame, type AllPage, type AllResponse, type BrowserControllerOptions, type BrowserControllerType, type BrowserCreationMethod, type BrowserManager, CheerioElement, type CheerioNode, CheerioPage, type CookieItem, type GotoOptions, type IframeOption, type InputOptions, type KeyInput, type KeyPressOptions, type LocalStorageItem, type LocalStorageOrigin, type LowerCasePaperFormat, type LsdBrowser, type LsdBrowserContext, type LsdBrowserContextOptions, type LsdBrowserController, type LsdBrowserType, type LsdConnectOptions, type LsdElement, type LsdLaunchOptions, type LsdPage, type MouseClickOptions, type NavigationWaitUntil, type PDFMargin, type PDFOptions, type PageEvent, type PageExtInPlaywright, type PageExtInPuppeteer, type PageInfo, type PageOpenType, type PageStatus, type PaperFormat, PlaywrightBrowser, PlaywrightBrowserContext, PlaywrightElement, PlaywrightPage, type Proxy, PuppeteerBrowser, PuppeteerBrowserContext, PuppeteerElement, PuppeteerPage, type RequestInterceptionAction, type RequestInterceptionOption, type RequestMatch, type RequestMethod, type RequestResourceType, type ResponseHandler, type ResponseHandlerOptions, type ResponseInterceptionItem, type ResponseInterceptionOption, type ResponseMatch, type ScreenshotOptions, type SelectOptions, type StateData, type UpdatablePageInfo, type ViewportSize, type WaitElementOptions, type WaitElementState, type WaitNavigationOptions, defaultProxy };
+export { type AllBrowser, type AllBrowserContext, type AllFrame, type AllPage, type AllResponse, type BrowserControllerOptions, type BrowserControllerType, type BrowserCreationMethod, type BrowserManager, CheerioElement, type CheerioNode, CheerioPage, type CookieItem, type GotoOptions, type IframeOption, type InputOptions, type KeyInput, type KeyPressOptions, type LocalStorageItem, type LocalStorageOrigin, type LowerCasePaperFormat, type LsdBrowser, type LsdBrowserContext, type LsdBrowserContextOptions, type LsdBrowserController, type LsdBrowserType, type LsdConnectOptions, type LsdElement, type LsdLaunchOptions, type LsdPage, type MouseClickOptions, type MouseClickType, type NavigationWaitUntil, type PDFMargin, type PDFOptions, type PageEvent, type PageExtInPlaywright, type PageExtInPuppeteer, type PageInfo, type PageOpenType, type PageStatus, type PaperFormat, PlaywrightBrowser, PlaywrightBrowserContext, PlaywrightElement, PlaywrightPage, type Proxy, PuppeteerBrowser, PuppeteerBrowserContext, PuppeteerElement, PuppeteerPage, type RequestInterceptionAction, type RequestInterceptionOption, type RequestMatch, type RequestMethod, type RequestResourceType, type ResponseHandler, type ResponseHandlerOptions, type ResponseInterceptionItem, type ResponseInterceptionOption, type ResponseMatch, type ScreenshotOptions, type SelectOptions, type StateData, type UpdatablePageInfo, type ViewportSize, type WaitElementOptions, type WaitElementState, type WaitNavigationOptions, defaultProxy };

package/dist/index.js

@@ -214,9 +214,15 @@ var PlaywrightElement = class _PlaywrightElement {
     return text3 ? text3 : "";
   }
   async click(options = {}) {
-    const { button, clickCount: count, delay, position: offset } = options;
+    const { button, clickCount: count, delay, position: offset, clickType = "click" } = options;
     const actOptions = { button, count, delay, offset };
-    await this.#locator.click(actOptions);
+    if (clickType === "click") {
+      await this.#locator.click(actOptions);
+    } else if (clickType === "evaluate") {
+      await this.#locator.evaluate(async (ev) => await ev.click());
+    } else {
+      unreachable(clickType);
+    }
     return true;
   }
   async focus() {
@@ -302,6 +308,7 @@ var PlaywrightPage = class extends EventEmitter {
   #pageId;
   #resquestInterceptionOptions;
   #responseInterceptionOptions;
+  #client;
   #hasValidUrl(page) {
     const url = page.url();
     return url.toLowerCase().startsWith("http");
@@ -513,6 +520,7 @@ var PlaywrightPage = class extends EventEmitter {
     this.#pageId = `page${browserIdx}-${browserContextIdx}-${pageIdx}`;
     this.#resquestInterceptionOptions = [];
     this.#responseInterceptionOptions = [];
+    this.#client = null;
     this.#addPageOn();
   }
   async bringToFront() {
@@ -768,6 +776,24 @@ var PlaywrightPage = class extends EventEmitter {
     );
     return true;
   }
+  async sendCDPMessage(method, params = null, detach = true) {
+    if (!this.#client) {
+      const origContext = this.browserContext()._origBrowserContext();
+      if (!origContext) {
+        throw new Error(`Invalid playwright browserContext`);
+      }
+      this.#client = origContext.newCDPSession(this.#page);
+    }
+    if (!this.#client) {
+      throw new Error("No valid CDP session to send message");
+    }
+    const response = params ? await this.#client.send(method, params) : await this.#client.send(method);
+    if (detach) {
+      await this.#client.detach();
+      this.#client = null;
+    }
+    return response;
+  }
   async setCookies(cookies) {
     if (!this.#page) {
       throw new Error("No valid page");
@@ -1631,9 +1657,16 @@ var PuppeteerElement = class _PuppeteerElement {
     return text3 ? text3 : "";
   }
   async click(options = {}) {
-    const { button, clickCount: count, delay, position: offset } = options;
+    const { button, clickCount: count, delay, position: offset, clickType = "click" } = options;
     const actOptions = { button, count, delay, offset };
-    await this.#$ele.click(actOptions);
+    if (clickType === "click") {
+      await this.#$ele.click(actOptions);
+    } else if (clickType === "evaluate") {
+      await this.#frame.evaluate(async (ev) => await ev.click(), this.#$ele);
+      await this.#$ele.click(actOptions);
+    } else {
+      unreachable3(clickType);
+    }
     return true;
   }
   async focus() {
@@ -1737,6 +1770,7 @@ var PuppeteerPage = class extends EventEmitter4 {
   #pageId;
   #requestInterceptionNum;
   #responseInterceptionNum;
+  #client;
   #hasValidUrl(page) {
     const url = page.url();
     return url.toLowerCase().startsWith("http");
@@ -1933,6 +1967,7 @@ var PuppeteerPage = class extends EventEmitter4 {
     this.#pageId = `page${browserIdx}-${browserContextIdx}-${pageIdx}`;
     this.#requestInterceptionNum = 0;
     this.#responseInterceptionNum = 0;
+    this.#client = null;
     this.#addPageOn();
   }
   async bringToFront() {
@@ -2191,6 +2226,23 @@ var PuppeteerPage = class extends EventEmitter4 {
     );
     return true;
   }
+  async sendCDPMessage(method, params = null, detach = true) {
+    if (!this.#page) {
+      throw new Error("No valid page");
+    }
+    if (!this.#client) {
+      this.#client = await this.#page.createCDPSession();
+    }
+    if (!this.#client) {
+      throw new Error("No valid CDP session to send message");
+    }
+    const response = params ? await this.#client.send(method, params) : await this.#client.send(method);
+    if (detach) {
+      await this.#client.detach();
+      this.#client = null;
+    }
+    return response;
+  }
   async setCookies(cookies) {
     if (!this.#page) {
       throw new Error("No valid page");
@@ -16980,6 +17032,9 @@ var CheerioPage = class extends EventEmitter7 {
   async scrollTo() {
     throw new Error("Not supported in CheerioElement.");
   }
+  async sendCDPMessage() {
+    throw new Error("Method not implemented.");
+  }
   async setCookies() {
     throw new Error("Not supported in CheerioPage.");
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@letsscrapedata/controller",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Unified browser / HTML controller interfaces that support playwright, puppeteer and cheerio",
   "type": "module",
   "main": "./dist/index.mjs",