playwright-ruby-client 1.20.1 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ac92a21e56cb8136a67c37b4f0a7f5edd5668124c8f54a7d676fd384568fd6
-  data.tar.gz: 8d1f15d0f9c3dfc190d0cc0976814ab6bf90a927af722d4164861e57c93564a2
+  metadata.gz: 82040f41eb8c972a8e3415aac148c27218e9fcbb00d7e09832bd75da506d2367
+  data.tar.gz: a42be0ab4e00bb0ef36516474cca8220147d8c635e44c581c799ee65e396721f
 SHA512:
-  metadata.gz: 746dcb1563f9777c374572d2b7ecfbde7833a3ce1b546933958ae920a417d1e474e27c8b569b3fc25cc117735e07bdb420dec838baadebe6375ab83d13c959bd
-  data.tar.gz: a9dca767fdfec65ba0ef854677e600ef00fabfbdd60ad534fb5182e292c603eb4cbb1b1eb77440f85415d5189bce902d3899389033c591f6e1d1d925de67afc4
+  metadata.gz: 615d15f014ca5f175d9da7504583693903d0ebd4c3d47522bf2f5c0add5aa01f26551300834b86cd944a2eacb2ef38062c341ec14f1177b7f517a16dab6e90fe
+  data.tar.gz: 97de038214b07abfbeb9eece923c0b031793b8939107df5f7b37268dbb4598c188dc88c4870766cf31d0bf28416610f46c996518a2f37fc8c73d5b672f713005

data/documentation/docs/api/api_request_context.md

@@ -5,10 +5,23 @@ sidebar_position: 10
 # APIRequestContext
 
 This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
-environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
-the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
+environment or the service to your e2e test.
+
+Each Playwright browser context has associated with it [APIRequestContext](./api_request_context) instance which shares cookie storage with the
+browser context and can be accessed via [BrowserContext#request](./browser_context#request) or [Page#request](./page#request). It is also
+possible to create a new APIRequestContext instance manually by calling [APIRequest#new_context](./api_request#new_context).
+
+**Cookie management**
+
+[APIRequestContext](./api_request_context) retuned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie storage
+with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values from the
+browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context) cookies
+and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
 logged in and vice versa.
 
+If you want API requests to not interfere with the browser cookies you shoud create a new [APIRequestContext](./api_request_context) by calling
+[APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
+
 ```ruby
 playwright.chromium.launch do |browser|
   # This will launch a new browser, create a context and page. When making HTTP

data/documentation/docs/api/browser_type.md

@@ -31,7 +31,7 @@ def connect_over_cdp(
       &block)
 ```
 
-This methods attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
+This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
 
 The default browser context is accessible via [Browser#contexts](./browser#contexts).
 

data/documentation/docs/api/console_message.md

@@ -4,7 +4,33 @@ sidebar_position: 10
 
 # ConsoleMessage
 
-[ConsoleMessage](./console_message) objects are dispatched by page via the [`event: Page.console`] event.
+[ConsoleMessage](./console_message) objects are dispatched by page via the [`event: Page.console`] event. For each console messages logged
+in the page there will be corresponding event in the Playwright context.
+
+```ruby
+# Listen for all console logs
+page.on("console", ->(msg) { puts msg.text })
+
+# Listen for all console events and handle errors
+page.on("console", ->(msg) {
+  if msg.type == 'error'
+    puts "error: #{msg.text}"
+  end
+})
+
+# Get the next console log
+msg = page.expect_console_message do
+  # Issue console.log inside the page
+  page.evaluate("console.error('hello', 42, { foo: 'bar' })")
+end
+
+# Deconstruct print arguments
+msg.args[0].json_value # => 'hello'
+msg.args[1].json_value # => 42
+msg.args[2].json_value # => { 'foo' => 'bar' }
+```
+
+
 
 ## args
 

data/documentation/docs/api/element_handle.md

@@ -330,7 +330,10 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -436,19 +439,25 @@ The method finds all elements matching the specified selector in the [ElementHan
 ```
 def screenshot(
       animations: nil,
+      caret: nil,
       mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
+      scale: nil,
       timeout: nil,
       type: nil)
 ```
 
-Returns the buffer with the captured screenshot.
+This method captures a screenshot of the page, clipped to the size and position of this particular element. If the
+element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable
+container, only the currently scrolled content will be visible on the screenshot.
 
 This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking a
 screenshot. If the element is detached from DOM, the method throws an error.
 
+Returns the buffer with the captured screenshot.
+
 ## scroll_into_view_if_needed
 
 ```
@@ -511,6 +520,10 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+If the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the
+control instead.
+
 ## set_checked
 
 ```
@@ -544,11 +557,13 @@ def set_input_files(files, noWaitAfter: nil, timeout: nil)
 ```
 alias: `input_files=`
 
-This method expects `elementHandle` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects [ElementHandle](./element_handle) to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 
@@ -641,8 +656,8 @@ def wait_for_element_state(state, timeout: nil)
 
 Returns when the element satisfies the `state`.
 
-Depending on the `state` parameter, this method waits for one of the [actionability](https://playwright.dev/python/docs/actionability) checks to pass.
-This method throws when the element is detached while waiting, unless waiting for the `"hidden"` state.
+Depending on the `state` parameter, this method waits for one of the [actionability](https://playwright.dev/python/docs/actionability) checks to
+pass. This method throws when the element is detached while waiting, unless waiting for the `"hidden"` state.
 - `"visible"` Wait until the element is [visible](https://playwright.dev/python/docs/actionability).
 - `"hidden"` Wait until the element is [not visible](https://playwright.dev/python/docs/actionability) or
   [not attached](https://playwright.dev/python/docs/actionability). Note that waiting for hidden does not throw when the element detaches.

data/documentation/docs/api/experimental/android.md

@@ -33,7 +33,7 @@ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
 ## devices
 
 ```
-def devices(port: nil)
+def devices(host: nil, omitDriverInstall: nil, port: nil)
 ```
 
 Returns the list of detected Android devices.

data/documentation/docs/api/file_chooser.md

@@ -47,4 +47,4 @@ def set_files(files, noWaitAfter: nil, timeout: nil)
 alias: `files=`
 
 Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths, then
-they are resolved relative to the the current working directory. For empty array, clears the selected files.
+they are resolved relative to the current working directory. For empty array, clears the selected files.

data/documentation/docs/api/frame.md

@@ -486,7 +486,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -556,6 +559,8 @@ The method returns an element locator that can be used to perform actions in the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
+
 ## name
 
 ```
@@ -724,11 +729,13 @@ def set_input_files(
       timeout: nil)
 ```
 
-This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects `selector` to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

data/documentation/docs/api/frame_locator.md

@@ -76,4 +76,4 @@ The method finds an element matching the specified selector in the FrameLocator'
 def nth(index)
 ```
 
-Returns locator to the n-th matching frame.
+Returns locator to the n-th matching frame. It's zero based, `nth(0)` selects the first frame.

data/documentation/docs/api/locator.md

@@ -285,6 +285,14 @@ instead.
 
 To send fine-grained keyboard events, use [Locator#type](./locator#type).
 
+## filter
+
+```
+def filter(has: nil, hasText: nil)
+```
+
+This method narrows existing locator according to the options, for example filters by text.
+
 ## first
 
 ```
@@ -378,7 +386,10 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -442,7 +453,8 @@ Returns locator to the last matching element.
 def locator(selector, has: nil, hasText: nil)
 ```
 
-The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
+The method finds an element matching the specified selector in the [Locator](./locator)'s subtree. It also accepts filter options,
+similar to [Locator#filter](./locator#filter) method.
 
 ## nth
 
@@ -450,7 +462,7 @@ The method finds an element matching the specified selector in the [Locator](./l
 def nth(index)
 ```
 
-Returns locator to the n-th matching element.
+Returns locator to the n-th matching element. It's zero based, `nth(0)` selects the first element.
 
 ## page
 
@@ -490,19 +502,25 @@ modifier, modifier is pressed and being held while the subsequent key is being p
 ```
 def screenshot(
       animations: nil,
+      caret: nil,
       mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
+      scale: nil,
       timeout: nil,
       type: nil)
 ```
 
-Returns the buffer with the captured screenshot.
+This method captures a screenshot of the page, clipped to the size and position of a particular element matching the
+locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element
+is a scrollable container, only the currently scrolled content will be visible on the screenshot.
 
 This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking a
 screenshot. If the element is detached from DOM, the method throws an error.
 
+Returns the buffer with the captured screenshot.
+
 ## scroll_into_view_if_needed
 
 ```
@@ -562,6 +580,10 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+If the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the
+control instead.
+
 ## set_checked
 
 ```
@@ -595,11 +617,13 @@ def set_input_files(files, noWaitAfter: nil, timeout: nil)
 ```
 alias: `input_files=`
 
-This method expects `element` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects [Locator](./locator) to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

data/documentation/docs/api/page.md

@@ -642,8 +642,8 @@ Navigate to the next page in history.
 def goto(url, referer: nil, timeout: nil, waitUntil: nil)
 ```
 
-Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
-last redirect.
+Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first
+non-redirect response.
 
 The method will throw an error if:
 - there's an SSL error (e.g. in case of self-signed certificates).
@@ -711,7 +711,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -781,6 +784,8 @@ The method returns an element locator that can be used to perform actions on the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
+
 Shortcut for main frame's [Frame#locator](./frame#locator).
 
 ## main_frame
@@ -1013,12 +1018,14 @@ To remove a route with its handler you can use [Page#unroute](./page#unroute).
 ```
 def screenshot(
       animations: nil,
+      caret: nil,
       clip: nil,
       fullPage: nil,
       mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
+      scale: nil,
       timeout: nil,
       type: nil)
 ```
@@ -1153,11 +1160,13 @@ def set_input_files(
       timeout: nil)
 ```
 
-This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects `selector` to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## set_viewport_size
 
@@ -1606,6 +1615,7 @@ associated with the page.
 
 ## request
 
-API testing helper associated with this page. Requests made with this API will use page cookies.
+API testing helper associated with this page. This method returns the same instance as
+[BrowserContext#request](./browser_context#request) on the page's context. See [BrowserContext#request](./browser_context#request) for more details.
 
 ## touchscreen

data/documentation/docs/api/route.md

@@ -7,6 +7,8 @@ sidebar_position: 10
 Whenever a network route is set up with [Page#route](./page#route) or [BrowserContext#route](./browser_context#route), the [Route](./route) object
 allows to handle the route.
 
+Learn more about [networking](https://playwright.dev/python/docs/network).
+
 ## abort
 
 ```

data/documentation/docs/include/api_coverage.md

@@ -413,6 +413,7 @@
 * evaluate_all
 * evaluate_handle
 * fill
+* filter
 * first
 * focus
 * frame_locator

data/documentation/package.json

@@ -14,14 +14,14 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.6",
-    "@docusaurus/preset-classic": "^2.0.0-beta.6",
-    "@mdx-js/react": "^1.6.21",
-    "@svgr/webpack": "^5.5.0",
+    "@docusaurus/core": "^2.0.0-beta.18",
+    "@docusaurus/preset-classic": "^2.0.0-beta.18",
+    "@mdx-js/react": "^1.6.22",
+    "@svgr/webpack": "^6.2.1",
     "clsx": "^1.1.1",
     "file-loader": "^6.2.0",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "url-loader": "^4.1.1"
   },
   "browserslist": {