bidi2pdf 0.1.13 → 0.1.14

data/sig/bidi2pdf/bidi/network_event.rbs

@@ -1,51 +1,59 @@
 module Bidi2pdf
   module Bidi
     class NetworkEvent
-      # Request data
-      @request_id: String
-      @url: String
-      @method: String
-      @headers: Hash[String, String]
-      @post_data: String?
-
-      # Response data
-      @response_status: Integer?
-      @response_headers: Hash[String, String]?
-      @response_body: String?
-
-      # Timing information
-      @timestamp: Float
-      @timing: Hash[Symbol, Float]?
-
-      attr_reader request_id: String
-      attr_reader url: String
-      attr_reader method: String
-      attr_reader headers: Hash[String, String]
-      attr_reader post_data: String?
-      attr_reader response_status: Integer?
-      attr_reader response_headers: Hash[String, String]?
-      attr_reader response_body: String?
-      attr_reader timestamp: Float
-      attr_reader timing: Hash[Symbol, Float]?
-
-      def initialize: (
-          request_id: String,
-          url: String,
-          method: String,
-          headers: Hash[String, String],
-          ?post_data: String?,
-          ?timestamp: Float?
-        ) -> void
-
-      def add_response: (
-          status: Integer,
-          headers: Hash[String, String],
-          ?body: String?
-        ) -> void
-
-      def add_timing: (Hash[Symbol, Float] timing_data) -> void
-
-      def completed?: () -> bool
+      @id: untyped
+
+      @url: untyped
+
+      @start_timestamp: untyped
+
+      @timing: untyped
+
+      @state: untyped
+
+      @http_status_code: untyped
+
+      @http_method: untyped
+
+      @end_timestamp: untyped
+
+      @bytes_received: untyped
+
+      attr_reader id: untyped
+
+      attr_reader url: untyped
+
+      attr_reader state: untyped
+
+      attr_reader start_timestamp: untyped
+
+      attr_reader end_timestamp: untyped
+
+      attr_reader timing: untyped
+
+      attr_reader http_status_code: untyped
+
+      attr_reader http_method: untyped
+
+      attr_reader bytes_received: untyped
+
+      STATE_MAP: { "network.responseStarted" => "started", "network.responseCompleted" => "completed", "network.fetchError" => "error" }
+
+      def initialize: (id: untyped, url: untyped, timestamp: untyped, timing: untyped, state: untyped, ?http_status_code: untyped?, ?http_method: untyped?) -> void
+
+      def update_state: (untyped new_state, ?timestamp: untyped?, ?timing: untyped?, ?http_status_code: untyped?, ?bytes_received: untyped?) -> untyped
+
+      def map_state: (untyped state) -> untyped
+
+      def format_timestamp: (untyped timestamp) -> ("N/A" | untyped)
+
+      def duration_seconds: () -> (nil | untyped)
+
+      def in_progress?: () -> untyped
+
+      def to_s: () -> ::String
+
+      def dup: () -> untyped
     end
   end
-end
+end

data/sig/bidi2pdf/bidi/network_event_formatters/network_event_console_formatter.rbs

@@ -0,0 +1,63 @@
+module Bidi2pdf
+  module Bidi
+    module NetworkEventFormatters
+      # rubocop: disable  Metrics/AbcSize
+      class NetworkEventConsoleFormatter
+        @color_enabled: untyped
+
+        @logger: untyped
+
+        include NetworkEventFormatterUtils
+
+        attr_reader color_enabled: untyped
+
+        attr_reader logger: untyped
+
+        # ANSI styles
+        RESET: "\e[0m"
+
+        BOLD: "\e[1m"
+
+        DIM: "\e[2m"
+
+        RED: "\e[31m"
+
+        GREEN: "\e[32m"
+
+        YELLOW: "\e[33m"
+
+        CYAN: "\e[36m"
+
+        GRAY: "\e[90m"
+
+        def initialize: (?color: bool, ?logger: untyped) -> void
+
+        def log: (untyped events) -> untyped
+
+        def pretty_log: (untyped event) -> untyped
+
+        private
+
+        def format_timing: (untyped event) -> ("" | untyped)
+
+        def color_for_status: (untyped code) -> untyped
+
+        def bold: (untyped str) -> (::String | untyped)
+
+        def dim: (untyped str) -> (::String | untyped)
+
+        def green: (?::String str) -> (::String | untyped)
+
+        def yellow: (?::String str) -> (::String | untyped)
+
+        def red: (?::String str) -> (::String | untyped)
+
+        def cyan: (?::String str) -> (::String | untyped)
+
+        def gray: (?::String str) -> (::String | untyped)
+
+        def reset: () -> (untyped | "")
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/network_event_formatters/network_event_formatter_utils.rbs

