puppeteer-bidi 0.0.1.beta1 → 0.0.1.beta2

data/lib/puppeteer/bidi/element_handle.rb

@@ -19,17 +19,17 @@ module Puppeteer
       BoxModel = Data.define(:content, :padding, :border, :margin, :width, :height)
 
       # Factory method to create ElementHandle from remote value
-      # @rbs remote_value: Hash[String, untyped]
-      # @rbs realm: Core::Realm
-      # @rbs return: ElementHandle
+      # @rbs remote_value: Hash[String, untyped] -- BiDi RemoteValue
+      # @rbs realm: Core::Realm -- Associated realm
+      # @rbs return: ElementHandle -- ElementHandle instance
       def self.from(remote_value, realm)
         new(realm, remote_value)
       end
 
       # Query for a descendant element matching the selector
       # Supports CSS selectors and prefixed selectors (xpath/, text/, aria/, pierce/)
-      # @rbs selector: String
-      # @rbs return: ElementHandle?
+      # @rbs selector: String -- Selector to query
+      # @rbs return: ElementHandle? -- Matching element or nil
       def query_selector(selector)
         assert_not_disposed
 
@@ -39,8 +39,8 @@ module Puppeteer
 
       # Query for all descendant elements matching the selector
       # Supports CSS selectors and prefixed selectors (xpath/, text/, aria/, pierce/)
-      # @rbs selector: String
-      # @rbs return: Array[ElementHandle]
+      # @rbs selector: String -- Selector to query
+      # @rbs return: Array[ElementHandle] -- All matching elements
       def query_selector_all(selector)
         assert_not_disposed
 
@@ -49,10 +49,10 @@ module Puppeteer
       end
 
       # Evaluate a function on the first element matching the selector
-      # @rbs selector: String
-      # @rbs page_function: String
-      # @rbs *args: untyped
-      # @rbs return: untyped
+      # @rbs selector: String -- Selector to query
+      # @rbs page_function: String -- JavaScript function to evaluate
+      # @rbs *args: untyped -- Arguments to pass to the function
+      # @rbs return: untyped -- Evaluation result
       def eval_on_selector(selector, page_function, *args)
         assert_not_disposed
 
@@ -67,10 +67,10 @@ module Puppeteer
       end
 
       # Evaluate a function on all elements matching the selector
-      # @rbs selector: String
-      # @rbs page_function: String
-      # @rbs *args: untyped
-      # @rbs return: untyped
+      # @rbs selector: String -- Selector to query
+      # @rbs page_function: String -- JavaScript function to evaluate
+      # @rbs *args: untyped -- Arguments to pass to the function
+      # @rbs return: untyped -- Evaluation result
       def eval_on_selector_all(selector, page_function, *args)
         assert_not_disposed
 
@@ -102,22 +102,22 @@ module Puppeteer
       end
 
       # Wait for an element matching the selector to appear as a descendant of this element
-      # @rbs selector: String
-      # @rbs visible: bool?
-      # @rbs hidden: bool?
-      # @rbs timeout: Numeric?
-      # @rbs &block: ((ElementHandle?) -> void)?
-      # @rbs return: ElementHandle?
+      # @rbs selector: String -- Selector to wait for
+      # @rbs visible: bool? -- Wait for element to be visible
+      # @rbs hidden: bool? -- Wait for element to be hidden
+      # @rbs timeout: Numeric? -- Wait timeout in ms
+      # @rbs &block: ((ElementHandle?) -> void)? -- Optional block called with element
+      # @rbs return: ElementHandle? -- Element or nil if hidden
       def wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil, &block)
         result = QueryHandler.instance.get_query_handler_and_selector(selector)
         result.query_handler.new.wait_for(self, result.updated_selector, visible: visible, hidden: hidden, polling: result.polling, timeout: timeout, &block)
       end
 
       # Click the element
