puppeteer-bidi 0.0.1.beta2 → 0.0.1.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48c2e579cbfaa59695d2bef7808b5d1e06a6eaabc32373c76922bb1546bc1b1
-  data.tar.gz: 1b7c45fd354031cbeb4fb79c44de2b60dfeb3daee83347c852cfb3ead069813e
+  metadata.gz: 2d3afdcd6aeda92482fb530cab98075505ae8e6d9b76da6a8f65dc01d3f76ee6
+  data.tar.gz: 2c74ca2d812a27ad8051911cb213d008a6d4077781ca5ecf0b782a2a0f62d72e
 SHA512:
-  metadata.gz: e871963ebf26bcd8739be7860c50f62fbb39869950f9a674369f6685a6971fa669d6d1df69b9e684adada354c6219fb11e5982a8c2103cac6425d5e32eb8dbb1
-  data.tar.gz: d3b5db4e138484081966a678e8e2f9f70d5c9031fcadd00631368920abbf8eb92d2f1f92beea34d48272b87e3bf63521a9e57d71e339667f2113d87fc8f3c495
+  metadata.gz: 0e900fd975d92973786eea9546f22f8b71afb2a856575c6ef15bba023285322abe888887c1b92458fa736d887cfff8192c0951738d75c91445d69cda46944740
+  data.tar.gz: 070afa10326ae5a789b70b40a55c5b5462dbb5599fc5b8e30b83cf8522752fe65d1c7959cc0e42d937d244a2e0fc23c050f0a48b89eb99f0c8fa5223bb924129

data/CLAUDE.md

