appium_lib_core 11.0.1 → 11.1.0

data/sig/gems/selenium/interactions.rbs

@@ -0,0 +1,11 @@
+module Selenium
+  module WebDriver
+    class Interactions
+      def key: (String key) -> untyped
+    end
+
+    class Point
+      def initialize: (Integer x, Integer y) -> untyped
+    end
+  end
+end

data/sig/gems/selenium/interfaces/commands.rbs

@@ -0,0 +1,3 @@
+interface _Commands
+  def commands: (untyped command) -> untyped
+end

data/sig/gems/selenium/interfaces/commands_list.rbs

@@ -0,0 +1,3 @@
+interface _CommandList
+  def command_list: () -> untyped
+end

data/sig/gems/selenium/interfaces/devtools.rbs

@@ -0,0 +1,3 @@
+interface _ExecuteScript
+  def execute_script: (untyped, *untyped) -> untyped
+end

data/sig/gems/selenium/interfaces/driver.rbs

@@ -0,0 +1,17 @@
+interface _Driver
+  def capabilities: () -> untyped
+
+  def devtools_url: () -> untyped
+
+  def devtools_version: () -> untyped
+
+  def devtools_address: () -> untyped
+
+  def ref: () -> untyped
+
+  def bridge: () -> untyped
+
+  def browser: () -> untyped
+
+  def service_url: (untyped service) -> untyped
+end

data/sig/gems/selenium/interfaces/features.rbs

@@ -0,0 +1,3 @@
+interface _Features
+  def upload_if_necessary: (untyped keys) -> untyped
+end

data/sig/gems/selenium/local_driver.rbs

@@ -0,0 +1,11 @@
+module Selenium
+  module WebDriver
+    module LocalDriver
+      include _Driver
+
+      def initialize_local_driver: (untyped options, untyped service, untyped url) -> Array[untyped]
+
+      def process_options: (untyped options, untyped service) -> untyped
+    end
+  end
+end

data/sig/gems/selenium/platform.rbs

@@ -0,0 +1,6 @@
+module Selenium
+  module WebDriver
+    module Platform
+    end
+  end
+end

data/sig/gems/selenium/profile_helper.rbs

@@ -0,0 +1,6 @@
+module Selenium
+  module WebDriver
+    module ProfileHelper
+    end
+  end
+end

data/sig/gems/selenium/{default.rbs → remote/bridge/commands.rbs}

@@ -1,9 +1,8 @@
 module Selenium
   module WebDriver
     module Remote
-      module Http
-        class Default
-        end
+      class Bridge
+        COMMANDS: Hash[Symbol, Array[Symbol | String]]
       end
     end
   end

data/sig/gems/selenium/{capabilities.rbs → remote/capabilities.rbs}

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

data/sig/gems/selenium/remote/http/common.rbs

@@ -0,0 +1,39 @@
+module Selenium
+  module WebDriver
+    module Remote
+      module Http
+        class Common
+          MAX_REDIRECTS: Integer
+
+          CONTENT_TYPE: String
+
+          DEFAULT_HEADERS: Hash[String, untyped]
+
+          attr_writer server_url: untyped
+
+          def quit_errors: () -> Array[untyped]
+
+          def close: () -> untyped
+
+          def call: (untyped verb, untyped url, untyped command_hash) -> untyped
+
+          def self.extra_headers: () -> untyped
+
+          def self.extra_headers=: (Hash[String, untyped]) -> untyped
+
+          def self.user_agent: () -> untyped
+
+          def self.user_agent=: (String) -> untyped
+
+          private
+
+          def server_url: () -> untyped
+
+          def request: (*untyped) -> untyped
+
+          def create_response: (untyped code, untyped body, untyped content_type) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/gems/selenium/remote/http/default.rbs