-      # @rbs button: String
-      # @rbs count: Integer
-      # @rbs delay: Numeric?
-      # @rbs offset: Hash[Symbol, Numeric]?
+      # @rbs button: String -- Mouse button ('left', 'right', 'middle')
+      # @rbs count: Integer -- Number of clicks
+      # @rbs delay: Numeric? -- Delay between clicks in ms
+      # @rbs offset: Hash[Symbol, Numeric]? -- Click offset from element center
       # @rbs return: void
       def click(button: 'left', count: 1, delay: nil, offset: nil)
         assert_not_disposed
@@ -129,8 +129,8 @@ module Puppeteer
       end
 
       # Type text into the element
-      # @rbs text: String
-      # @rbs delay: Numeric
+      # @rbs text: String -- Text to type
+      # @rbs delay: Numeric -- Delay between key presses in ms
       # @rbs return: void
       def type(text, delay: 0)
         assert_not_disposed
@@ -145,9 +145,9 @@ module Puppeteer
       end
 
       # Press a key on the element
-      # @rbs key: String
-      # @rbs delay: Numeric?
-      # @rbs text: String?
+      # @rbs key: String -- Key to press
+      # @rbs delay: Numeric? -- Delay between keydown and keyup in ms
+      # @rbs text: String? -- Text to send with key press
       # @rbs return: void
       def press(key, delay: nil, text: nil)
         assert_not_disposed
@@ -163,14 +163,14 @@ module Puppeteer
 
       # Get the frame this element belongs to
       # Following Puppeteer's pattern: realm.environment
-      # @rbs return: Frame
+      # @rbs return: Frame -- Owning frame
       def frame
         @realm.environment
       end
 
       # Get the content frame for iframe/frame elements
       # Returns the frame that the iframe/frame element refers to
-      # @rbs return: Frame?
+      # @rbs return: Frame? -- Content frame or nil
       def content_frame
         assert_not_disposed
 
@@ -204,7 +204,7 @@ module Puppeteer
       # - It has computed styles
       # - Its visibility is not 'hidden' or 'collapse'
       # - Its bounding box is not empty (width > 0 AND height > 0)
-      # @rbs return: bool
+      # @rbs return: bool -- Whether element is visible
       def visible?
         check_visibility(true)
       end
@@ -214,15 +214,15 @@ module Puppeteer
       # - It has no computed styles
       # - Its visibility is 'hidden' or 'collapse'
       # - Its bounding box is empty (width == 0 OR height == 0)
-      # @rbs return: bool
+      # @rbs return: bool -- Whether element is hidden
       def hidden?
         check_visibility(false)
       end
 
       # Convert the current handle to the given element type
       # Validates that the element matches the expected tag name
-      # @rbs tag_name: String
-      # @rbs return: ElementHandle
+      # @rbs tag_name: String -- Expected tag name
+      # @rbs return: ElementHandle -- This element if matching
       def to_element(tag_name)
         assert_not_disposed
 
@@ -253,7 +253,7 @@ module Puppeteer
 
       # Upload files to this element (for <input type="file">)
       # Following Puppeteer's implementation: ElementHandle.uploadFile -> Frame.setFiles
-      # @rbs *files: String
+      # @rbs *files: String -- File paths to upload
       # @rbs return: void
       def upload_file(*files)
         assert_not_disposed
@@ -271,7 +271,7 @@ module Puppeteer
       end
 
       # Get the remote value as a SharedReference for BiDi commands
-      # @rbs return: Hash[Symbol, String]
+      # @rbs return: Hash[Symbol, String] -- SharedReference for BiDi
       def remote_value_as_shared_reference
         if @remote_value['sharedId']
           { sharedId: @remote_value['sharedId'] }
@@ -300,8 +300,8 @@ module Puppeteer
       end
 
       # Check if element is intersecting the viewport
-      # @rbs threshold: Numeric
-      # @rbs return: bool
+      # @rbs threshold: Numeric -- Intersection ratio threshold
+      # @rbs return: bool -- Whether element intersects viewport
       def intersecting_viewport?(threshold: 0)
         assert_not_disposed
 
@@ -321,8 +321,8 @@ module Puppeteer
       end
 
       # Get clickable point for the element
