brave-real-puppeteer-core 24.25.0 → 24.33.0-patch.1

package/lib/es5-iife/puppeteer-core-browser.d.ts

@@ -91,6 +91,33 @@ export declare interface ActionOptions {
  */
 export declare type ActionResult = 'continue' | 'abort' | 'respond';
 
+/**
+ * @license
+ * Copyright 2025 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @public
+ * Emulated bluetooth adapter state.
+ */
+export declare type AdapterState = 'absent' | 'powered-off' | 'powered-on';
+
+/**
+ * @public
+ */
+export declare interface AddScreenParams {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    workAreaInsets?: WorkAreaInsets;
+    devicePixelRatio?: number;
+    rotation?: number;
+    colorDepth?: number;
+    label?: string;
+    isInternal?: boolean;
+}
+
 /**
  * @public
  */
@@ -127,6 +154,83 @@ export declare type AwaitablePredicate<T> = (value: T) => Awaitable<boolean>;
  */
 export declare type AwaitedLocator<T> = T extends Locator<infer S> ? S : never;
 
+/**
+ * Exposes the bluetooth emulation abilities.
+ *
+ * @remarks {@link https://webbluetoothcg.github.io/web-bluetooth/#simulated-bluetooth-adapter|Web Bluetooth specification}
+ * requires the emulated adapters should be isolated per top-level navigable. However,
+ * at the moment Chromium's bluetooth emulation implementation is tight to the browser
+ * context, not the page. This means the bluetooth emulation exposed from different pages
+ * of the same browser context would interfere their states.
+ *
+ * @example
+ *
+ * ```ts
+ * await page.bluetooth.emulateAdapter('powered-on');
+ * await page.bluetooth.simulatePreconnectedPeripheral({
+ *   address: '09:09:09:09:09:09',
+ *   name: 'SOME_NAME',
+ *   manufacturerData: [
+ *     {
+ *       key: 17,
+ *       data: 'AP8BAX8=',
+ *     },
+ *   ],
+ *   knownServiceUuids: ['12345678-1234-5678-9abc-def123456789'],
+ * });
+ * await page.bluetooth.disableEmulation();
+ * ```
+ *
+ * @experimental
+ * @public
+ */
+export declare interface BluetoothEmulation {
+    /**
+     * Emulate Bluetooth adapter. Required for bluetooth simulations
+     * See {@link https://webbluetoothcg.github.io/web-bluetooth/#bluetooth-simulateAdapter-command|bluetooth.simulateAdapter}.
+     *
+     * @param state - The desired bluetooth adapter state.
+     * @param leSupported - Mark if the adapter supports low-energy bluetooth.
+     *
+     * @experimental
+     * @public
+     */
+    emulateAdapter(state: AdapterState, leSupported?: boolean): Promise<void>;
+    /**
+     * Disable emulated bluetooth adapter.
+     * See {@link https://webbluetoothcg.github.io/web-bluetooth/#bluetooth-disableSimulation-command|bluetooth.disableSimulation}.
+     *
+     * @experimental
+     * @public
+     */
+    disableEmulation(): Promise<void>;
+    /**
+     * Simulated preconnected Bluetooth Peripheral.
+     * See {@link https://webbluetoothcg.github.io/web-bluetooth/#bluetooth-simulateconnectedperipheral-command|bluetooth.simulatePreconnectedPeripheral}.
+     *
+     * @param preconnectedPeripheral - The peripheral to simulate.
+     *
+     * @experimental
+     * @public
+     */
+    simulatePreconnectedPeripheral(preconnectedPeripheral: PreconnectedPeripheral): Promise<void>;
+}
+
+/**
+ * @public
+ * Represents the simulated bluetooth peripheral's manufacturer data.
+ */
+export declare interface BluetoothManufacturerData {
+    /**
+     * The company identifier, as defined by the {@link https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers/|Bluetooth SIG}.
+     */
+    key: number;
+    /**
+     * The manufacturer-specific data as a base64-encoded string.
+     */
+    data: string;
+}
+
 /**
  * @public
  */
@@ -254,7 +358,15 @@ export declare abstract class Browser extends EventEmitter<BrowserEvents> {
      * Creates a new {@link Page | page} in the
      * {@link Browser.defaultBrowserContext | default browser context}.
      */
-    abstract newPage(): Promise<Page>;
+    abstract newPage(options?: CreatePageOptions): Promise<Page>;
+    /**
+     * Gets the specified window {@link WindowBounds | bounds}.
+     */
+    abstract getWindowBounds(windowId: WindowId): Promise<WindowBounds>;
+    /**
+     * Sets the specified window {@link WindowBounds | bounds}.
+     */
+    abstract setWindowBounds(windowId: WindowId, windowBounds: WindowBounds): Promise<void>;
     /**
      * Gets all active {@link Target | targets}.
      *
@@ -291,10 +403,12 @@ export declare abstract class Browser extends EventEmitter<BrowserEvents> {
      * returns all {@link Page | pages} in all
      * {@link BrowserContext | browser contexts}.
      *
+     * @param includeAll - experimental, setting to true includes all kinds of pages.
+     *
      * @remarks Non-visible {@link Page | pages}, such as `"background_page"`,
      * will not be listed here. You can find them using {@link Target.page}.
      */
-    pages(): Promise<Page[]>;
+    pages(includeAll?: boolean): Promise<Page[]>;
     /**
      * Gets a string representing this {@link Browser | browser's} name and
      * version.
@@ -375,6 +489,26 @@ export declare abstract class Browser extends EventEmitter<BrowserEvents> {
      * `--enable-unsafe-extension-debugging` flag is set.
      */
     abstract uninstallExtension(id: string): Promise<void>;
+    /**
+     * Gets a list of {@link ScreenInfo | screen information objects}.
+     */
+    abstract screens(): Promise<ScreenInfo[]>;
+    /**
+     * Adds a new screen, returns the added {@link ScreenInfo | screen information object}.
+     *
+     * @remarks
+     *
+     * Only supported in headless mode.
+     */
+    abstract addScreen(params: AddScreenParams): Promise<ScreenInfo>;
+    /**
+     * Removes a screen.
+     *
+     * @remarks
+     *
+     * Only supported in headless mode. Fails if the primary screen id is specified.
+     */
+    abstract removeScreen(screenId: string): Promise<void>;
     /**
      * Whether Puppeteer is connected to this {@link Browser | browser}.
      *
@@ -470,10 +604,12 @@ export declare abstract class BrowserContext extends EventEmitter<BrowserContext
      * Gets a list of all open {@link Page | pages} inside this
      * {@link BrowserContext | browser context}.
      *
+     * @param includeAll - experimental, setting to true includes all kinds of pages.
+     *
      * @remarks Non-visible {@link Page | pages}, such as `"background_page"`,
      * will not be listed here. You can find them using {@link Target.page}.
      */
-    abstract pages(): Promise<Page[]>;
+    abstract pages(includeAll?: boolean): Promise<Page[]>;
     /**
      * Grants this {@link BrowserContext | browser context} the given
      * `permissions` within the given `origin`.
@@ -513,7 +649,7 @@ export declare abstract class BrowserContext extends EventEmitter<BrowserContext
      * Creates a new {@link Page | page} in this
      * {@link BrowserContext | browser context}.
      */
-    abstract newPage(): Promise<Page>;
+    abstract newPage(options?: CreatePageOptions): Promise<Page>;
     /**
      * Gets the {@link Browser | browser} associated with this
      * {@link BrowserContext | browser context}.
@@ -984,13 +1120,14 @@ connect: (options: Puppeteer_2.ConnectOptions) => Promise<Puppeteer_2.Browser>;
  */
 export declare class Connection extends EventEmitter<CDPSessionEvents> {
     
-    constructor(url: string, transport: ConnectionTransport, delay?: number, timeout?: number, rawErrors?: boolean);
+    constructor(url: string, transport: ConnectionTransport, delay?: number, timeout?: number, rawErrors?: boolean, idGenerator?: () => number);
     static fromSession(session: CDPSession): Connection | undefined;
 
     get timeout(): number;
 
 
 
+
     /**
      * @param sessionId - The session id
      * @returns The current CDP session if it exists
@@ -1046,6 +1183,17 @@ export declare interface ConnectOptions {
      * @defaultValue `false`
      */
     acceptInsecureCerts?: boolean;
+    /**
+     * If specified, puppeteer looks for an open WebSocket at the well-known
+     * default user data directory for the specified channel and attempts to
+     * connect to it using ws://localhost:$ActivePort/devtools/browser. Only works
+     * for Chrome and when run in Node.js.
+     *
+     * This option is experimental when used with puppeteer.connect().
+     *
+     * @experimental
+     */
+    channel?: ChromeReleaseChannel;
     /**
      * Experimental setting to disable monitoring network events by default. When
      * set to `false`, parts of Puppeteer that depend on network events would not
@@ -1103,6 +1251,7 @@ export declare interface ConnectOptions {
     browserWSEndpoint?: string;
     browserURL?: string;
     transport?: ConnectionTransport;
+
     /**
      * Headers to use for the web socket connection.
      * @remarks
@@ -1145,6 +1294,7 @@ export declare class ConsoleMessage {
      * The array of locations on the stack of the console message.
      */
     stackTrace(): ConsoleMessageLocation[];
+
 }
 
 /**
@@ -1497,6 +1647,16 @@ export declare interface CoverageEntry {
     }>;
 }
 
+/**
+ * @public
+ */
+export declare type CreatePageOptions = {
+    type: 'tab';
+} | {
+    type: 'window';
+    windowBounds?: WindowBounds;
+};
+
 /**
  * @public
  */
@@ -1656,25 +1816,23 @@ export declare interface Device {
  *
  * @public
  */
-export declare class DeviceRequestPrompt {
-    
+export declare abstract class DeviceRequestPrompt {
     /**
      * Current list of selectable devices.
      */
-    devices: DeviceRequestPromptDevice[];
-
+    readonly devices: DeviceRequestPromptDevice[];
     /**
      * Resolve to the first device in the prompt matching a filter.
      */
-    waitForDevice(filter: (device: DeviceRequestPromptDevice) => boolean, options?: WaitTimeoutOptions): Promise<DeviceRequestPromptDevice>;
+    abstract waitForDevice(filter: (device: DeviceRequestPromptDevice) => boolean, options?: WaitTimeoutOptions): Promise<DeviceRequestPromptDevice>;
     /**
      * Select a device in the prompt's list.
      */
-    select(device: DeviceRequestPromptDevice): Promise<void>;
+    abstract select(device: DeviceRequestPromptDevice): Promise<void>;
     /**
      * Cancel the prompt.
      */
-    cancel(): Promise<void>;
+    abstract cancel(): Promise<void>;
 }
 
 /**
@@ -1682,7 +1840,7 @@ export declare class DeviceRequestPrompt {
  *
  * @public
  */
-export declare class DeviceRequestPromptDevice {
+export declare interface DeviceRequestPromptDevice {
     /**
      * Device id during a prompt.
      */
@@ -1691,7 +1849,6 @@ export declare class DeviceRequestPromptDevice {
      * Device name as it appears in a prompt.
      */
     name: string;
-
 }
 
 /**
@@ -3302,7 +3459,7 @@ export declare abstract class HTTPRequest {
      */
     abstract method(): string;
     /**
-     * The request's post body, if any.
+     * @deprecated Use {@link HTTPRequest.fetchPostData}.
      */
     abstract postData(): string | undefined;
     /**
@@ -5449,7 +5606,7 @@ export declare abstract class Page extends EventEmitter<PageEvents> {
      * multiple redirects, the navigation will resolve with the response of the
      * last redirect.
      */
-    abstract reload(options?: WaitForOptions): Promise<HTTPResponse | null>;
+    abstract reload(options?: ReloadOptions): Promise<HTTPResponse | null>;
     /**
      * Waits for the page to navigate to a new URL or to reload. It is useful when
      * you run code that will indirectly cause the page to navigate.
@@ -5976,6 +6133,12 @@ export declare abstract class Page extends EventEmitter<PageEvents> {
         encoding: 'base64';
     }): Promise<string>;
     screenshot(options?: Readonly<ScreenshotOptions>): Promise<Uint8Array>;
+    /**
+     * Emulates focus state of the page.
+     *
+     * @param enabled - Whether to emulate focus.
+     */
+    abstract emulateFocusedPage(enabled: boolean): Promise<void>;
 
     /**
      * Generates a PDF of the page with the `print` CSS media type.
@@ -6367,8 +6530,23 @@ export declare abstract class Page extends EventEmitter<PageEvents> {
      */
     abstract waitForDevicePrompt(options?: WaitTimeoutOptions): Promise<DeviceRequestPrompt>;
 
+    /**
+     * Returns the page's window id.
+     *
+     * @experimental
+     */
+    abstract windowId(): Promise<WindowId>;
 
 
+    /**
+     * Opens DevTools for the current Page and returns the DevTools Page. This
+     * method is only available in Chrome.
+     */
+    abstract openDevTools(): Promise<Page>;
+    /**
+     * {@inheritDoc BluetoothEmulation}
+     */
+    abstract get bluetooth(): BluetoothEmulation;
 }
 
 /**
@@ -6447,7 +6625,7 @@ export declare const enum PageEvent {
     Metrics = "metrics",
     /**
      * Emitted when an uncaught exception happens within the page. Contains an
-     * `Error`.
+     * `Error` or data of type unknown.
      */
     PageError = "pageerror",
     /**
@@ -6545,7 +6723,7 @@ export declare interface PageEvents extends Record<EventType, unknown> {
         title: string;
         metrics: Metrics;
     };
-    [PageEvent.PageError]: Error;
+    [PageEvent.PageError]: Error | unknown;
     [PageEvent.Popup]: Page | null;
     [PageEvent.Request]: HTTPRequest;
     [PageEvent.Response]: HTTPResponse;
@@ -6745,6 +6923,17 @@ declare namespace PQuerySelector {
     }
 }
 
+/**
+ * @public
+ * A bluetooth peripheral to be simulated.
+ */
+export declare interface PreconnectedPeripheral {
+    address: string;
+    name: string;
+    manufacturerData: BluetoothManufacturerData[];
+    knownServiceUuids: string[];
+}
+
 /**
  * A list of pre-defined network conditions to be used with
  * {@link Page.emulateNetworkConditions}.
@@ -6888,6 +7077,10 @@ declare namespace Puppeteer_2 {
     export {
         Protocol,
         Session,
+        AdapterState,
+        BluetoothManufacturerData,
+        PreconnectedPeripheral,
+        BluetoothEmulation,
         BrowserContextOptions,
         TargetFilterCallback,
         Permission,
@@ -6895,6 +7088,14 @@ declare namespace Puppeteer_2 {
         BrowserEvent,
         BrowserEvents,
         DebugInfo,
+        WindowState,
+        WindowBounds,
+        WindowId,
+        CreatePageOptions,
+        ScreenOrientation_2 as ScreenOrientation,
+        ScreenInfo,
+        WorkAreaInsets,
+        AddScreenParams,
         Browser,
         BrowserContextEvent,
         BrowserContextEvents,
@@ -6904,6 +7105,8 @@ declare namespace Puppeteer_2 {
         CDPSessionEvents,
         CommandOptions,
         CDPSession,
+        DeviceRequestPromptDevice,
+        DeviceRequestPrompt,
         Dialog,
         Quad,
         BoxModel,
@@ -6961,6 +7164,7 @@ declare namespace Puppeteer_2 {
         PageEvent,
         PageEvents,
         NewDocumentScriptEvaluation,
+        ReloadOptions,
         Page,
         TargetType,
         Target,
@@ -6986,8 +7190,6 @@ declare namespace Puppeteer_2 {
         Coverage,
         JSCoverage,
         CSSCoverage,
-        DeviceRequestPromptDevice,
-        DeviceRequestPrompt,
         ExtensionTransport,
         PuppeteerLifeCycleEvent,
         ProtocolLifeCycleEvent,
@@ -7005,6 +7207,7 @@ declare namespace Puppeteer_2 {
         ProtocolType,
         SupportedWebDriverCapability,
         SupportedWebDriverCapabilities,
+        ChromeReleaseChannel,
         ConnectOptions,
         ConsoleMessageLocation,
         ConsoleMessageType,
@@ -7055,7 +7258,6 @@ declare namespace Puppeteer_2 {
         Viewport,
         DownloadPolicy,
         DownloadBehavior,
-        ChromeReleaseChannel,
         LaunchOptions,
         BrowserLauncher,
         PuppeteerNode,
@@ -7259,6 +7461,19 @@ export declare interface QueryOptions {
     isolate: boolean;
 }
 
+/**
+ * @public
+ */
+export declare interface ReloadOptions extends WaitForOptions {
+    /**
+     * If set to true, the browser caches are ignored for the page reload.
+     *
+     * @defaultValue true
+     * @public
+     */
+    ignoreCache?: boolean;
+}
+
 /**
  * @public
  */
@@ -7385,6 +7600,37 @@ export declare interface ScreencastOptions {
     ffmpegPath?: string;
 }
 
+/**
+ * @public
+ */
+export declare interface ScreenInfo {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    availLeft: number;
+    availTop: number;
+    availWidth: number;
+    availHeight: number;
+    devicePixelRatio: number;
+    colorDepth: number;
+    orientation: ScreenOrientation_2;
+    isExtended: boolean;
+    isInternal: boolean;
+    isPrimary: boolean;
+    label: string;
+    id: string;
+}
+
+/**
+ * @public
+ */
+declare interface ScreenOrientation_2 {
+    angle: number;
+    type: string;
+}
+export { ScreenOrientation_2 as ScreenOrientation }
+
 /**
  * @public
  */
@@ -7450,7 +7696,7 @@ export declare interface ScreenshotOptions {
      * relative to current working directory. If no path is provided, the image
      * won't be saved to the disk.
      */
-    path?: `${string}.${ImageFormat}`;
+    path?: string;
     /**
      * Specifies the region of the page/element to clip.
      */
@@ -7573,10 +7819,15 @@ export declare interface SerializedAXNode {
      */
     invalid?: string;
     orientation?: string;
+    /**
+     * Url for link elements.
+     */
+    url?: string;
     /**
      * Children of this node, if there are any.
      */
     children?: SerializedAXNode[];
+
     /**
      * Get an ElementHandle for this AXNode if available.
      *
@@ -8102,4 +8353,35 @@ export declare abstract class WebWorker extends EventEmitter<Record<EventType, u
     close(): Promise<void>;
 }
 
+/**
+ * @public
+ */
+export declare interface WindowBounds {
+    left?: number;
+    top?: number;
+    width?: number;
+    height?: number;
+    windowState?: WindowState;
+}
+
+/**
+ * @public
+ */
+export declare type WindowId = string;
+
+/**
+ * @public
+ */
+export declare type WindowState = 'normal' | 'minimized' | 'maximized' | 'fullscreen';
+
+/**
+ * @public
+ */
+export declare interface WorkAreaInsets {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+}
+
 export { }