@@ -0,0 +1,48 @@
+module Selenium
+  module WebDriver
+    module Remote
+      module Http
+        # @api private
+        class Default < Common
+          @open_timeout: untyped
+
+          @read_timeout: untyped
+
+          @http: untyped
+
+          @proxy: untyped
+
+          attr_writer proxy: untyped
+
+          attr_accessor open_timeout: untyped
+
+          attr_accessor read_timeout: untyped
+
+          def initialize: (?open_timeout: untyped?, ?read_timeout: untyped?) -> void
+
+          def close: () -> untyped
+
+          private
+
+          def http: () -> untyped
+
+          def start: (untyped http) -> untyped
+
+          MAX_RETRIES: Integer
+
+          def request: (untyped verb, untyped url, untyped headers, untyped payload, ?::Integer redirects) -> untyped
+
+          def new_request_for: (untyped verb, untyped url, untyped headers, untyped payload) -> untyped
+
+          def response_for: (untyped request) -> untyped
+
+          def new_http_client: () -> untyped
+
+          def proxy: () -> untyped
+
+          def use_proxy?: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/gems/selenium/{common.rbs → remote/response.rbs}

@@ -1,9 +1,7 @@
 module Selenium
   module WebDriver
     module Remote
-      module Http
-        class Common
-        end
+      class Response
       end
     end
   end

data/sig/gems/selenium/safari/features.rbs

@@ -0,0 +1,23 @@
+module Selenium
+  module WebDriver
+    module Safari
+      module Features
+        include _Bridge
+
+        SAFARI_COMMANDS: Hash[Symbol, Array[Symbol | String]]
+
+        COMMANDS: untyped
+
+        def command_list: -> untyped
+
+        def commands: (untyped command) -> untyped
+
+        def permissions: () -> untyped
+
+        def permissions=: (untyped permissions) -> untyped
+
+        def attach_debugger: () -> untyped
+      end
+    end
+  end
+end

data/sig/gems/selenium/search_context.rbs

@@ -0,0 +1,17 @@
+module Selenium
+  module WebDriver
+    module SearchContext
+      include _Driver
+
+      FINDERS: untyped
+
+      def find_element: (*untyped args) -> untyped
+
+      def find_elements: (*untyped args) -> untyped
+
+      private
+
+      def extract_args: (untyped args) -> untyped
+    end
+  end
+end

data/sig/interfaces/bridge.rbs

@@ -0,0 +1,5 @@
+interface _Bridge
+  def bridge: -> untyped
+
+  def execute: (untyped command, ?Hash[untyped, untyped] opts, ?untyped? command_hash) -> untyped
+end

data/sig/lib/appium_lib_core/android/device/auth_finger_print.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Authentication
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def self.add_methods: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/device/clipboard.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Clipboard
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def self.add_methods: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/device/emulator.rbs

