appium_lib_core 9.1.3 → 9.2.1

data/rbs_collection.yaml

@@ -0,0 +1,15 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true

data/sig/gems/selenium/abstract_event_listener.rbs

@@ -0,0 +1,8 @@
+module Selenium
+  module WebDriver
+    module Support
+      class AbstractEventListener
+      end
+    end
+  end
+end

data/sig/gems/selenium/capabilities.rbs

@@ -0,0 +1,8 @@
+module Selenium
+  module WebDriver
+    module Remote
+        class Capabilities
+        end
+    end
+  end
+end

data/sig/gems/selenium/common.rbs

@@ -0,0 +1,10 @@
+module Selenium
+  module WebDriver
+    module Remote
+      module Http
+        class Common
+        end
+      end
+    end
+  end
+end

data/sig/gems/selenium/default.rbs

@@ -0,0 +1,10 @@
+module Selenium
+  module WebDriver
+    module Remote
+      module Http
+        class Default
+        end
+      end
+    end
+  end
+end

data/sig/gems/selenium/driver.rbs

@@ -0,0 +1,7 @@
+module Selenium
+  module WebDriver
+    class Driver
+      def capabilities: () -> untyped
+    end
+  end
+end

data/sig/gems/selenium/has_session_id.rbs

@@ -0,0 +1,8 @@
+module Selenium
+  module WebDriver
+    module DriverExtensions
+      module HasSessionId
+      end
+    end
+  end
+end

data/sig/gems/selenium/has_web_storage.rbs

@@ -0,0 +1,8 @@
+module Selenium
+  module WebDriver
+    module DriverExtensions
+      module HasWebStorage
+      end
+    end
+  end
+end

data/sig/gems/selenium/uploads_files.rbs

@@ -0,0 +1,8 @@
+module Selenium
+  module WebDriver
+    module DriverExtensions
+      module UploadsFiles
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/capabilities.rbs

@@ -0,0 +1,9 @@
+module Appium
+  module Core
+    class Base
+      class Capabilities < Selenium::WebDriver::Remote::Capabilities
+        def convert_key: (untyped key) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/driver.rbs

