patchright-core 1.50.0 → 1.51.0

package/types/types.d.ts

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 import { ChildProcess } from 'child_process';
-import { EventEmitter } from 'events';
 import { Readable } from 'stream';
 import { ReadStream } from 'fs';
 import { Protocol } from './protocol';
@@ -2565,6 +2564,12 @@ export interface Page {
      */
     colorScheme?: null|"light"|"dark"|"no-preference";
 
+    /**
+     * Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. Passing `null`
+     * disables contrast emulation.
+     */
+    contrast?: null|"no-preference"|"more";
+
     /**
      * Emulates `'forced-colors'` media feature, supported values are `'active'` and `'none'`. Passing `null` disables
      * forced colors emulation.
@@ -9260,10 +9265,21 @@ export interface BrowserContext {
   setOffline(offline: boolean): Promise<void>;
 
   /**
-   * Returns storage state for this browser context, contains current cookies and local storage snapshot.
+   * Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB
+   * snapshot.
    * @param options
    */
   storageState(options?: {
+    /**
+     * Set to `true` to include [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) in the storage
+     * state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase Authentication,
+     * enable this.
+     *
+     * **NOTE** IndexedDBs with typed arrays are currently not supported.
+     *
+     */
+    indexedDB?: boolean;
+
     /**
      * The file path to save the storage state to. If
      * [`path`](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state-option-path) is a
@@ -9770,6 +9786,13 @@ export interface Browser {
      */
     colorScheme?: null|"light"|"dark"|"no-preference";
 
+    /**
+     * Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
+     * [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
+     * Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`.
+     */
+    contrast?: null|"no-preference"|"more";
+
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
      * [emulating devices with device scale factor](https://playwright.dev/docs/emulation#devices).
@@ -10049,12 +10072,12 @@ export interface Browser {
         sameSite: "Strict"|"Lax"|"None";
       }>;
 
-      /**
-       * localStorage to set for context
-       */
       origins: Array<{
         origin: string;
 
+        /**
+         * localStorage to set for context
+         */
         localStorage: Array<{
           name: string;
 
@@ -11627,7 +11650,8 @@ export interface ElementHandle<T=Node> extends JSHandle<T> {
      * Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
      * box `#FF00FF` (customized by
      * [`maskColor`](https://playwright.dev/docs/api/class-elementhandle#element-handle-screenshot-option-mask-color))
-     * that completely covers its bounding box.
+     * that completely covers its bounding box. The mask is also applied to invisible elements, see
+     * [Matching only visible elements](https://playwright.dev/docs/locators#matching-only-visible-elements) to disable that.
      */
     mask?: Array<Locator>;
 
@@ -12176,12 +12200,6 @@ export interface Locator {
    * rejects, this method throws.
    *
    * **Usage**
-   *
-   * ```js
-   * const tweets = page.locator('.tweet .retweets');
-   * expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');
-   * ```
-   *
    * @param pageFunction Function to be evaluated in the page context.
    * @param arg Optional argument to pass to
    * [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression).
@@ -12207,12 +12225,6 @@ export interface Locator {
    * rejects, this method throws.
    *
    * **Usage**
-   *
-   * ```js
-   * const tweets = page.locator('.tweet .retweets');
-   * expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');
-   * ```
-   *
    * @param pageFunction Function to be evaluated in the page context.
    * @param arg Optional argument to pass to
    * [`pageFunction`](https://playwright.dev/docs/api/class-locator#locator-evaluate-option-expression).
@@ -12429,7 +12441,7 @@ export interface Locator {
 
   /**
    * Captures the aria snapshot of the given element. Read more about [aria snapshots](https://playwright.dev/docs/aria-snapshots) and
-   * [expect(locator).toMatchAriaSnapshot(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot-1)
+   * [expect(locator).toMatchAriaSnapshot(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot)
    * for the corresponding assertion.
    *
    * **Usage**
@@ -13111,6 +13123,11 @@ export interface Locator {
      * `<article><div>Playwright</div></article>`.
      */
     hasText?: string|RegExp;
+
+    /**
+     * Only matches visible or invisible elements.
+     */
+    visible?: boolean;
   }): Locator;
 
   /**
@@ -14062,9 +14079,9 @@ export interface Locator {
    *
    * ```html
    * <select multiple>
-   *   <option value="red">Red</div>
-   *   <option value="green">Green</div>
-   *   <option value="blue">Blue</div>
+   *   <option value="red">Red</option>
+   *   <option value="green">Green</option>
+   *   <option value="blue">Blue</option>
    * </select>
    * ```
    *
@@ -14313,7 +14330,8 @@ export interface Locator {
   }): Promise<void>;
 
   /**
-   * Perform a tap gesture on the element matching the locator.
+   * Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually
+   * dispatching touch events, see the [emulating legacy touch events](https://playwright.dev/docs/touch-events) page.
    *
    * **Details**
    *
@@ -14566,6 +14584,11 @@ export interface BrowserType<Unused = {}> {
    *
    * **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
    *
+   * **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via
+   * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
+   * If you are experiencing issues or attempting to use advanced functionality, you probably want to use
+   * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
+   *
    * **Usage**
    *
    * ```js
@@ -14591,6 +14614,11 @@ export interface BrowserType<Unused = {}> {
    *
    * **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
    *
+   * **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via
+   * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
+   * If you are experiencing issues or attempting to use advanced functionality, you probably want to use
+   * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
+   *
    * **Usage**
    *
    * ```js
@@ -14605,10 +14633,12 @@ export interface BrowserType<Unused = {}> {
    */
   connectOverCDP(options: ConnectOverCDPOptions & { wsEndpoint?: string }): Promise<Browser>;
   /**
-   * This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
-   * `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is
-   * compatible with 1.2.x).
-   * @param wsEndpoint A browser websocket endpoint to connect to.
+   * This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
+   *
+   * **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of
+   * Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
+   *
+   * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.
    * @param options
    */
   connect(wsEndpoint: string, options?: ConnectOptions): Promise<Browser>;
@@ -14619,10 +14649,12 @@ export interface BrowserType<Unused = {}> {
    * @deprecated
    */
   /**
-   * This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
-   * `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is
-   * compatible with 1.2.x).
-   * @param wsEndpoint A browser websocket endpoint to connect to.
+   * This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
+   *
+   * **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of
+   * Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
+   *
+   * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.
    * @param options
    */
   connect(options: ConnectOptions & { wsEndpoint?: string }): Promise<Browser>;
@@ -14795,6 +14827,13 @@ export interface BrowserType<Unused = {}> {
      */
     colorScheme?: null|"light"|"dark"|"no-preference";
 
+    /**
+     * Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
+     * [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
+     * Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`.
+     */
+    contrast?: null|"no-preference"|"more";
+
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
      * [emulating devices with device scale factor](https://playwright.dev/docs/emulation#devices).
@@ -16607,6 +16646,13 @@ export interface AndroidDevice {
      */
     colorScheme?: null|"light"|"dark"|"no-preference";
 
+    /**
+     * Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
+     * [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
+     * Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`.
+     */
+    contrast?: null|"no-preference"|"more";
+
     /**
      * Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
      * [emulating devices with device scale factor](https://playwright.dev/docs/emulation#devices).
@@ -17482,6 +17528,12 @@ export interface APIRequest {
      */
     extraHTTPHeaders?: { [key: string]: string; };
 
+    /**
+     * Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
+     * codes.
+     */
+    failOnStatusCode?: boolean;
+
     /**
      * Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
      * origin is specified, the username and password are sent to any servers upon unauthorized responses.
@@ -18351,6 +18403,11 @@ export interface APIRequestContext {
    * @param options
    */
   storageState(options?: {
+    /**
+     * Set to `true` to include IndexedDB in the storage state snapshot.
+     */
+    indexedDB?: boolean;
+
     /**
      * The file path to save the storage state to. If
      * [`path`](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state-option-path) is
@@ -21049,6 +21106,9 @@ export interface Selectors {
 /**
  * The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on
  * the touchscreen can only be used in browser contexts that have been initialized with `hasTouch` set to true.
+ *
+ * This class is limited to emulating tap gestures. For examples of other gestures simulated by manually dispatching
+ * touch events, see the [emulating legacy touch events](https://playwright.dev/docs/touch-events) page.
  */
 export interface Touchscreen {
   /**
@@ -21299,8 +21359,11 @@ export interface WebError {
 }
 
 /**
- * The [WebSocket](https://playwright.dev/docs/api/class-websocket) class represents websocket connections in the
- * page.
+ * The [WebSocket](https://playwright.dev/docs/api/class-websocket) class represents WebSocket connections within a
+ * page. It provides the ability to inspect and manipulate the data being transmitted and received.
+ *
+ * If you want to intercept or modify WebSocket frames, consider using
+ * [WebSocketRoute](https://playwright.dev/docs/api/class-websocketroute).
  */
 export interface WebSocket {
   /**
@@ -21785,7 +21848,8 @@ export interface LocatorScreenshotOptions {
    * Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
    * box `#FF00FF` (customized by
    * [`maskColor`](https://playwright.dev/docs/api/class-locator#locator-screenshot-option-mask-color)) that completely
-   * covers its bounding box.
+   * covers its bounding box. The mask is also applied to invisible elements, see
+   * [Matching only visible elements](https://playwright.dev/docs/locators#matching-only-visible-elements) to disable that.
    */
   mask?: Array<Locator>;
 
@@ -21964,6 +22028,13 @@ export interface BrowserContextOptions {
    */
   colorScheme?: null|"light"|"dark"|"no-preference";
 
+  /**
+   * Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
+   * [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
+   * Passing `null` resets emulation to system defaults. Defaults to `'no-preference'`.
+   */
+  contrast?: null|"no-preference"|"more";
+
   /**
    * Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
    * [emulating devices with device scale factor](https://playwright.dev/docs/emulation#devices).
@@ -22210,12 +22281,12 @@ export interface BrowserContextOptions {
       sameSite: "Strict"|"Lax"|"None";
     }>;
 
-    /**
-     * localStorage to set for context
-     */
     origins: Array<{
       origin: string;
 
+      /**
+       * localStorage to set for context
+       */
       localStorage: Array<{
         name: string;
 
@@ -22443,7 +22514,8 @@ export interface PageScreenshotOptions {
    * Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
    * box `#FF00FF` (customized by
    * [`maskColor`](https://playwright.dev/docs/api/class-page#page-screenshot-option-mask-color)) that completely covers
-   * its bounding box.
+   * its bounding box. The mask is also applied to invisible elements, see
+   * [Matching only visible elements](https://playwright.dev/docs/locators#matching-only-visible-elements) to disable that.
    */
   mask?: Array<Locator>;
 

package/lib/utils/stackTrace.js

@@ -1,134 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.addInternalStackPrefix = void 0;
-exports.captureLibraryStackText = captureLibraryStackText;
-exports.captureLibraryStackTrace = captureLibraryStackTrace;
-exports.captureRawStack = captureRawStack;
-exports.compressCallLog = compressCallLog;
-exports.formatCallLog = formatCallLog;
-exports.rewriteErrorMessage = rewriteErrorMessage;
-exports.splitErrorMessage = splitErrorMessage;
-exports.stringifyStackFrames = stringifyStackFrames;
-var _path = _interopRequireDefault(require("path"));
-var _utilsBundle = require("../utilsBundle");
-var _sequence = require("./sequence");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-function rewriteErrorMessage(e, newMessage) {
-  var _e$stack;
-  const lines = (((_e$stack = e.stack) === null || _e$stack === void 0 ? void 0 : _e$stack.split('\n')) || []).filter(l => l.startsWith('    at '));
-  e.message = newMessage;
-  const errorTitle = `${e.name}: ${e.message}`;
-  if (lines.length) e.stack = `${errorTitle}\n${lines.join('\n')}`;
-  return e;
-}
-const CORE_DIR = _path.default.resolve(__dirname, '..', '..');
-const internalStackPrefixes = [CORE_DIR];
-const addInternalStackPrefix = prefix => internalStackPrefixes.push(prefix);
-exports.addInternalStackPrefix = addInternalStackPrefix;
-function captureRawStack() {
-  const stackTraceLimit = Error.stackTraceLimit;
-  Error.stackTraceLimit = 50;
-  const error = new Error();
-  const stack = error.stack || '';
-  Error.stackTraceLimit = stackTraceLimit;
-  return stack.split('\n');
-}
-function captureLibraryStackTrace() {
-  const stack = captureRawStack();
-  let parsedFrames = stack.map(line => {
-    const frame = (0, _utilsBundle.parseStackTraceLine)(line);
-    if (!frame || !frame.file) return null;
-    const isPlaywrightLibrary = frame.file.startsWith(CORE_DIR);
-    const parsed = {
-      frame,
-      frameText: line,
-      isPlaywrightLibrary
-    };
-    return parsed;
-  }).filter(Boolean);
-  let apiName = '';
-
-  // Deepest transition between non-client code calling into client
-  // code is the api entry.
-  for (let i = 0; i < parsedFrames.length - 1; i++) {
-    const parsedFrame = parsedFrames[i];
-    if (parsedFrame.isPlaywrightLibrary && !parsedFrames[i + 1].isPlaywrightLibrary) {
-      apiName = apiName || normalizeAPIName(parsedFrame.frame.function);
-      break;
-    }
-  }
-  function normalizeAPIName(name) {
-    if (!name) return '';
-    const match = name.match(/(API|JS|CDP|[A-Z])(.*)/);
-    if (!match) return name;
-    return match[1].toLowerCase() + match[2];
-  }
-
-  // This is for the inspector so that it did not include the test runner stack frames.
-  parsedFrames = parsedFrames.filter(f => {
-    if (process.env.PWDEBUGIMPL) return true;
-    if (internalStackPrefixes.some(prefix => f.frame.file.startsWith(prefix))) return false;
-    return true;
-  });
-  return {
-    frames: parsedFrames.map(p => p.frame),
-    apiName
-  };
-}
-function stringifyStackFrames(frames) {
-  const stackLines = [];
-  for (const frame of frames) {
-    if (frame.function) stackLines.push(`    at ${frame.function} (${frame.file}:${frame.line}:${frame.column})`);else stackLines.push(`    at ${frame.file}:${frame.line}:${frame.column}`);
-  }
-  return stackLines;
-}
-function captureLibraryStackText() {
-  const parsed = captureLibraryStackTrace();
-  return stringifyStackFrames(parsed.frames).join('\n');
-}
-function splitErrorMessage(message) {
-  const separationIdx = message.indexOf(':');
-  return {
-    name: separationIdx !== -1 ? message.slice(0, separationIdx) : '',
-    message: separationIdx !== -1 && separationIdx + 2 <= message.length ? message.substring(separationIdx + 2) : message
-  };
-}
-function formatCallLog(log) {
-  if (!log || !log.some(l => !!l)) return '';
-  return `
-Call log:
-${_utilsBundle.colors.dim(log.join('\n'))}
-`;
-}
-function compressCallLog(log) {
-  const lines = [];
-  for (const block of (0, _sequence.findRepeatedSubsequences)(log)) {
-    for (let i = 0; i < block.sequence.length; i++) {
-      const line = block.sequence[i];
-      const leadingWhitespace = line.match(/^\s*/);
-      const whitespacePrefix = '  ' + (leadingWhitespace === null || leadingWhitespace === void 0 ? void 0 : leadingWhitespace[0]) || '';
-      const countPrefix = `${block.count} × `;
-      if (block.count > 1 && i === 0) lines.push(whitespacePrefix + countPrefix + line.trim());else if (block.count > 1) lines.push(whitespacePrefix + ' '.repeat(countPrefix.length - 2) + '- ' + line.trim());else lines.push(whitespacePrefix + '- ' + line.trim());
-    }
-  }
-  return lines;
-}

package/lib/utils/traceUtils.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.serializeClientSideCallMetadata = serializeClientSideCallMetadata;
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-function serializeClientSideCallMetadata(metadatas) {
-  const fileNames = new Map();
-  const stacks = [];
-  for (const m of metadatas) {
-    if (!m.stack || !m.stack.length) continue;
-    const stack = [];
-    for (const frame of m.stack) {
-      let ordinal = fileNames.get(frame.file);
-      if (typeof ordinal !== 'number') {
-        ordinal = fileNames.size;
-        fileNames.set(frame.file, ordinal);
-      }
-      const stackFrame = [ordinal, frame.line || 0, frame.column || 0, frame.function || ''];
-      stack.push(stackFrame);
-    }
-    stacks.push([m.id, stack]);
-  }
-  return {
-    files: [...fileNames.keys()],
-    stacks
-  };
-}