-      # @rbs offset: Hash[Symbol, Numeric]?
-      # @rbs return: Point
+      # @rbs offset: Hash[Symbol, Numeric]? -- Offset from element center
+      # @rbs return: Point -- Clickable point coordinates
       def clickable_point(offset: nil)
         assert_not_disposed
 
@@ -344,7 +344,7 @@ module Puppeteer
 
       # Get the bounding box of the element
       # Uses getBoundingClientRect() to get the element's position and size
-      # @rbs return: BoundingBox?
+      # @rbs return: BoundingBox? -- Bounding box or nil if not visible
       def bounding_box
         assert_not_disposed
 
@@ -372,7 +372,7 @@ module Puppeteer
       end
 
       # Get the box model of the element (content, padding, border, margin)
-      # @rbs return: BoxModel?
+      # @rbs return: BoxModel? -- Box model or nil if not visible
       def box_model
         assert_not_disposed
 
@@ -465,7 +465,7 @@ module Puppeteer
       # Uses getClientRects() to handle wrapped/multi-line elements correctly
       # Following Puppeteer's implementation:
       # https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/api/ElementHandle.ts#clickableBox
-      # @rbs return: Hash[Symbol, Numeric]?
+      # @rbs return: Hash[Symbol, Numeric]? -- Clickable box or nil
       def clickable_box
         assert_not_disposed
 
@@ -508,7 +508,7 @@ module Puppeteer
 
       # Intersect bounding boxes with frame viewport boundaries
       # Modifies boxes in-place to clip them to visible area
-      # @rbs boxes: Array[Hash[String, Numeric]]
+      # @rbs boxes: Array[Hash[String, Numeric]] -- Bounding boxes to clip
       # @rbs return: void
       def intersect_bounding_boxes_with_frame(boxes)
         # Get document dimensions using element's evaluate (which handles deserialization)
@@ -532,9 +532,9 @@ module Puppeteer
 
       # Intersect a single bounding box with given width/height boundaries
       # Modifies box in-place
-      # @rbs box: Hash[String, Numeric]
-      # @rbs width: Numeric
-      # @rbs height: Numeric
+      # @rbs box: Hash[String, Numeric] -- Box to clip
+      # @rbs width: Numeric -- Viewport width
+      # @rbs height: Numeric -- Viewport height
       # @rbs return: void
       def intersect_bounding_box(box, width, height)
         # Clip width
@@ -559,8 +559,8 @@ module Puppeteer
       end
 
       # Check element visibility
-      # @rbs visible: bool
-      # @rbs return: bool
+      # @rbs visible: bool -- Expected visibility state
+      # @rbs return: bool -- Whether element matches visibility state
       def check_visibility(visible)
         assert_not_disposed
 
@@ -592,7 +592,7 @@ module Puppeteer
       end
 
       # String representation includes element type
-      # @rbs return: String
+      # @rbs return: String -- String representation
       def to_s
         return 'ElementHandle@disposed' if disposed?
         'ElementHandle@node'

data/lib/puppeteer/bidi/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi

data/lib/puppeteer/bidi/file_chooser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi

data/lib/puppeteer/bidi/frame.rb

@@ -10,17 +10,17 @@ module Puppeteer
       attr_reader :browsing_context #: Core::BrowsingContext
 
       # Factory method following Puppeteer's BidiFrame.from pattern
-      # @rbs parent: Page | Frame
-      # @rbs browsing_context: Core::BrowsingContext
-      # @rbs return: Frame
+      # @rbs parent: Page | Frame -- Parent page or frame
+      # @rbs browsing_context: Core::BrowsingContext -- Associated browsing context
+      # @rbs return: Frame -- New frame instance
       def self.from(parent, browsing_context)
         frame = new(parent, browsing_context)
         frame.send(:initialize_frame)
         frame
       end
 
-      # @rbs parent: Page | Frame
-      # @rbs browsing_context: Core::BrowsingContext
+      # @rbs parent: Page | Frame -- Parent page or frame
+      # @rbs browsing_context: Core::BrowsingContext -- Associated browsing context
       # @rbs return: void
       def initialize(parent, browsing_context)
         @parent = parent
