appium_lib_core 11.0.1 → 11.0.2

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

data/sig/lib/appium_lib_core/mac2/bridge.rbs

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

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

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Mac2
+      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

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

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    module Mac2
+      module Device
+        extend Forwardable
+
+        def self.extended: (untyped _mod) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/support/event_firing_bridge.rbs

@@ -0,0 +1,21 @@
+module Appium
+  module Support
+    class EventFiringBridge < ::Selenium::WebDriver::Support::EventFiringBridge
+      @appium_options: untyped
+
+      @driver: untyped
+
+      def initialize: (untyped delegate, untyped listener, **untyped opts) -> void
+
+      def find_element_by: (untyped how, untyped what, ?untyped? parent) -> untyped
+
+      def find_elements_by: (untyped how, untyped what, ?untyped? parent) -> untyped
+
+      private
+
+      def create_element: (untyped ref) -> untyped
+
+      def driver: () -> untyped
+    end
+  end
+end

data/sig/lib/appium_lib_core/windows/bridge.rbs

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

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

@@ -0,0 +1,13 @@
+module Appium
+  module Core
+    module Windows
+      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

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

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    module Windows
+      module Device
+        extend Forwardable
+
+        def self.extended: (untyped _mod) -> untyped
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 11.0.1
+  version: 11.0.2
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -130,15 +130,66 @@ files:
 - lib/appium_lib_core/windows/device/screen.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
+- sig/gems/em.rbs
+- sig/gems/faye.rbs
 - sig/gems/selenium/abstract_event_listener.rbs
-- sig/gems/selenium/capabilities.rbs
-- sig/gems/selenium/common.rbs
-- sig/gems/selenium/default.rbs
+- sig/gems/selenium/atoms.rbs
+- sig/gems/selenium/bidi/browsing_context.rbs
+- sig/gems/selenium/bidi/browsing_context_info.rbs
+- sig/gems/selenium/bidi/log_inspector.rbs
+- sig/gems/selenium/bidi/navigate_result.rbs
+- sig/gems/selenium/bidi/session.rbs
+- sig/gems/selenium/bridge.rbs
+- sig/gems/selenium/chrome/features.rbs
+- sig/gems/selenium/chromium/features.rbs
+- sig/gems/selenium/common/element.rbs
 - sig/gems/selenium/driver.rbs
+- sig/gems/selenium/edge/features.rbs
+- sig/gems/selenium/error.rbs
+- sig/gems/selenium/event_firing_bridge.rbs
+- sig/gems/selenium/firefox/driver.rbs
+- sig/gems/selenium/firefox/extension.rbs
+- sig/gems/selenium/firefox/features.rbs
+- sig/gems/selenium/firefox/options.rbs
+- sig/gems/selenium/firefox/profile.rbs
+- sig/gems/selenium/firefox/profiles_ini.rbs
+- sig/gems/selenium/firefox/service.rbs
+- sig/gems/selenium/firefox/util.rbs
 - sig/gems/selenium/has_session_id.rbs
+- sig/gems/selenium/ie/features.rbs
+- sig/gems/selenium/interactions.rbs
+- sig/gems/selenium/interfaces/commands.rbs
+- sig/gems/selenium/interfaces/commands_list.rbs
+- sig/gems/selenium/interfaces/devtools.rbs
+- sig/gems/selenium/interfaces/driver.rbs
+- sig/gems/selenium/interfaces/features.rbs
+- sig/gems/selenium/local_driver.rbs
+- sig/gems/selenium/platform.rbs
+- sig/gems/selenium/profile_helper.rbs
+- sig/gems/selenium/remote/bridge/commands.rbs
+- sig/gems/selenium/remote/capabilities.rbs
+- sig/gems/selenium/remote/http/common.rbs
+- sig/gems/selenium/remote/http/default.rbs
+- sig/gems/selenium/remote/response.rbs
+- sig/gems/selenium/safari/features.rbs
+- sig/gems/selenium/search_context.rbs
 - sig/gems/selenium/uploads_files.rbs
+- sig/interfaces/bridge.rbs
 - sig/lib/appium_lib_core.rbs
