puppeteer-bidi 0.0.1.beta1 → 0.0.1.beta2

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -19,13 +20,14 @@ module Puppeteer
         end
 
         # Get the target for script execution
-        # @return [Hash] BiDi target descriptor
+        # @rbs return: Hash[Symbol, untyped] -- BiDi target descriptor
         def target
           { realm: @id }
         end
 
         # Disown handles (remove references)
-        # @param handles [Array<String>] Handle IDs to disown
+        # @rbs handles: Array[String] -- Handle IDs to disown
+        # @rbs return: Async::Task[untyped]
         def disown(handles)
           raise RealmDestroyedError, @reason if disposed?
           session.async_send_command('script.disown', {
@@ -35,10 +37,10 @@ module Puppeteer
         end
 
         # Call a function in the realm
-        # @param function_declaration [String] Function source code
-        # @param await_promise [Boolean] Whether to await promise results (Note: different from returnByValue!)
-        # @param options [Hash] Additional options (arguments, serializationOptions, resultOwnership, etc.)
-        # @return [Hash] Evaluation result (with 'type', 'realm', and optionally 'result'/'exceptionDetails')
+        # @rbs function_declaration: String -- Function source code
+        # @rbs await_promise: bool -- Whether to await promise results
+        # @rbs **options: untyped -- Additional options (arguments, serializationOptions, resultOwnership, etc.)
+        # @rbs return: Async::Task[Hash[String, untyped]] -- Evaluation result
         def call_function(function_declaration, await_promise, **options)
           raise RealmDestroyedError, @reason if disposed?
 
@@ -58,10 +60,10 @@ module Puppeteer
         end
 
         # Evaluate an expression in the realm
-        # @param expression [String] JavaScript expression
-        # @param await_promise [Boolean] Whether to await promise results
-        # @param options [Hash] Additional options (serializationOptions, resultOwnership, etc.)
-        # @return [Hash] Evaluation result (with 'type', 'realm', and optionally 'result'/'exceptionDetails')
+        # @rbs expression: String -- JavaScript expression
+        # @rbs await_promise: bool -- Whether to await promise results
+        # @rbs **options: untyped -- Additional options (serializationOptions, resultOwnership, etc.)
+        # @rbs return: Async::Task[Hash[String, untyped]] -- Evaluation result
         def evaluate(expression, await_promise, **options)
           raise RealmDestroyedError, @reason if disposed?
 
@@ -78,7 +80,7 @@ module Puppeteer
         end
 
         # Resolve the CDP execution context ID for this realm
-        # @return [Integer] Execution context ID
+        # @rbs return: Integer -- Execution context ID
         def resolve_execution_context_id
           return @execution_context_id if @execution_context_id
 
@@ -90,7 +92,7 @@ module Puppeteer
         protected
 
         # Abstract method - must be implemented by subclasses
-        # @return [Session] The session for this realm
+        # @rbs return: Session -- The session for this realm
         def session
           raise NotImplementedError, 'Subclasses must implement #session'
         end
@@ -106,9 +108,9 @@ module Puppeteer
       # WindowRealm represents a JavaScript realm in a window or iframe
       class WindowRealm < Realm
         # Create a window realm
-        # @param browsing_context [BrowsingContext] The browsing context
-        # @param sandbox [String, nil] Sandbox name
-        # @return [WindowRealm] New window realm
+        # @rbs browsing_context: BrowsingContext -- The browsing context
+        # @rbs sandbox: String? -- Sandbox name
+        # @rbs return: WindowRealm -- New window realm
         def self.from(browsing_context, sandbox = nil)
           realm = new(browsing_context, sandbox)
           realm.send(:initialize_realm)
@@ -126,19 +128,20 @@ module Puppeteer
 
         # Set the environment (Frame) for this realm
         # This is set by Frame when it's created
-        # @param frame [Frame] The frame environment
+        # @rbs frame: untyped -- The frame environment
+        # @rbs return: void
         def environment=(frame)
           @environment = frame
         end
 
         # Get the environment (Frame) for this realm
-        # @return [Frame] The frame environment
+        # @rbs return: untyped -- The frame environment
         def environment
           @environment
         end
 
         # Override target to use context-based target
-        # @return [Hash] BiDi target descriptor
+        # @rbs return: Hash[Symbol, untyped] -- BiDi target descriptor
         def target
           result = { context: @browsing_context.id }
           result[:sandbox] = @sandbox if @sandbox
@@ -197,10 +200,10 @@ module Puppeteer
       # DedicatedWorkerRealm represents a JavaScript realm in a dedicated worker
       class DedicatedWorkerRealm < Realm
         # Create a dedicated worker realm
-        # @param owner [WindowRealm, DedicatedWorkerRealm, SharedWorkerRealm] Owner realm
-        # @param id [String] Realm ID
-        # @param origin [String] Realm origin
-        # @return [DedicatedWorkerRealm] New dedicated worker realm
+        # @rbs owner: WindowRealm | DedicatedWorkerRealm | SharedWorkerRealm -- Owner realm
+        # @rbs id: String -- Realm ID
+        # @rbs origin: String -- Realm origin
+        # @rbs return: DedicatedWorkerRealm -- New dedicated worker realm
         def self.from(owner, id, origin)
           realm = new(owner, id, origin)
           realm.send(:initialize_realm)
@@ -256,10 +259,10 @@ module Puppeteer
       # SharedWorkerRealm represents a JavaScript realm in a shared worker
       class SharedWorkerRealm < Realm
         # Create a shared worker realm
-        # @param browser [Browser] Browser instance
-        # @param id [String] Realm ID
-        # @param origin [String] Realm origin
-        # @return [SharedWorkerRealm] New shared worker realm
+        # @rbs browser: Browser -- Browser instance
+        # @rbs id: String -- Realm ID
+        # @rbs origin: String -- Realm origin
+        # @rbs return: SharedWorkerRealm -- New shared worker realm
         def self.from(browser, id, origin)
           realm = new(browser, id, origin)
           realm.send(:initialize_realm)

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -8,9 +9,9 @@ module Puppeteer
         include Disposable::DisposableMixin
 
         # Create a request instance from a beforeRequestSent event
-        # @param browsing_context [BrowsingContext] The browsing context
-        # @param event [Hash] The beforeRequestSent event data
-        # @return [Request] New request instance
+        # @rbs browsing_context: BrowsingContext -- The browsing context
+        # @rbs event: Hash[String, untyped] -- The beforeRequestSent event data
+        # @rbs return: Request -- New request instance
         def self.from(browsing_context, event)
           request = new(browsing_context, event)
           request.send(:initialize_request)
@@ -32,43 +33,43 @@ module Puppeteer
         end
 
         # Get request ID
-        # @return [String] Request ID
+        # @rbs return: String -- Request ID
         def id
           @event.dig('request', 'request')
         end
 
         # Get request URL
-        # @return [String] Request URL
+        # @rbs return: String -- Request URL
         def url
           @event.dig('request', 'url')
         end
 
         # Get request method
-        # @return [String] Request method (GET, POST, etc.)
+        # @rbs return: String -- Request method (GET, POST, etc.)
         def method
           @event.dig('request', 'method')
         end
 
         # Get request headers
-        # @return [Array<Hash>] Request headers
+        # @rbs return: Array[Hash[String, untyped]] -- Request headers
         def headers
           @event.dig('request', 'headers') || []
         end
 
         # Get navigation ID if this is a navigation request
-        # @return [String, nil] Navigation ID
+        # @rbs return: String? -- Navigation ID
         def navigation
           @event['navigation']
         end
 
         # Get redirect request if this request was redirected
-        # @return [Request, nil] Redirect request
+        # @rbs return: Request? -- Redirect request
         def redirect
           @redirect
         end
 
         # Get the last redirect in the chain
-        # @return [Request, nil] Last redirect request
+        # @rbs return: Request? -- Last redirect request
         def last_redirect
           redirect_request = @redirect
           while redirect_request
@@ -79,7 +80,7 @@ module Puppeteer
         end
 
         # Get request initiator information
-        # @return [Hash, nil] Initiator info
+        # @rbs return: Hash[String, untyped]? -- Initiator info
         def initiator
           initiator_data = @event['initiator']
           return nil unless initiator_data
@@ -92,41 +93,42 @@ module Puppeteer
         end
 
         # Check if the request is blocked
-        # @return [Boolean] Whether the request is blocked
+        # @rbs return: bool -- Whether the request is blocked
         def blocked?
           @event['isBlocked'] == true
         end
 
         # Get resource type (non-standard)
-        # @return [String, nil] Resource type
+        # @rbs return: String? -- Resource type
         def resource_type
           @event.dig('request', 'goog:resourceType')
         end
 
         # Get POST data (non-standard)
-        # @return [String, nil] POST data
+        # @rbs return: String? -- POST data
         def post_data
           @event.dig('request', 'goog:postData')
         end
 
         # Check if request has POST data
-        # @return [Boolean] Whether request has POST data
+        # @rbs return: bool -- Whether request has POST data
         def has_post_data?
           (@event.dig('request', 'bodySize') || 0) > 0
         end
 
         # Get timing information
-        # @return [Hash] Timing info
+        # @rbs return: Hash[String, untyped] -- Timing info
         def timing
           @event.dig('request', 'timings') || {}
         end
 
         # Continue the request with optional modifications
-        # @param url [String, nil] Modified URL
-        # @param method [String, nil] Modified method
-        # @param headers [Array<Hash>, nil] Modified headers
-        # @param cookies [Array<Hash>, nil] Modified cookies
-        # @param body [Hash, nil] Modified body
+        # @rbs url: String? -- Modified URL
+        # @rbs method: String? -- Modified method
+        # @rbs headers: Array[Hash[String, untyped]]? -- Modified headers
+        # @rbs cookies: Array[Hash[String, untyped]]? -- Modified cookies
+        # @rbs body: Hash[String, untyped]? -- Modified body
+        # @rbs return: untyped
         def continue_request(url: nil, method: nil, headers: nil, cookies: nil, body: nil)
           params = { request: id }
           params[:url] = url if url
@@ -144,10 +146,11 @@ module Puppeteer
         end
 
         # Provide a response for the request
-        # @param status_code [Integer, nil] Response status code
-        # @param reason_phrase [String, nil] Response reason phrase
-        # @param headers [Array<Hash>, nil] Response headers
-        # @param body [Hash, nil] Response body
+        # @rbs status_code: Integer? -- Response status code
+        # @rbs reason_phrase: String? -- Response reason phrase
+        # @rbs headers: Array[Hash[String, untyped]]? -- Response headers
+        # @rbs body: Hash[String, untyped]? -- Response body
+        # @rbs return: untyped
         def provide_response(status_code: nil, reason_phrase: nil, headers: nil, body: nil)
           params = { request: id }
           params[:statusCode] = status_code if status_code
@@ -159,7 +162,7 @@ module Puppeteer
         end
 
         # Fetch POST data for the request
-        # @return [String, nil] POST data
+        # @rbs return: String? -- POST data
         def fetch_post_data
           return nil unless has_post_data?
           return @request_body_promise if @request_body_promise
@@ -180,7 +183,7 @@ module Puppeteer
         end
 
         # Get response content
-        # @return [String] Response content as binary string
+        # @rbs return: String -- Response content as binary string
         def response_content
           return @response_content_promise if @response_content_promise
 
@@ -205,8 +208,9 @@ module Puppeteer
         end
 
         # Continue with authentication
-        # @param action [String] 'provideCredentials', 'default', or 'cancel'
-        # @param credentials [Hash, nil] Credentials hash with username and password
+        # @rbs action: String -- 'provideCredentials', 'default', or 'cancel'
+        # @rbs credentials: Hash[String, untyped]? -- Credentials hash with username and password
+        # @rbs return: untyped
         def continue_with_auth(action:, credentials: nil)
           params = {
             request: id,

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -9,9 +10,9 @@ module Puppeteer
         include Disposable::DisposableMixin
 
         # Create a new session from an existing connection
-        # @param connection [Puppeteer::Bidi::Connection] The BiDi connection
-        # @param capabilities [Hash] Session capabilities
-        # @return [Session] New session instance
+        # @rbs connection: Puppeteer::Bidi::Connection -- The BiDi connection
+        # @rbs capabilities: Hash[String, untyped] -- Session capabilities
+        # @rbs return: Async::Task[Session]
         def self.from(connection:, capabilities:)
           Async do
             result = connection.async_send_command('session.new', { capabilities: capabilities }).wait
@@ -45,17 +46,18 @@ module Puppeteer
         alias disposed? ended?
 
         # Send a BiDi command through this session
-        # @param method [String] BiDi method name
-        # @param params [Hash] Command parameters
-        # @return [Hash] Command result
+        # @rbs method: String -- BiDi method name
+        # @rbs params: Hash[String | Symbol, untyped] -- Command parameters
+        # @rbs return: Async::Task[Hash[String, untyped]]
         def async_send_command(method, params = {})
           raise SessionEndedError, @reason if ended?
           @connection.async_send_command(method, params)
         end
 
         # Subscribe to BiDi events
-        # @param events [Array<String>] Event names to subscribe to
-        # @param contexts [Array<String>, nil] Context IDs (optional)
+        # @rbs events: Array[String] -- Event names to subscribe to
+        # @rbs contexts: Array[String]? -- Context IDs (optional)
+        # @rbs return: Async::Task[untyped]
         def subscribe(events, contexts = nil)
           raise SessionEndedError, @reason if ended?
           params = { events: events }
@@ -64,8 +66,9 @@ module Puppeteer
         end
 
         # Add intercepts (same as subscribe but for interception events)
-        # @param events [Array<String>] Event names to intercept
-        # @param contexts [Array<String>, nil] Context IDs (optional)
+        # @rbs events: Array[String] -- Event names to intercept
+        # @rbs contexts: Array[String]? -- Context IDs (optional)
+        # @rbs return: Async::Task[untyped]
         def add_intercepts(events, contexts = nil)
           subscribe(events, contexts)
         end
@@ -75,7 +78,7 @@ module Puppeteer
           return if ended?
 
           begin
-            send_command('session.end', {})
+            async_send_command('session.end', {}).wait
           ensure
             dispose_session('Session ended')
           end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -10,9 +11,9 @@ module Puppeteer
         DEFAULT = 'default'
 
         # Create a user context
-        # @param browser [Browser] Parent browser
-        # @param id [String] Context ID
-        # @return [UserContext] New user context
+        # @rbs browser: Browser -- Parent browser
+        # @rbs id: String -- Context ID
+        # @rbs return: UserContext
         def self.create(browser, id)
           context = new(browser, id)
           context.send(:initialize_context)
@@ -38,16 +39,15 @@ module Puppeteer
         alias disposed? closed?
 
         # Get all browsing contexts in this user context
-        # @return [Array<BrowsingContext>] Top-level browsing contexts
+        # @rbs return: Array[BrowsingContext] -- Top-level browsing contexts
         def browsing_contexts
           @browsing_contexts.values
         end
 
         # Create a new browsing context (tab or window)
-        # @param type [String] 'tab' or 'window'
-        # @param options [Hash] Creation options
-        # @option options [BrowsingContext] :reference_context Reference context
-        # @return [BrowsingContext] New browsing context
+        # @rbs type: String -- 'tab' or 'window'
+        # @rbs reference_context: BrowsingContext? -- Reference context
+        # @rbs return: BrowsingContext -- New browsing context
         def create_browsing_context(type, **options)
           raise UserContextClosedError, @reason if closed?
 
@@ -96,9 +96,8 @@ module Puppeteer
         end
 
         # Get cookies for this user context
-        # @param options [Hash] Cookie filter options
-        # @option options [String] :source_origin Source origin
-        # @return [Array<Hash>] Cookies
+        # @rbs source_origin: String? -- Source origin
+        # @rbs return: Array[Hash[String, untyped]] -- Cookies
         def get_cookies(**options)
           raise UserContextClosedError, @reason if closed?
 
@@ -115,8 +114,9 @@ module Puppeteer
         end
 
         # Set a cookie in this user context
-        # @param cookie [Hash] Cookie data
-        # @option options [String] :source_origin Source origin
+        # @rbs cookie: Hash[String, untyped] -- Cookie data
+        # @rbs source_origin: String? -- Source origin
+        # @rbs return: void
         def set_cookie(cookie, **options)
           raise UserContextClosedError, @reason if closed?
 
@@ -134,9 +134,10 @@ module Puppeteer
         end
 
         # Set permissions for an origin
-        # @param origin [String] Origin URL
-        # @param descriptor [Hash] Permission descriptor
-        # @param state [String] Permission state
+        # @rbs origin: String -- Origin URL
+        # @rbs descriptor: Hash[String, untyped] -- Permission descriptor
+        # @rbs state: String -- Permission state
+        # @rbs return: void
         def set_permissions(origin, descriptor, state)
           raise UserContextClosedError, @reason if closed?
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Puppeteer
   module Bidi
@@ -8,9 +9,9 @@ module Puppeteer
         include Disposable::DisposableMixin
 
         # Create a user prompt instance
-        # @param browsing_context [BrowsingContext] The browsing context
-        # @param info [Hash] The userPromptOpened event data
-        # @return [UserPrompt] New user prompt instance
+        # @rbs browsing_context: BrowsingContext -- The browsing context
+        # @rbs info: Hash[String, untyped] -- The userPromptOpened event data
+        # @rbs return: UserPrompt -- New user prompt instance
         def self.from(browsing_context, info)
           prompt = new(browsing_context, info)
           prompt.send(:initialize_prompt)
@@ -37,7 +38,7 @@ module Puppeteer
 
         # Check if the prompt has been handled
         # Auto-handled prompts return true immediately
-        # @return [Boolean] Whether the prompt is handled
+        # @rbs return: bool -- Whether the prompt is handled
         def handled?
           handler = @info['handler']
           return true if handler == 'accept' || handler == 'dismiss'
@@ -45,9 +46,9 @@ module Puppeteer
         end
 
         # Handle the user prompt
-        # @param accept [Boolean, nil] Whether to accept the prompt
-        # @param user_text [String, nil] Text to enter (for prompt dialogs)
-        # @return [Hash] Result of handling the prompt
+        # @rbs accept: bool? -- Whether to accept the prompt
+        # @rbs user_text: String? -- Text to enter (for prompt dialogs)
+        # @rbs return: Hash[String, untyped] -- Result of handling the prompt
         def handle(accept: nil, user_text: nil)
           raise UserPromptClosedError, @reason if closed?
 

data/lib/puppeteer/bidi/core.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 # Core module provides low-level BiDi protocol abstractions
 # This layer sits above the WebSocket transport and provides

data/lib/puppeteer/bidi/deserializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 require 'time'
 require 'set'