@@ -34,55 +34,55 @@ module Puppeteer
         @isolated_realm = FrameRealm.new(self, internal_core_realm)
       end
 
-      # @rbs return: FrameRealm
+      # @rbs return: FrameRealm -- Main execution realm
       def main_realm
         @main_realm
       end
 
-      # @rbs return: FrameRealm
+      # @rbs return: FrameRealm -- Isolated execution realm
       def isolated_realm
         @isolated_realm
       end
 
       # Backwards compatibility for call sites that previously accessed Frame#realm.
-      # @rbs return: FrameRealm
+      # @rbs return: FrameRealm -- Main execution realm
       def realm
         main_realm
       end
 
       # Get the page that owns this frame
       # Traverses up the parent chain until reaching a Page
-      # @rbs return: Page
+      # @rbs return: Page -- Owning page
       def page
         @parent.is_a?(Page) ? @parent : @parent.page
       end
 
       # Get the parent frame
-      # @rbs return: Frame?
+      # @rbs return: Frame? -- Parent frame or nil for main frame
       def parent_frame
         @parent.is_a?(Frame) ? @parent : nil
       end
 
       # Evaluate JavaScript in the frame context
-      # @rbs script: String
-      # @rbs *args: untyped
-      # @rbs return: untyped
+      # @rbs script: String -- JavaScript code to evaluate
+      # @rbs *args: untyped -- Arguments to pass to the script
+      # @rbs return: untyped -- Evaluation result
       def evaluate(script, *args)
         assert_not_detached
         main_realm.evaluate(script, *args)
       end
 
       # Evaluate JavaScript and return a handle to the result
-      # @rbs script: String
-      # @rbs *args: untyped
-      # @rbs return: JSHandle
+      # @rbs script: String -- JavaScript code to evaluate
+      # @rbs *args: untyped -- Arguments to pass to the script
+      # @rbs return: JSHandle -- Handle to the result
       def evaluate_handle(script, *args)
         assert_not_detached
         main_realm.evaluate_handle(script, *args)
       end
 
       # Get the document element handle
-      # @rbs return: ElementHandle
+      # @rbs return: ElementHandle -- Document element handle
       def document
         assert_not_detached
         handle = main_realm.evaluate_handle('document')
@@ -94,8 +94,8 @@ module Puppeteer
       end
 
       # Query for an element matching the selector
-      # @rbs selector: String
-      # @rbs return: ElementHandle?
+      # @rbs selector: String -- Selector to query
+      # @rbs return: ElementHandle? -- Matching element or nil
       def query_selector(selector)
         doc = document
         begin
@@ -106,8 +106,8 @@ module Puppeteer
       end
 
       # Query for all elements matching the selector
-      # @rbs selector: String
-      # @rbs return: Array[ElementHandle]
+      # @rbs selector: String -- Selector to query
+      # @rbs return: Array[ElementHandle] -- All matching elements
       def query_selector_all(selector)
         doc = document
         begin
@@ -118,10 +118,10 @@ module Puppeteer
       end
 
       # Evaluate a function on the first element matching the selector
-      # @rbs selector: String
-      # @rbs page_function: String
-      # @rbs *args: untyped
-      # @rbs return: untyped
+      # @rbs selector: String -- Selector to query
+      # @rbs page_function: String -- JavaScript function to evaluate
+      # @rbs *args: untyped -- Arguments to pass to the function
+      # @rbs return: untyped -- Evaluation result
       def eval_on_selector(selector, page_function, *args)
         doc = document
         begin
@@ -132,10 +132,10 @@ module Puppeteer
       end
 
       # Evaluate a function on all elements matching the selector
-      # @rbs selector: String
-      # @rbs page_function: String
-      # @rbs *args: untyped
-      # @rbs return: untyped
+      # @rbs selector: String -- Selector to query
+      # @rbs page_function: String -- JavaScript function to evaluate
+      # @rbs *args: untyped -- Arguments to pass to the function
+      # @rbs return: untyped -- Evaluation result
       def eval_on_selector_all(selector, page_function, *args)
         doc = document
         begin
