@letsscrapedata/controller 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,1133 @@
+import EventEmitter from 'node:events';
+import { Browser as Browser$1, BrowserContext as BrowserContext$1, Frame as Frame$1, Page as Page$1, HTTPResponse, ElementHandle } from 'puppeteer';
+import { Browser, BrowserContext, Frame, Page, Response, Locator } from 'playwright';
+import * as cheerio from 'cheerio';
+
+/**
+ * 命名规则：为了与playwright/puppeteer中的同名区别
+ * 1. 类型type的名称：AllXxxYyy，如AllBrowserContext
+ * 2. 接口interface的名称: InterfaceXxxYyy，如InterfaceBrowserContext
+ * 3. 接口的实现类class的名称: LsdXxxYyy，如LsdBrowserContext
+ */
+
+type AllBrowser = Browser | Browser$1;
+type AllBrowserContext = BrowserContext | BrowserContext$1;
+type AllFrame = Frame | Frame$1;
+type AllPage = Page | Page$1;
+type AllResponse = Response | HTTPResponse;
+type CheerioNode = cheerio.Cheerio<cheerio.Element>;
+type Proxy = {
+    server: string;
+    username?: string;
+    password?: string;
+    proxyId?: string;
+    host?: string;
+    port?: number;
+    expireTime?: number;
+    proxyIpType?: string;
+    proxyDurationType?: string;
+    proxySharedType?: string;
+    latitude?: number;
+    longitude?: number;
+    freeable?: boolean;
+    interfaceName?: string;
+    packageName?: string;
+};
+type BrowserControllerType = "puppeteer" | "playwright";
+type BrowserCreationMethod = "launch" | "connect";
+type LsdBrowserType = "chromium" | "firefox" | "webkit";
+type BrowserControllerOptions = {
+    browserControllerType: BrowserControllerType;
+};
+declare const defaultProxy: Proxy;
+interface BrowserOptions {
+    /**
+     * Interval between closing free pages (seconds) if more than 0
+     * @default 300
+     */
+    closeFreePagesIntervalSeconds?: number;
+    /**
+     * max browserContexts per browser
+     * @default 10
+     */
+    maxBrowserContextsPerBrowser?: number;
+    /**
+     * max pages per browserContext
+     * @default 20
+     */
+    maxPagesPerBrowserContext?: number;
+    /**
+     * pages, that are free more than this, will be closed
+     * @default 900
+     */
+    maxPageFreeSeconds?: number;
+    /**
+     * The proxy actually used by the connected browser; for efficient web scraping, please pass an accurate value
+     * * this will used as default proxy when creating new browserContexts later
+     * @default null
+     */
+    proxy?: Proxy | null;
+    /**
+     * Maximum time in milliseconds to wait for the browser instance to start. Pass 0 to disable timeout.
+     * * default 30_000 (30 seconds)
+     */
+    timeout?: number;
+}
+interface LsdLaunchOptions extends BrowserOptions {
+    args?: string[];
+    executablePath?: string;
+    /**
+     * @default true
+     */
+    headless?: boolean;
+    /** * @default false for puppeteer, true for playwright
+     */
+    incognito?: boolean;
+    /**
+     * workaround for chromium issue on windows: https://github.com/microsoft/playwright/issues/17252 (same in puppeteer)
+     * @default false
+     */
+    proxyPerBrowserContext?: boolean;
+    /**
+     * userAgent of the new browserContext that is created during launching the browser, valid only in puppeteer:
+     * * playwright does not create a browserContext during launching browser
+     * * puppeteer creates a default/new browserContext during launching browser
+     */
+    userAgent?: string;
+    userDataDir?: string;
+}
+interface LsdConnectOptions extends BrowserOptions {
+    /**
+     * url that starts with "http://", such as "http://localhost:9222/"
+     */
+    browserUrl: string;
+    /**
+     * executable path of connected browser, optional
+     * @default "" that means unkown
+     */
+    executablePath?: string;
+    /**
+     * whether the connected browser is headless
+     * @default false
+     */
+    headless?: boolean;
+    /**
+     * whether the connected browser is headless
+     * @default false
+     */
+    incognito?: boolean;
+    /**
+     * userAgent of the current browserContexts that were created before connecting to the browser, valid only in puppeteer:
+     * * playwright: does not support page.setUserAgent
+     * * puppeteer: supports page.setUserAgent
+     */
+    userAgent?: string;
+}
+type LsdBrowserContextOptions = {
+    proxy: Proxy | null;
+    /**
+     * userAgent of the browserContext:
+     * * playwright: set when creating the new browserContext
+     * * puppeteer: set when creating the new page in the browserContext
+     */
+    userAgent?: string;
+    fingerPrint: Object;
+};
+type PageStatus = "free" | "busy" | "closed";
+/**
+ * newpage: open by browserContext.newPage()
+ * popup: open by clicking etc, 主要关注此类
+ * manual: open by manual operation
+ * launch: open by puppeteer.launch
+ * connect: opened pages before connecting to browser
+ * other: unkown
+ */
+/**
+ * * launch: open when creating browserContext(includes launching browser)
+ * * connect: open before connected
+ * * newpage: open by browserContext.newPage()
+ * * popup: popup page
+ * * manual: open by adding new page manually
+ * * other:
+ */
+type PageOpenType = "newpage" | "popup" | "manual" | "launch" | "connect" | "other";
+type PageInfo = {
+    /**
+     * browser index in all browsers, that starts from 1
+     * @default 0
+     */
+    browserIdx: number;
+    /**
+     * browserContext index in the same browser, that starts from 1
+     * @default 0
+     */
+    browserContextIdx: number;
+    /**
+     * page index in the same browserContext, that starts from 1
+     * @default 0
+     */
+    pageIdx: number;
+    /**
+     * how the page is opened
+     * @default other
+     */
+    openType: PageOpenType;
+    /**
+     * page添加时间：针对非connect场景，也是page打开时间
+     * @default current unix time
+     */
+    openTime: number;
+    /**
+     * 上次status变化时间：如果status为free，表示空闲开始时间；如果status为busy，表示TE开始数据
+     * @default current unix time
+     */
+    lastStatusUpdateTime: number;
+    /**
+     * 正在执行的task的ID，参见enumSpecialTaskId
+     * @default 0
+     */
+    taskId: number;
+};
+interface PageExtInPuppeteer extends Page$1 {
+    pageInfo?: PageInfo;
+}
+interface PageExtInPlaywright extends Page {
+    pageInfo?: PageInfo;
+}
+interface MouseClickOptions {
+    /**
+     * Which button will be pressed.
+     * @default left
+     */
+    button?: "left" | "right" | "middle";
+    /**
+     * Number of clicks to perform.
+     * * puppeteer: count (clickCount deprecated)
+     * @default 1
+     */
+    clickCount?: 1 | 2 | 3;
+    /**
+     * Time to wait between mousedown and mouseup in milliseconds.
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
+     * * puppeteer: offset
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * @default []
+     * * puppeteer: not supported, ignored
+     */
+    modifiers?: Array<"Alt" | "Control" | "Meta" | "Shift">;
+}
+interface SelectOptions {
+    /**
+     * Which attribute of select option to match
+     */
+    type: "value" | "label" | "index";
+    /**
+     * Matches by option.value
+     */
+    values?: string[];
+    /**
+     * Matches by the index, that starts from 0
+     */
+    indexes?: number[];
+    /**
+     * Matches by option.label
+     */
+    labels?: string[];
+}
+interface GotoOptions {
+    referer?: string;
+    timeout?: number;
+    /**
+     * playwright: "load" | "domcontentloaded" | "networkidle" | "commit", "networkidle0" | "networkidle2" => "networkidle";
+     * puppeteer: "load" | "domcontentloaded" | "networkidle0" | "networkidle2", "networkidle" => "networkidle0", "commit" ignored;
+     */
+    waitUntil?: "load" | "domcontentloaded" | "networkidle" | "commit" | "networkidle0" | "networkidle2";
+}
+/**
+ * * src takes precedence over selector, at least one of them must be defined
+ * * it is recommended to use srcPrefix because selector is valid only in puppeteer
+ */
+interface IframeOption {
+    /**
+     * * string: iframe.src starts with this string
+     * * RegExp: iframe.src matches this RegExp
+     */
+    src?: string | RegExp;
+    /**
+     * CSS selector or XPath
+     */
+    selector?: string;
+}
+type KeyInput = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'Power' | 'Eject' | 'Abort' | 'Help' | 'Backspace' | 'Tab' | 'Numpad5' | 'NumpadEnter' | 'Enter' | '\r' | '\n' | 'ShiftLeft' | 'ShiftRight' | 'ControlLeft' | 'ControlRight' | 'AltLeft' | 'AltRight' | 'Pause' | 'CapsLock' | 'Escape' | 'Convert' | 'NonConvert' | 'Space' | 'Numpad9' | 'PageUp' | 'Numpad3' | 'PageDown' | 'End' | 'Numpad1' | 'Home' | 'Numpad7' | 'ArrowLeft' | 'Numpad4' | 'Numpad8' | 'ArrowUp' | 'ArrowRight' | 'Numpad6' | 'Numpad2' | 'ArrowDown' | 'Select' | 'Open' | 'PrintScreen' | 'Insert' | 'Numpad0' | 'Delete' | 'NumpadDecimal' | 'Digit0' | 'Digit1' | 'Digit2' | 'Digit3' | 'Digit4' | 'Digit5' | 'Digit6' | 'Digit7' | 'Digit8' | 'Digit9' | 'KeyA' | 'KeyB' | 'KeyC' | 'KeyD' | 'KeyE' | 'KeyF' | 'KeyG' | 'KeyH' | 'KeyI' | 'KeyJ' | 'KeyK' | 'KeyL' | 'KeyM' | 'KeyN' | 'KeyO' | 'KeyP' | 'KeyQ' | 'KeyR' | 'KeyS' | 'KeyT' | 'KeyU' | 'KeyV' | 'KeyW' | 'KeyX' | 'KeyY' | 'KeyZ' | 'MetaLeft' | 'MetaRight' | 'ContextMenu' | 'NumpadMultiply' | 'NumpadAdd' | 'NumpadSubtract' | 'NumpadDivide' | 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12' | 'F13' | 'F14' | 'F15' | 'F16' | 'F17' | 'F18' | 'F19' | 'F20' | 'F21' | 'F22' | 'F23' | 'F24' | 'NumLock' | 'ScrollLock' | 'AudioVolumeMute' | 'AudioVolumeDown' | 'AudioVolumeUp' | 'MediaTrackNext' | 'MediaTrackPrevious' | 'MediaStop' | 'MediaPlayPause' | 'Semicolon' | 'Equal' | 'NumpadEqual' | 'Comma' | 'Minus' | 'Period' | 'Slash' | 'Backquote' | 'BracketLeft' | 'Backslash' | 'BracketRight' | 'Quote' | 'AltGraph' | 'Props' | 'Cancel' | 'Clear' | 'Shift' | 'Control' | 'Alt' | 'Accept' | 'ModeChange' | ' ' | 'Print' | 'Execute' | '\u0000' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'Meta' | '*' | '+' | '-' | '/' | ';' | '=' | ',' | '.' | '`' | '[' | '\\' | ']' | "'" | 'Attn' | 'CrSel' | 'ExSel' | 'EraseEof' | 'Play' | 'ZoomOut' | ')' | '!' | '@' | '#' | '$' | '%' | '^' | '&' | '(' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | ':' | '<' | '_' | '>' | '?' | '~' | '{' | '|' | '}' | '"' | 'SoftLeft' | 'SoftRight' | 'Camera' | 'Call' | 'EndCall' | 'VolumeDown' | 'VolumeUp';
+interface KeyPressOptions {
+    /**
+     * Time to wait between keydown and keyup in milliseconds. Defaults to 0.
+     */
+    delay?: number;
+}
+interface InputOptions {
+    /**
+     * Time to wait between mousedown and mouseup in milliseconds.
+     * * playwright: not supported, ignored
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * whether to replace the current value
+     * @default false
+     */
+    replace?: boolean;
+    /**
+     * whether to press Enter after input the value
+     * @default false
+     */
+    enter?: boolean;
+}
+interface LsdElement {
+    /**
+     *
+     * @return the value of a specified attribute on the element
+     * @param attributeName
+     */
+    attribute(attributeName: string): Promise<string>;
+    /**
+     * @returns the attribute names of the element
+     */
+    attributeNames(): Promise<string[]>;
+    /**
+     * @returns the first element matching the given CSS selector or XPath
+     * @param selectorOrXpath CSS selector or XPath; if this parameter is an array, each selectorOrXpath in the array will be tried until elements are selected
+     * @param iframeOptions default [], options to select decendant frame
+     * @param absolute valid only if iframeOptions.length===0
+     */
+    findElement(selectorOrXpath: string | string[], iframeOptions?: IframeOption[], absolute?: boolean): Promise<LsdElement | null>;
+    /**
+     * @returns elements matching the given CSS selector or XPath
+     * @param selectorOrXpath CSS selector or XPath; if this parameter is an array, each selectorOrXpath in the array will be tried until elements are selected
+     * @param iframeOptions default [], options to select decendant frame
+     * @param absolute valid only if iframeOptions.length===0
+     */
+    findElements(selectorOrXpath: string | string[], iframeOptions?: IframeOption[], absolute?: boolean): Promise<LsdElement[]>;
+    /**
+     * @returns whether the element has the specified attribute or not
+     * @param attributeName
+     */
+    hasAttribute(attributeName: string): Promise<boolean>;
+    /**
+     * @returns the HTML or XML markup contained within the element
+     */
+    innerHtml(): Promise<string>;
+    /**
+     * @returns innerText of element
+     * @param onlyChild default false, whether to include only the text of the child text nodes
+     */
+    innerText(onlyChild?: boolean): Promise<string>;
+    /**
+     * @returns the serialized HTML fragment describing the element including its descendants
+     */
+    outerHtml(): Promise<string>;
+    textContent(): Promise<string>;
+    /**
+     * Click this element.
+     * @param options default {button: "left", count: 1, delay: 0, modifies: []}
+     */
+    click(options?: MouseClickOptions): Promise<boolean>;
+    focus(): Promise<boolean>;
+    hover(): Promise<boolean>;
+    /**
+     * * playwright: fill
+     * * puppeteer: type
+     */
+    input(value: string, options?: InputOptions): Promise<boolean>;
+    press(key: KeyInput, options: KeyPressOptions): Promise<boolean>;
+    select(options: SelectOptions): Promise<boolean>;
+    screenshot(options?: ScreenshotOptions): Promise<Buffer>;
+    scrollBy(x: number, y: number): Promise<boolean>;
+    scrollIntoView(): Promise<boolean>;
+    scrollTo(x: number, y: number): Promise<boolean>;
+}
+interface ViewportSize {
+    height: number;
+    width: number;
+}
+interface CookieItem {
+    name: string;
+    value: string;
+    domain: string;
+    path: string;
+    expires: number;
+    httpOnly: boolean;
+    secure: boolean;
+    sameSite: 'Strict' | 'Lax' | 'None';
+}
+interface LocalStorageItem {
+    name: string;
+    value: string;
+}
+interface LocalStorageOrigin {
+    origin: string;
+    localStorage: LocalStorageItem[];
+}
+interface StateData {
+    cookies: CookieItem[];
+    localStorage: LocalStorageOrigin[];
+}
+/**
+ * copy from playwright
+export type URLMatch = string | RegExp | ((url: URL) => boolean);
+export type RouteHandlerCallback = (route: RouteInPlaywright, request: RequestInPlayWright) => Promise<any> | void;
+
+export type RequestHandlerCallback = (request: RequestInPlayWright) => Promise<any> | void;
+ */
+type RequestResourceType = "document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "eventsource" | "websocket" | "manifest" | "other";
+type RequestMethod = "DELETE" | "GET" | "POST" | "PUT" | "CONNECT" | "HEAD" | "OPTIONS" | "PATCH" | "TRACE";
+interface RequestMatch {
+    methods?: RequestMethod[];
+    postData?: RegExp;
+    resourceTypes?: RequestResourceType[];
+    url?: RegExp;
+}
+type RequestInterceptionAction = "abort" | "fulfill";
+interface RequestInterceptionOption {
+    /**
+     * Requests that match all conditions will be intercepted; all requests will be intercepted if no condition.
+     */
+    requestMatch?: RequestMatch;
+    action: RequestInterceptionAction;
+    /**
+     * required when action is "fulfill"
+     */
+    fulfill?: string;
+}
+interface ResponseMatch {
+    /**
+     * min length of response.text()
+     */
+    minLength?: number;
+    /**
+     * max length of response.text()
+     */
+    maxLength?: number;
+}
+type ResponseHandlerOptions = Record<string, any>;
+type ResponseHandler = (response: AllResponse, options?: ResponseHandlerOptions) => Promise<void> | void;
+interface ResponseInterceptionItem {
+    /**
+     * page.url()
+     */
+    pageUrl: string;
+    /**
+     * request.method()
+     */
+    requestMethod: RequestMethod;
+    /**
+     * request.url()
+     */
+    rquestUrl: string;
+    /**
+     * request.postData()
+     */
+    requestData: string;
+    /**
+     * response.text()
+     */
+    resposeData: string;
+}
+interface ResponseInterceptionOption {
+    requestMatch?: RequestMatch;
+    responseMatch?: ResponseMatch;
+    /**
+     * the ResponseInterceptionData will be pushed into this array if Array.isArray(cacheArray)
+     */
+    cacheArray?: Array<any>;
+    /**
+     * handler will be called if handler is a function
+     */
+    handler?: ResponseHandler;
+    handlerOptions?: ResponseHandlerOptions;
+}
+interface PDFMargin {
+    top?: string | number;
+    bottom?: string | number;
+    left?: string | number;
+    right?: string | number;
+}
+/**
+ * @public
+ */
+type LowerCasePaperFormat = 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
+/**
+ * All the valid paper format types when printing a PDF.
+ *
+ * @remarks
+ *
+ * The sizes of each format are as follows:
+ *
+ * - `Letter`: 8.5in x 11in
+ *
+ * - `Legal`: 8.5in x 14in
+ *
+ * - `Tabloid`: 11in x 17in
+ *
+ * - `Ledger`: 17in x 11in
+ *
+ * - `A0`: 33.1in x 46.8in
+ *
+ * - `A1`: 23.4in x 33.1in
+ *
+ * - `A2`: 16.54in x 23.4in
+ *
+ * - `A3`: 11.7in x 16.54in
+ *
+ * - `A4`: 8.27in x 11.7in
+ *
+ * - `A5`: 5.83in x 8.27in
+ *
+ * - `A6`: 4.13in x 5.83in
+ *
+ * @public
+ */
+type PaperFormat = Uppercase<LowerCasePaperFormat> | Capitalize<LowerCasePaperFormat> | LowerCasePaperFormat;
+/**
+ * Valid options to configure PDF generation via {@link Page.pdf}.
+ * @public
+ */
+interface PDFOptions {
+    /**
+     * Whether to show the header and footer.
+     * @defaultValue `false`
+     */
+    displayHeaderFooter?: boolean;
+    /**
+     * HTML template for the print footer. Has the same constraints and support
+     * for special classes as {@link PDFOptions | PDFOptions.headerTemplate}.
+     */
+    footerTemplate?: string;
+    /**
+     * @remarks
+     * If set, this takes priority over the `width` and `height` options.
+     * @defaultValue `letter`.
+     */
+    format?: PaperFormat;
+    /**
+     * HTML template for the print header. Should be valid HTML with the following
+     * classes used to inject values into them:
+     *
+     * - `date` formatted print date
+     *
+     * - `title` document title
+     *
+     * - `url` document location
+     *
+     * - `pageNumber` current page number
+     *
+     * - `totalPages` total pages in the document
+     */
+    headerTemplate?: string;
+    /**
+     * Sets the height of paper. You can pass in a number or a string with a unit.
+     */
+    height?: string | number;
+    /**
+     * Whether to print in landscape orientation.
+     * @defaultValue `false`
+     */
+    landscape?: boolean;
+    /**
+     * Set the PDF margins.
+     * @defaultValue `undefined` no margins are set.
+     */
+    margin?: PDFMargin;
+    /**
+     * Hides default white background and allows generating pdfs with transparency.
+     * @defaultValue `false`
+     */
+    /**
+     * Generate document outline.
+     *
+     * @remarks
+     * If this is enabled the PDF will also be tagged (accessible)
+     * Currently only works in old Headless (headless = 'shell')
+     * crbug/840455#c47
+     *
+     * @defaultValue `false`
+     * @experimental
+     */
+    outline?: boolean;
+    /**
+     * Paper ranges to print, e.g. `1-5, 8, 11-13`.
+     * @defaultValue The empty string, which means all pages are printed.
+     */
+    pageRanges?: string;
+    /**
+     * The path to save the file to.
+     *
+     * @remarks
+     *
+     * If the path is relative, it's resolved relative to the current working directory.
+     *
+     * @defaultValue `undefined`, which means the PDF will not be written to disk.
+     */
+    path?: string;
+    /**
+     * Give any CSS `@page` size declared in the page priority over what is
+     * declared in the `width` or `height` or `format` option.
+     * @defaultValue `false`, which will scale the content to fit the paper size.
+     */
+    preferCSSPageSize?: boolean;
+    /**
+     * Set to `true` to print background graphics.
+     * @defaultValue `false`
+     */
+    printBackground?: boolean;
+    /**
+     * Scales the rendering of the web page. Amount must be between `0.1` and `2`.
+     * @defaultValue `1`
+     */
+    scale?: number;
+    /**
+     * Generate tagged (accessible) PDF.
+     * @defaultValue `true`
+     * @experimental
+     */
+    tagged?: boolean;
+    /**
+     * Timeout in milliseconds. Pass `0` to disable timeout.
+     * @defaultValue `30_000`
+     */
+    /**
+     * Sets the width of paper. You can pass in a number or a string with a unit.
+     */
+    width?: string | number;
+}
+/**
+ * @public
+ * not supported by puppeteer: animations, caret, mask, maskColor, scale, style, timeout
+ */
+interface ScreenshotOptions {
+    /**
+     * Capture the screenshot beyond the viewport.
+     *
+     * @defaultValue `false` if there is no `clip`. `true` otherwise.
+     */
+    /**
+     * Specifies the region of the page to clip.
+     */
+    clip?: {
+        /**
+         * x-coordinate of top-left corner of clip area
+         */
+        x: number;
+        /**
+         * y-coordinate of top-left corner of clip area
+         */
+        y: number;
+        /**
+         * the width of the element in pixels.
+         */
+        width: number;
+        /**
+         * the height of the element in pixels.
+         */
+        height: number;
+    };
+    /**
+     * Encoding of the image.
+     *
+     * @defaultValue `'binary'`
+     */
+    /**
+     * Capture the screenshot from the surface, rather than the view.
+     *
+     * @defaultValue `true`
+     */
+    /**
+     * When `true`, takes a screenshot of the full page.
+     *
+     * @defaultValue `false`
+     */
+    fullPage?: boolean;
+    /**
+     * Hides default white background and allows capturing screenshots with transparency.
+     *
+     * @defaultValue `false`
+     */
+    omitBackground?: boolean;
+    /**
+     * @defaultValue `false`
+     */
+    /**
+     * Quality of the image, between 0-100. Not applicable to `png` images.
+     */
+    quality?: number;
+    /**
+     * The file path to save the image to. The screenshot type will be inferred
+     * from file extension. If path is a relative path, then it is resolved
+     * relative to current working directory. If no path is provided, the image
+     * won't be saved to the disk.
+     */
+    path?: string;
+    /**
+     * @defaultValue `'png'`
+     */
+    type?: 'png' | 'jpeg';
+}
+interface LsdPage extends EventEmitter {
+    bringToFront(): Promise<boolean>;
+    browserContext(): LsdBrowserContext;
+    clearCookies(): Promise<boolean>;
+    clearLocalStorage(): Promise<boolean>;
+    /**
+     * Clear all request interceptions on the page
+     */
+    clearRequestInterceptions(): Promise<boolean>;
+    /**
+     * Clear all response interceptions on the page
+     */
+    clearResponseInterceptions(): Promise<boolean>;
+    clearStateData(): Promise<boolean>;
+    /**
+     * Only free page can be closed!
+     */
+    close(): Promise<boolean>;
+    /**
+     * Get the full HTML content of the page or decendant frame
+     * @param iframeOptions default [], selectors of decendant frames
+     */
+    content(iframeOptions?: IframeOption[]): Promise<string>;
+    cookies(): Promise<CookieItem[]>;
+    /**
+     * @returns the first element matching the given CSS selector or XPath
+     * @param selectorOrXpath CSS selector or XPath; if this parameter is an array, each selectorOrXpath in the array will be tried until elements are selected
+     * @param iframeOptions default [], options to select decendant frame
+     */
+    findElement(selectorOrXpath: string | string[], iframeOptions?: IframeOption[]): Promise<LsdElement | null>;
+    /**
+     * @returns elements matching the given CSS selector or XPath
+     * @param selectorOrXpath CSS selector or XPath; if this parameter is an array, each selectorOrXpath in the array will be tried until elements are selected
+     * @param iframeOptions default [], options to select decendant frame
+     */
+    findElements(selectorOrXpath: string | string[], iframeOptions?: IframeOption[]): Promise<LsdElement[]>;
+    /**
+     * Free a busy page. All request and response interceptions will be cleared.
+     */
+    free(): Promise<boolean>;
+    /**
+     * @returns whether the element has the specified attribute or not
+     * @param attributeName
+     */
+    goto(url: string, options?: GotoOptions): Promise<boolean>;
+    id(): string;
+    isFree(): boolean;
+    /**
+     * valid only in CheerioPage
+     */
+    load(html: string): boolean;
+    localStroage(): Promise<LocalStorageOrigin[]>;
+    mainFrame(): AllFrame;
+    maximizeViewport(): Promise<boolean>;
+    pageHeight(): Promise<number>;
+    pageInfo(): PageInfo;
+    pageWidth(): Promise<number>;
+    pdf(options?: PDFOptions): Promise<boolean>;
+    screenshot(options?: ScreenshotOptions): Promise<Buffer>;
+    setCookies(cookies: CookieItem[]): Promise<boolean>;
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
+    /**
+     * set localStorage on the current web page(page.url())
+     * @param localStorageItems
+     */
+    setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
+    setPageInfo(pageInfo: PageInfo): boolean;
+    /**
+     * Intercept requests that meet the conditions(requestMatch) to perform an action(action and fulfill).
+     * @param options
+     */
+    setRequestInterception(options: RequestInterceptionOption | RequestInterceptionOption[]): Promise<boolean>;
+    /**
+     * Intercept responses that meet the conditions(requestMatch and responseMatch) to perform actions(cacheArray and handler )
+     * @param options
+     */
+    setResponseInterception(options: ResponseInterceptionOption | ResponseInterceptionOption[]): Promise<boolean>;
+    /**
+     * Shortcut for LsdPage.browserContext().setStateData(stateData)
+     * @param stateData
+     */
+    setStateData(stateData: StateData): Promise<boolean>;
+    setUserAgent(userAgent: string): Promise<boolean>;
+    setViewportSize(viewPortSize: ViewportSize): Promise<boolean>;
+    stateData(): Promise<StateData>;
+    status(): PageStatus;
+    title(): Promise<string>;
+    url(): string;
+    /**
+     * 开始使用该page(当前状态必须为free)
+     */
+    use(): boolean;
+    /**
+     * obj=window?.[key1]...?.[keyn]
+     * @return obj ? JSON.stringify(obj) : ""
+     * @param keys
+     */
+    windowMember(keys: string[]): Promise<string>;
+}
+interface LsdBrowserContext extends EventEmitter {
+    browser(): LsdBrowser;
+    close(): Promise<boolean>;
+    /**
+     * close pages that are free more than maxPageFreeSeconds if maxPageFreeSeconds > 0
+     * * but the last page in the browserContext will not be closed
+     * @default 0 the default maxPageFreeSeconds of the browserContext will be used
+     */
+    closeFreePages(maxPageFreeSeconds?: number): Promise<boolean>;
+    /**
+     * 获取一个page供执行TE（可能从空闲的page中获取，也可能新建一个page）
+     * * TBD：需要预留pageQuota给需要capName的TE使用
+     */
+    getPage(): Promise<LsdPage | null>;
+    /**
+     * 是否可以获取新page（现有空闲的或新建page）
+     * @param pageNum default 1，需要的pages数量
+     */
+    hasNewPage(pageNum?: number): boolean;
+    id(): string;
+    isIncognito(): boolean;
+    pages(): LsdPage[];
+    proxy(): Proxy | null;
+    setStateData(stateData: StateData): Promise<boolean>;
+    _origBrowserContext(): AllBrowserContext | null;
+}
+interface LsdBrowser extends EventEmitter {
+    newBrowserContext(options?: LsdBrowserContextOptions): Promise<LsdBrowserContext | null>;
+    close(): Promise<boolean>;
+    browserContexts(): LsdBrowserContext[];
+    browserControllerType(): BrowserControllerType;
+    browserCreationMethod(): BrowserCreationMethod;
+    browserType(): LsdBrowserType;
+    executablePath(): string;
+    id(): string;
+    isConnected(): boolean;
+    isHeadless(): boolean;
+    options(): LsdLaunchOptions | LsdConnectOptions;
+    version(): Promise<string>;
+    _origBrowserContexts(): AllBrowserContext[];
+}
+interface LsdBrowserController {
+    launch(browserControllerType: BrowserControllerType, browserType: LsdBrowserType, options?: LsdLaunchOptions): Promise<LsdBrowser>;
+    connect(browserControllerType: BrowserControllerType, browserType: LsdBrowserType, options?: LsdConnectOptions): Promise<LsdBrowser>;
+}
+/**
+ * globObj.cfg.XXX:
+ * 1. 最大browser数:
+ * 2. 最大browserContext数/browser:
+ * 3. 最大page数/browserContext:
+ *
+ * 影响一个browserContext是否满足执行某TE(taskCfg)要求的因素包括：
+ * 1. domainCfg/taskCfg对代理的要求：proxyTypes:
+ * 2. domainCfg/taskCfg对浏览器的要求：
+ * * browserControllerTypes: playwright | puppeteer
+ * * browserTypes: chromium | firefox | webkit
+ * * browserModes: normal | incognito
+ * * browserHeads: headless | headful
+ * * APP支持的浏览器因素：globObj.cfg.supportedBrowserControllerTypes/supportedBrowserTypes(尝试启动新浏览器时判断)
+ * 3. 能力账号：capName
+ *
+ * 连接已有浏览器：
+ * * endpoint：
+ * * browserControllerTypes: playwright | puppeteer
+ * * browserType: chromium | firefox | webkit
+ * * browserMode: normal
+ * * browserHead: headful
+ * * proxyTypes：
+ */
+interface BrowserManager {
+    getPage(): any;
+}
+
+declare class PlaywrightBrowser extends EventEmitter implements LsdBrowser {
+    #private;
+    constructor(browser: Browser, browerType: LsdBrowserType, browserCreateMethod: BrowserCreationMethod, options: LsdLaunchOptions | LsdConnectOptions, browserIdx?: number);
+    newBrowserContext(options?: LsdBrowserContextOptions): Promise<LsdBrowserContext | null>;
+    close(): Promise<boolean>;
+    browserContexts(): LsdBrowserContext[];
+    browserControllerType(): BrowserControllerType;
+    browserCreationMethod(): BrowserCreationMethod;
+    browserType(): LsdBrowserType;
+    executablePath(): string;
+    id(): string;
+    isConnected(): boolean;
+    isHeadless(): boolean;
+    options(): LsdLaunchOptions | LsdConnectOptions;
+    version(): Promise<string>;
+    _origBrowserContexts(): AllBrowserContext[];
+}
+
+declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowserContext {
+    #private;
+    constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, incognito?: boolean, proxy?: Proxy | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number);
+    browser(): LsdBrowser;
+    close(): Promise<boolean>;
+    closeFreePages(maxPageFreeSeconds?: number): Promise<boolean>;
+    getPage(): Promise<LsdPage | null>;
+    hasNewPage(pageNum?: number): boolean;
+    id(): string;
+    isIncognito(): boolean;
+    pages(): LsdPage[];
+    proxy(): Proxy | null;
+    setStateData(stateData: StateData): Promise<boolean>;
+    _origBrowserContext(): AllBrowserContext | null;
+}
+
+declare class PlaywrightPage extends EventEmitter implements LsdPage {
+    #private;
+    constructor(browserContext: LsdBrowserContext, page: Page, pageInfo?: PageInfo);
+    bringToFront(): Promise<boolean>;
+    browserContext(): LsdBrowserContext;
+    clearCookies(): Promise<boolean>;
+    clearLocalStorage(): Promise<boolean>;
+    clearRequestInterceptions(): Promise<boolean>;
+    clearResponseInterceptions(): Promise<boolean>;
+    clearStateData(): Promise<boolean>;
+    close(): Promise<boolean>;
+    content(iframeOptions?: IframeOption[]): Promise<string>;
+    cookies(): Promise<CookieItem[]>;
+    documentHeight(): Promise<number>;
+    findElement(selectorOrXpath: string | string[], iframeOptions?: IframeOption[]): Promise<LsdElement | null>;
+    findElements(selectorOrXpath: string | string[], iframeOptions?: IframeOption[]): Promise<LsdElement[]>;
+    free(): Promise<boolean>;
+    goto(url: string, options?: GotoOptions | undefined): Promise<boolean>;
+    id(): string;
+    isFree(): boolean;
+    localStroage(): Promise<LocalStorageOrigin[]>;
+    load(): boolean;
+    mainFrame(): AllFrame;
+    maximizeViewport(): Promise<boolean>;
+    pageHeight(): Promise<number>;
+    pageInfo(): PageInfo;
+    pageWidth(): Promise<number>;
+    pdf(options?: PDFOptions | undefined): Promise<boolean>;
+    screenshot(options?: ScreenshotOptions): Promise<Buffer>;
+    setCookies(cookies: CookieItem[]): Promise<boolean>;
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
+    setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
+    setPageInfo(pageInfo: PageInfo): boolean;
+    setRequestInterception(options: RequestInterceptionOption | RequestInterceptionOption[]): Promise<boolean>;
+    setResponseInterception(options: ResponseInterceptionOption | ResponseInterceptionOption[]): Promise<boolean>;
+    setStateData(stateData: StateData): Promise<boolean>;
+    setUserAgent(userAgent: string): Promise<boolean>;
+    setViewportSize(viewPortSize: ViewportSize): Promise<boolean>;
+    stateData(): Promise<StateData>;
+    status(): PageStatus;
+    title(): Promise<string>;
+    url(): string;
+    use(): boolean;
+    windowMember(keys: string[]): Promise<string>;
+}
+
+declare class PlaywrightElement implements LsdElement {
+    #private;
+    constructor(locator: Locator, frame: Frame);
+    attribute(attributeName: string): Promise<string>;
+    attributeNames(): Promise<string[]>;
+    findElement(selectorOrXpath: string | string[], iframeOptions?: IframeOption[], absolute?: boolean): Promise<LsdElement | null>;
+    findElements(selectorOrXpath: string | string[], iframeOptions?: IframeOption[], absolute?: boolean): Promise<LsdElement[]>;
+    hasAttribute(attributeName: string): Promise<boolean>;
+    innerHtml(): Promise<string>;
+    innerText(onlyChild?: boolean): Promise<string>;
+    outerHtml(): Promise<string>;
+    textContent(): Promise<string>;
+    click(options?: MouseClickOptions): Promise<boolean>;
+    focus(): Promise<boolean>;
+    hover(): Promise<boolean>;
+    input(value: string, options?: InputOptions): Promise<boolean>;
+    press(key: KeyInput, options?: KeyPressOptions): Promise<boolean>;
+    select(options: SelectOptions): Promise<boolean>;
+    screenshot(options?: ScreenshotOptions): Promise<Buffer>;
+    scrollBy(x: number, y: number): Promise<boolean>;
+    scrollIntoView(): Promise<boolean>;
+    scrollTo(x: number, y: number): Promise<boolean>;
+}
+
+declare class PuppeteerBrowser extends EventEmitter implements LsdBrowser {
+    #private;
+    constructor(browser: Browser$1, browerType: LsdBrowserType, browserCreateMethod: BrowserCreationMethod, options: LsdLaunchOptions | LsdConnectOptions, browserIdx?: number);
+    newBrowserContext(options?: LsdBrowserContextOptions | undefined): Promise<LsdBrowserContext | null>;
+    close(): Promise<boolean>;
+    browserContexts(): LsdBrowserContext[];
+    browserControllerType(): BrowserControllerType;
+    browserCreationMethod(): BrowserCreationMethod;
+    browserType(): LsdBrowserType;
+    executablePath(): string;
+    id(): string;
+    isConnected(): boolean;
+    isHeadless(): boolean;
+    options(): LsdLaunchOptions | LsdConnectOptions;
+    version(): Promise<string>;
+    _origBrowserContexts(): AllBrowserContext[];
+}
+
+declare class PuppeteerBrowserContext extends EventEmitter implements LsdBrowserContext {
+    #private;
+    constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext$1, incognito?: boolean, proxy?: Proxy | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, userAgent?: string);
+    browser(): LsdBrowser;
+    close(): Promise<boolean>;
+    closeFreePages(maxPageFreeSeconds?: number): Promise<boolean>;
+    getPage(): Promise<LsdPage | null>;
+    hasNewPage(pageNum?: number): boolean;
+    id(): string;
+    isIncognito(): boolean;
+    pages(): LsdPage[];
+    proxy(): Proxy | null;
+    setStateData(stateData: StateData): Promise<boolean>;
+    _origBrowserContext(): AllBrowserContext | null;
+}
+
+declare class PuppeteerPage extends EventEmitter implements LsdPage {
+    #private;
+    constructor(browserContext: LsdBrowserContext, page: Page$1, pageInfo?: PageInfo);
+    bringToFront(): Promise<boolean>;
+    browserContext(): LsdBrowserContext;
+    clearCookies(): Promise<boolean>;
+    clearLocalStorage(): Promise<boolean>;
+    clearRequestInterceptions(): Promise<boolean>;
+    clearResponseInterceptions(): Promise<boolean>;
+    clearStateData(): Promise<boolean>;
+    close(): Promise<boolean>;
+    content(iframeOptions?: IframeOption[]): Promise<string>;
+    cookies(): Promise<CookieItem[]>;
+    documentHeight(): Promise<number>;
+    findElement(selectorOrXpath: string | string[], iframeOptions?: IframeOption[]): Promise<LsdElement | null>;
+    findElements(selectorOrXpath: string | string[], iframeOptions?: IframeOption[]): Promise<LsdElement[]>;
+    free(): Promise<boolean>;
+    goto(url: string, options?: GotoOptions | undefined): Promise<boolean>;
+    id(): string;
+    isFree(): boolean;
+    localStroage(): Promise<LocalStorageOrigin[]>;
+    load(): boolean;
+    mainFrame(): AllFrame;
+    maximizeViewport(): Promise<boolean>;
+    pageHeight(): Promise<number>;
+    pageInfo(): PageInfo;
+    pageWidth(): Promise<number>;
+    pdf(options?: PDFOptions | undefined): Promise<boolean>;
+    screenshot(options?: ScreenshotOptions): Promise<Buffer>;
+    setCookies(cookies: CookieItem[]): Promise<boolean>;
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<boolean>;
+    setLocalStroage(localStorageItems: LocalStorageItem[]): Promise<boolean>;
+    setPageInfo(pageInfo: PageInfo): boolean;
+    setRequestInterception(options: RequestInterceptionOption | RequestInterceptionOption[]): Promise<boolean>;
+    setResponseInterception(options: ResponseInterceptionOption | ResponseInterceptionOption[]): Promise<boolean>;
+    setStateData(stateData: StateData): Promise<boolean>;
+    setUserAgent(userAgent: string): Promise<boolean>;
+    setViewportSize(viewPortSize: ViewportSize): Promise<boolean>;
+    stateData(): Promise<StateData>;
+    status(): PageStatus;
+    title(): Promise<string>;
+    url(): string;
+    use(): boolean;
+    windowMember(keys: string[]): Promise<string>;
+}
+
+declare class PuppeteerElement implements LsdElement {
+    #private;
+    constructor($ele: ElementHandle, frame: Frame$1);
+    attribute(attributeName: string): Promise<string>;
+    attributeNames(): Promise<string[]>;
+    findElement(selectorOrXpath: string | string[], iframeOptions?: IframeOption[], absolute?: boolean): Promise<LsdElement | null>;
+    findElements(selectorOrXpath: string | string[], iframeOptions?: IframeOption[], absolute?: boolean): Promise<LsdElement[]>;
+    hasAttribute(attributeName: string): Promise<boolean>;
+    innerHtml(): Promise<string>;
+    innerText(onlyChild?: boolean): Promise<string>;
+    outerHtml(): Promise<string>;
+    textContent(): Promise<string>;
+    click(options?: MouseClickOptions): Promise<boolean>;
+    focus(): Promise<boolean>;
+    hover(): Promise<boolean>;
+    input(value: string, options?: InputOptions): Promise<boolean>;
+    press(key: KeyInput, options?: KeyPressOptions): Promise<boolean>;
+    select(options: SelectOptions): Promise<boolean>;
+    screenshot(options?: ScreenshotOptions): Promise<Buffer>;
+    scrollBy(x: number, y: number): Promise<boolean>;
+    scrollIntoView(): Promise<boolean>;
+    scrollTo(x: number, y: number): Promise<boolean>;
+}
+
+declare class CheerioPage extends EventEmitter implements LsdPage {
+    #private;
+    constructor(html?: string);
+    bringToFront(): Promise<boolean>;
+    browserContext(): LsdBrowserContext;
+    clearCookies(): Promise<boolean>;
+    clearLocalStorage(): Promise<boolean>;
+    clearRequestInterceptions(): Promise<boolean>;
+    clearResponseInterceptions(): Promise<boolean>;
+    clearStateData(): Promise<boolean>;
+    close(): Promise<boolean>;
+    content(): Promise<string>;
+    cookies(): Promise<CookieItem[]>;
+    findElement(selectorOrXpath: string | string[]): Promise<LsdElement | null>;
+    findElements(selectorOrXpath: string | string[]): Promise<LsdElement[]>;
+    free(): Promise<boolean>;
+    goto(): Promise<boolean>;
+    id(): string;
+    isFree(): boolean;
+    load(html: string): boolean;
+    localStroage(): Promise<LocalStorageOrigin[]>;
+    mainFrame(): AllFrame;
+    maximizeViewport(): Promise<boolean>;
+    pageHeight(): Promise<number>;
+    pageInfo(): PageInfo;
+    pageWidth(): Promise<number>;
+    pdf(): Promise<boolean>;
+    screenshot(): Promise<Buffer>;
+    setCookies(): Promise<boolean>;
+    setExtraHTTPHeaders(): Promise<boolean>;
+    setLocalStroage(): Promise<boolean>;
+    setPageInfo(): boolean;
+    setRequestInterception(): Promise<boolean>;
+    setResponseInterception(): Promise<boolean>;
+    setStateData(): Promise<boolean>;
+    setUserAgent(): Promise<boolean>;
+    setViewportSize(): Promise<boolean>;
+    stateData(): Promise<StateData>;
+    status(): PageStatus;
+    title(): Promise<string>;
+    url(): string;
+    use(): boolean;
+    windowMember(): Promise<string>;
+}
+
+declare class CheerioElement implements LsdElement {
+    #private;
+    constructor(node: CheerioNode);
+    attribute(attributeName: string): Promise<string>;
+    attributeNames(): Promise<string[]>;
+    findElement(selectorOrXpath: string | string[]): Promise<LsdElement | null>;
+    findElements(selectorOrXpath: string | string[]): Promise<LsdElement[]>;
+    hasAttribute(attributeName: string): Promise<boolean>;
+    innerHtml(): Promise<string>;
+    innerText(): Promise<string>;
+    outerHtml(): Promise<string>;
+    textContent(): Promise<string>;
+    click(): Promise<boolean>;
+    focus(): Promise<boolean>;
+    hover(): Promise<boolean>;
+    input(): Promise<boolean>;
+    press(): Promise<boolean>;
+    select(): Promise<boolean>;
+    screenshot(): Promise<Buffer>;
+    scrollBy(): Promise<boolean>;
+    scrollIntoView(): Promise<boolean>;
+    scrollTo(): 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 PDFMargin, type PDFOptions, 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 ViewportSize, defaultProxy };