@@ -0,0 +1,167 @@
+module Appium
+  module Core
+    class Base
+      class Driver < Selenium::WebDriver::Driver
+        @wait_timeout: untyped
+
+        @wait_interval: untyped
+
+        @devtools: untyped
+
+        @bidi: untyped
+
+        @bridge: untyped
+
+        @settings: untyped
+
+        @ime: untyped
+
+        @logs: untyped
+
+        include Selenium::WebDriver::DriverExtensions::UploadsFiles
+
+        include Selenium::WebDriver::DriverExtensions::HasSessionId
+
+        include Selenium::WebDriver::DriverExtensions::HasWebStorage
+
+        include Base::Rotatable
+
+        include Base::TakesScreenshot
+
+        include Base::HasRemoteStatus
+
+        include Base::HasLocation
+
+        include Base::HasNetworkConnection
+
+        include Core::Waitable
+
+        attr_reader bridge: untyped
+
+        def initialize: (?bridge: untyped?, ?listener: untyped?, **untyped opts) -> void
+
+        private
+
+        def create_bridge: (**untyped opts) -> untyped
+
+        public
+
+        def update_sending_request_to: (protocol: untyped, host: untyped, port: untyped, path: untyped) -> (nil | untyped)
+
+        AVAILABLE_METHODS: ::Array[:get | :head | :post | :put | :delete | :connect | :options | :trace | :patch]
+
+        def add_command: (method: untyped, url: untyped, name: untyped) { () -> untyped } -> untyped
+
+        def key_action: (?async: bool) -> untyped
+
+        def lock: (?untyped? duration) -> untyped
+
+        def locked?: () -> untyped
+
+        alias device_locked? locked?
+
+        def unlock: () -> untyped
+
+        def hide_keyboard: (?untyped? close_key, ?untyped? strategy) -> untyped
+
+        def keyboard_shown?: () -> untyped
+
+        alias is_keyboard_shown keyboard_shown?
+
+        def settings: () -> untyped
+
+        def get_settings: () -> untyped
+
+        def settings=: (untyped value) -> untyped
+
+        alias update_settings settings=
+
+        def ime: () -> untyped
+
+        def ime_activate: (untyped ime_name) -> untyped
+
+        def ime_available_engines: () -> untyped
+
+        def ime_active_engine: () -> untyped
+
+        def ime_activated: () -> untyped
+
+        def ime_deactivate: () -> untyped
+
+        def within_context: (untyped context) ?{ () -> untyped } -> untyped
+
+        def current_context: () -> untyped
+
+        def available_contexts: () -> untyped
+
+        def context=: (?untyped? context) -> untyped
+
+        alias set_context context=
+
+        def push_file: (untyped path, untyped filedata) -> untyped
+
+        def pull_file: (untyped path) -> untyped
+
+        def pull_folder: (untyped path) -> untyped
+
+        def press_keycode: (untyped key, ?metastate: untyped, ?flags: untyped) -> untyped
+
+        def long_press_keycode: (untyped key, ?metastate: untyped, ?flags: untyped) -> untyped
+
+        def app_strings: (?untyped? language) -> untyped
+
+        def background_app: (?::Integer duration) -> untyped
+
+        def install_app: (untyped path, **untyped options) -> untyped
+
+        def remove_app: (untyped app_id, ?keep_data: untyped?, ?timeout: untyped?) -> untyped
+
+        def app_installed?: (untyped app_id) -> untyped
+
+        def activate_app: (untyped app_id) -> untyped
+
+        def terminate_app: (untyped app_id, ?timeout: untyped?) -> untyped
+
+        def app_state: (untyped app_id) -> untyped
+
+        alias query_app_state app_state
+
+        def stop_recording_screen: (?remote_path: untyped?, ?user: untyped?, ?pass: untyped?, ?method: ::String) -> untyped
+
+        def stop_and_save_recording_screen: (untyped file_path) -> untyped
+
+        def shake: () -> untyped
+
+        def device_time: (?untyped? format) -> untyped
+
+        def perform_actions: (untyped data) -> nil
+
+        def window_size: () -> untyped
+
+        def window_rect: () -> untyped
+
+        def back: () -> untyped
+
+        def logs: () -> untyped
+
+        def get_timeouts: () -> untyped
+
+        def match_images_features: (first_image: untyped, second_image: untyped, ?detector_name: ::String, ?match_func: ::String, ?good_matches_factor: untyped?, ?visualize: bool) -> untyped
+
+        def find_image_occurrence: (full_image: untyped, partial_image: untyped, ?visualize: bool, ?threshold: untyped?, ?multiple: untyped?, ?match_neighbour_threshold: untyped?) -> untyped
+
+        def get_images_similarity: (first_image: untyped, second_image: untyped, ?visualize: bool) -> untyped
+
+        def compare_images: (first_image: untyped, second_image: untyped, ?mode: ::Symbol, ?options: untyped?) -> untyped
+
+        def find_element_by_image: (untyped img_path) -> untyped
+
+        def find_elements_by_image: (untyped img_path) -> untyped
+
+        def execute_driver: (?script: ::String, ?type: ::String, ?timeout_ms: untyped?) -> untyped
+
+        def convert_to_element: (untyped response_id) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/driver_settings.rbs

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    class Base
+      class DriverSettings
+        @bridge: untyped
+
+        def initialize: (untyped bridge) -> void
+
+        def get: () -> untyped
+
+        def update: (untyped settings) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/has_location.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    class Base
+      module HasLocation
+        def location: () -> untyped
+
+        def location=: (untyped location) -> untyped
+
+        def set_location: (untyped latitude, untyped longitude, untyped altitude, ?speed: untyped?, ?satellites: untyped?) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/has_network_connection.rbs

@@ -0,0 +1,19 @@
+module Appium
+  module Core
+    class Base
+      module HasNetworkConnection
+        def network_connection_type: () -> untyped
+
+        def network_connection_type=: (untyped connection_type) -> untyped
+
+        private
+
+        def type_to_values: () -> Hash[Symbol, Integer]
+
+        def values_to_type: () -> untyped
+
+        def valid_type?: (untyped type) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/http_default.rbs

@@ -0,0 +1,38 @@
+module Appium
+  module Core
+    class Base
+      module Http
+        module RequestHeaders
+          KEYS: Hash[Symbol, String]
+        end
+
+        class Default < Selenium::WebDriver::Remote::Http::Default
+          @open_timeout: untyped
+
+          @read_timeout: untyped
+
+          @additional_headers: untyped
+
+          @http: untyped
+
+          @server_url: untyped
+
+          attr_reader additional_headers: untyped
+
+          # override
+          def initialize: (?open_timeout: untyped?, ?read_timeout: untyped?) -> void
+
+          def set_additional_header: (untyped key, untyped value) -> untyped
+
+          def delete_additional_header: (untyped key) -> untyped
+
+          def update_sending_request_to: (scheme: untyped, host: untyped, port: untyped, path: untyped) -> untyped
+
+          private
+
+          def validate_url_param: (untyped scheme, untyped host, untyped port, untyped path) -> bool
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/platform.rbs