@@ -146,11 +146,11 @@ module Puppeteer
       end
 
       # Click an element matching the selector
-      # @rbs selector: String
-      # @rbs button: String
-      # @rbs count: Integer
-      # @rbs delay: Numeric?
-      # @rbs offset: Hash[Symbol, Numeric]?
+      # @rbs selector: String -- Selector to click
+      # @rbs button: String -- Mouse button ('left', 'right', 'middle')
+      # @rbs count: Integer -- Number of clicks
+      # @rbs delay: Numeric? -- Delay between clicks in ms
+      # @rbs offset: Hash[Symbol, Numeric]? -- Click offset from element center
       # @rbs return: void
       def click(selector, button: 'left', count: 1, delay: nil, offset: nil)
         assert_not_detached
@@ -166,9 +166,9 @@ module Puppeteer
       end
 
       # Type text into an element matching the selector
-      # @rbs selector: String
-      # @rbs text: String
-      # @rbs delay: Numeric
+      # @rbs selector: String -- Selector to type into
+      # @rbs text: String -- Text to type
+      # @rbs delay: Numeric -- Delay between key presses in ms
       # @rbs return: void
       def type(selector, text, delay: 0)
         assert_not_detached
@@ -184,7 +184,7 @@ module Puppeteer
       end
 
       # Hover over an element matching the selector
-      # @rbs selector: String
+      # @rbs selector: String -- Selector to hover
       # @rbs return: void
       def hover(selector)
         assert_not_detached
@@ -200,16 +200,16 @@ module Puppeteer
       end
 
       # Get the frame URL
-      # @rbs return: String
+      # @rbs return: String -- Current URL
       def url
         @browsing_context.url
       end
 
       # Navigate to a URL
-      # @rbs url: String
-      # @rbs wait_until: String
-      # @rbs timeout: Numeric
-      # @rbs return: HTTPResponse?
+      # @rbs url: String -- URL to navigate to
+      # @rbs wait_until: String -- When to consider navigation complete ('load', 'domcontentloaded')
+      # @rbs timeout: Numeric -- Navigation timeout in ms
+      # @rbs return: HTTPResponse? -- Response or nil
       def goto(url, wait_until: 'load', timeout: 30000)
         response = wait_for_navigation(timeout: timeout, wait_until: wait_until) do
           @browsing_context.navigate(url, wait: 'interactive').wait
@@ -221,8 +221,8 @@ module Puppeteer
       end
 
       # Set frame content
-      # @rbs html: String
-      # @rbs wait_until: String
+      # @rbs html: String -- HTML content to set
+      # @rbs wait_until: String -- When to consider content set ('load', 'domcontentloaded')
       # @rbs return: void
       def set_content(html, wait_until: 'load')
         assert_not_detached
@@ -259,7 +259,7 @@ module Puppeteer
 
       # Set frame content using document.open/write/close
       # This is a low-level method that doesn't wait for load events
-      # @rbs content: String
+      # @rbs content: String -- HTML content to set
       # @rbs return: void
       def set_frame_content(content)
         assert_not_detached
@@ -274,20 +274,20 @@ module Puppeteer
       end
 
       # Get the frame name
-      # @rbs return: String
+      # @rbs return: String -- Frame name
       def name
         @_name || ''
       end
 
       # Check if frame is detached
-      # @rbs return: bool
+      # @rbs return: bool -- Whether frame is detached
       def detached?
         @browsing_context.closed?
       end
 
       # Get child frames
       # Returns cached frame instances following Puppeteer's pattern
-      # @rbs return: Array[Frame]
+      # @rbs return: Array[Frame] -- Child frames
       def child_frames
         @browsing_context.children.map do |child_context|
           @frames[child_context.id]
