puppeteer-bidi 0.0.1.beta1 → 0.0.1.beta3

data/lib/puppeteer/bidi/js_handle.rb

@@ -8,8 +8,8 @@ module Puppeteer
     class JSHandle
       attr_reader :realm #: Core::Realm
 
-      # @rbs remote_value: Hash[String, untyped]
-      # @rbs realm: Core::Realm
+      # @rbs remote_value: Hash[String, untyped] -- BiDi RemoteValue
+      # @rbs realm: Core::Realm -- Associated realm
       # @rbs return: void
       def initialize(realm, remote_value)
         @realm = realm
@@ -18,9 +18,9 @@ module Puppeteer
       end
 
       # Factory method to create JSHandle from remote value
-      # @rbs remote_value: Hash[String, untyped]
-      # @rbs realm: Core::Realm
-      # @rbs return: JSHandle | ElementHandle
+      # @rbs remote_value: Hash[String, untyped] -- BiDi RemoteValue
+      # @rbs realm: Core::Realm -- Associated realm
+      # @rbs return: JSHandle | ElementHandle -- JSHandle or ElementHandle instance
       def self.from(remote_value, realm)
         if remote_value['type'] == 'node'
           ElementHandle.new(realm, remote_value)
@@ -30,19 +30,19 @@ module Puppeteer
       end
 
       # Get the remote value (BiDi Script.RemoteValue)
-      # @rbs return: Hash[String, untyped]
+      # @rbs return: Hash[String, untyped] -- BiDi RemoteValue
       def remote_value
         @remote_value
       end
 
       # Get the remote object (alias for remote_value)
-      # @rbs return: Hash[String, untyped]
+      # @rbs return: Hash[String, untyped] -- BiDi RemoteValue
       def remote_object
         @remote_value
       end
 
       # Check if handle has been disposed
-      # @rbs return: bool
+      # @rbs return: bool -- Whether handle is disposed
       def disposed?
         @disposed
       end
@@ -60,15 +60,15 @@ module Puppeteer
       end
 
       # Get the handle ID (handle or sharedId)
-      # @rbs return: String?
+      # @rbs return: String? -- Handle ID or nil
       def id
         @remote_value['handle'] || @remote_value['sharedId']
       end
 
       # Evaluate JavaScript function with this handle as the first argument
-      # @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_disposed
 
@@ -87,9 +87,9 @@ module Puppeteer
       end
 
       # Evaluate JavaScript function 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_disposed
 
@@ -109,8 +109,8 @@ module Puppeteer
       end
 
       # Get a property of the object
-      # @rbs property_name: String
-      # @rbs return: JSHandle
+      # @rbs property_name: String -- Property name to get
+      # @rbs return: JSHandle -- Handle to the property value
       def get_property(property_name)
         assert_not_disposed
 
@@ -133,7 +133,7 @@ module Puppeteer
       end
 
       # Get all properties of the object
-      # @rbs return: Hash[String, JSHandle]
+      # @rbs return: Hash[String, JSHandle] -- Map of property names to handles
       def get_properties
         assert_not_disposed
 
@@ -212,7 +212,7 @@ module Puppeteer
       end
 
       # Convert this handle to a JSON-serializable value
-      # @rbs return: untyped
+      # @rbs return: untyped -- JSON-serializable value
       def json_value
         assert_not_disposed
 
@@ -222,7 +222,7 @@ module Puppeteer
       end
 
       # Convert to ElementHandle if this is an element
-      # @rbs return: ElementHandle?
+      # @rbs return: ElementHandle? -- ElementHandle or nil if not an element
       def as_element
         return nil unless @remote_value['type'] == 'node'
 
@@ -246,14 +246,14 @@ module Puppeteer
       end
 
       # Check if this is a primitive value
-      # @rbs return: bool
+      # @rbs return: bool -- Whether this is a primitive value
       def primitive_value?
         type = @remote_value['type']
         %w[string number bigint boolean undefined null].include?(type)
       end
 
       # String representation of this handle
-      # @rbs return: String
+      # @rbs return: String -- String representation
       def to_s
         return 'JSHandle@disposed' if @disposed
 
@@ -279,7 +279,7 @@ module Puppeteer
       end
 
       # Handle evaluation exceptions