@@ -0,0 +1,15 @@
+module Bidi2pdf
+  module Bidi
+    module NetworkEventFormatters
+      module NetworkEventFormatterUtils
+        def format_bytes: (untyped size) -> ("N/A" | untyped)
+
+        def parse_timing: (untyped event) -> (::Array[untyped] | untyped)
+
+        def format_timestamp: (untyped timestamp) -> ("N/A" | untyped)
+
+        def shorten_url: (untyped url) -> (untyped | "data:text/html,...")
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/network_event_formatters/network_event_html_formatter.rbs

@@ -0,0 +1,18 @@
+module Bidi2pdf
+  module Bidi
+    module NetworkEventFormatters
+      class NetworkEventHtmlFormatter
+        include NetworkEventFormatterUtils
+
+        def render: (untyped events) -> (nil | ::String)
+
+        def toc_entry: (untyped event, untyped index) -> ::String
+
+        # rubocop: disable Metrics/AbcSize
+        def render_event: (untyped event, untyped index) -> ::String
+
+        def render_timing_bars: (untyped timing) -> ("" | ::String)
+      end
+    end
+  end
+end

data/sig/bidi2pdf/bidi/network_event_formatters.rbs

@@ -0,0 +1,6 @@
+module Bidi2pdf
+  module Bidi
+    module NetworkEventFormatters
+    end
+  end
+end

data/sig/bidi2pdf/bidi/network_events.rbs

@@ -1,55 +1,30 @@
 module Bidi2pdf
   module Bidi
     class NetworkEvents
-      include Enumerable[NetworkEvent]
+      @context_id: untyped
 
-      @events: Hash[String, NetworkEvent]
-      @browser: Bidi2pdf::Bidi::Browser?
-      @event_manager: Bidi2pdf::Bidi::EventManager?
-      @recording: bool
-      @filters: Array[Proc]
+      @events: untyped
 
-      attr_reader events: Hash[String, NetworkEvent]
-      attr_reader recording: bool
+      @network_event_formatter: untyped
 
-      def initialize: (?browser: Bidi2pdf::Bidi::Browser?) -> void
+      attr_reader context_id: untyped
 
-      def start_recording: (?browser: Bidi2pdf::Bidi::Browser?) -> void
+      attr_reader events: untyped
 
-      def stop_recording: () -> void
+      attr_reader network_event_formatter: untyped
 
-      def add_filter: () { (NetworkEvent) -> bool } -> void
+      def initialize: (untyped context_id) -> void
 
-      def clear_filters: () -> void
+      def handle_event: (untyped data) -> untyped
 
-      def clear: () -> void
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def handle_response: (untyped method, untyped event) -> (nil | untyped)
 
-      def size: () -> Integer
+      def all_events: () -> untyped
 
-      def []: (String request_id) -> NetworkEvent?
+      def log_network_traffic: (?format: ::Symbol) -> untyped
 
-      def each: () { (NetworkEvent) -> void } -> self
-        | () -> Enumerator[NetworkEvent, self]
-
-      def find_by_url: (String url_pattern) -> Array[NetworkEvent]
-
-      def find_by_method: (String method) -> Array[NetworkEvent]
-
-      def completed_requests: () -> Array[NetworkEvent]
-
-      def pending_requests: () -> Array[NetworkEvent]
-
-      def to_a: () -> Array[NetworkEvent]
-
-      private
-
-      def setup_event_listeners: () -> void
-
-      def handle_request_event: (Hash[String, untyped] params) -> void
-
-      def handle_response_event: (Hash[String, untyped] params) -> void
-
-      def handle_loading_finished_event: (Hash[String, untyped] params) -> void
+      def wait_until_network_idle: (?timeout: ::Integer, ?poll_interval: ::Float) -> untyped
     end
   end