@@ -297,7 +297,7 @@ module Puppeteer
       # Get the frame element (iframe/frame DOM element) for this frame
       # Returns nil for the main frame
       # Following Puppeteer's Frame.frameElement() implementation exactly
-      # @rbs return: ElementHandle?
+      # @rbs return: ElementHandle? -- Frame element or nil for main frame
       def frame_element
         assert_not_detached
 
@@ -333,10 +333,10 @@ module Puppeteer
       end
 
       # Wait for navigation to complete
-      # @rbs timeout: Numeric
-      # @rbs wait_until: String | Array[String]
-      # @rbs &block: (-> void)?
-      # @rbs return: HTTPResponse?
+      # @rbs timeout: Numeric -- Navigation timeout in ms
+      # @rbs wait_until: String | Array[String] -- When to consider navigation complete
+      # @rbs &block: (-> void)? -- Optional block to trigger navigation
+      # @rbs return: HTTPResponse? -- Response or nil
       def wait_for_navigation(timeout: 30000, wait_until: 'load', &block)
         assert_not_detached
 
@@ -478,30 +478,30 @@ module Puppeteer
       end
 
       # Wait for a function to return a truthy value
-      # @rbs page_function: String
-      # @rbs options: Hash[Symbol, untyped]
-      # @rbs *args: untyped
-      # @rbs &block: ((JSHandle) -> void)?
-      # @rbs return: JSHandle
+      # @rbs page_function: String -- JavaScript function to evaluate
+      # @rbs options: Hash[Symbol, untyped] -- Wait options (timeout, polling)
+      # @rbs *args: untyped -- Arguments to pass to the function
+      # @rbs &block: ((JSHandle) -> void)? -- Optional block called with result
+      # @rbs return: JSHandle -- Handle to the truthy result
       def wait_for_function(page_function, options = {}, *args, &block)
         main_realm.wait_for_function(page_function, options, *args, &block)
       end
 
       # Wait for an element matching the selector to appear in the frame
-      # @rbs selector: String
-      # @rbs visible: bool?
-      # @rbs hidden: bool?
-      # @rbs timeout: Numeric?
-      # @rbs &block: ((ElementHandle?) -> void)?
-      # @rbs return: ElementHandle?
+      # @rbs selector: String -- Selector to wait for
+      # @rbs visible: bool? -- Wait for element to be visible
+      # @rbs hidden: bool? -- Wait for element to be hidden
+      # @rbs timeout: Numeric? -- Wait timeout in ms
+      # @rbs &block: ((ElementHandle?) -> void)? -- Optional block called with element
+      # @rbs return: ElementHandle? -- Element or nil if hidden
       def wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil, &block)
         result = QueryHandler.instance.get_query_handler_and_selector(selector)
         result.query_handler.new.wait_for(self, result.updated_selector, visible: visible, hidden: hidden, polling: result.polling, timeout: timeout, &block)
       end
 
       # Set files on an input element
-      # @rbs element: ElementHandle
-      # @rbs files: Array[String]
+      # @rbs element: ElementHandle -- Input element
+      # @rbs files: Array[String] -- File paths to set
       # @rbs return: void
       def set_files(element, files)
         assert_not_detached
@@ -514,7 +514,7 @@ module Puppeteer
 
       # Get the frame ID (browsing context ID)
       # Following Puppeteer's _id pattern
-      # @rbs return: String
+      # @rbs return: String -- Frame ID
       def _id
         @browsing_context.id
       end
@@ -568,8 +568,8 @@ module Puppeteer
       #   });
       # Note: FrameDetached is NOT emitted here - it's emitted in #initialize
       # when the frame's own browsing context closes
-      # @rbs browsing_context: Core::BrowsingContext
-      # @rbs return: Frame
+      # @rbs browsing_context: Core::BrowsingContext -- Child browsing context
+      # @rbs return: Frame -- New child frame
       def create_frame_target(browsing_context)
         frame = Frame.from(self, browsing_context)
         @frames[browsing_context.id] = frame

data/lib/puppeteer/bidi/http_response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi

data/lib/puppeteer/bidi/injected_source.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi