bidi2pdf 0.1.13 → 0.1.15

data/sig/bidi2pdf/bidi/client.rbs

@@ -1,72 +1,132 @@
 module Bidi2pdf
   module Bidi
+    # Represents a WebSocket client for managing communication with a remote server
+    # using the Bidi2pdf library. This class handles the setup, connection, and
+    # communication with the WebSocket server, including sending commands and
+    # handling responses.
+    #
+    # @example Creating and starting a client
+    #   client = Bidi2pdf::Bidi::Client.new("ws://example.com/socket")
+    #   client.start
+    #
+    # @example Sending a command
+    #   command = Bidi2pdf::Bidi::Commands::ScriptEvaluate.new context: browsing_context_id, expression: script
+    #   client.send_cmd(command)
+    #
+    # @example Subscribing to events
+    #   client.on_event("eventName") do |event_data|
+    #     puts "Received event: #{event_data}"
+    #   end
+    #
+    # @param [String] ws_url The WebSocket URL to connect to.
     class Client
-      @next_id_mutex: Mutex
       @ws_url: untyped
 
-      @id: untyped
-
-      @pending_responses: Hash[String, Thread::Queue]
-
-      @connected: untyped
-
-      @connection_mutex: Mutex
-
-      @send_cmd_mutex: Mutex
-
-      @connection_cv: untyped
-
       @started: untyped
 
+      @connection_manager: untyped
+
       @socket: untyped
 
       @dispatcher: untyped
 
-      include Bidi2pdf::Utils
-
+      # @return [String] The WebSocket URL.
       attr_reader ws_url: untyped
 
+      # Initializes a new WebSocket client.
+      #
+      # @param [String] ws_url The WebSocket URL to connect to.
       def initialize: (untyped ws_url) -> void
 
+      # Starts the WebSocket client and establishes a connection.
+      #
+      # @return [BufferedWebSocketClient] The WebSocket connection object.
       def start: () -> untyped
 
+      # Checks if the WebSocket client has started. Unlike #open?, this never flips back to false on
+      # its own if the connection dies externally - it only reflects whether #start has run.
+      #
+      # @return [Boolean] True if the client has started, false otherwise.
       def started?: () -> untyped
 
+      # Checks if the underlying WebSocket connection is actually open right now - false before
+      # #start, after #close, or if the reader thread noticed the connection died on its own (a
+      # real liveness signal, not just an internal "did we ever start" flag).
+      #
+      # @return [Boolean] True if the underlying socket reports itself open.
+      def open?: () -> untyped
+
+      # Waits until the WebSocket connection is open.
+      #
+      # @param [Integer] timeout The timeout duration in seconds.
+      # @raise [Bidi2pdf::WebsocketError] If the connection is not established within the timeout.
       def wait_until_open: (?timeout: untyped) -> untyped
 
