playwright-ruby-client 1.20.2 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf7d8c81cfea6013b4c2f002b93f5b705b75db9cf5ce633ed99beda7d41263f6
-  data.tar.gz: f8a705969e6aa35661b4de50ce15e94b763ddd8b7b1c454e9a323a421fa3748b
+  metadata.gz: 5e2dee736be02c56e75b6a89e2eab014c4d205ca23688b30084ea3854f50dfda
+  data.tar.gz: a213f955daad15c58bc1edd1b123cb6768cbc6df5ec6be0b09e537a8b6ea22ec
 SHA512:
-  metadata.gz: 8971e9467e336ea9915bc1b4ec6f1b1598e6a0a797271de5897deda8073fdc16d13d346146563c1e549de4c064a8100c853248b97de2072851727465ed6e432d
-  data.tar.gz: 4245aeee24a0004ca5d8259e01b5026bab8c32f2567c6eb2e7dfa6524d01359d3cd34d495f3bd83f95443d0776c0ea4e5cd326d857de2b886cfd6eb83084ec3f
+  metadata.gz: eba2fed3585b9ef5aa1b068cfc3294acc0f134e1ecccec6fae465bfd8df52c2395d02d706cb8958342c8e1af8be2066b537bc7af9eb3da1fe3748536677ba0c0
+  data.tar.gz: 2264ea9fd32bd7b02e15453a17876c2ee5fa8d51fb5eca652242959254ead0fda4ee721e9c35a1a24c1dc005d42268fd49b4566bd844841499bb8933ba83b8a3

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

@@ -436,10 +436,12 @@ 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)
 ```
@@ -641,8 +643,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(omitDriverInstall: nil, port: nil)
 ```
 
 Returns the list of detected Android devices.

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

@@ -450,7 +450,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,10 +490,12 @@ 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)
 ```

data/documentation/docs/api/page.md

@@ -1013,12 +1013,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)
 ```
@@ -1606,6 +1608,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/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": {