@@ -86,14 +86,15 @@ Use [rbs-inline](https://github.com/soutaro/rbs-inline) for type annotations in
 class Example
   attr_reader :name #: String
 
-  # @rbs name: String
+  # @rbs name: String -- The name to set
   # @rbs return: void
   def initialize(name)
     @name = name
   end
 
-  # @rbs selector: String
-  # @rbs return: ElementHandle?
+  # Query for an element matching the selector
+  # @rbs selector: String -- CSS selector to query
+  # @rbs return: ElementHandle? -- Matching element or nil
   def query_selector(selector)
     # ...
   end
@@ -103,8 +104,14 @@ end
 **Conventions:**
 - Use `A?` for nullable types (not `A | nil`)
 - Use `A | B | nil` for union types with nil
-- Add space around `--` for inline comments: `# @rbs name: String -- the name`
+- **Always include descriptions** with `--` separator: `# @rbs name: String -- the name`
 - Public methods should have type annotations
+- **Do NOT use `@rbs!` blocks** - RubyMine IDE doesn't recognize them
+- **Use direct union types** instead of type aliases: `BrowserTarget | PageTarget | FrameTarget` not `target`
+- **Do NOT use `**options` in public APIs** - RubyMine shows as `untyped`. Use explicit keyword arguments:
+  - Optional params: `param: nil`
+  - Boolean params with default: `headless: true` or `enabled: false`
+  - Internal/Core layer methods may still use `**options` for flexibility
 
 **Generate RBS files:**
 ```bash
@@ -135,7 +142,6 @@ bundle exec steep check    # Run type checker
 2. **`sig/_supplementary.rbs`** - Types rbs-inline cannot generate
    - `extend self` pattern: Add `extend ModuleName` declaration
    - Singleton pattern: Add `extend Singleton::SingletonClassMethods`
-   - Union type aliases that rbs-inline doesn't preserve
 
 **Common Issues:**
 

data/lib/puppeteer/bidi/browser.rb

@@ -68,24 +68,19 @@ module Puppeteer
         }
       end
 
-      # @rbs!
-      #   type launch_options = {
-      #     ?executable_path: String,
-      #     ?user_data_dir: String,
-      #     ?headless: bool,
-      #     ?args: Array[String],
-      #     ?timeout: Numeric
-      #   }
-
       # Launch a new Firefox browser instance
-      # @rbs **options: launch_options -- Launch options
+      # @rbs executable_path: String? -- Path to browser executable
+      # @rbs user_data_dir: String? -- Path to user data directory
+      # @rbs headless: bool -- Run browser in headless mode
+      # @rbs args: Array[String]? -- Additional browser arguments
+      # @rbs timeout: Numeric? -- Launch timeout in seconds
       # @rbs return: Browser -- Browser instance
-      def self.launch(**options)
+      def self.launch(executable_path: nil, user_data_dir: nil, headless: true, args: nil, timeout: nil)
         launcher = BrowserLauncher.new(
-          executable_path: options[:executable_path],
-          user_data_dir: options[:user_data_dir],
-          headless: options.fetch(:headless, true),
-          args: options.fetch(:args, [])
+          executable_path: executable_path,
+          user_data_dir: user_data_dir,
+          headless: headless,
+          args: args || []
         )
 
         ws_endpoint = launcher.launch
@@ -95,7 +90,7 @@ module Puppeteer
 
         # Start transport connection in background thread with Sync reactor
         # Sync is the preferred way to run async code at the top level
-        AsyncUtils.async_timeout(options.fetch(:timeout, 30) * 1000, transport.connect).wait
+        AsyncUtils.async_timeout((timeout || 30) * 1000, transport.connect).wait
 
         connection = Connection.new(transport)
 
@@ -163,8 +158,8 @@ module Puppeteer
 
       # Wait until a target (top-level browsing context) satisfies the predicate.
       # @rbs timeout: Integer? -- Timeout in milliseconds (default: 30000)
-      # @rbs &predicate: (target) -> boolish -- Predicate evaluated against each Target
-      # @rbs return: target -- Matching target
+      # @rbs &predicate: (BrowserTarget | PageTarget | FrameTarget) -> boolish -- Predicate evaluated against each Target
+      # @rbs return: BrowserTarget | PageTarget | FrameTarget -- Matching target
       def wait_for_target(timeout: nil, &predicate)
         predicate ||= ->(_target) { true }
         timeout_ms = timeout || 30_000
@@ -256,8 +251,8 @@ module Puppeteer
 
       private
 
-      # @rbs &block: (target) -> void -- Block to yield each target to
-      # @rbs return: Enumerator[target, void] -- Enumerator of targets
+      # @rbs &block: (BrowserTarget | PageTarget | FrameTarget) -> void -- Block to yield each target to
+      # @rbs return: Enumerator[BrowserTarget | PageTarget | FrameTarget, void] -- Enumerator of targets
       def each_target(&block)
         return enum_for(:each_target) unless block_given?
         return unless @core_browser
@@ -279,8 +274,8 @@ module Puppeteer
         end
       end
 
-      # @rbs predicate: ^(target) -> boolish -- Predicate to match targets
-      # @rbs return: target? -- Matching target or nil
+      # @rbs predicate: ^(BrowserTarget | PageTarget | FrameTarget) -> boolish -- Predicate to match targets
+      # @rbs return: (BrowserTarget | PageTarget | FrameTarget)? -- Matching target or nil
       def find_target(predicate)
         each_target do |target|
           return target if predicate.call(target)

data/lib/puppeteer/bidi/core/request.rb

@@ -80,7 +80,7 @@ module Puppeteer
         end
 
         # Get request initiator information
-        # @rbs return: Hash[String, untyped]? -- Initiator info
+        # @rbs return: untyped -- Initiator info (mixed String/Symbol keys)
         def initiator
           initiator_data = @event['initiator']
           return nil unless initiator_data

data/lib/puppeteer/bidi/realm.rb

@@ -7,7 +7,7 @@ module Puppeteer
     # Provides shared lifecycle management for WaitTask instances.
     # https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/api/Realm.ts
     class Realm
-      attr_reader :task_manager #: TaskManager
+      attr_reader :task_manager #: Puppeteer::Bidi::TaskManager
 
       # @rbs timeout_settings: TimeoutSettings -- Timeout settings
       # @rbs return: void

data/lib/puppeteer/bidi/target.rb

@@ -3,9 +3,6 @@
 
 module Puppeteer
   module Bidi
-    # @rbs!
-    #   type Target = BrowserTarget | PageTarget | FrameTarget
-
     class BrowserTarget
       # @rbs browser: Browser
       # @rbs return: void

data/lib/puppeteer/bidi/task_manager.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -6,27 +7,31 @@ module Puppeteer
     # This is a faithful port of Puppeteer's TaskManager implementation:
     # https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/common/WaitTask.ts
     class TaskManager
+      # @rbs return: void
       def initialize
         @tasks = Set.new
       end
 
       # Add a task to the manager
       # Corresponds to Puppeteer's add(task: WaitTask<any>): void
-      # @param task [WaitTask] Task to add
+      # @rbs task: WaitTask -- Task to add
+      # @rbs return: void
       def add(task)
         @tasks.add(task)
       end
 
       # Delete a task from the manager
       # Corresponds to Puppeteer's delete(task: WaitTask<any>): void
-      # @param task [WaitTask] Task to delete
+      # @rbs task: WaitTask -- Task to delete
+      # @rbs return: void
       def delete(task)
         @tasks.delete(task)
       end
 
       # Terminate all tasks with an optional error
       # Corresponds to Puppeteer's terminateAll(error?: Error): void
-      # @param error [Exception, nil] Error to terminate with
+      # @rbs error: Exception? -- Error to terminate with
+      # @rbs return: void
       def terminate_all(error = nil)
         @tasks.each do |task|
           task.terminate(error)
@@ -36,6 +41,7 @@ module Puppeteer
 
       # Rerun all tasks in parallel
       # Corresponds to Puppeteer's async rerunAll(): Promise<void>
+      # @rbs return: void
       def rerun_all
         @tasks.each(&:rerun)
       end

data/lib/puppeteer/bidi/version.rb

@@ -2,6 +2,6 @@
 
 module Puppeteer
   module Bidi
-    VERSION = "0.0.1.beta2"
+    VERSION = "0.0.1.beta4"
   end
 end

data/lib/puppeteer/bidi.rb

@@ -32,20 +32,21 @@ require "puppeteer/bidi/browser"
 
 module Puppeteer
   module Bidi
-    # @rbs!
-    #   type launch_options = {
-    #     ?executable_path: String,
-    #     ?user_data_dir: String,
-    #     ?headless: bool,
-    #     ?args: Array[String],
-    #     ?timeout: Numeric
-    #   }
-
     # Launch a new browser instance
-    # @rbs **options: launch_options -- Launch options
+    # @rbs executable_path: String? -- Path to browser executable
+    # @rbs user_data_dir: String? -- Path to user data directory
+    # @rbs headless: bool -- Run browser in headless mode
+    # @rbs args: Array[String]? -- Additional browser arguments
+    # @rbs timeout: Numeric? -- Launch timeout in seconds
     # @rbs return: Browser -- Browser instance
-    def self.launch(**options)
-      Browser.launch(**options)
+    def self.launch(executable_path: nil, user_data_dir: nil, headless: true, args: nil, timeout: nil)
+      Browser.launch(
+        executable_path: executable_path,
+        user_data_dir: user_data_dir,
+        headless: headless,
+        args: args,
+        timeout: timeout
+      )
     end
 
     # Connect to an existing browser instance

data/sig/_external.rbs

@@ -126,9 +126,3 @@ class DateTime
   def to_time: () -> Time
 end
 
-# Puppeteer::Bidi types that rbs-inline doesn't generate correctly
-module Puppeteer
-  module Bidi
-    type target = BrowserTarget | PageTarget | FrameTarget
-  end
-end

data/sig/puppeteer/bidi/browser.rbs

@@ -22,12 +22,14 @@ module Puppeteer
       # @rbs return: void
       def initialize: (connection: Connection, launcher: BrowserLauncher?, core_browser: Core::Browser, session: Core::Session) -> void
 
-      type launch_options = { ?executable_path: String, ?user_data_dir: String, ?headless: bool, ?args: Array[String], ?timeout: Numeric }
-
       # Launch a new Firefox browser instance
-      # @rbs **options: launch_options -- Launch options
+      # @rbs executable_path: String? -- Path to browser executable
+      # @rbs user_data_dir: String? -- Path to user data directory
+      # @rbs headless: bool -- Run browser in headless mode
+      # @rbs args: Array[String]? -- Additional browser arguments
+      # @rbs timeout: Numeric? -- Launch timeout in seconds
       # @rbs return: Browser -- Browser instance
-      def self.launch: (**launch_options options) -> Browser
+      def self.launch: (?executable_path: String?, ?user_data_dir: String?, ?headless: bool, ?args: Array[String]?, ?timeout: Numeric?) -> Browser
 
       # Connect to an existing Firefox browser instance
       # @rbs ws_endpoint: String -- WebSocket endpoint URL
@@ -61,9 +63,9 @@ module Puppeteer
 
       # Wait until a target (top-level browsing context) satisfies the predicate.
       # @rbs timeout: Integer? -- Timeout in milliseconds (default: 30000)
-      # @rbs &predicate: (target) -> boolish -- Predicate evaluated against each Target
-      # @rbs return: target -- Matching target
-      def wait_for_target: (?timeout: Integer?) { (target) -> boolish } -> target
+      # @rbs &predicate: (BrowserTarget | PageTarget | FrameTarget) -> boolish -- Predicate evaluated against each Target
+      # @rbs return: BrowserTarget | PageTarget | FrameTarget -- Matching target
+      def wait_for_target: (?timeout: Integer?) { (BrowserTarget | PageTarget | FrameTarget) -> boolish } -> (BrowserTarget | PageTarget | FrameTarget)
 
       # Wait for browser process to exit
       # @rbs return: void
@@ -71,13 +73,13 @@ module Puppeteer
 
       private
 
-      # @rbs &block: (target) -> void -- Block to yield each target to
-      # @rbs return: Enumerator[target, void] -- Enumerator of targets
-      def each_target: () { (target) -> void } -> Enumerator[target, void]
+      # @rbs &block: (BrowserTarget | PageTarget | FrameTarget) -> void -- Block to yield each target to
+      # @rbs return: Enumerator[BrowserTarget | PageTarget | FrameTarget, void] -- Enumerator of targets
+      def each_target: () { (BrowserTarget | PageTarget | FrameTarget) -> void } -> Enumerator[BrowserTarget | PageTarget | FrameTarget, void]
 
-      # @rbs predicate: ^(target) -> boolish -- Predicate to match targets
-      # @rbs return: target? -- Matching target or nil
-      def find_target: (^(target) -> boolish predicate) -> target?
+      # @rbs predicate: ^(BrowserTarget | PageTarget | FrameTarget) -> boolish -- Predicate to match targets
+      # @rbs return: (BrowserTarget | PageTarget | FrameTarget)? -- Matching target or nil
+      def find_target: (^(BrowserTarget | PageTarget | FrameTarget) -> boolish predicate) -> (BrowserTarget | PageTarget | FrameTarget)?
 
       # @rbs user_context: Core::UserContext -- User context to get browser context for
       # @rbs return: BrowserContext? -- Browser context or nil

data/sig/puppeteer/bidi/core/request.rbs

@@ -50,8 +50,8 @@ module Puppeteer
         def last_redirect: () -> Request?
 
         # Get request initiator information
-        # @rbs return: Hash[String, untyped]? -- Initiator info
-        def initiator: () -> Hash[String, untyped]?
+        # @rbs return: untyped -- Initiator info (mixed String/Symbol keys)
+        def initiator: () -> untyped
 
         # Check if the request is blocked
         # @rbs return: bool -- Whether the request is blocked

data/sig/puppeteer/bidi/realm.rbs

@@ -6,7 +6,7 @@ module Puppeteer
     # Provides shared lifecycle management for WaitTask instances.
     # https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/api/Realm.ts
     class Realm
-      attr_reader task_manager: TaskManager
+      attr_reader task_manager: Puppeteer::Bidi::TaskManager
 
       # @rbs timeout_settings: TimeoutSettings -- Timeout settings
       # @rbs return: void

data/sig/puppeteer/bidi/task_manager.rbs

@@ -0,0 +1,36 @@
+# Generated from lib/puppeteer/bidi/task_manager.rb with RBS::Inline
+
+module Puppeteer
+  module Bidi
+    # TaskManager tracks active WaitTask instances to enable coordinated lifecycle management
+    # This is a faithful port of Puppeteer's TaskManager implementation:
+    # https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/common/WaitTask.ts
+    class TaskManager
+      # @rbs return: void
+      def initialize: () -> void
+
+      # Add a task to the manager
+      # Corresponds to Puppeteer's add(task: WaitTask<any>): void
+      # @rbs task: WaitTask -- Task to add
+      # @rbs return: void
+      def add: (WaitTask task) -> void
+
+      # Delete a task from the manager
+      # Corresponds to Puppeteer's delete(task: WaitTask<any>): void
+      # @rbs task: WaitTask -- Task to delete
+      # @rbs return: void
+      def delete: (WaitTask task) -> void
+
+      # Terminate all tasks with an optional error
+      # Corresponds to Puppeteer's terminateAll(error?: Error): void
+      # @rbs error: Exception? -- Error to terminate with
+      # @rbs return: void
+      def terminate_all: (?Exception? error) -> void
+
+      # Rerun all tasks in parallel
+      # Corresponds to Puppeteer's async rerunAll(): Promise<void>
+      # @rbs return: void
+      def rerun_all: () -> void
+    end
+  end
+end

data/sig/puppeteer/bidi.rbs

@@ -2,12 +2,14 @@
 
 module Puppeteer
   module Bidi
-    type launch_options = { ?executable_path: String, ?user_data_dir: String, ?headless: bool, ?args: Array[String], ?timeout: Numeric }
-
     # Launch a new browser instance
-    # @rbs **options: launch_options -- Launch options
+    # @rbs executable_path: String? -- Path to browser executable
+    # @rbs user_data_dir: String? -- Path to user data directory
+    # @rbs headless: bool -- Run browser in headless mode
+    # @rbs args: Array[String]? -- Additional browser arguments
+    # @rbs timeout: Numeric? -- Launch timeout in seconds
     # @rbs return: Browser -- Browser instance
-    def self.launch: (**launch_options options) -> Browser
+    def self.launch: (?executable_path: String?, ?user_data_dir: String?, ?headless: bool, ?args: Array[String]?, ?timeout: Numeric?) -> Browser
 
     # Connect to an existing browser instance
     # @rbs ws_endpoint: String -- WebSocket endpoint URL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-bidi
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta2
+  version: 0.0.1.beta4
 platform: ruby
 authors:
 - YusukeIwaki
@@ -180,6 +180,7 @@ files:
 - sig/puppeteer/bidi/realm.rbs
 - sig/puppeteer/bidi/serializer.rbs
 - sig/puppeteer/bidi/target.rbs
+- sig/puppeteer/bidi/task_manager.rbs
 - sig/puppeteer/bidi/timeout_settings.rbs
 - sig/puppeteer/bidi/transport.rbs
 - sig/puppeteer/bidi/wait_task.rbs