bidi2pdf 0.1.13 → 0.1.14

data/sig/bidi2pdf/bidi/web_socket_dispatcher.rbs

@@ -1,53 +1,45 @@
 module Bidi2pdf
   module Bidi
     class WebSocketDispatcher
-      @url: String
-      @socket: WebSocket::Driver
-      @connection: TCPSocket
-      @pending_requests: Hash[Integer, Concurrent::Promises::ResolvableFuture]
-      @message_id: Integer
-      @listeners: Hash[String, Array[Proc]]
-      @thread: Thread?
-      @mutex: Mutex
-      @connected: bool
-      @logger: Logger?
+      @socket: untyped
 
-      attr_reader url: String
-      attr_reader connected: bool
+      @socket_events: untyped
 
-      def initialize: (String url, ?logger: Logger?) -> void
+      @session_events: untyped
 
-      def connect: () -> bool
+      attr_reader socket_events: untyped
 
-      def disconnect: () -> void
+      attr_reader session_events: untyped
 
-      def send_command: [T] (String method, ?Hash[Symbol, untyped] params) -> T
+      def initialize: (untyped socket) -> void
 
-      def send_message: (Hash[Symbol, untyped] message) -> Integer
+      def start_listening: () -> untyped
 
-      def add_event_listener: (String event_name) { (Hash[String, untyped]) -> void } -> void
+      def on_message: () { (?) -> untyped } -> untyped
 
-      def remove_event_listener: (String event_name, ?Proc? callback) -> void
+      def on_event: (*untyped event_names) { (?) -> untyped } -> untyped
 
-      def connected?: () -> bool
+      def on_open: () { (?) -> untyped } -> untyped
 
-      private
+      def on_close: () { (?) -> untyped } -> untyped
+
+      def on_error: () { (?) -> untyped } -> untyped
 
-      def generate_message_id: () -> Integer
+      def remove_message_listener: (untyped block) -> untyped
 
-      def create_socket: () -> WebSocket::Driver
+      def remove_event_listener: (untyped name, untyped listener) -> untyped
 
-      def handle_open: () -> void
+      def remove_open_listener: (untyped listener) -> untyped
 
-      def handle_message: (String data) -> void
+      def remove_close_listener: (untyped listener) -> untyped
 
-      def handle_close: () -> void
+      def remove_error_listener: (untyped listener) -> untyped
 
-      def handle_error: (Exception error) -> void
+      private
 
-      def dispatch_event: (String event_name, Hash[String, untyped] params) -> void
+      def setup_message_handler: () -> untyped
 
-      def listen_for_messages: () -> void
+      def setup_connection_lifecycle_handlers: () -> untyped
     end
   end
-end
+end

data/sig/bidi2pdf/chromedriver_manager.rbs

@@ -1,42 +1,77 @@
 module Bidi2pdf
   class ChromedriverManager
-    @port: Integer
-    @headless: bool
+    @port: untyped
+
+    @headless: untyped
+
     @session: untyped
-    @pid: Integer?
 
-    attr_reader port: Integer
-    attr_reader pid: Integer?
-    attr_reader session: untyped
+    @started: untyped
+
+    @chrome_args: untyped
+
+    @shutdown_mutex: untyped
+
+    @pid: untyped
+
+    include Chromedriver::Binary::Platform
+
+    attr_reader port: untyped
+
+    attr_reader pid: untyped
+
+    attr_reader started: untyped
+
+    attr_reader headless: untyped
 
-    def initialize: (?port: Integer, ?headless: bool) -> void
+    attr_reader chrome_args: untyped
 
-    def start: () -> self
+    attr_reader shutdown_mutex: untyped
 
