appium_lib_core 11.0.1 → 11.1.0

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,9 @@
+module Appium
+  module Core
+    class Base
+      module SearchContext
+        APPIUM_EXTRA_FINDERS: { Symbol => String }
+      end
+    end
+  end
+end

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

data/sig/lib/appium_lib_core/common/ws/websocket.rbs

@@ -0,0 +1,103 @@
+module Appium
+  module Core
+    class WebSocket
+      @endpoint: untyped
+
+      @ws_thread: untyped
+
+      @client: untyped
+
+      attr_reader client: untyped
+
+      attr_reader endpoint: untyped
+
+      # A websocket client based on Faye::WebSocket::Client .
+      # Uses eventmachine to wait response from the peer. The eventmachine works on a thread. The thread will exit
+      # with close method.
+      #
+      # @param [String] url URL to establish web socket connection. If the URL has no port, the client use:
+      #                     +ws+: 80, +wss+: 443 ports.
+      # @param [Array] protocols An array of strings representing acceptable subprotocols for use over the socket.
+      #                          The driver will negotiate one of these to use via the Sec-WebSocket-Protocol header
+      #                          if supported by the other peer. Default is nil.
+      #                          The protocols is equal to https://github.com/faye/faye-websocket-ruby/ 's one for client.
+      # @param [Hash] options Initialize options for Faye client. Read https://github.com/faye/faye-websocket-ruby#initialization-options
+      #                       for more details. Default is +{}+.
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.client #=> #<Faye::WebSocket::Client:.....> # An instance of Faye::WebSocket::Client
+      #     ws.message 'some message' #=> nil. Send a message to the peer.
+      #     ws.close #=> Kill the thread which run a eventmachine.
+      #
+      def initialize: (url: untyped, ?protocols: untyped?, ?options: ::Hash[untyped, untyped]) -> void
+
+      #
+      # Sends a ping frame with an optional message and fires the callback when a matching pong is received.
+      #
+      # @param [String] message A message to send ping.
+      # @param [Block] callback
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.ping 'message'
+      #
+      def ping: (untyped message) { (?) -> untyped } -> untyped
+
+      # Accepts either a String or an Array of byte-sized integers and sends a text or binary message over the connection
+      # to the other peer; binary data must be encoded as an Array.
+      #
+      # @param [String|Array] message A message to send a text or binary message over the connection
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.send 'happy testing'
+      #
+      def send: (untyped message) -> untyped
+
+      # Closes the connection, sending the given status code and reason text, both of which are optional.
+      #
+      # @param [Integer] code A status code to send to the peer with close signal. Default is nil.
+      # @param [String] reason A reason to send to the peer with close signal. Default is 'close from ruby_lib_core'.
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.close reason: 'a something special reason'
+      #
+      def close: (?code: untyped?, ?reason: ::String) -> untyped
+
+      #
+      # Fires when the socket connection is established. Event has no attributes.
+      #
+      # Default is just put a debug message.
+      #
+      def handle_open: () -> untyped
+
+      #
+      # Fires when the socket receives a message. The message gas one +data+ attribute and this method can handle the data.
+      # The data is either a String (for text frames) or an Array of byte-sized integers (for binary frames).
+      #
+      # Default is just put a debug message and puts the result on standard out.
+      # In general, users should override this handler to handle messages from the peer.
+      #
+      def handle_message_data: (untyped data) -> untyped
+
+      #
+      # Fires when there is a protocol error due to bad data sent by the other peer.
+      # This event is purely informational, you do not need to implement error recovery.
+      #
+      # Default is just put a error message.
+      #
+      def handle_error: () -> untyped
+
+      #
+      # Fires when either the client or the server closes the connection. The method gets +code+ and +reason+ attributes.
+      # They expose the status code and message sent by the peer that closed the connection.
+      #
+      # Default is just put a error message.
+      # The methods also clear +client+ instance and stop the eventmachine which is called in initialising this class.
+      #
+      def handle_close: (untyped code, untyped reason) -> untyped
+    end
+  end
+end

data/sig/lib/appium_lib_core/driver.rbs

@@ -109,7 +109,7 @@ module Appium
 
       attr_reader enable_idempotency_header: bool
 
-      attr_reader device: Symbol
+      attr_reader device: Symbol | String
 
       attr_reader automation_name: Symbol
 
@@ -164,7 +164,7 @@ module Appium
 
       private
 
-      def convert_to_symbol: (untyped? value) -> Symbol
+      def convert_to_symbol: (untyped? value) -> Symbol?
 
       def extend_for: (device: Symbol | String, automation_name: Symbol) -> self
 
@@ -183,10 +183,10 @@ module Appium
       def set_app_path: () -> String?
 
       def set_appium_lib_specific_values: (
-          Hash[Symbol, Symbol | String | Hash[Symbol, String | Numeric] | Numeric]? appium_lib_opts
-        ) -> self
+          Hash[Symbol, String] appium_lib_opts
+        ) -> bool
 
-      def set_appium_device: () -> String
+      def set_appium_device: () -> Symbol
 
       def set_automation_name: () -> Symbol?
 

data/sig/lib/appium_lib_core/element.rbs

@@ -0,0 +1,24 @@
+module Appium
+  module Core
+    class Element < ::Selenium::WebDriver::Element
+      include ::Appium::Core::Base::TakesScreenshot
+
+      attr_reader id: untyped
+
+      def method_missing: (untyped method_name, *untyped args) { (?) -> untyped } -> (nil | untyped)
+
+      def respond_to_missing?: (*untyped) -> true
+
+      # Alias for type
+      alias type send_keys
+
+      def location_rel: (untyped driver) -> untyped
+
+      def screenshot: () -> untyped
+
+      def screenshot_as: (untyped format) -> untyped
+
+      def save_screenshot: (untyped png_path) -> untyped
+    end
+  end
+end

data/sig/lib/appium_lib_core/ios/clipboard.rbs

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

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

@@ -0,0 +1,12 @@
+module Appium
+  module Core
+    module Ios
+      module Device
+        include _Bridge
+        extend Forwardable
+
+        def self.toggle_touch_id_enrollment: -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/ios/xcuitest/bridge.rbs

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

data/sig/lib/appium_lib_core/ios/xcuitest/device/performance.rbs

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Ios
+      module Xcuitest
+        module Device
+          module Performance
+            def self.add_methods: () -> untyped
+          end
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/ios/xcuitest/device/screen.rbs

@@ -0,0 +1,15 @@
+module Appium
+  module Core
+    module Ios
+      module Xcuitest
+        module Device
+          module Screen
+            def execute: (Symbol command, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+
+            def self.add_methods: () -> untyped
+          end
+        end
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/ios/xcuitest/device.rbs

@@ -0,0 +1,14 @@
+module Appium
+  module Core
+    module Ios
+      module Xcuitest
+        module Device
+          extend Forwardable
+          include _Bridge
+
+          def self.extended: (untyped _mod) -> untyped
+        end
+      end
+    end
+  end
+end