-      # @rbs result: Hash[String, untyped]
+      # @rbs result: Hash[String, untyped] -- Evaluation result containing exception
       # @rbs return: void
       def handle_evaluation_exception(result)
         exception_details = result['exceptionDetails']

data/lib/puppeteer/bidi/keyboard.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
     # Keyboard class for keyboard input operations
     # Based on Puppeteer's BidiKeyboard implementation
     class Keyboard
+      # @rbs page: Page -- Page instance
+      # @rbs browsing_context: Core::BrowsingContext -- Browsing context
+      # @rbs return: void
       def initialize(page, browsing_context)
         @page = page
         @browsing_context = browsing_context
@@ -12,9 +16,10 @@ module Puppeteer
       end
 
       # Press key down
-      # @param key [String] Key name (e.g., 'a', 'Enter', 'ArrowLeft')
-      # @param text [String, nil] Text to insert (for CDP compatibility, not used in BiDi)
-      # @param commands [Array<String>, nil] Commands to trigger (for CDP compatibility, not used in BiDi)
+      # @rbs key: String -- Key name (e.g., 'a', 'Enter', 'ArrowLeft')
+      # @rbs text: String? -- Text to insert (for CDP compatibility, not used in BiDi)
+      # @rbs commands: Array[String]? -- Commands to trigger (for CDP compatibility, not used in BiDi)
+      # @rbs return: void
       def down(key, text: nil, commands: nil)
         # Note: text and commands parameters exist for CDP compatibility but are not used in BiDi
         actions = [{
@@ -27,7 +32,8 @@ module Puppeteer
       end
 
       # Release key
-      # @param key [String] Key name
+      # @rbs key: String -- Key name
+      # @rbs return: void
       def up(key)
         actions = [{
           type: 'keyUp',
@@ -39,10 +45,11 @@ module Puppeteer
       end
 
       # Press and release a key
-      # @param key [String] Key name
-      # @param delay [Numeric, nil] Delay between keydown and keyup in milliseconds
-      # @param text [String, nil] Text to insert (for CDP compatibility, not used in BiDi)
-      # @param commands [Array<String>, nil] Commands to trigger (for CDP compatibility, not used in BiDi)
+      # @rbs key: String -- Key name
+      # @rbs delay: Numeric? -- Delay between keydown and keyup in milliseconds
+      # @rbs text: String? -- Text to insert (for CDP compatibility, not used in BiDi)
+      # @rbs commands: Array[String]? -- Commands to trigger (for CDP compatibility, not used in BiDi)
+      # @rbs return: void
       def press(key, delay: nil, text: nil, commands: nil)
         # Note: text and commands parameters exist for CDP compatibility but are not used in BiDi
         actions = [{ type: 'keyDown', value: get_bidi_key_value(key) }]
@@ -60,8 +67,9 @@ module Puppeteer
       end
 
       # Type text (types each character with keydown/keyup events)
-      # @param text [String] Text to type
-      # @param delay [Numeric] Delay between each character in milliseconds
+      # @rbs text: String -- Text to type
+      # @rbs delay: Numeric -- Delay between each character in milliseconds
+      # @rbs return: void
       def type(text, delay: 0)
         actions = []
 
@@ -84,7 +92,8 @@ module Puppeteer
       end
 
       # Send character directly (bypasses keyboard events, uses execCommand)
-      # @param char [String] Character to send
+      # @rbs char: String -- Character to send
+      # @rbs return: void
       def send_character(char)
         # Validate: cannot send more than 1 character
         # Measures the number of code points rather than UTF-16 code units
@@ -106,8 +115,8 @@ module Puppeteer
       private
 
       # Convert key name to BiDi protocol value
-      # @param key [String] Key name
-      # @return [String] BiDi key value (Unicode character or escape sequence)
+      # @rbs key: String -- Key name
+      # @rbs return: String -- BiDi key value (Unicode character or escape sequence)
       def get_bidi_key_value(key)
         # Normalize line breaks
         normalized_key = case key
@@ -251,6 +260,8 @@ module Puppeteer
       end
 
       # Perform input actions via BiDi
+      # @rbs action_list: Array[Hash[Symbol, untyped]] -- List of key actions
+      # @rbs return: void
       def perform_actions(action_list)
         @browsing_context.perform_actions([
           {

data/lib/puppeteer/bidi/lazy_arg.rb

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

data/lib/puppeteer/bidi/mouse.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -6,12 +7,14 @@ module Puppeteer
     # Based on Puppeteer's BidiMouse implementation
     class Mouse
       # Mouse button constants
-      LEFT = 'left'
-      RIGHT = 'right'
-      MIDDLE = 'middle'
-      BACK = 'back'
-      FORWARD = 'forward'
-
+      LEFT = 'left' #: String
+      RIGHT = 'right' #: String
+      MIDDLE = 'middle' #: String
+      BACK = 'back' #: String
+      FORWARD = 'forward' #: String
+
+      # @rbs browsing_context: Core::BrowsingContext -- Browsing context
+      # @rbs return: void
       def initialize(browsing_context)
         @browsing_context = browsing_context
         @x = 0
@@ -19,9 +22,10 @@ module Puppeteer
       end
 
       # Move mouse to coordinates
-      # @param x [Numeric] X coordinate
-      # @param y [Numeric] Y coordinate
-      # @param steps [Integer] Number of intermediate steps (for smooth movement)
+      # @rbs x: Numeric -- X coordinate
+      # @rbs y: Numeric -- Y coordinate
+      # @rbs steps: Integer -- Number of intermediate steps (for smooth movement)
+      # @rbs return: void
       def move(x, y, steps: 1)
         from_x = @x
         from_y = @y
@@ -46,7 +50,8 @@ module Puppeteer
       end
 
       # Press mouse button down
-      # @param button [String] Mouse button ('left', 'right', 'middle', 'back', 'forward')
+      # @rbs button: String -- Mouse button ('left', 'right', 'middle', 'back', 'forward')
+      # @rbs return: void
       def down(button: LEFT)
         actions = [{
           type: 'pointerDown',
@@ -56,7 +61,8 @@ module Puppeteer
       end
 
       # Release mouse button
-      # @param button [String] Mouse button
+      # @rbs button: String -- Mouse button
+      # @rbs return: void
       def up(button: LEFT)
         actions = [{
           type: 'pointerUp',
@@ -66,11 +72,12 @@ module Puppeteer
       end
 
       # Click at coordinates
-      # @param x [Numeric] X coordinate
-      # @param y [Numeric] Y coordinate
-      # @param button [String] Mouse button
-      # @param count [Integer] Number of clicks (1 for single, 2 for double, 3 for triple)
-      # @param delay [Numeric] Delay between down and up in milliseconds
+      # @rbs x: Numeric -- X coordinate
+      # @rbs y: Numeric -- Y coordinate
+      # @rbs button: String -- Mouse button
+      # @rbs count: Integer -- Number of clicks (1 for single, 2 for double, 3 for triple)
+      # @rbs delay: Numeric? -- Delay between down and up in milliseconds
+      # @rbs return: void
       def click(x, y, button: LEFT, count: 1, delay: nil)
         actions = []
 
@@ -113,8 +120,9 @@ module Puppeteer
       end
 
       # Scroll using mouse wheel
-      # @param delta_x [Numeric] Horizontal scroll amount
-      # @param delta_y [Numeric] Vertical scroll amount
+      # @rbs delta_x: Numeric -- Horizontal scroll amount
+      # @rbs delta_y: Numeric -- Vertical scroll amount
+      # @rbs return: void
       def wheel(delta_x: 0, delta_y: 0)
         @browsing_context.perform_actions([
           {
@@ -135,6 +143,7 @@ module Puppeteer
 
       # Reset mouse state
       # Resets position to origin and releases all pressed buttons
+      # @rbs return: void
       def reset
         @x = 0
         @y = 0
@@ -144,6 +153,8 @@ module Puppeteer
       private
 
       # Convert mouse button name to BiDi button number
+      # @rbs button: String -- Mouse button name
+      # @rbs return: Integer -- BiDi button number
       def button_to_bidi(button)
         case button
         when LEFT then 0
@@ -156,6 +167,8 @@ module Puppeteer
       end
 
       # Perform input actions via BiDi
+      # @rbs action_list: Array[Hash[Symbol, untyped]] -- List of pointer actions
+      # @rbs return: void
       def perform_actions(action_list)
         @browsing_context.perform_actions([
           {