-    def stop: (?timeout: Integer) -> bool
+    attr_accessor reader_thread: untyped
+
+    def initialize: (?port: ::Integer, ?headless: bool, ?chrome_args: untyped) -> void
+
+    def start: () -> untyped
+
+    def session: () -> (nil | untyped)
+
+    def session_url: () -> (nil | ::String)
+
+    # rubocop: disable Metrics/AbcSize
+    def stop: (?timeout: ::Integer) -> untyped
 
     private
 
-    # rubocop:disable Metrics/AbcSize
-    def detect_zombie_processes: () -> Array[Integer]?
+    def spawn_process: (untyped cmd) -> untyped
+
+    def detect_zombie_processes: (untyped old_childprocesses) -> (nil | untyped)
+
+    def term_zombie_processes: (untyped zombie_processes) -> untyped
+
+    def debug_show_all_children: () -> untyped
+
+    def close_session: () -> untyped
+
+    def term_chromedriver: () -> untyped
 
-    def debug_show_all_children: () -> void
+    def kill_chromedriver: (?timeout: ::Integer) -> untyped
 
-    def close_session: () -> void
+    def build_cmd: () -> untyped
 
-    def term_chromedriver: () -> bool
+    def chromedriver_log_level: () -> untyped
 
-    def kill_chromedriver: (?timeout: Integer) -> bool
+    def user_data_dir_arg: () -> (untyped | ::String)
 
-    def build_cmd: () -> Array[String]
+    def process_chrome_args: () -> (::Array[untyped] | untyped)
 
-    def update_chromedriver: () -> void
+    def update_chromedriver: () -> untyped
 
-    # rubocop:disable Metrics/AbcSize
-    def parse_port_from_output: (IO io, ?timeout: Integer) -> Integer?
+    # rubocop: disable Metrics/AbcSize
+    def parse_port_from_output: (untyped io, ?timeout: ::Integer) -> (nil | untyped)
 
-    def process_alive?: (?pid: Integer?) -> bool
+    def process_alive?: (?untyped pid) -> (false | untyped)
 
-    def wait_until_chromedriver_ready: (?timeout: Integer) -> bool
+    def wait_until_chromedriver_ready: (?timeout: ::Integer) -> (true | untyped)
   end
-end
+end

data/sig/bidi2pdf/cli.rbs

@@ -1,13 +1,31 @@
 module Bidi2pdf
+  # rubocop:disable Metrics/AbcSize
   class CLI < Thor
-    # rubocop:disable Layout/BeginEndAlignment
     @launcher: untyped
 
+    def self.exit_on_failure?: () -> true
+
     def render: () -> untyped
 
+    def version: () -> untyped
+
+    def template: () -> untyped
+
     private
 
-    # rubocop:disable  Metrics/AbcSize
+    def load_config: () -> (nil | untyped)
+
+    def validate_required_options!: () -> (untyped | untyped | nil)
+
+    def validate_print_options: (untyped opts) -> untyped
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def print_options: () -> untyped
+
+    def option_provided?: (untyped key) -> untyped
+
+    def assign_if_provided: (untyped hash, untyped key, ?untyped option_key) -> (untyped | nil)
+
     def launcher: () -> untyped
 
     def configure: () -> untyped
@@ -17,5 +35,7 @@ module Bidi2pdf
     def parse_key_values: (untyped pairs) -> untyped
 
     def parse_auth: (untyped auth_string) -> ::Array[untyped]
+
+    def merged_options: () -> untyped
   end
 end

data/sig/bidi2pdf/dsl.rbs