@@ -0,0 +1,23 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Emulator
+          GSM_CALL_ACTIONS: ::Array[:call | :accept | :cancel | :hold]
+
+          GSM_VOICE_STATES: ::Array[:on | :off | :denied | :searching | :roaming | :home | :unregistered]
+
+          GSM_SIGNALS: { none_or_unknown: 0, poor: 1, moderate: 2, good: 3, great: 4 }
+
+          NET_SPEED: ::Array[:gsm | :scsd | :gprs | :edge | :umts | :hsdpa | :lte | :evdo | :full]
+
+          POWER_AC_STATE: ::Array[:on | :off]
+
+          def self.add_methods: () -> untyped
+
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/device/network.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Network
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def self.add_methods: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/device/performance.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Performance
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def self.add_methods: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/device/screen.rbs

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module Screen
+          def self.add_methods: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/device.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        extend Forwardable
+
+        def self.execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+        def self.extended: (untyped _mod) -> (nil | untyped)
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/espresso/bridge.rbs

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    module Android
+      module Espresso
+        module Bridge
+          def self.for: (untyped target) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/uiautomator1/bridge.rbs

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    module Android
+      module Uiautomator1
+        module Bridge
+          def self.for: (untyped target) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/uiautomator2/bridge.rbs

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    module Android
+      module Uiautomator2
+        module Bridge
+          def self.for: (untyped target) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/android/uiautomator2/device/battery.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Android
+      module Uiautomator2
+        module Device
+          module Battery
+            def self.add_methods: () -> untyped
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Appium
+  module Core
+    class Base
+      class BiDiBridge < ::Appium::Core::Base::Bridge
+        @bidi: ::Selenium::WebDriver::BiDi
+
+        def attach_to: (untyped session_id, untyped platform_name, untyped automation_name) -> untyped
+
+        def create_session: (untyped capabilities) -> ::Appium::Core::Base::Capabilities
+
+        def get: (string url) -> untyped
+
+        def go_back: () -> untyped
+
+        def go_forward: () -> untyped
+
+        def refresh: () -> untyped
+
+        def quit: () -> untyped
+
+        def close: () -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,206 @@
+module Appium
+  module Core
+    class Base
+      class LocatorConverter
+        def convert: (untyped how, untyped what) -> ::Array[untyped]
+      end
+
+      class Bridge < ::Selenium::WebDriver::Remote::Bridge
+        @browser: untyped
+
+        @available_commands: untyped
+
+        @session_id: untyped
+
+        # generate a dummy capabilities instance which only has the given platformName and automationName
+        @capabilities: untyped
+
+        include Device::DeviceLock
+
+        include Device::Keyboard
+
+        include Device::ImeActions
+
+        include Device::Setting
+
+        include Device::Context
+
+        include Device::FileManagement
+
+        include Device::KeyEvent
+
+        include Device::ImageComparison
+
+        include Device::AppManagement
+
+        include Device::AppState
+
+        include Device::ScreenRecord::Command
+
+        include Device::Device
+
+        include Device::ExecuteDriver
+
+        include Device::Orientation
+
+        # Prefix for extra capability defined by W3C
+        APPIUM_PREFIX: "appium:"
+
+        # No 'browserName' means the session is native appium connection
+        APPIUM_NATIVE_BROWSER_NAME: "appium"
+
+        attr_reader available_commands: untyped
+
+        def browser: () -> untyped
+
+        # Appium only.
+        # Attach to an existing session.
+        #
+        # @param [String] The session id to attach to.
+        # @param [String] platform_name The platform name to keep in the dummy capabilities
+        # @param [String] platform_name The automation name to keep in the dummy capabilities
+        # @return [::Appium::Core::Base::Capabilities]
+        #
+        # @example
+        #
+        #   new_driver = ::Appium::Core::Driver.attach_to(
+        #     driver.session_id,
+        #     url: 'http://127.0.0.1:4723/wd/hub', automation_name: 'UiAutomator2', platform_name: 'Android'
+        #   )
+        #
+        def attach_to: (untyped session_id, untyped platform_name, untyped automation_name) -> untyped
+
+        # Override
+        # Creates session handling.
+        #
+        # @param [::Appium::Core::Base::Capabilities, Hash] capabilities A capability
+        # @return [::Appium::Core::Base::Capabilities]
+        #
+        # @example
+        #
+        #   opts = {
+        #     caps: {
+        #       platformName: :ios,
+        #       automationName: 'XCUITest',
+        #       app: 'test/functional/app/UICatalog.app.zip',
+        #       platformVersion: '11.4',
+        #       deviceName: 'iPhone Simulator',
+        #       useNewWDA: true,
+        #     },
+        #     appium_lib: {
+        #       wait: 30
+        #     }
+        #   }
+        #   core = ::Appium::Core.for(caps)
+        #   driver = core.start_driver
+        #
+        def create_session: (untyped capabilities) -> ::Appium::Core::Base::Capabilities
+
+        # Append +appium:+ prefix for Appium following W3C spec
+        # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
+        #
+        # @param [::Appium::Core::Base::Capabilities, Hash] capabilities A capability
+        # @return [::Appium::Core::Base::Capabilities]
+        def add_appium_prefix: (untyped capabilities) -> untyped
+
+        private
+
+        def camel_case: (untyped str_or_sym) -> untyped
+
+        def extension_prefix?: (untyped capability_name) -> untyped
+
+        def json_create: (untyped value) -> untyped
+
+        public
+
+        def add_command: (method: untyped, url: untyped, name: untyped) { (?) -> untyped } -> untyped
+
+        def commands: (untyped command) -> untyped
+
+        def status: () -> untyped
+
+        # Perform 'touch' actions for W3C module.
+        # Generate +touch+ pointer action here and users can use this via +driver.action+
+        # - https://www.selenium.dev/documentation/webdriver/actions_api/
+        # - https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/ActionBuilder.html
+        # - https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
+        # - https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
+        #
+        # The pointer type is 'touch' by default in the Appium Ruby client.
+        #
+        # @example
+        #
+        #     element = @driver.find_element(:id, "some id")
+        #     @driver.action.click(element).perform # The 'click' is a part of 'PointerActions'
+        #
+        def action: (?untyped? _deprecated_async, ?async: bool, ?devices: untyped?) -> untyped
+
+        # Port from MJSONWP
+        def get_timeouts: () -> untyped
+
+        # For Appium
+        # override
+        def element_displayed?: (untyped element) -> untyped
+
+        # For Appium
+        # override
+        def element_attribute: (untyped element, untyped name) -> untyped
+
+        # For Appium
+        alias switch_to_active_element active_element
+
+        # For Appium
+        # @param [Hash] id The id which can get as a response from server
+        # @return [::Appium::Core::Element]
+        def convert_to_element: (untyped id) -> untyped
+
+        # For Appium
+        # override
+        # called in 'extend DriverExtensions::HasNetworkConnection'
+        def network_connection: () -> untyped
+
+        # For Appium
+        # override
+        # called in 'extend DriverExtensions::HasNetworkConnection'
+        def network_connection=: (untyped type) -> untyped
+
+        # For Appium
+        # No implementation for W3C webdriver module
+        # called in 'extend DriverExtensions::HasLocation'
+        def location: () -> untyped
+
+        # For Appium
+        # No implementation for W3C webdriver module
+        def set_location: (untyped lat, untyped lon, ?::Float alt, ?speed: untyped?, ?satellites: untyped?) -> untyped
+
+        #
+        # logs
+        #
+        # For Appium
+        # No implementation for W3C webdriver module
+        def available_log_types: () -> untyped
+
+        # For Appium
+        # No implementation for W3C webdriver module
+        def log: (untyped type) -> untyped
+
+        # For Appium
+        def log_event: (untyped vendor, untyped event) -> untyped
+
+        # For Appium
+        def log_events: (?untyped? type) -> untyped
+
+        def viewport_screenshot: () -> untyped
+
+        def element_screenshot: (untyped element_id) -> untyped
+
+        # for selenium-webdriver compatibility in chrome browser session.
+        # This may be needed in selenium-webdriver 4.8 or over? (around the version)
+        # when a session starts browserName: 'chrome' for bridge.
+        # This method is not only for Android, but also chrome desktop browser as well.
+        # So this bridge itself does not restrict the target module.
+        def send_command: (untyped command_params) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+      class DeviceIME
+        @bridge: untyped
+
+        # @private this class is private
+        def initialize: (untyped bridge) -> void
+
+        def activate: (untyped ime_name) -> untyped
+
+        def available_engines: () -> untyped
+
+        def active_engine: () -> untyped
+
+        def activated?: () -> untyped
+
+        def deactivate: () -> untyped
+      end
+    end
+  end
+end

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

@@ -2,6 +2,8 @@ module Appium
   module Core
     class Base
       module HasRemoteStatus
+        include _Bridge
+
         def remote_status: () -> untyped
       end
     end