-      def send_cmd: (Bidi2pdf::Bidi::Commands::Base cmd) -> untyped
-
-      # rubocop:disable Metrics/AbcSize
-      def send_cmd_and_wait: (untyped method, ?::Hash[untyped, untyped] params, ?timeout: untyped) ?{ (untyped) -> untyped } -> untyped
-
-      # Event API for external consumers
-      def on_message: () { () -> untyped } -> untyped
-
-      def on_open: () { () -> untyped } -> untyped
-
-      def on_close: () { () -> untyped } -> untyped
-
-      def on_error: () { () -> untyped } -> untyped
-
-      def on_event: (*untyped names) { () -> untyped } -> untyped
-
-      def remove_message_listener: (untyped block) -> untyped
-
-      def remove_event_listener: (*untyped names) { () -> untyped } -> untyped
-
-      def add_headers_interceptor: (context: untyped, url_patterns: untyped, headers: untyped) -> untyped
-
-      def add_auth_interceptor: (context: untyped, url_patterns: untyped, username: untyped, password: untyped) -> untyped
+      # Sends a command to the WebSocket server.
+      #
+      # @param [Bidi2pdf::Bidi::Commands::Base] cmd The command to send.
+      # @raise [Bidi2pdf::ClientError] If the client has not started.
+      def send_cmd: (untyped cmd) -> untyped
+
+      # Sends a command to the WebSocket server and waits for a response.
+      #
+      # @param [Object] cmd The command to send.
+      # @param [Integer] timeout The timeout duration in seconds.
+      # @yield [response] A block to handle the response.
+      # @raise [Bidi2pdf::ClientError] If the client has not started.
+      def send_cmd_and_wait: (untyped cmd, ?timeout: untyped) { (?) -> untyped } -> untyped
+
+      # Registers a callback for incoming WebSocket messages.
+      #
+      # @yield [message] A block to handle the incoming message.
+      def on_message: () { (?) -> untyped } -> untyped
+
+      # Registers a callback for when the WebSocket connection is opened.
+      #
+      # @yield A block to execute when the connection is opened.
+      def on_open: () { (?) -> untyped } -> untyped
+
+      # Registers a callback for when the WebSocket connection is closed.
+      #
+      # @yield A block to execute when the connection is closed.
+      def on_close: () { (?) -> untyped } -> untyped
+
+      # Registers a callback for WebSocket errors.
+      #
+      # @yield [error] A block to handle the error.
+      def on_error: () { (?) -> untyped } -> untyped
+
+      # Subscribes to specific WebSocket events.
+      #
+      # @param [Array<String>] names The names of the events to subscribe to.
+      # @yield [event_data] A block to handle the event data.
+      def on_event: (*untyped names) { (?) -> untyped } -> untyped
+
+      # Removes a message listener.
+      #
+      # @param [Proc] block The listener block to remove.
+      def remove_message_listener: (untyped listener) -> untyped
+
+      # Removes event listeners for specific events.
+      #
+      # @param [Array<String>] names The names of the events to unsubscribe from.
+      # @param [Proc] block The listener block to remove.
+      def remove_event_listener: (*untyped names, untyped listener) -> untyped
+
+      # Closes the WebSocket connection.
+      def close: () -> (nil | untyped)
 
       private
 
-      def next_id: () -> untyped
-
-      def handle_open: () -> untyped
+      # Returns the WebSocket dispatcher for managing events and messages.
+      #
+      # @return [WebSocketDispatcher] The dispatcher instance.
+      def dispatcher: () -> untyped
 
+      # Handles responses to commands sent to the WebSocket server.
+      #
+      # @param [Hash] data The response data.
       def handle_response_to_cmd: (untyped data) -> untyped
-
-      def redact_sensitive_fields: (untyped obj, ?::Array[untyped] sensitive_keys) -> untyped
     end
   end
 end

data/sig/bidi2pdf/bidi/command_manager.rbs

@@ -3,39 +3,27 @@ module Bidi2pdf
     class CommandManager
       self.@id: untyped
 
-      self.@id_mutex: untyped
-
       @socket: untyped
 
-      @logger: untyped
-
       @pending_responses: untyped
 
-      @initiated_cmds: untyped
-
       def self.initialize_counter: () -> untyped
 
       def self.next_id: () -> untyped
 
-      def initialize: (untyped socket, logger: untyped) -> void
+      def initialize: (untyped socket) -> void
 
-      def send_cmd: (untyped cmd, ?store_response: bool) -> untyped
+      def send_cmd: (untyped cmd, ?result_queue: untyped?) -> untyped
 
-      def send_cmd_and_wait: (untyped cmd, ?timeout: untyped) ?{ (untyped) -> untyped } -> untyped
+      def send_cmd_and_wait: (untyped cmd, ?timeout: untyped) { (?) -> untyped } -> untyped
 
-      def pop_response: (untyped id, timeout: untyped) -> untyped
-
-      def handle_response: (untyped data) -> (true | untyped | false)
+      def handle_response: (untyped data) -> untyped
 
       private
 
-      def init_queue_for: (untyped id) -> untyped
+      def init_queue_for: (untyped id, untyped result_queue) -> untyped
 
       def next_id: () -> untyped