@@ -0,0 +1,34 @@
+module Bidi2pdf
+  module DSL
+    # rubocop: disable  Metrics/AbcSize
+    #
+    # Executes a block of code within the context of a browser tab.
+    #
+    # This method handles the setup and teardown of a browser session, user context,
+    # browser window, and tab. It ensures that resources are properly cleaned up
+    # after the block is executed.
+    #
+    # @param [String, nil] remote_browser_url The URL of a remote browser to connect to.
+    #   If provided, the session will connect to this browser in headless mode.
+    # @param [Integer] port The port to use for the local browser session. Defaults to 0 (chooses a random port).
+    # @param [Boolean] headless Whether to run the browser in headless mode. Defaults to true.
+    # @param [Array<String>] chrome_args Additional arguments to pass to the Chrome browser.
+    #   Defaults to the `DEFAULT_CHROME_ARGS` from the `Bidi2pdf::Bidi::Session` class.
+    #
+    # @yield [tab] The browser tab created within the session.
+    # @yieldparam [Object] tab The browser tab object.
+    #
+    # @example Using a local browser session
+    #   Bidi2pdf::DSL.with_tab(port: 9222, headless: false) do |tab|
+    #     # Perform actions with the tab
+    #   end
+    #
+    # @example Using a remote browser session
+    #   Bidi2pdf::DSL.with_tab(remote_browser_url: "http://remote-browser:9222/session") do |tab|
+    #     # Perform actions with the tab
+    #   end
+    #
+    # @return [void]
+    def self.with_tab: (?remote_browser_url: untyped?, ?port: ::Integer, ?headless: bool, ?chrome_args: untyped) { (untyped) -> untyped } -> untyped
+  end
+end

data/sig/bidi2pdf/launcher.rbs

@@ -1,7 +1,39 @@
 module Bidi2pdf
+  # Represents a launcher for managing browser sessions and executing tasks
+  # using the Bidi2pdf library. This class handles the setup and teardown
+  # of browser sessions, as well as the execution of tasks within those sessions.
+  #
+  # @example Launching a session
+  #   launcher = Bidi2pdf::Launcher.new(
+  #     url: "http://example.com",
+  #     inputfile: "input.pdf",
+  #     output: "output.pdf",
+  #     cookies: [],
+  #     headers: {},
+  #     auth: nil,
+  #     headless: true
+  #   )
+  #   launcher.launch
+  #   launcher.stop
+  #
+  # @param [String] url The URL to navigate to in the browser session.
+  # @param [String] inputfile The path to the input file to be processed.
+  # @param [String] output The path to the output file to be generated.
+  # @param [Array<Hash>] cookies An array of cookies to set in the browser session.
+  # @param [Hash] headers A hash of HTTP headers to include in the browser session.
+  # @param [Hash, nil] auth Authentication credentials (e.g., username and password).
+  # @param [Boolean] headless Whether to run the browser in headless mode. Defaults to true.
+  # @param [Integer] port The port to use for the browser session. Defaults to 0.
+  # @param [Boolean] wait_window_loaded Whether to wait for the window to fully load. Defaults to false.
+  # @param [Boolean] wait_network_idle Whether to wait for the network to become idle. Defaults to false.
+  # @param [Hash] print_options Options for printing the page. Defaults to an empty hash.
+  # @param [String, nil] remote_browser_url The URL of a remote browser to connect to. Defaults to nil.
+  # @param [Symbol] network_log_format The format for network logs. Defaults to :console.
   class Launcher
     @url: untyped
 
+    @inputfile: untyped
+
     @port: untyped
 
     @headless: untyped
@@ -24,8 +56,14 @@ module Bidi2pdf
 
     @remote_browser_url: untyped
 
+    @custom_session: untyped
+
+    @network_log_format: untyped
+
+    @chrome_args: untyped
+
     # rubocop:disable Metrics/ParameterLists
-    def initialize: (url: untyped, output: untyped, cookies: untyped, headers: untyped, auth: untyped, ?headless: bool, ?port: ::Integer, ?wait_window_loaded: bool, ?wait_network_idle: bool, ?print_options: ::Hash[untyped, untyped], ?remote_browser_url: untyped?) -> void
+    def initialize: (url: untyped, inputfile: untyped, output: untyped, cookies: untyped, headers: untyped, auth: untyped, ?headless: bool, ?port: ::Integer, ?wait_window_loaded: bool, ?wait_network_idle: bool, ?print_options: ::Hash[untyped, untyped], ?remote_browser_url: untyped?, ?network_log_format: ::Symbol, ?chrome_args: untyped) -> void
 
     def launch: () -> untyped
 

