playwright-ruby-client 1.60.0 → 1.61.0

data/lib/playwright_api/page.rb

@@ -53,6 +53,18 @@ module Playwright
       wrap_impl(@impl.keyboard)
     end
 
+    #
+    # Provides access to the page's `localStorage` for the current origin. See `WebStorage`.
+    def local_storage # property
+      wrap_impl(@impl.local_storage)
+    end
+
+    #
+    # Provides access to the page's `sessionStorage` for the current origin. See `WebStorage`.
+    def session_storage # property
+      wrap_impl(@impl.session_storage)
+    end
+
     def mouse # property
       wrap_impl(@impl.mouse)
     end
@@ -402,7 +414,7 @@ module Playwright
     # `ElementHandle` instances can be passed as an argument to the [`method: Page.evaluate`]:
     #
     # ```python sync
-    # body_handle = page.evaluate("document.body")
+    # body_handle = page.evaluate_handle("document.body")
     # html = page.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
     # body_handle.dispose()
     # ```
@@ -1495,7 +1507,7 @@ module Playwright
     # When all steps combined have not finished during the specified `timeout`, this method throws a
     # `TimeoutError`. Passing zero timeout disables this.
     #
-    # **NOTE**: [`method: Page.tap`] the method will throw if `hasTouch` option of the browser context is false.
+    # **NOTE**: [`method: Page.tap`] will throw if the `hasTouch` option of the browser context is false.
     def tap_point(
           selector,
           force: nil,
@@ -1868,29 +1880,24 @@ module Playwright
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
-    # @nodoc
-    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
-    end
-
     # @nodoc
     def _assertions(timeout, is_not, message)
       wrap_impl(@impl._assertions(unwrap_impl(timeout), unwrap_impl(is_not), unwrap_impl(message)))
     end
 
     # @nodoc
-    def guid
-      wrap_impl(@impl.guid)
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
-    def owned_context=(req)
-      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
+    def snapshot_for_ai(timeout: nil, depth: nil, boxes: nil, _track: nil)
+      wrap_impl(@impl.snapshot_for_ai(timeout: unwrap_impl(timeout), depth: unwrap_impl(depth), boxes: unwrap_impl(boxes), _track: unwrap_impl(_track)))
     end
 
     # @nodoc
-    def snapshot_for_ai(timeout: nil, depth: nil, boxes: nil, _track: nil)
-      wrap_impl(@impl.snapshot_for_ai(timeout: unwrap_impl(timeout), depth: unwrap_impl(depth), boxes: unwrap_impl(boxes), _track: unwrap_impl(_track)))
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
     end
 
     # @nodoc
@@ -1899,19 +1906,18 @@ module Playwright
     end
 
     # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
+    def stop_css_coverage
+      wrap_impl(@impl.stop_css_coverage)
     end
 
     # @nodoc
-    def stop_css_coverage
-      wrap_impl(@impl.stop_css_coverage)
+    def guid
+      wrap_impl(@impl.guid)
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def owned_context=(req)
+      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --
@@ -1926,6 +1932,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

@@ -103,12 +103,6 @@ module Playwright
       wrap_impl(@impl.electron)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -121,6 +115,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/request.rb

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

data/lib/playwright_api/response.rb

@@ -133,12 +133,6 @@ module Playwright
       wrap_impl(@impl.from_service_worker?)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -151,6 +145,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/route.rb

@@ -177,12 +177,6 @@ module Playwright
       wrap_impl(@impl.redirect_navigation_request(unwrap_impl(url)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -195,6 +189,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/touchscreen.rb

@@ -9,7 +9,7 @@ module Playwright
     #
     # Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).
     #
-    # **NOTE**: [`method: Page.tap`] the method will throw if `hasTouch` option of the browser context is false.
+    # **NOTE**: [`method: Touchscreen.tap`] will throw if the `hasTouch` option of the browser context is false.
     def tap_point(x, y)
       wrap_impl(@impl.tap_point(unwrap_impl(x), unwrap_impl(y)))
     end

data/lib/playwright_api/tracing.rb

@@ -127,12 +127,6 @@ module Playwright
       wrap_impl(@impl.stop_har)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -145,6 +139,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/web_socket.rb

@@ -34,12 +34,6 @@ module Playwright
       wrap_impl(@impl.wait_for_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -52,6 +46,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/web_storage.rb

@@ -0,0 +1,48 @@
+module Playwright
+  #
+  # WebStorage exposes the page's `localStorage` or `sessionStorage` for the current origin via an async,
+  # [browser-consistent](https://developer.mozilla.org/en-US/docs/Web/API/Storage) API.
+  #
+  # Instances are accessed through [`property: Page.localStorage`] and [`property: Page.sessionStorage`].
+  #
+  # ```python sync
+  # page.goto("https://example.com")
+  # page.local_storage.set_item("token", "abc")
+  # token = page.local_storage.get_item("token")
+  # all = page.local_storage.items()
+  # page.local_storage.remove_item("token")
+  # page.local_storage.clear()
+  # ```
+  class WebStorage < PlaywrightApi
+
+    #
+    # Returns all items in the storage as name/value pairs.
+    def items
+      wrap_impl(@impl.items)
+    end
+
+    #
+    # Returns the value for the given `name` if present.
+    def get_item(name)
+      wrap_impl(@impl.get_item(unwrap_impl(name)))
+    end
+
+    #
+    # Sets the value for the given `name`. Overwrites any existing value for that name.
+    def set_item(name, value)
+      wrap_impl(@impl.set_item(unwrap_impl(name), unwrap_impl(value)))
+    end
+
+    #
+    # Removes the item with the given `name`. No-op if the item is absent.
+    def remove_item(name)
+      wrap_impl(@impl.remove_item(unwrap_impl(name)))
+    end
+
+    #
+    # Removes all items from the storage.
+    def clear
+      wrap_impl(@impl.clear)
+    end
+  end
+end

data/lib/playwright_api/worker.rb

@@ -63,20 +63,14 @@ module Playwright
       wrap_impl(@impl.expect_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
-    # @nodoc
-    def context=(req)
-      wrap_impl(@impl.context=(unwrap_impl(req)))
-    end
-
     # @nodoc
     def page=(req)
       wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def context=(req)
+      wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --
@@ -91,6 +85,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/sig/playwright.rbs

@@ -376,6 +376,8 @@ module Playwright
 
     attr_reader clock: Clock
     attr_reader keyboard: Keyboard
+    attr_reader local_storage: WebStorage
+    attr_reader session_storage: WebStorage
     attr_reader mouse: Mouse
     attr_reader request: APIRequestContext
     attr_reader screencast: untyped
@@ -421,6 +423,7 @@ module Playwright
     def expect_page: (?predicate: function, ?timeout: Float) { () -> void } -> Page
 
     attr_reader clock: Clock
+    attr_reader credentials: Credentials
     attr_reader request: APIRequestContext
     attr_reader tracing: Tracing
   end
@@ -447,7 +450,7 @@ module Playwright
 
   class BrowserType
     def connect: (String endpoint, ?exposeNetwork: String, ?headers: Hash[untyped, untyped], ?slowMo: Float, ?timeout: Float) ?{ (untyped) -> untyped } -> Browser
-    def connect_over_cdp: (String endpointURL, ?headers: Hash[untyped, untyped], ?isLocal: bool, ?noDefaults: bool, ?slowMo: Float, ?timeout: Float) ?{ (untyped) -> untyped } -> Browser
+    def connect_over_cdp: (String endpointURL, ?artifactsDir: (String | File), ?headers: Hash[untyped, untyped], ?isLocal: bool, ?noDefaults: bool, ?slowMo: Float, ?timeout: Float) ?{ (untyped) -> untyped } -> Browser
     def executable_path: -> String
     def launch: (?args: Array[untyped], ?artifactsDir: (String | File), ?channel: String, ?chromiumSandbox: bool, ?downloadsPath: (String | File), ?env: Hash[untyped, untyped], ?executablePath: (String | File), ?firefoxUserPrefs: Hash[untyped, untyped], ?handleSIGHUP: bool, ?handleSIGINT: bool, ?handleSIGTERM: bool, ?headless: bool, ?ignoreDefaultArgs: (bool | Array[untyped]), ?proxy: Hash[untyped, untyped], ?slowMo: Float, ?timeout: Float, ?tracesDir: (String | File)) ?{ (Browser) -> untyped } -> Browser
     def launch_persistent_context: ((String | File) userDataDir, ?acceptDownloads: bool, ?args: Array[untyped], ?artifactsDir: (String | File), ?baseURL: String, ?bypassCSP: bool, ?channel: String, ?chromiumSandbox: bool, ?clientCertificates: Array[untyped], ?colorScheme: ("light" | "dark" | "no-preference" | "null"), ?contrast: ("no-preference" | "more" | "null"), ?deviceScaleFactor: Float, ?downloadsPath: (String | File), ?env: Hash[untyped, untyped], ?executablePath: (String | File), ?extraHTTPHeaders: Hash[untyped, untyped], ?firefoxUserPrefs: Hash[untyped, untyped], ?forcedColors: ("active" | "none" | "null"), ?geolocation: Hash[untyped, untyped], ?handleSIGHUP: bool, ?handleSIGINT: bool, ?handleSIGTERM: bool, ?hasTouch: bool, ?headless: bool, ?httpCredentials: Hash[untyped, untyped], ?ignoreDefaultArgs: (bool | Array[untyped]), ?ignoreHTTPSErrors: bool, ?isMobile: bool, ?javaScriptEnabled: bool, ?locale: String, ?noViewport: bool, ?offline: bool, ?permissions: Array[untyped], ?proxy: Hash[untyped, untyped], ?record_har_content: ("omit" | "embed" | "attach"), ?record_har_mode: ("full" | "minimal"), ?record_har_omit_content: bool, ?record_har_path: (String | File), ?record_har_url_filter: (String | Regexp), ?record_video_dir: (String | File), ?record_video_size: Hash[untyped, untyped], ?reducedMotion: ("reduce" | "no-preference" | "null"), ?screen: Hash[untyped, untyped], ?serviceWorkers: ("allow" | "block"), ?slowMo: Float, ?strictSelectors: bool, ?timeout: Float, ?timezoneId: String, ?tracesDir: (String | File), ?userAgent: String, ?viewport: (nil | Hash[untyped, untyped])) ?{ (untyped) -> untyped } -> BrowserContext
@@ -572,6 +575,8 @@ module Playwright
     def headers_array: -> Array[untyped]
     def json: -> untyped
     def ok: -> bool
+    def security_details: -> (nil | Hash[untyped, untyped])
+    def server_addr: -> (nil | Hash[untyped, untyped])
     def status: -> Integer
     def status_text: -> String
     def text: -> String
@@ -659,5 +664,20 @@ module Playwright
     def to_have_url: ((String | Regexp) urlOrRegExp, ?ignoreCase: bool, ?timeout: Float) -> void
   end
 
+  class WebStorage
+    def items: -> Array[untyped]
+    def get_item: (String name) -> (nil | String)
+    def set_item: (String name, String value) -> void
+    def remove_item: (String name) -> void
+    def clear: -> void
+  end
+
+  class Credentials
+    def install: -> void
+    def create: (String rpId, ?id: String, ?privateKey: String, ?publicKey: String, ?userHandle: String) -> Hash[untyped, untyped]
+    def delete: (String id) -> void
+    def get: (?id: String, ?rpId: String) -> Array[untyped]
+  end
+
   def self.create: (playwright_cli_executable_path: String) { (Playwright) -> void } -> void
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.60.0
+  version: 1.61.0
 platform: ruby
 authors:
 - YusukeIwaki
@@ -245,6 +245,7 @@ files:
 - documentation/docs/api/cdp_session.md
 - documentation/docs/api/clock.md
 - documentation/docs/api/console_message.md
+- documentation/docs/api/credentials.md
 - documentation/docs/api/dialog.md
 - documentation/docs/api/download.md
 - documentation/docs/api/element_handle.md
@@ -267,6 +268,7 @@ files:
 - documentation/docs/api/touchscreen.md
 - documentation/docs/api/tracing.md
 - documentation/docs/api/web_socket.md
+- documentation/docs/api/web_storage.md
 - documentation/docs/api/worker.md
 - documentation/docs/article/api_coverage.mdx
 - documentation/docs/article/getting_started.md
@@ -338,6 +340,7 @@ files:
 - lib/playwright/clock_impl.rb
 - lib/playwright/connection.rb
 - lib/playwright/console_message_impl.rb
+- lib/playwright/credentials_impl.rb
 - lib/playwright/disposable.rb
 - lib/playwright/download_impl.rb
 - lib/playwright/errors.rb
@@ -380,6 +383,7 @@ files:
 - lib/playwright/waiter.rb
 - lib/playwright/web_socket_client.rb
 - lib/playwright/web_socket_transport.rb
+- lib/playwright/web_storage_impl.rb
 - lib/playwright_api/api_request.rb
 - lib/playwright_api/api_request_context.rb
 - lib/playwright_api/api_response.rb
@@ -389,6 +393,7 @@ files:
 - lib/playwright_api/cdp_session.rb
 - lib/playwright_api/clock.rb
 - lib/playwright_api/console_message.rb
+- lib/playwright_api/credentials.rb
 - lib/playwright_api/dialog.rb
 - lib/playwright_api/download.rb
 - lib/playwright_api/element_handle.rb
@@ -410,6 +415,7 @@ files:
 - lib/playwright_api/touchscreen.rb
 - lib/playwright_api/tracing.rb
 - lib/playwright_api/web_socket.rb
+- lib/playwright_api/web_storage.rb
 - lib/playwright_api/worker.rb
 - playwright.gemspec
 - sig/playwright.rbs
@@ -433,5 +439,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.60.0
+summary: The Ruby binding of playwright driver 1.61.1
 test_files: []