-
-      def redact_sensitive_fields: (untyped obj, ?::Array[untyped] sensitive_keys) -> untyped
-
-      def raise_timeout_error: (untyped id, untyped cmd) -> untyped
     end
   end
 end

data/sig/bidi2pdf/bidi/commands/add_intercept.rbs

@@ -2,19 +2,27 @@ module Bidi2pdf
   module Bidi
     module Commands
       class AddIntercept
+        @context: untyped
+
+        @phases: untyped
+
+        @url_patterns: untyped
+
         include Base
 
-        BEFORE_REQUEST: String
-        RESPONSE_STARTED: String
-        AUTH_REQUIRED: String
+        BEFORE_REQUEST: "beforeRequestSent"
+
+        RESPONSE_STARTED: "responseStarted"
+
+        AUTH_REQUIRED: "authRequired"
+
+        def initialize: (context: untyped, phases: untyped, url_patterns: untyped) -> void
 
-        @context: String
-        @phases: Array[String]
-        @url_patterns: Array[String]
+        def method_name: () -> "network.addIntercept"
 
-        def initialize: (context: String, phases: Array[String], url_patterns: Array[String]) -> void
+        def params: () -> untyped
 
-        def validate_phases!: () -> void
+        def validate_phases!: () -> untyped
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/base.rbs

@@ -1,26 +1,66 @@
 module Bidi2pdf
   module Bidi
     module Commands
+      # Base module for defining WebSocket commands in the Bidi2pdf library.
+      # This module provides common functionality for creating, comparing, and
+      # inspecting WebSocket command payloads.
       module Base
-        def method_name: () -> String
+        # Abstract method that must be implemented in subclasses to define the
+        # WebSocket command method name.
+        #
+        # @raise [NotImplementedError] If the method is not implemented in a subclass.
+        def method_name: () -> untyped
 
-        def params: () -> Hash[Symbol, untyped]
+        # Returns the parameters for the WebSocket command.
+        #
+        # @return [Hash] The parameters for the command. Defaults to an empty hash.
+        def params: () -> ::Hash[untyped, untyped]
 
-        def as_payload: (untyped id) -> Hash[Symbol, untyped]
+        # Constructs the payload for the WebSocket command.
+        #
+        # @param [Integer] id The unique identifier for the command.
+        # @return [Hash] The payload containing the command ID, method name, and parameters.
+        def as_payload: (untyped id) -> { id: untyped, method: untyped, params: untyped }
 
-        def ==: (untyped other) -> bool
+        # Compares the current command with another command for equality.
+        #
+        # @param [Object] other The other command to compare.
+        # @return [Boolean] True if the commands are equal, false otherwise.
+        # rubocop: disable Metrics/AbcSize
+        def ==: (untyped other) -> (false | untyped)
 
-        def eql?: (untyped other) -> bool
+        # Checks if the current command is hash-equal to another command.
+        #
+        # @param [Object] other The other command to compare.
+        # @return [Boolean] True if the commands are hash-equal, false otherwise.
+        def eql?: (untyped other) -> (false | untyped)
 
-        def hash: () -> Integer
+        # Computes the hash value for the command.
+        #
+        # @return [Integer] The hash value based on the method name and parameters.
+        def hash: () -> untyped
 
-        def inspect: () -> String
+        # Returns a string representation of the command, with sensitive fields redacted.
+        #
+        # @return [String] The string representation of the command.
+        def inspect: () -> ::String
 
         private
 
-        def redact_sensitive_fields: (untyped obj, Array[String] sensitive_keys) -> untyped
+        # Redacts sensitive fields in a given object.
+        #
+        # @param [Object] obj The object to redact.
+        # @param [Array<String>] sensitive_keys The list of sensitive keys to redact. Defaults to common sensitive keys.
+        # @return [Object] The object with sensitive fields redacted.
+        def redact_sensitive_fields: (untyped obj, ?::Array[untyped] sensitive_keys) -> untyped
 
