chore: generate versioned docs

docs/supported-browsers.md

@@ -10,6 +10,7 @@ The following versions of the browsers are supported, mapped to Puppeteer versio
 
 <!-- version-start -->
 
+- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 124.0.6367.91 - [Puppeteer v22.8.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.8.0/docs/api/index.md)
 - [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 124.0.6367.78 - [Puppeteer v22.7.1](https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.7.1/docs/api/index.md)
 - [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 124.0.6367.60 - [Puppeteer v22.7.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.7.0/docs/api/index.md)
 - [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 123.0.6312.122 - [Puppeteer v22.6.4](https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.6.4/docs/api/index.md)

versions.js

@@ -7,7 +7,7 @@
 const versionsPerRelease = new Map([
   // This is a mapping from Chrome version => Puppeteer version.
   // In Chrome roll patches, use `NEXT` for the Puppeteer version.
-  ['124.0.6367.91', 'NEXT'],
+  ['124.0.6367.91', 'v22.8.0'],
   ['124.0.6367.78', 'v22.7.1'],
   ['124.0.6367.60', 'v22.7.0'],
   ['123.0.6312.122', 'v22.6.4'],

website/versioned_docs/version-22.7.1/api/puppeteer.accessibility.md → website/versioned_docs/version-22.8.0/api/puppeteer.accessibility.md

@@ -47,5 +47,9 @@ Description
 
 Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.
 
+**Remarks:**
+
+**NOTE** The Chrome accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
+
 </td></tr>
 </tbody></table>

website/versioned_docs/version-22.7.1/api/puppeteer.browser.md → website/versioned_docs/version-22.8.0/api/puppeteer.browser.md

@@ -104,7 +104,11 @@ Whether Puppeteer is connected to this [browser](./puppeteer.browser.md).
 
 </td><td>
 
-Get debug information from Puppeteer.
+**_(Experimental)_** Get debug information from Puppeteer.
+
+**Remarks:**
+
+Currently, includes pending protocol calls. In the future, we might add more info.
 
 </td></tr>
 </tbody></table>
@@ -171,6 +175,10 @@ This won't share cookies/cache with other [browser contexts](./puppeteer.browser
 
 Gets the default [browser context](./puppeteer.browsercontext.md).
 
+**Remarks:**
+
+The default [browser context](./puppeteer.browsercontext.md) cannot be closed.
+
 </td></tr>
 <tr><td>
 
@@ -223,6 +231,10 @@ Gets a list of all open [pages](./puppeteer.page.md) inside this [Browser](./pup
 
 If there ar multiple [browser contexts](./puppeteer.browsercontext.md), this returns all [pages](./puppeteer.page.md) in all [browser contexts](./puppeteer.browsercontext.md).
 
+**Remarks:**
+
+Non-visible [pages](./puppeteer.page.md), such as `"background_page"`, will not be listed here. You can find them using [Target.page()](./puppeteer.target.page.md).
+
 </td></tr>
 <tr><td>
 
@@ -316,5 +328,9 @@ You can find the debugger URL (`webSocketDebuggerUrl`) from `http://HOST:PORT/js
 
 See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.
 
+**Remarks:**
+
+The format is always `ws://HOST:PORT/devtools/browser/<id>`.
+
 </td></tr>
 </tbody></table>

website/versioned_docs/version-22.7.1/api/puppeteer.browsercontext.md → website/versioned_docs/version-22.8.0/api/puppeteer.browsercontext.md

@@ -141,6 +141,10 @@ Clears all permission overrides for this [browser context](./puppeteer.browserco
 
 Closes this [browser context](./puppeteer.browsercontext.md) and all associated [pages](./puppeteer.page.md).
 
+**Remarks:**
+
+The [default browser context](./puppeteer.browser.defaultbrowsercontext.md) cannot be closed.
+
 </td></tr>
 <tr><td>
 
@@ -193,6 +197,10 @@ Grants this [browser context](./puppeteer.browsercontext.md) the given `permissi
 
 Gets a list of all open [pages](./puppeteer.page.md) inside this [browser context](./puppeteer.browsercontext.md).
 
+**Remarks:**
+
+Non-visible [pages](./puppeteer.page.md), such as `"background_page"`, will not be listed here. You can find them using [Target.page()](./puppeteer.target.page.md).
+
 </td></tr>
 <tr><td>
 

website/versioned_docs/version-22.7.1/api/puppeteer.browserevent.md → website/versioned_docs/version-22.8.0/api/puppeteer.browserevent.md

@@ -54,6 +54,10 @@ TargetChanged
 
 Emitted when the URL of a target changes. Contains a [Target](./puppeteer.target.md) instance.
 
+**Remarks:**
+
+Note that this includes target changes in all browser contexts.
+
 </td></tr>
 <tr><td>
 
@@ -69,6 +73,10 @@ Emitted when a target is created, for example when a new page is opened by [wind
 
 Contains a [Target](./puppeteer.target.md) instance.
 
+**Remarks:**
+
+Note that this includes target creations in all browser contexts.
+
 </td></tr>
 <tr><td>
 
@@ -82,5 +90,9 @@ TargetDestroyed
 
 Emitted when a target is destroyed, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance.
 
+**Remarks:**
+
+Note that this includes target destructions in all browser contexts.
+
 </td></tr>
 </tbody></table>

website/versioned_docs/version-22.7.1/api/puppeteer.browserlaunchargumentoptions.md → website/versioned_docs/version-22.8.0/api/puppeteer.browserlaunchargumentoptions.md

@@ -110,6 +110,12 @@ boolean \| 'shell'
 
 Whether to run the browser in headless mode.
 
+**Remarks:**
+
+- `true` launches the browser in the [new headless](https://developer.chrome.com/articles/new-headless/) mode.
+
+- `'shell'` launches [shell](https://developer.chrome.com/blog/chrome-headless-shell) known as the old headless mode.
+
 </td><td>
 
 `true`

website/versioned_docs/version-22.7.1/api/puppeteer.configuration.md → website/versioned_docs/version-22.8.0/api/puppeteer.configuration.md

@@ -128,6 +128,10 @@ Specifies the URL prefix that is used to download the browser.
 
 Can be overridden by `PUPPETEER_DOWNLOAD_BASE_URL`.
 
+**Remarks:**
+
+This must include the protocol and may even need a path prefix.
+
 </td><td>
 
 Either https://storage.googleapis.com/chrome-for-testing-public or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.

website/versioned_docs/version-22.7.1/api/puppeteer.connectoptions.md → website/versioned_docs/version-22.8.0/api/puppeteer.connectoptions.md

@@ -85,6 +85,10 @@ Record<string, string>
 
 Headers to use for the web socket connection.
 
+**Remarks:**
+
+Only works in the Node.js environment.
+
 </td><td>
 
 </td></tr>

website/versioned_docs/version-22.7.1/api/puppeteer.coverage.md → website/versioned_docs/version-22.8.0/api/puppeteer.coverage.md

@@ -103,6 +103,10 @@ Description
 
 </td><td>
 
+**Remarks:**
+
+Anonymous scripts are ones that don't have an associated url. These are scripts that are dynamically created on the page using `eval` or `new Function`. If `reportAnonymousScripts` is set to `true`, anonymous scripts URL will start with `debugger://VM` (unless a magic //\# sourceURL comment is present, in which case that will the be URL).
+
 </td></tr>
 <tr><td>
 
@@ -114,6 +118,10 @@ Description
 
 Promise that resolves to the array of coverage reports for all stylesheets.
 
+**Remarks:**
+
+CSS Coverage doesn't include dynamically injected style tags without sourceURLs.
+
 </td></tr>
 <tr><td>
 
@@ -125,5 +133,9 @@ Promise that resolves to the array of coverage reports for all stylesheets.
 
 Promise that resolves to the array of coverage reports for all scripts.
 
+**Remarks:**
+
+JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are reported.
+
 </td></tr>
 </tbody></table>

website/versioned_docs/version-22.7.1/api/puppeteer.elementhandle.md → website/versioned_docs/version-22.8.0/api/puppeteer.elementhandle.md

@@ -150,6 +150,25 @@ If the given function returns a promise, then this method will wait till the pro
 
 If the element is a form input, you can use [ElementHandle.autofill()](./puppeteer.elementhandle.autofill.md) to test if the form is compatible with the browser's autofill implementation. Throws an error if the form cannot be autofilled.
 
+**Remarks:**
+
+Currently, Puppeteer supports auto-filling credit card information only and in Chrome in the new headless and headful modes only.
+
+```ts
+// Select an input on the credit card form.
+const name = await page.waitForSelector('form #name');
+// Trigger autofill with the desired data.
+await name.autofill({
+  creditCard: {
+    number: '4444444444444444',
+    name: 'John Smith',
+    expiryMonth: '01',
+    expiryYear: '2030',
+    cvc: '123',
+  },
+});
+```
+
 </td></tr>
 <tr><td>
 
@@ -172,6 +191,10 @@ This method returns the bounding box of the element (relative to the main frame)
 
 This method returns boxes of the element, or `null` if the element is [not part of the layout](https://drafts.csswg.org/css-display-4/#box-generation) (example: `display: none`).
 
+**Remarks:**
+
+Boxes are represented as an array of points; Each Point is an object `{x, y}`. Box points are sorted clock-wise.
+
 </td></tr>
 <tr><td>
 
@@ -362,6 +385,12 @@ Checks if an element is visible using the same mechanism as [ElementHandle.waitF
 
 Focuses the element, and then uses [Keyboard.down()](./puppeteer.keyboard.down.md) and [Keyboard.up()](./puppeteer.keyboard.up.md).
 
+**Remarks:**
+
+If `key` is a single character and no modifier keys besides `Shift` are being held down, a `keypress`/`input` event will also be generated. The `text` option can be specified to force an input event to be generated.
+
+**NOTE** Modifier keys DO affect `elementHandle.press`. Holding down `Shift` will type the text in upper case.
+
 </td></tr>
 <tr><td>
 
@@ -477,6 +506,10 @@ To press a special key, like `Control` or `ArrowDown`, use [ElementHandle.press(
 
 Sets the value of an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) to the given file paths.
 
+**Remarks:**
+
+This will not validate whether the file paths exists. Also, if a path is relative, then it is resolved against the [current working directory](https://nodejs.org/api/process.html#process_process_cwd). For locals script connecting to remote chrome environments, paths must be absolute.
+
 </td></tr>
 <tr><td>
 

website/versioned_docs/version-22.7.1/api/puppeteer.filechooser.md → website/versioned_docs/version-22.8.0/api/puppeteer.filechooser.md

@@ -55,6 +55,10 @@ Description
 
 Accept the file chooser request with the given file paths.
 
+**Remarks:**
+
+This will not validate whether the file paths exists. Also, if a path is relative, then it is resolved against the [current working directory](https://nodejs.org/api/process.html#process_process_cwd). For locals script connecting to remote chrome environments, paths must be absolute.
+
 </td></tr>
 <tr><td>
 

website/versioned_docs/version-22.7.1/api/puppeteer.frame.md → website/versioned_docs/version-22.8.0/api/puppeteer.frame.md

@@ -214,6 +214,17 @@ An array of child frames.
 
 Clicks the first element found that matches `selector`.
 
+**Remarks:**
+
+If `click()` triggers a navigation event and there's a separate `page.waitForNavigation()` promise to be resolved, you may end up with a race condition that yields unexpected results. The correct pattern for click and wait for navigation is the following:
+
+```ts
+const [response] = await Promise.all([
+  page.waitForNavigation(waitOptions),
+  frame.click(selector, clickOptions),
+]);
+```
+
 </td></tr>
 <tr><td>
 
@@ -278,6 +289,16 @@ Focuses the first element that matches the `selector`.
 
 Navigates the frame to the given `url`.
 
+**Remarks:**
+
+Navigation to `about:blank` or navigation to the same URL with a different hash will succeed and return `null`.
+
+:::warning
+
+Headless mode doesn't support navigation to a PDF document. See the [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
+
+:::
+
 </td></tr>
 <tr><td>
 
@@ -328,6 +349,10 @@ Is `true` if the frame is an out-of-process (OOP) frame. Otherwise, `false`.
 
 Creates a locator for the provided selector. See [Locator](./puppeteer.locator.md) for details and supported actions.
 
+**Remarks:**
+
+Locators API is experimental and we will not follow semver for breaking change in the Locators API.
+
 </td></tr>
 <tr><td>
 
@@ -339,6 +364,10 @@ Creates a locator for the provided selector. See [Locator](./puppeteer.locator.m
 
 Creates a locator for the provided function. See [Locator](./puppeteer.locator.md) for details and supported actions.
 
+**Remarks:**
+
+Locators API is experimental and we will not follow semver for breaking change in the Locators API.
+
 </td></tr>
 <tr><td>
 
@@ -361,6 +390,10 @@ const element = await frame.frameElement();
 const nameOrId = await element.evaluate(frame => frame.name ?? frame.id);
 ```
 
+**Remarks:**
+
+This value is calculated once when the frame is created, and will not update if the attribute is changed later.
+
 </td></tr>
 <tr><td>
 
@@ -438,6 +471,10 @@ The frame's title.
 
 Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
 
+**Remarks:**
+
+To press a special key, like `Control` or `ArrowDown`, use [Keyboard.press()](./puppeteer.keyboard.press.md).
+
 </td></tr>
 <tr><td>
 

website/versioned_docs/version-22.7.1/api/puppeteer.frameaddscripttagoptions.md → website/versioned_docs/version-22.8.0/api/puppeteer.frameaddscripttagoptions.md

@@ -87,6 +87,10 @@ string
 
 Path to a JavaScript file to be injected into the frame.
 
+**Remarks:**
+
+If `path` is a relative path, it is resolved relative to the current working directory (`process.cwd()` in Node.js).
+
 </td><td>
 
 </td></tr>

website/versioned_docs/version-22.7.1/api/puppeteer.frameaddstyletagoptions.md → website/versioned_docs/version-22.8.0/api/puppeteer.frameaddstyletagoptions.md

@@ -68,6 +68,10 @@ string
 
 The path to a CSS file to be injected into the frame.
 
+**Remarks:**
+
+If `path` is a relative path, it is resolved relative to the current working directory (`process.cwd()` in Node.js).
+
 </td><td>
 
 </td></tr>