-end
+end

data/sig/bidi2pdf/bidi/session.rbs

@@ -1,52 +1,165 @@
+# Represents a session for managing browser interactions and communication
+# using the Bidi2pdf library. This class handles the setup, configuration,
+# and execution of browser-related workflows, including session creation,
+# WebSocket communication, and browser management.
+#
+# @example Creating and starting a session
+#   session = Bidi2pdf::Bidi::Session.new(session_url: "http://example.com/session", headless: true)
+#   session.start
+#
+# @example Retrieving user contexts
+#   session.user_contexts
+#
+# @example Closing the session
+#   session.close
+#
+# @param [String] session_url The URL for the session.
+# @param [Boolean] headless Whether to run the browser in headless mode. Defaults to true.
+# @param [Array<String>] chrome_args Additional Chrome arguments. Defaults to predefined arguments.
 module Bidi2pdf
   module Bidi
     class Session
-      @browser: Bidi2pdf::Bidi::Browser
-      @session_id: String?
-      @contexts: Array[String]
-      @timeout: Integer
-      @event_manager: Bidi2pdf::Bidi::EventManager?
-      @network_events: Bidi2pdf::Bidi::NetworkEvents?
+      @session_uri: untyped
 
-      attr_reader browser: Bidi2pdf::Bidi::Browser
-      attr_reader session_id: String?
-      attr_reader contexts: Array[String]
+      @headless: untyped
 
-      def initialize: (
-          browser: Bidi2pdf::Bidi::Browser,
-          ?session_id: String?,
-          ?timeout: Integer
-        ) -> void
+      @started: untyped
 
-      def create: () -> String
+      @chrome_args: untyped
 
-      def attach: (session_id: String) -> String
+      @client: untyped
 
-      def detach: () -> void
+      @browser: untyped
 
-      def execute_command: [T] (String method, ?Hash[Symbol, untyped] params) -> T
+      @websocket_url: untyped
 
-      def navigate_to: (String url) -> void
+      # Events to subscribe to during the session.
+      SUBSCRIBE_EVENTS: ::Array["script"]
 
-      def evaluate: [T] (String script) -> T
+      # Default Chrome arguments for the session.
+      DEFAULT_CHROME_ARGS: ::Array["--allow-pre-commit-input" | "--disable-dev-shm-usage" | "--disable-gpu" | "--disable-popup-blocking" | "--disable-hang-monitor" | "--disable-background-networking" | "--disable-background-timer-throttling" | "--disable-client-side-phishing-detection" | "--disable-component-extensions-with-background-pages" | "--disable-crash-reporter" | "--disable-default-apps" | "--disable-infobars" | "--disable-ipc-flooding-protection" | "--disable-prompt-on-repost" | "--disable-renderer-backgrounding" | "--disable-search-engine-choice-screen" | "--disable-sync" | "--enable-automation" | "--export-tagged-pdf" | "--force-color-profile=srgb" | "--generate-pdf-document-outline" | "--metrics-recording-only" | "--no-first-run" | "--password-store=basic" | "--use-mock-keychain" | "--disable-backgrounding-occluded-windows" | "--disable-breakpad" | "--enable-features=PdfOopif" | "--disable-features=Translate,AcceptCHFrame,MediaRouter,OptimizationHints,ProcessPerSiteUpToMainFrameThreshold,IsolateSandboxedIframes" | "--disable-extensions about:blank"]
 
-      def wait_for_load: (?timeout: Integer?) -> void
+      # @return [URI] The URI of the session.
+      attr_reader session_uri: untyped
 
-      def network_events: () -> Bidi2pdf::Bidi::NetworkEvents
+      # @return [Boolean] Whether the session has started.
+      attr_reader started: untyped
 
-      def capture_screenshot: (?path: String?) -> String
+      # @return [Array<String>] The Chrome arguments for the session.
+      attr_reader chrome_args: untyped
 