+- sig/lib/appium_lib_core/android/device.rbs
+- sig/lib/appium_lib_core/android/device/auth_finger_print.rbs
+- sig/lib/appium_lib_core/android/device/clipboard.rbs
+- sig/lib/appium_lib_core/android/device/emulator.rbs
+- sig/lib/appium_lib_core/android/device/network.rbs
+- sig/lib/appium_lib_core/android/device/performance.rbs
+- sig/lib/appium_lib_core/android/device/screen.rbs
+- sig/lib/appium_lib_core/android/espresso/bridge.rbs
+- sig/lib/appium_lib_core/android/uiautomator1/bridge.rbs
+- sig/lib/appium_lib_core/android/uiautomator2/bridge.rbs
+- sig/lib/appium_lib_core/android/uiautomator2/device/battery.rbs
+- sig/lib/appium_lib_core/common/base/bridge.rbs
 - sig/lib/appium_lib_core/common/base/capabilities.rbs
+- sig/lib/appium_lib_core/common/base/device_ime.rbs
 - sig/lib/appium_lib_core/common/base/driver.rbs
 - sig/lib/appium_lib_core/common/base/driver_settings.rbs
 - sig/lib/appium_lib_core/common/base/has_location.rbs
@@ -147,12 +198,48 @@ files:
 - sig/lib/appium_lib_core/common/base/remote_status.rbs
 - sig/lib/appium_lib_core/common/base/rotable.rbs
 - sig/lib/appium_lib_core/common/base/screenshot.rbs
+- sig/lib/appium_lib_core/common/base/search_context.rbs
+- sig/lib/appium_lib_core/common/command.rbs
+- sig/lib/appium_lib_core/common/device/app_management.rbs
+- sig/lib/appium_lib_core/common/device/app_state.rbs
 - sig/lib/appium_lib_core/common/device/battery_status.rbs
+- sig/lib/appium_lib_core/common/device/clipboard_content_type.rbs
+- sig/lib/appium_lib_core/common/device/context.rbs
+- sig/lib/appium_lib_core/common/device/device.rbs
+- sig/lib/appium_lib_core/common/device/device_lock.rbs
+- sig/lib/appium_lib_core/common/device/execute_driver.rbs
+- sig/lib/appium_lib_core/common/device/file_management.rbs
+- sig/lib/appium_lib_core/common/device/image_comparison.rbs
+- sig/lib/appium_lib_core/common/device/ime_actions.rbs
+- sig/lib/appium_lib_core/common/device/keyboard.rbs
+- sig/lib/appium_lib_core/common/device/keyevent.rbs
+- sig/lib/appium_lib_core/common/device/orientation.rbs
+- sig/lib/appium_lib_core/common/device/screen_record.rbs
+- sig/lib/appium_lib_core/common/device/setting.rbs
+- sig/lib/appium_lib_core/common/error.rbs
+- sig/lib/appium_lib_core/common/log.rbs
+- sig/lib/appium_lib_core/common/logger.rbs
 - sig/lib/appium_lib_core/common/wait.rbs
+- sig/lib/appium_lib_core/common/wait/timer.rbs
+- sig/lib/appium_lib_core/common/ws/websocket.rbs
 - sig/lib/appium_lib_core/device.rbs
 - sig/lib/appium_lib_core/driver.rbs
+- sig/lib/appium_lib_core/element.rbs
+- sig/lib/appium_lib_core/ios/clipboard.rbs
+- sig/lib/appium_lib_core/ios/device.rbs
+- sig/lib/appium_lib_core/ios/xcuitest/bridge.rbs
+- sig/lib/appium_lib_core/ios/xcuitest/device.rbs
 - sig/lib/appium_lib_core/ios/xcuitest/device/battery.rbs
+- sig/lib/appium_lib_core/ios/xcuitest/device/performance.rbs
+- sig/lib/appium_lib_core/ios/xcuitest/device/screen.rbs
+- sig/lib/appium_lib_core/mac2/bridge.rbs
+- sig/lib/appium_lib_core/mac2/device.rbs
+- sig/lib/appium_lib_core/mac2/device/screen.rbs
+- sig/lib/appium_lib_core/support/event_firing_bridge.rbs
 - sig/lib/appium_lib_core/version.rbs
+- sig/lib/appium_lib_core/windows/bridge.rbs
+- sig/lib/appium_lib_core/windows/device.rbs
+- sig/lib/appium_lib_core/windows/device/screen.rbs
 homepage: https://github.com/appium/ruby_lib_core/
 licenses:
 - Apache-2.0
@@ -173,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Minimal Ruby library for Appium.