@@ -0,0 +1,7 @@
+module Appium
+  module Core
+    class Base
+      def self.platform: () -> untyped
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/remote_status.rbs

@@ -0,0 +1,9 @@
+module Appium
+  module Core
+    class Base
+      module HasRemoteStatus
+        def remote_status: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/rotable.rbs

@@ -0,0 +1,17 @@
+module Appium
+  module Core
+    class Base
+      module Rotatable
+        ORIENTATIONS: Array[Symbol]
+
+        def rotation=: (untyped orientation) -> untyped
+
+        alias rotate rotation=
+
+        alias orientation= rotation=
+
+        def orientation: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/screenshot.rbs

@@ -0,0 +1,19 @@
+module Appium
+  module Core
+    class Base
+      module TakesScreenshot
+        def save_screenshot: (untyped png_path) -> untyped
+
+        def screenshot_as: (untyped format) -> untyped
+
+        def save_element_screenshot: (untyped element, untyped png_path) -> untyped
+
+        alias take_element_screenshot save_element_screenshot
+
+        def element_screenshot_as: (untyped element, untyped format) -> untyped
+
+        def save_viewport_screenshot: (untyped png_path) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/device/battery_status.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module BatteryStatus
+          ANDROID: Array[Symbol]
+
+          IOS: Array[Symbol]
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/wait.rbs

@@ -0,0 +1,31 @@
+module Appium
+  module Core
+    module Wait
+      class TimeoutError < StandardError
+      end
+
+      DEFAULT_TIMEOUT: Integer
+
+      DEFAULT_INTERVAL: Float
+
+      def self.until: (?timeout: untyped, ?interval: untyped, ?message: untyped?, ?ignored: untyped?, ?object: untyped?) { (untyped) -> untyped } -> untyped
+
+      def self.until_true: (?timeout: untyped, ?interval: untyped, ?message: untyped?, ?ignored: untyped?, ?object: untyped?) { (untyped) -> untyped } -> untyped
+
+      private
+
+      def self.message_for: (untyped timeout, untyped message) -> untyped
+    end
+
+    module Waitable
+
+      def wait_until_true: (?timeout: untyped?, ?interval: untyped?, ?message: untyped?, ?ignored: untyped?) { (?) -> untyped } -> untyped
+
+      alias wait_true wait_until_true
+
+      def wait_until: (?timeout: untyped?, ?interval: untyped?, ?message: untyped?, ?ignored: untyped?) { (?) -> untyped } -> untyped
+
+      alias wait wait_until
+    end
+  end
+end

data/sig/lib/appium_lib_core/device.rbs

@@ -0,0 +1,21 @@
+module Appium
+  module Core
+    module Device
+      extend Forwardable
+
+      def self.extended: (untyped _mod) -> untyped
+
+      def self.add_endpoint_method: (untyped method) ?{ () -> untyped } -> untyped
+
+      def self.extend_webdriver_with_forwardable: () -> (nil | untyped)
+
+      private
+
+      def self.delegate_from_appium_driver: (untyped method, Symbol? delegation_target) -> (nil | untyped)
+
+      def self.delegate_driver_method: (untyped method) -> (nil | untyped)
+
+      def self.create_bridge_command: (untyped method) ?{ () -> untyped } -> untyped
+    end
+  end
+end

data/sig/lib/appium_lib_core/driver.rbs

@@ -0,0 +1,200 @@
+module Appium
+  Location: Class
+
+  module Core
+    module Android
+    end
+
+    module Ios
+    end
+
+    class Options
+      @custom_url: String
+
+      @default_wait: Integer
+
+      @enable_idempotency_header: bool
+
+      @direct_connect: bool
+
+      @port: Integer
+
+      @wait_timeout: Integer
+
+      @wait_interval: Integer
+
+      @listener: Selenium::WebDriver::Support::AbstractEventListener
+
+      attr_reader custom_url: String
+
+      attr_reader default_wait: Integer
+
+      attr_reader port: Integer
+
+      attr_reader wait_timeout: Integer
+
+      attr_reader wait_interval: Integer
+
+      attr_reader listener: Selenium::WebDriver::Support::AbstractEventListener
+
+      attr_reader direct_connect: bool
+
+      attr_reader enable_idempotency_header: bool
+
+      def initialize: (Hash[Symbol, String] appium_lib_opts) -> void
+
+      private
+
+      def default_tmp_appium_lib_session: () -> String
+    end
+
+    class DirectConnections
+      @protocol: String
+
+      @host: String
+
+      @port: String
+
+      @path: String
+
+      KEYS: Hash[String | Symbol, String]
+
+      W3C_KEYS: Hash[String | Symbol, String]
+
+      attr_reader protocol: String
+
+      attr_reader host: String
+
+      attr_reader port: String
+
+      attr_reader path: String
+
+      def initialize: (Hash[String | Symbol, String] capabilities) -> void
+    end
+
+    class Driver
+      @delegate_target: self
+
+      @automation_name: Symbol
+
+      @custom_url: String
+
+      @caps: Hash[Symbol | String, Symbol | String | Integer]
+
+      @http_client: Core::Base::Http::Default
+
+      @driver: Core::Base::Driver
+
+      @device: Symbol | String
+
+      @enable_idempotency_header: bool
+
+      @default_wait: Integer
+
+      @port: Integer
+
+      @wait_timeout: Integer
+
+      @wait_interval: Integer
+
+      @listener: Selenium::WebDriver::Support::AbstractEventListener
+
+      @direct_connect: bool
+
+      include Waitable
+
+      attr_reader caps: Base::Capabilities
+
+      attr_reader http_client: Base::Http::Default
+
+      attr_reader enable_idempotency_header: bool
+
+      attr_reader device: Symbol
+
+      attr_reader automation_name: Symbol
+
+      attr_reader custom_url: String
+
+      attr_reader default_wait: Integer
+
+      attr_reader port: Integer
+
+      DEFAULT_APPIUM_PORT: Integer
+
+      attr_reader wait_timeout: Integer
+
+      attr_reader wait_interval: Integer
+
+      attr_reader listener: Selenium::WebDriver::Support::AbstractEventListener
+
+      attr_reader driver: Core::Base::Driver
+
+      attr_reader direct_connect: bool
+
+      def self.for: (Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric] opts) -> Driver
+
+      def self.attach_to: (
+          String session_id,
+          ?url: String?,
+          ?automation_name: Symbol,
+          ?platform_name: String?,
+          ?http_client_ops:
+          Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric]
+        ) -> Selenium::WebDriver
+
+      private
+
+      def delegated_target_for_test: () -> self
+
+      def initialize: () -> void
+
+      public
+
+      def setup_for_new_session: (?Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric] opts) -> self
+
+      def start_driver: (?server_url: untyped?, ?http_client_ops: ::Hash[untyped, untyped]) -> untyped
+
+      def attach_to: (untyped session_id, ?url: untyped?, ?automation_name: Symbol, ?platform_name: untyped?, ?http_client_ops: Hash[untyped, untyped]) -> untyped
+
+      def get_http_client: (?http_client: untyped?, ?open_timeout: untyped?, ?read_timeout: untyped?) -> untyped
+
+      def set_implicit_wait_by_default: (untyped wait) -> untyped
+
+      def quit_driver: () -> void
+
+      def appium_server_version: () -> Hash[String, String]
+
+      private
+
+      def convert_to_symbol: (untyped? value) -> Symbol
+
+      def extend_for: (device: Symbol | String, automation_name: Symbol) -> self
+
+      extend Core
+
+      extend Core::Device
+
+      def get_caps: (Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric]? opts)
+        -> Core::Base::Capabilities
+
+      def get_appium_lib_opts: (Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric]? opts)
+        -> (Symbol | String | Hash[Symbol, String | Numeric] | Numeric)
+
+      def get_app: () -> String?
+
+      def set_app_path: () -> String?
+
+      def set_appium_lib_specific_values: (
+          Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric]? appium_lib_opts
+        ) -> self
+
+      def set_appium_device: () -> String
+
+      def set_automation_name: () -> Symbol?
+
+      def convert_downcase: (Symbol value) -> Symbol
+
+      def set_automation_name_if_nil: () -> Symbol?
+    end
+  end
+end