data/sig/bidi2pdf/notifications/event.rbs

@@ -0,0 +1,40 @@
+module Bidi2pdf
+  # rubocop: disable Lint/RescueException
+  module Notifications
+    class Event
+      @name: untyped
+
+      @payload: untyped
+
+      @time: untyped
+
+      @transaction_id: untyped
+
+      @end: untyped
+
+      attr_reader name: untyped
+
+      attr_reader transaction_id: untyped
+
+      attr_accessor payload: untyped
+
+      def initialize: (untyped name, untyped start, untyped ending, untyped transaction_id, untyped payload) -> void
+
+      def record: () ?{ (untyped) -> untyped } -> untyped
+
+      def start!: () -> untyped
+
+      def finish!: () -> untyped
+
+      def duration: () -> untyped
+
+      def time: () -> (untyped | nil)
+
+      def end: () -> (untyped | nil)
+
+      private
+
+      def now: () -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/notifications/instrumenter.rbs

@@ -0,0 +1,21 @@
+module Bidi2pdf
+  # rubocop: disable Lint/RescueException, Lint/SuppressedException
+  module Notifications
+    class Instrumenter
+      @id: untyped
+
+      attr_reader id: untyped
+
+      def initialize: () -> void
+
+      def notify: (untyped name, untyped payload) { (?) -> untyped } -> untyped
+
+      private
+
+      def create_event: (untyped name, untyped payload) -> untyped
+
+      # rubocop:disable  Style/CaseEquality
+      def notify_subscribers: (untyped name, untyped event) -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/notifications/logging_subscriber.rbs

@@ -0,0 +1,41 @@
+module Bidi2pdf
+  module Notifications
+    # for reuse within ActiveSupport::LogSubscriber
+    module LoggingSubscriberActions
+      def handle_response: (untyped event) -> untyped
+
+      def send_cmd: (untyped event) -> untyped
+
+      def send_cmd_and_wait: (untyped event) -> (nil | untyped)
+
+      def session_close: (untyped event) -> (nil | untyped)
+
+      # rubocop: disable Metrics/AbcSize
+      def network_event_received: (untyped event) -> (nil | untyped)
+
+      # rubocop:disable  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def network_idle: (untyped event) -> (nil | untyped)
+
+      def page_loaded: (untyped event) -> untyped
+
+      def print: (untyped event) -> untyped
+
+      private
+
+      def redact_sensitive_fields: (untyped obj, ?::Array[untyped] sensitive_keys) -> untyped
+    end
+
+    class LoggingSubscriber
+      @logger: untyped
+
+      include LoggingSubscriberActions
+
+      attr_accessor logger: untyped
+
+      # rubocop: disable Metrics/AbcSize, Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
+      def initialize: (?logger: untyped) -> void
+
+      def unsubscribe: () -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/notifications.rbs

@@ -0,0 +1,24 @@
+module Bidi2pdf
+  module Notifications
+    self.@subscribers: untyped
+
+    attr_reader self.subscribers: untyped
+
+    def self.instrument: (untyped name, ?::Hash[untyped, untyped] payload) ?{ (untyped) -> untyped } -> untyped
+
+    def self.subscribe: (untyped event_pattern) { (?) -> untyped } -> untyped
+
+    def self.unsubscribe: (untyped event_pattern, ?untyped? block) -> untyped
+
+    # rubocop: disable Style/CaseEquality
+    def self.listening?: (untyped name) -> untyped
+
+    private
+
+    def self.bidi2pdf_notification_instrumenter: () -> untyped
+
+    def self.notify: (untyped name, untyped payload) { (?) -> untyped } -> untyped
+
+    def self.normalize_pattern: (untyped pat) -> untyped
+  end
+end

data/sig/bidi2pdf/process_tree.rbs

@@ -10,7 +10,7 @@ module Bidi2pdf
 
     def children: (untyped of_pid) -> (::Array[untyped] | untyped)
 
-    def traverse: () { () -> untyped } -> untyped
+    def traverse: () { (?) -> untyped } -> untyped
 
     private
 
@@ -22,6 +22,6 @@ module Bidi2pdf
 
     def root_pids: () -> (::Array[untyped] | untyped)
 
-    def traverse_branch: (untyped pid, ?::Integer level) { () -> untyped } -> (nil | untyped)
+    def traverse_branch: (untyped pid, ?::Integer level) { (?) -> untyped } -> (nil | untyped)
   end
 end

data/sig/bidi2pdf/session_runner.rbs

@@ -1,9 +1,43 @@
 module Bidi2pdf
+  # Represents a runner for managing browser sessions and executing tasks
+  # using the Bidi2pdf library. This class handles the setup, configuration,
+  # and execution of browser-related workflows, including navigation, cookie
+  # management, and printing.
+  #
+  # @example Running a session
+  #   session_runner = Bidi2pdf::SessionRunner.new(
+  #     session: session,
+  #     url: "http://example.com",
+  #     inputfile: "input.html",
+  #     output: "output.pdf",
+  #     cookies: { "key" => "value" },
+  #     headers: { "Authorization" => "Bearer token" },
+  #     auth: { username: "user", password: "pass" },
+  #     wait_window_loaded: true,
+  #     wait_network_idle: true,
+  #     print_options: { landscape: true },
+  #     network_log_format: :json
+  #   )
+  #   session_runner.run
+  #
+  # @param [Object] session The browser session object to use.
+  # @param [String, nil] url The URL to navigate to in the browser session.
+  # @param [String, nil] inputfile The path to the input file to be processed if no URL is provided.
+  # @param [String, nil] output The path to the output file to be generated.
+  # @param [Hash] cookies A hash of cookies to set in the browser session. Defaults to an empty hash.
+  # @param [Hash] headers A hash of HTTP headers to include in the browser session. Defaults to an empty hash.
+  # @param [Hash, nil] auth Authentication credentials (e.g., username and password). Defaults to an empty hash.
+  # @param [Boolean] wait_window_loaded Whether to wait for the window to fully load. Defaults to false.
+  # @param [Boolean] wait_network_idle Whether to wait for the network to become idle. Defaults to false.
+  # @param [Hash] print_options Options for printing the page. Defaults to an empty hash.
+  # @param [Symbol] network_log_format The format for network logs. Defaults to :console.
   class SessionRunner
     @session: untyped
 
     @url: untyped
 
+    @inputfile: untyped
+
     @output: untyped
 
     @cookies: untyped
@@ -18,13 +52,18 @@ module Bidi2pdf
 
     @print_options: untyped
 
+    @network_log_format: untyped
+
     @window: untyped
 
     @tab: untyped
 
+    @user_context: untyped
+
     @uri: untyped
 
-    def initialize: (session: untyped, url: untyped, output: untyped, ?cookies: ::Hash[untyped, untyped], ?headers: ::Hash[untyped, untyped], ?auth: ::Hash[untyped, untyped], ?wait_window_loaded: bool, ?wait_network_idle: bool, ?print_options: ::Hash[untyped, untyped]) -> void
+    # rubocop: disable Metrics/ParameterLists
+    def initialize: (session: untyped, url: untyped, inputfile: untyped, output: untyped, ?cookies: ::Hash[untyped, untyped], ?headers: ::Hash[untyped, untyped], ?auth: ::Hash[untyped, untyped], ?wait_window_loaded: bool, ?wait_network_idle: bool, ?print_options: ::Hash[untyped, untyped], ?network_log_format: ::Symbol) -> void
 
     def run: () -> untyped
 