-        def raise_timeout_error: (untyped id, String method, Hash[Symbol, untyped] params) -> void
+        # Logs and raises a timeout error for a command.
+        #
+        # @param [Integer] id The unique identifier for the command.
+        # @param [String] method The method name of the command.
+        # @param [Hash] params The parameters of the command.
+        # @raise [CmdTimeoutError] If the command times out.
+        def raise_timeout_error: (untyped id, untyped method, untyped params) -> untyped
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/browser_close.rbs

@@ -2,7 +2,9 @@ module Bidi2pdf
   module Bidi
     module Commands
       class BrowserClose
-        include Commands::Base
+        include Base
+
+        def method_name: () -> "browser.close"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/browser_create_user_context.rbs

@@ -3,6 +3,8 @@ module Bidi2pdf
     module Commands
       class BrowserCreateUserContext
         include Base
+
+        def method_name: () -> "browser.createUserContext"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/browser_remove_user_context.rbs

@@ -0,0 +1,19 @@
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class BrowserRemoveUserContext
+        @user_context_id: untyped
+
+        include Base
+
+        attr_reader user_context_id: untyped
+
+        def initialize: (?user_context_id: untyped?) -> void
+
+        def params: () -> untyped
+
+        def method_name: () -> "browser.removeUserContext"
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/commands/browsing_context_close.rbs

@@ -2,9 +2,15 @@ module Bidi2pdf
   module Bidi
     module Commands
       class BrowsingContextClose
-        include Commands::Base
+        @context: untyped
 
-        def initialize: (context: String) -> void
+        include Base
+
+        def initialize: (context: untyped) -> void
+
+        def params: () -> { context: untyped }
+
+        def method_name: () -> "browsingContext.close"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/browsing_context_navigate.rbs

@@ -2,13 +2,19 @@ module Bidi2pdf
   module Bidi
     module Commands
       class BrowsingContextNavigate
-        include Commands::Base
+        @url: untyped
 
-        def initialize: (
-            url: String,
-            context: String,
-            ?wait: String
-          ) -> void
+        @context: untyped
+
+        @wait: untyped
+
+        include Base
+
+        def initialize: (url: untyped, context: untyped, ?wait: ::String) -> void
+
+        def params: () -> { url: untyped, context: untyped, wait: untyped }
+
+        def method_name: () -> "browsingContext.navigate"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/browsing_context_print.rbs

@@ -2,12 +2,17 @@ module Bidi2pdf
   module Bidi
     module Commands
       class BrowsingContextPrint
-        include Commands::Base
+        @context: untyped
 
-        def initialize: (
-            context: String,
-            print_options: Hash[Symbol, untyped]?
-          ) -> void
+        @print_options: untyped
+
+        include Base
+
+        def initialize: (context: untyped, print_options: untyped) -> void
+
+        def params: () -> untyped
+
+        def method_name: () -> "browsingContext.print"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/cancel_auth.rbs

@@ -2,9 +2,15 @@ module Bidi2pdf
   module Bidi
     module Commands
       class CancelAuth
-        include Commands::Base
+        @request: untyped
 
-        def initialize: (request: String) -> void
+        include Base
+
+        def initialize: (request: untyped) -> void
+
+        def params: () -> { request: untyped, action: "cancel" }
+
+        def method_name: () -> "network.continueWithAuth"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/capture_screenshot.rbs

@@ -0,0 +1,31 @@
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CaptureScreenshot
+        @context: untyped
+
+        @origin: untyped
+
+        @format: untyped
+
+        @clip: untyped
+
+        include Base
+
+        attr_reader context: untyped
+
+        attr_reader origin: untyped
+
+        attr_reader format: untyped
+
+        attr_reader clip: untyped
+
+        def initialize: (context: untyped, ?origin: ::String, ?format: untyped?, ?clip: untyped?) -> void
+
+        def method_name: () -> "browsingContext.captureScreenshot"
+
+        def params: () -> untyped
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/commands/cdp_get_session.rbs

@@ -0,0 +1,17 @@
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CdpGetSession
+        @context: untyped
+
+        include Base
+
+        def initialize: (context: untyped) -> void
+
+        def params: () -> { context: untyped }
+
+        def method_name: () -> "goog:cdp.getSession"
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/commands/create_window.rbs