-      def print_to_pdf: (
-          ?Hash[Symbol, untyped] parameters
-        ) -> String
+      # Initializes a new session.
+      #
+      # @param [String] session_url The URL for the session.
+      # @param [Boolean] headless Whether to run the browser in headless mode. Defaults to true.
+      # @param [Array<String>] chrome_args Additional Chrome arguments. Defaults to predefined arguments.
+      def initialize: (session_url: untyped, ?headless: bool, ?chrome_args: untyped) -> void
 
-      def close: () -> void
+      # Starts the session and initializes the client.
+      #
+      # @raise [StandardError] If an error occurs during session start.
+      def start: () -> untyped
 
-      private
+      # Returns the WebSocket client for the session.
+      #
+      # @return [Bidi2pdf::Bidi::Client, nil] The WebSocket client, or nil if the session is not started.
+      def client: () -> untyped
+
+      # Returns the browser instance for the session.
+      #
+      # @return [Bidi2pdf::Bidi::Browser] The browser instance.
+      def browser: () -> untyped
+
+      # Closes the session and cleans up resources.
+      # rubocop:disable Metrics/AbcSize
+      def close: () -> untyped
+
+      # Retrieves user contexts for the session.
+      def user_contexts: () -> untyped
 
-      def ensure_session: () -> String
+      # Retrieves the status of the session.
+      def status: () -> untyped
+
+      # Checks if the session has started.
+      #
+      # @return [Boolean] True if the session has started, false otherwise.
+      def started?: () -> untyped
+
+      # Retrieves the WebSocket URL for the session.
+      #
+      # @return [String] The WebSocket URL.
+      def websocket_url: () -> untyped
+
+      private
 
-      def setup_event_listeners: () -> void
+      # Sends a command to the WebSocket client.
+      #
+      # @param [Object] command The command to send.
+      # @yield [response] A block to handle the response.
+      def send_cmd: (untyped command) { (?) -> untyped } -> untyped
+
+      # Creates a new browser instance.
+      #
+      # @return [Bidi2pdf::Bidi::Browser] The browser instance.
+      # rubocop:disable Metrics/AbcSize
+      def create_browser: () -> untyped
+
+      # Creates a new WebSocket client.
+      #
+      # @return [Bidi2pdf::Bidi::Client] The WebSocket client.
+      def create_client: () -> untyped
+
+      # Creates a new session and retrieves the WebSocket URL.
+      #
+      # @return [String] The WebSocket URL.
+      def create_new_session: () -> untyped
+
+      # Builds the session request payload.
+      #
+      # @return [Hash] The session request payload.
+      def session_request: () -> { "capabilities" => { "alwaysMatch" => { "browserName" => "chrome", "goog:chromeOptions" => { "args" => untyped }, "goog:prerenderingDisabled" => true, "unhandledPromptBehavior" => { default: "ignore" }, "acceptInsecureCerts" => true, "webSocketUrl" => true } } }
+
+      # Executes an API call with the given payload.
+      #
+      # @param [Hash] payload The payload for the API call.
+      # @return [Hash] The parsed response data.
+      def exec_api_call: (untyped payload) -> untyped
+
+      # Logs an API error.
+      #
+      # @param [String] message The error message.
+      # @param [Integer] code The response code.
+      # @param [String] body The response body.
+      def log_api_error: (untyped message, untyped code, untyped body) -> untyped
+
+      # Determines the error category based on the exception.
+      #
+      # @param [Exception] exception The exception to categorize.
+      # @return [String] The error category.
+      def error_category: (untyped exception) -> untyped
+
+      # Retrieves the error description for a given error type.
+      #
+      # @param [String] type The error type.
+      # @return [String] The error description.
+      def error_description: (untyped type) -> untyped
+
+      # Builds an error response.
+      #
+      # @param [String] error The error type.
+      # @param [String] message The error message.
+      # @param [Array<String>, nil] backtrace The error backtrace.
+      # @return [Hash] The error response.
+      def build_error: (untyped error, untyped message, ?untyped? backtrace) -> { "value" => untyped }
+
+      # Handles an error response from the session.
+      #
+      # @param [Hash] value The error response value.
+      # @raise [SessionNotStartedError] If the session could not be started.
+      def handle_error: (untyped value) -> (nil | untyped)
+
+      # Cleans up resources associated with the session.
+      def cleanup: () -> untyped
     end
   end
