playwright-ruby-client 1.62.0 → 1.63.0

data/lib/playwright_api/browser_context.rb

@@ -423,13 +423,13 @@ module Playwright
     alias_method :offline=, :set_offline
 
     #
-    # Returns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot and virtual WebAuthn credentials.
-    def storage_state(credentials: nil, indexedDB: nil, path: nil)
-      wrap_impl(@impl.storage_state(credentials: unwrap_impl(credentials), indexedDB: unwrap_impl(indexedDB), path: unwrap_impl(path)))
+    # Returns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot, origin private file system snapshot and virtual WebAuthn credentials.
+    def storage_state(credentials: nil, indexedDB: nil, opfs: nil, path: nil)
+      wrap_impl(@impl.storage_state(credentials: unwrap_impl(credentials), indexedDB: unwrap_impl(indexedDB), opfs: unwrap_impl(opfs), path: unwrap_impl(path)))
     end
 
     #
-    # Clears the existing cookies, local storage, IndexedDB entries and virtual WebAuthn credentials, and sets the new storage
+    # Clears the existing cookies, local storage, IndexedDB entries, origin private file system entries and virtual WebAuthn credentials, and sets the new storage
     # state. When the storage state contains credentials, the virtual WebAuthn authenticator is installed (equivalent to
     # [`method: Credentials.install`]), preventing all real authenticators from working in this context.
     #