@@ -38,6 +77,7 @@ module Bidi2pdf
 
     def add_basic_auth: () -> (nil | untyped)
 
+    # rubocop: disable Metrics/AbcSize
     def run_flow: () -> untyped
 
     def uri: () -> untyped

data/sig/bidi2pdf/test_helpers/configuration.rbs

@@ -0,0 +1,51 @@
+module Bidi2pdf
+  module TestHelpers
+    self.@configuration: untyped
+
+    class Configuration
+      @spec_dir: untyped
+
+      @docker_dir: untyped
+
+      @fixture_dir: untyped
+
+      @tmp_dir: untyped
+
+      @prefix: untyped
+
+      # @!attribute [rw] spec_dir
+      #   @return [Pathname] the directory where specs are located
+      attr_accessor spec_dir: untyped
+
+      # @!attribute [rw] tmp_dir
+      #   @return [String] the directory for temporary files
+      attr_accessor tmp_dir: untyped
+
+      # @!attribute [rw] prefix
+      #   @return [String] the prefix for temporary files
+      attr_accessor prefix: untyped
+
+      # @!attribute [rw] docker_dir
+      #  @return [String] the directory for Docker files
+      attr_accessor docker_dir: untyped
+
+      # @!attribute [rw] fixture_dir
+      # @return [String] the directory for fixture files
+      attr_accessor fixture_dir: untyped
+
+      def initialize: () -> void
+    end
+
+    # Retrieves the current configuration object for TestHelpers.
+    # @return [Configuration] the configuration object
+    def self.configuration: () -> untyped
+
+    # Sets the configuration object for TestHelpers.
+    # @param [Configuration] config the configuration object to set
+    attr_writer self.configuration: untyped
+
+    # Allows configuration of TestHelpers by yielding the configuration object.
+    # @yieldparam [Configuration] configuration the configuration object to modify
+    def self.configure: () { (untyped) -> untyped } -> untyped
+  end
+end

data/sig/bidi2pdf/test_helpers/images/extractor.rbs

@@ -0,0 +1,43 @@
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      class Extractor
+        @pages: untyped
+
+        @logger: untyped
+
+        @extracted_images: untyped
+
+        include PDFReaderUtils
+
+        include TIFFHelper
+
+        attr_reader pages: untyped
+
+        attr_reader logger: untyped
+
+        def initialize: (untyped pdf_data, ?logger: untyped) -> void
+
+        def all_images: () -> untyped
+
+        def image_on_page: (untyped page_number, untyped image_number) -> (nil | untyped)
+
+        def images_on_page: (untyped page_number) -> untyped
+
+        private
+
+        def extracted_images: () -> untyped
+
+        def extract_images: (untyped page) -> (nil | untyped)
+
+        def process_image_stream: (untyped stream) -> (nil | untyped)
+
+        def extract_raw_image_data: (untyped stream, untyped filter) -> untyped
+
+        def handle_compressed_image: (untyped stream) -> untyped
+
+        def create_vips_image: (untyped raw, untyped filter) -> untyped
+      end
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/images/image_similarity_checker.rbs

@@ -0,0 +1,35 @@
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      class ImageSimilarityChecker
+        @expected_image: untyped
+
+        @image_to_check: untyped
+
+        @expected_fingerprint: untyped
+
+        @actual_fingerprint: untyped
+
+        @distance: untyped
+
+        def initialize: (untyped expected_image, untyped image_to_check) -> void
+
+        def similar?: (?tolerance: ::Integer) -> untyped
+
+        def very_similar?: () -> untyped
+
+        def slightly_similar?: () -> untyped
+
+        def different?: () -> untyped
+
+        def expected_fingerprint: () -> untyped
+
+        def actual_fingerprint: () -> untyped
+
+        def distance: () -> untyped
+
+        def fingerprint: (untyped image) -> untyped
+      end
+    end
+  end
+end