-end
+end

data/sig/bidi2pdf/bidi/user_context.rbs

@@ -1,50 +1,69 @@
 module Bidi2pdf
   module Bidi
+    # Represents a user context for managing browser interactions and cookies
+    # using the Bidi2pdf library. This class provides methods for creating
+    # user contexts, setting cookies, and creating browser windows.
+    #
+    # @example Creating a user context
+    #   user_context = Bidi2pdf::Bidi::UserContext.new(client)
+    #
+    # @example Setting a cookie
+    #   user_context.set_cookie(
+    #     name: "session",
+    #     value: "abc123",
+    #     domain: "example.com",
+    #     source_origin: "http://example.com"
+    #   )
+    #
+    # @example Creating a browser window
+    #   browser_window = user_context.create_browser_window
+    #
+    # @param [Object] client The WebSocket client for communication.
     class UserContext
-      @browser: Bidi2pdf::Bidi::Browser
-      @context_id: String
-      @session_id: String?
-      @event_manager: Bidi2pdf::Bidi::EventManager?
-      @network_events: Bidi2pdf::Bidi::NetworkEvents?
-      @closed: bool
-
-      attr_reader context_id: String
-      attr_reader browser: Bidi2pdf::Bidi::Browser
-      attr_reader session_id: String?
-
-      def initialize: (
-          browser: Bidi2pdf::Bidi::Browser,
-          context_id: String,
-          ?session_id: String?
-        ) -> void
-
-      def create_session: () -> String
-
-      def attach_session: (session_id: String) -> String
-
-      def execute_command: [T] (String method, ?Hash[Symbol, untyped] params) -> T
-
-      def navigate_to: (String url) -> void
-
-      def evaluate: [T] (String script) -> T
-
-      def wait_for_load: (?timeout: Integer?) -> void
-
-      def network_events: () -> Bidi2pdf::Bidi::NetworkEvents
-
-      def capture_screenshot: (?path: String?) -> String
-
-      def print_to_pdf: (?Hash[Symbol, untyped] parameters) -> String
-
-      def close: () -> void
-
-      def closed?: () -> bool
-
-      private
-
-      def ensure_open: () -> void
-
-      def setup_event_listeners: () -> void
+      @client: untyped
+
+      @context_id: untyped
+
+      # @return [Object] The WebSocket client.
+      attr_reader client: untyped
+
+      # Initializes a new user context.
+      #
+      # @param [Object] client The WebSocket client for communication.
+      def initialize: (untyped client) -> void
+
+      # Retrieves the user context ID, creating it if it does not exist.
+      #
+      # @return [String] The user context ID.
+      # @raise [RuntimeError] If an error occurs while creating the user context.
+      def context_id: () -> untyped
+
+      # Sets a cookie in the user context.
+      #
+      # @param [String] name The name of the cookie.
+      # @param [String] value The value of the cookie.
+      # @param [String] domain The domain for the cookie.
+      # @param [String] source_origin The source origin for the cookie.
+      # @param [String] path The path for the cookie. Defaults to "/".
+      # @param [Boolean] secure Whether the cookie is secure. Defaults to true.
+      # @param [Boolean] http_only Whether the cookie is HTTP-only. Defaults to false.
+      # @param [String] same_site The SameSite attribute for the cookie. Defaults to "strict".
+      # @param [Integer] ttl The time-to-live for the cookie in seconds. Defaults to 30.
+      def set_cookie: (name: untyped, value: untyped, domain: untyped, source_origin: untyped, ?path: ::String, ?secure: bool, ?http_only: bool, ?same_site: ::String, ?ttl: ::Integer) -> untyped
+
+      # Creates a new browser window in the user context.
+      #
+      # @return [BrowserTab] The newly created browser tab.
+      def create_browser_window: () -> untyped
+
+      # Closes the user context.
+      #
+      # This method removes the user context from the browser, effectively cleaning up
+      # any associated resources. If the user context does not exist, the method does nothing.
+      #
+      # @return [nil]
+      # @raise [RuntimeError] If an error occurs while removing the user context.
+      def close: () -> (nil | untyped)
     end
   end
-end
+end