playwright-ruby-client 1.15.beta2 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2247f39a5fa4881e45ad884606295d7003b3e42ca9db5436b223d921649e5553
-  data.tar.gz: f7f57d5044c66e300912578faa1d8114ee98f2eb1de736eac3da698e7851b9d6
+  metadata.gz: d6230bd49d8e914d2ba9f4d23910e69fcc003f983cf51abb142d4361e1332fd6
+  data.tar.gz: 9cf6be0bde1f294a50604f22f8be756040a02af94c61fff376354c5b1ec8d9fe
 SHA512:
-  metadata.gz: 86b2003368d06755bfef64cebe40c716ef9d0156d6bd21f18fddc79cef07ffee5a48f562294c32b956dd664b5480326587736ee56334c76e80e8a8e2b89dfb72
-  data.tar.gz: 20697ed55fb7ce54856d04dc0f9568316d5941b0b103ce5c0138e680a28aeda1b7876a3cf4d358f006a2b5d7115a267ed8e7c689064bf54f65e6797848d69a2f
+  metadata.gz: 97bcd9185a7ac82910dcbae93c0131cf285b9c73d881705ae9b88b01fef388b999b4001e37f866f229dba2a0cb0d81af65bee34cb4301eaf16389b927aaba334
+  data.tar.gz: 047dd6e73800e629a439341d720df9e9281e9456f5f94eeeeaf475de7d439c5b0bf97332242497937684ae919e8b603f1b532a97cf6880f16c77f4f42d400ab2

data/documentation/docs/api/api_request_context.md

@@ -0,0 +1,10 @@
+---
+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
+logged in and vice versa.

data/documentation/docs/api/browser_context.md

@@ -11,7 +11,7 @@ BrowserContexts provide a way to operate multiple independent browser sessions.
 If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser
 context.
 
-Playwright allows creation of "incognito" browser contexts with [Browser#new_context](./browser#new_context) method. "Incognito" browser
+Playwright allows creating "incognito" browser contexts with [Browser#new_context](./browser#new_context) method. "Incognito" browser
 contexts don't write any browsing data to disk.
 
 ```ruby

data/documentation/docs/api/locator.md

@@ -677,3 +677,21 @@ If the element is detached from the DOM at any moment during the action, this me
 
 When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
 zero timeout disables this.
+
+## wait_for
+
+```
+def wait_for(state: nil, timeout: nil)
+```
+
+Returns when element specified by locator satisfies the `state` option.
+
+If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to `timeout`
+milliseconds until the condition is met.
+
+```ruby
+order_sent = page.locator("#order-sent")
+order_sent.wait_for
+```
+
+

data/documentation/docs/api/mouse.md

@@ -66,3 +66,14 @@ def up(button: nil, clickCount: nil)
 ```
 
 Dispatches a `mouseup` event.
+
+## wheel
+
+```
+def wheel(deltaX, deltaY)
+```
+
+Dispatches a `wheel` event.
+
+> NOTE: Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to
+finish before returning.

data/documentation/docs/api/page.md

@@ -1141,7 +1141,8 @@ In the case of multiple pages in a single browser, each page can have its own vi
 [Browser#new_context](./browser#new_context) allows to set viewport size (and more) for all pages in the context at once.
 
 `page.setViewportSize` will resize the page. A lot of websites don't expect phones to change size, so you should set the
-viewport size before navigating to the page.
+viewport size before navigating to the page. [Page#set_viewport_size](./page#set_viewport_size) will also reset `screen` size, use
+[Browser#new_context](./browser#new_context) with `screen` and `viewport` parameters if you need better control of these properties.
 
 ```ruby
 page.viewport_size = { width: 640, height: 480 }

data/documentation/docs/api/request.md

@@ -65,7 +65,15 @@ def headers_array
 ```
 
 An array with all the request HTTP headers associated with this request. Unlike [Request#all_headers](./request#all_headers), header
-names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+
+## header_value
+
+```
+def header_value(name)
+```
+
+Returns the value of the header matching the name. The name is case insensitive.
 
 ## navigation_request?
 
@@ -179,8 +187,7 @@ Returns the matching [Response](./response) object, or `null` if the response wa
 def sizes
 ```
 
-Returns resource size information for given request. Requires the response to be finished via
-[Response#finished](./response#finished) to ensure the info is available.
+Returns resource size information for given request.
 
 ## timing
 

data/documentation/docs/api/response.md

@@ -28,7 +28,7 @@ Returns the buffer with response body.
 def finished
 ```
 
-Waits for this response to finish, returns failure error if request failed.
+Waits for this response to finish, returns always `null`.
 
 ## frame
 
@@ -53,7 +53,25 @@ def headers_array
 ```
 
 An array with all the request HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header
-names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+
+## header_value
+
+```
+def header_value(name)
+```
+
+Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name
+(except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If
+no headers are found, `null` is returned.
+
+## header_values
+
+```
+def header_values(name)
+```
+
+Returns all values of the headers matching the name, for example `set-cookie`. The name is case insensitive.
 
 ## json
 

data/documentation/docs/include/api_coverage.md

@@ -1,5 +1,17 @@
 # API coverages
 
+## APIRequestContext
+
+* ~~delete~~
+* ~~dispose~~
+* ~~fetch~~
+* ~~get~~
+* ~~head~~
+* ~~patch~~
+* ~~post~~
+* ~~put~~
+* ~~storage_state~~
+
 ## Request
 
 * all_headers
@@ -7,6 +19,7 @@
 * frame
 * headers
 * headers_array
+* header_value
 * navigation_request?
 * method
 * post_data
@@ -28,6 +41,8 @@
 * frame
 * headers
 * headers_array
+* header_value
+* header_values
 * json
 * ok
 * request
@@ -67,6 +82,7 @@
 * down
 * move
 * up
+* wheel
 
 ## Touchscreen
 
@@ -430,6 +446,7 @@
 * text_content
 * type
 * uncheck
+* wait_for
 
 ## Android
 

data/documentation/package.json

@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.5",
-    "@docusaurus/preset-classic": "^2.0.0-beta.5",
+    "@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",
     "clsx": "^1.1.1",