@@ -498,11 +498,21 @@ module Playwright
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
+    # @nodoc
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def browser=(req)
       wrap_impl(@impl.browser=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def enable_debug_console!
       wrap_impl(@impl.enable_debug_console!)
@@ -513,14 +523,10 @@ module Playwright
       wrap_impl(@impl.pause)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
-    end
-
-    # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -535,12 +541,6 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_type.rb

@@ -188,20 +188,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/cdp_session.rb

@@ -33,20 +33,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/dialog.rb

@@ -70,20 +70,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/element_handle.rb

@@ -583,20 +583,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/frame.rb

@@ -347,6 +347,10 @@ module Playwright
     # When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
     # in that iframe.
     #
+    # When called without `selector`, the search starts in this frame or in any of the iframes inside it,
+    # so that you don't need to locate each iframe first. Note that the rest of the locator is resolved inside a single
+    # frame, just like any other locator. If it matches elements inside multiple frames, an error is thrown.
+    #
     # **Usage**
     #
     # Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe id="my-frame">`:
@@ -355,7 +359,14 @@ module Playwright
     # locator = frame.frame_locator("#my-iframe").get_by_text("Submit")
     # locator.click()
     # ```
-    def frame_locator(selector)
+    #
+    # Following snippet locates a button, either in the frame or in one of the iframes inside it:
+    #
+    # ```python sync
+    # locator = frame.frame_locator().get_by_role("button")
+    # locator.click()
+    # ```
+    def frame_locator(selector = nil)
       wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
     end
 
@@ -1054,6 +1065,16 @@ module Playwright
       wrap_impl(@impl.drop(unwrap_impl(selector), unwrap_impl(payload), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # @nodoc
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    end
+
+    # @nodoc
+    def highlight(selector, style: nil)
+      wrap_impl(@impl.highlight(unwrap_impl(selector), style: unwrap_impl(style)))
+    end
+
     # @nodoc
     def hide_highlight(selector)
       wrap_impl(@impl.hide_highlight(unwrap_impl(selector)))
@@ -1064,14 +1085,10 @@ module Playwright
       wrap_impl(@impl.expect(unwrap_impl(selector), unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
-    end
-
-    # @nodoc
-    def highlight(selector, style: nil)
-      wrap_impl(@impl.highlight(unwrap_impl(selector), style: unwrap_impl(style)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -1086,12 +1103,6 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/frame_locator.rb

@@ -19,6 +19,26 @@ module Playwright
   # page.locator('.result-frame').first.content_frame.get_by_role('button').click()
   # ```
   #
+  # **Any frame**
+  #
+  # Calling [`method: Page.frameLocator`] or [`method: Frame.frameLocator`] without a selector creates a frame locator that
+  # starts the search in any frame of the subtree - so that you don't
+  # need to locate the iframe first.
+  #
+  # ```python sync
+  # # Finds the button in any frame on the page:
+  # page.frame_locator().get_by_role("button").click()
+  #
+  # # Finds the iframe with id "my-frame" anywhere on the page, and clicks the button inside it:
+  # page.frame_locator().locator("#my-frame").content_frame.get_by_role("button").click()
+  # ```
+  #
+  # Only the start of the search is affected - the rest of the locator is resolved inside a single frame, just like any
+  # other locator. Following the strictness rules above, an error is thrown when elements are matched in multiple frames.
+  #
+  # Such a frame locator does not point to a particular `iframe`, so [`method: FrameLocator.owner`],
+  # [`method: FrameLocator.first`], [`method: FrameLocator.last`] and [`method: FrameLocator.nth`] are not supported on it.
+  #
   # **Converting Locator to FrameLocator**
   #
   # If you have a `Locator` object pointing to an `iframe` it can be converted to `FrameLocator` using [`method: Locator.contentFrame`].

data/lib/playwright_api/js_handle.rb

@@ -100,20 +100,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/locator.rb

@@ -1317,6 +1317,31 @@ module Playwright
       wrap_impl(@impl.uncheck(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
+    # Returns a locator that matches only [visible](../actionability.md#visible) elements, ignoring the invisible ones. This is the recommended way to distinguish elements by visibility, as opposed to the `:visible` CSS pseudo-class.
+    #
+    # Note that visibility is checked every time the locator is used, and not at the moment of the [`method: Locator.visible`] call.
+    #
+    # **Usage**
+    #
+    # Consider a page with two buttons, the first invisible and the second visible.
+    #
+    # ```html
+    # <button style='display: none'>Invisible</button>
+    # <button>Visible</button>
+    # ```
+    #
+    # This will only find the second button, because it is visible, and then click it.
+    #
+    # ```python sync
+    # page.locator("button").visible.click()
+    # ```
+    #
+    # To match invisible elements instead, use [`method: Locator.filter`] with the `visible` option set to `false`.
+    def visible
+      wrap_impl(@impl.visible)
+    end
+
     #
     # Returns when element specified by locator satisfies the `state` option.
     #

data/lib/playwright_api/page.rb

@@ -592,6 +592,10 @@ module Playwright
     # When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
     # in that iframe.
     #
+    # When called without `selector`, the search starts in any frame on the page - the main frame or any of
+    # the iframes - so that you don't need to locate each iframe first. Note that the rest of the locator is resolved
+    # inside a single frame, just like any other locator. If it matches elements inside multiple frames, an error is thrown.
+    #
     # **Usage**
     #
     # Following snippet locates element with text "Submit" in the iframe with id `my-frame`,
@@ -601,7 +605,14 @@ module Playwright
     # locator = page.frame_locator("#my-iframe").get_by_text("Submit")
     # locator.click()
     # ```
-    def frame_locator(selector)
+    #
+    # Following snippet locates a button, either in the main frame or in one of the iframes:
+    #
+    # ```python sync
+    # locator = page.frame_locator().get_by_role("button")
+    # locator.click()
+    # ```
+    def frame_locator(selector = nil)
       wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
     end
 
@@ -1895,13 +1906,13 @@ module Playwright
     end
 
     # @nodoc
-    def snapshot_for_ai(timeout: nil, depth: nil, boxes: nil)
-      wrap_impl(@impl.snapshot_for_ai(timeout: unwrap_impl(timeout), depth: unwrap_impl(depth), boxes: unwrap_impl(boxes)))
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
     end
 
     # @nodoc
-    def _assertions(timeout, is_not, message)
-      wrap_impl(@impl._assertions(unwrap_impl(timeout), unwrap_impl(is_not), unwrap_impl(message)))
+    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
@@ -1910,18 +1921,18 @@ module Playwright
     end
 
     # @nodoc
-    def stop_css_coverage
-      wrap_impl(@impl.stop_css_coverage)
+    def snapshot_for_ai(timeout: nil, depth: nil, boxes: nil)
+      wrap_impl(@impl.snapshot_for_ai(timeout: unwrap_impl(timeout), depth: unwrap_impl(depth), boxes: unwrap_impl(boxes)))
     end
 
     # @nodoc
-    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
+    def stop_css_coverage
+      wrap_impl(@impl.stop_css_coverage)
     end
 
     # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
+    def _assertions(timeout, is_not, message)
+      wrap_impl(@impl._assertions(unwrap_impl(timeout), unwrap_impl(is_not), unwrap_impl(message)))
     end
 
     # @nodoc
@@ -1936,20 +1947,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/playwright.rb

@@ -105,20 +105,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/request.rb

@@ -217,14 +217,20 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # @nodoc
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    end
+
     # @nodoc
     def apply_fallback_overrides(overrides)
       wrap_impl(@impl.apply_fallback_overrides(unwrap_impl(overrides)))
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def header_values(name)
-      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -239,12 +245,6 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/response.rb

@@ -135,20 +135,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/route.rb

@@ -179,20 +179,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/tracing.rb

@@ -34,13 +34,15 @@ module Playwright
     # context.tracing.stop(path = "trace.zip")
     # ```
     def start(
+          ariaSnapshots: nil,
           live: nil,
           name: nil,
           screenshots: nil,
+          screenSnapshots: nil,
           snapshots: nil,
           sources: nil,
           title: nil)
-      wrap_impl(@impl.start(live: unwrap_impl(live), name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots), sources: unwrap_impl(sources), title: unwrap_impl(title)))
+      wrap_impl(@impl.start(ariaSnapshots: unwrap_impl(ariaSnapshots), live: unwrap_impl(live), name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), screenSnapshots: unwrap_impl(screenSnapshots), snapshots: unwrap_impl(snapshots), sources: unwrap_impl(sources), title: unwrap_impl(title)))
     end
 
     #
@@ -70,7 +72,7 @@ module Playwright
     #
     # Start recording a HAR (HTTP Archive) of network activity in this context. The HAR file is written to disk when [`method: Tracing.stopHar`] is called, or when the returned `Disposable` is disposed.
     #
-    # Only one HAR recording can be active at a time per `BrowserContext`.
+    # Only one HAR recording can be active at a time per `Tracing` instance.
     #
     # **Usage**
     #
@@ -129,20 +131,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/web_socket.rb

@@ -36,20 +36,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy