appium_lib_core 11.0.1 → 11.0.2

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) -> untyped
+
+        # 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

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

@@ -2,6 +2,8 @@ module Appium
   module Core
     class Base
       module TakesScreenshot
+        include _Bridge
+
         def save_screenshot: (untyped png_path) -> untyped
 
         def screenshot_as: (untyped format) -> untyped

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

@@ -0,0 +1 @@
+APPIUM_EXTRA_FINDERS: { accessibility_id: "accessibility id", image: "-image", custom: "-custom", uiautomator: "-android uiautomator", viewtag: "-android viewtag", data_matcher: "-android datamatcher", view_matcher: "-android viewmatcher", predicate: "-ios predicate string", class_chain: "-ios class chain" }

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

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Commands
+      COMMAND: Hash[Symbol, Array[Symbol | String]]
+
+      COMMAND_ANDROID: Hash[Symbol, Array[Symbol | String]]
+
+      COMMAND_IOS: Hash[Symbol, Array[Symbol | String]]
+
+      COMMANDS: untyped
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module AppManagement
+          include _Bridge
+
+          def app_strings: (?untyped? language) -> untyped
+
+          def background_app: (Integer? duration) -> untyped
+
+          def install_app: (untyped path, Hash[untyped, untyped]? options) -> untyped
+
+          def remove_app: (untyped 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
+
+          private
+
+          def options?: (*untyped args) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module AppState
+          STATUS: ::Array[:not_installed | :not_running | :running_in_background_suspended | :running_in_background | :running_in_foreground]
+
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def app_state: (untyped app_id) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module Clipboard
+          CONTENT_TYPE: ::Array[:plaintext | :image | :url]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module Context
+          def within_context: (untyped context) ?{ () -> untyped } -> untyped
+
+          def current_context: () -> untyped
+
+          def available_contexts: () -> untyped
+
+          def set_context: (?untyped? context) -> untyped
+
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module Device
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def shake: () -> untyped
+
+          def device_time: (?untyped? format) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module DeviceLock
+          def lock: (?untyped? duration) -> untyped
+
+          def device_locked?: () -> untyped
+
+          def unlock: () -> untyped
+
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module ExecuteDriver
+          class Result
+            @result: untyped
+
+            @logs: untyped
+
+            attr_reader result: untyped
+
+            attr_reader logs: untyped
+
+            def initialize: (untyped response) -> void
+          end
+
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def execute_driver: (?script: ::String, ?type: ::String, ?timeout_ms: untyped?) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module FileManagement
+          def push_file: (untyped path, untyped filedata) -> untyped
+
+          def pull_file: (untyped path) -> untyped
+
+          def pull_folder: (untyped path) -> untyped
+
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module ImageComparison
+          MODE: Array[Symbol]
+
+          MATCH_FEATURES: { detector_name: untyped }
+
+          MATCH_TEMPLATE: { visualize: Array[bool] }
+
+          GET_SIMILARITY: { visualize: Array[bool] }
+
+          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 execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module ImeActions
+          include _Bridge
+
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module Keyboard
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def hide_keyboard: (?untyped? close_key, ?untyped? strategy) -> untyped
+
+          def is_keyboard_shown: () -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module KeyEvent
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def keyevent: (untyped key, ?untyped? metastate) -> untyped
+
+          def press_keycode: (untyped key, ?metastate: untyped, ?flags: untyped) -> untyped
+
+          def long_press_keycode: (untyped key, ?metastate: untyped, ?flags: untyped) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module Orientation
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def screen_orientation=: (untyped orientation) -> untyped
+
+          def screen_orientation: () -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        class ScreenRecord
+          @upload_option: untyped
+
+          attr_reader upload_option: untyped
+
+          METHOD: ::Array["POST" | "PUT"]
+
+          def initialize: (?remote_path: untyped?, ?user: untyped?, ?pass: untyped?, ?method: ::String, ?file_field_name: untyped?, ?form_fields: untyped?, ?headers: untyped?, ?force_restart: untyped?) -> void
+
+          module Command
+            def stop_recording_screen: (?remote_path: untyped?, ?user: untyped?, ?pass: untyped?, ?method: ::String, ?file_field_name: untyped?, ?form_fields: untyped?, ?headers: untyped?) -> untyped
+
+            def stop_and_save_recording_screen: (untyped file_path) -> untyped
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    class Base
+      module Device
+        module Setting
+          def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+          def get_settings: () -> untyped
+
+          def update_settings: (untyped settings) -> untyped
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Appium
+  module Core
+    module Error
+      class CoreError < StandardError
+      end
+
+      class NotSupportedAppiumServer < CoreError
+      end
+
+      class NoSuchElementError < CoreError
+      end
+
+      class UnsupportedOperationError < CoreError
+      end
+
+      class ServerError < CoreError
+      end
+
+      class SessionNotCreatedError < CoreError
+      end
+
+      class ArgumentError < CoreError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Appium
+  module Core
+    class Logs
+      @bridge: untyped
+
+      def initialize: (untyped bridge) -> void
+
+      def get: (untyped type) -> untyped
+
+      def available_types: () -> untyped
+
+      def event: (vendor: untyped, event: untyped) -> untyped
+
+      def event=: (untyped log_event) -> untyped
+
+      def events: (?untyped? type) -> untyped
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Appium
+  module Logger
+    self.@logger: untyped
+
+    extend Forwardable
+
+    attr_writer self.logger: untyped
+
+    def self.debug: (String message) -> untyped
+
+    def self.info: (String message) -> untyped
+
+    def self.warn: (String message) -> untyped
+
+    def self.error: (String message) -> untyped
+
+    def self.fatal: (String message) -> untyped
+
+    private
+
+    def self.logger: () -> untyped
+  end
+end

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

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    module Wait
+      class Timer
+        @end_time: untyped
+
+        def initialize: (Numeric timeout) -> void
+
+        def timeout?: () -> bool
+
+        def current_time: () -> Float
+      end
+    end
+  end
+end