@@ -12,6 +12,10 @@ module Bidi2pdf
 
         def initialize: (?user_context_id: untyped?, ?reference_context: untyped?, ?background: bool) -> void
 
+        def method_name: () -> "browsingContext.create"
+
+        def params: () -> untyped
+
         def type: () -> "window"
       end
     end

data/sig/bidi2pdf/bidi/commands/get_user_contexts.rbs

@@ -3,6 +3,8 @@ module Bidi2pdf
     module Commands
       class GetUserContexts
         include Base
+
+        def method_name: () -> "browser.getUserContexts"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/network_continue.rbs

@@ -13,6 +13,10 @@ module Bidi2pdf
         attr_reader headers: untyped
 
         def initialize: (request: untyped, headers: untyped) -> void
+
+        def method_name: () -> "network.continueRequest"
+
+        def params: () -> untyped
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/page_print.rbs

@@ -0,0 +1,28 @@
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class PagePrint
+        @cdp_session: untyped
+
+        @print_options: untyped
+
+        include Base
+
+        def initialize: (cdp_session: untyped, print_options: untyped) -> void
+
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def params: () -> { method: "Page.printToPDF", session: untyped, params: untyped }
+
+        def method_name: () -> "goog:cdp.sendCommand"
+
+        private
+
+        # rubocop:disable  Naming/MethodParameterName
+        def cm_to_inch: (untyped cm) -> (nil | untyped)
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def page_ranges_to_string: (untyped input) -> (nil | untyped)
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/commands/print_parameters_validator.rbs

@@ -15,6 +15,7 @@ module Bidi2pdf
       #   },
       #   orientation: "portrait" or "landscape" (optional, default: "portrait"),
       #   page: {
+      #     format: String (optional, use either format or width/height),
       #     width: Float >= 0.0352 (optional, default: 21.59),
       #     height: Float >= 0.0352 (optional, default: 27.94)
       #   },
@@ -32,6 +33,7 @@ module Bidi2pdf
 
         def initialize: (untyped params) -> void
 
+        # rubocop:disable Naming/PredicateMethod
         def validate!: () -> true
 
         private
@@ -46,6 +48,7 @@ module Bidi2pdf
 
         def validate_margin: () -> (nil | untyped)
 
+        # rubocop: disable Metrics/CyclomaticComplexity
         def validate_page_size: () -> (nil | untyped)
       end
     end

data/sig/bidi2pdf/bidi/commands/provide_credentials.rbs

@@ -2,13 +2,19 @@ module Bidi2pdf
   module Bidi
     module Commands
       class ProvideCredentials
-        include Commands::Base
+        @request: untyped
 
-        def initialize: (
-            request: String,
-            username: String,
-            password: String
-          ) -> void
+        @username: untyped
+
+        @password: untyped
+
+        include Base
+
+        def initialize: (request: untyped, username: untyped, password: untyped) -> void
+
+        def params: () -> { request: untyped, action: "provideCredentials", credentials: { type: "password", username: untyped, password: untyped } }
+
+        def method_name: () -> "network.continueWithAuth"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/script_evaluate.rbs

@@ -11,6 +11,10 @@ module Bidi2pdf
         include Base
 
         def initialize: (expression: untyped, context: untyped, ?await_promise: bool) -> void
+
+        def params: () -> { expression: untyped, target: { context: untyped }, awaitPromise: untyped }
+
+        def method_name: () -> "script.evaluate"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/session_end.rbs

@@ -3,6 +3,8 @@ module Bidi2pdf
     module Commands
       class SessionEnd
         include Base
+
+        def method_name: () -> "session.end"
       end
     end
   end

data/sig/bidi2pdf/bidi/commands/session_status.rbs

@@ -2,7 +2,9 @@ module Bidi2pdf
   module Bidi
     module Commands
       class SessionStatus
-        include Commands::Base
+        include Base
+
+        def method_name: () -> "session.status"
       end
     end
   end