appium-mcp 0.0.1 → 1.1.4

package/src/resources/submodules/appium-xcuitest-driver/docs/installation/index.md

@@ -0,0 +1,137 @@
+---
+hide:
+  - navigation
+
+title: Installation
+---
+
+Like all Appium drivers, the XCUITest driver requires Appium to be installed. Refer to the
+[Appium documentation](https://appium.io/docs/en/latest/quickstart/install/) for its requirements
+and prerequisites.
+
+!!! info
+
+    XCUITest driver `10.0.0` or later requires Appium 3, and no longer supports Appium 2. For more
+    details, refer to the [Appium Server Support](#appium-server-support) section.
+
+## Install the Driver
+
+Once Appium has been installed, you can use the [extension CLI](https://appium.io/docs/en/latest/cli/extensions/)
+to install the XCUITest driver:
+
+```bash
+appium driver install xcuitest
+```
+
+Alternatively, if you are running a Node.js project, you can include `appium-xcuitest-driver` as
+one of your project dependencies. [Refer to the Appium documentation](https://appium.io/docs/en/latest/guides/managing-exts/#do-it-yourself-with-npm)
+for more information about this approach.
+
+## Load the Driver
+
+To activate the driver, simply launch the Appium server. By default, Appium will load all the
+installed drivers:
+
+```bash
+appium
+```
+
+The server log output should include a line like the following:
+
+```
+[Appium] XCUITestDriver has been successfully loaded in 0.789s
+```
+
+Once the driver has been loaded, you can continue with [device preparation](../preparation/index.md).
+
+## System Requirements
+
+!!! note
+
+    Many of the below requirements can be validated after installing the driver, via the built-in
+    Appium Doctor support:
+    ```
+    appium driver doctor xcuitest
+    ```
+
+- macOS host platform
+- Xcode and Xcode Developer Tools
+    - Make sure to install an Xcode version that supports the iOS/iPadOS/tvOS version you want to test.
+      Different Xcode versions also have different macOS host version requirements. For more details,
+      refer to the [Xcode Release Notes](https://developer.apple.com/documentation/xcode-release-notes/).
+    - New major Xcode versions (especially beta) will likely require you to also update the driver. See the
+      [iOS Version Support](#ios-version-support) section for details.
+- If automating real devices, additional manual configuration is required - please refer to the
+  [Real Device Configuration](../preparation/real-device-config.md) guide.
+- If testing web or hybrid apps, their webviews must be debuggable. If it is not possible to connect to your
+  webview(s) using [Safari remote debugger](https://appletoolbox.com/use-web-inspector-debug-mobile-safari/),
+  then the driver will not be able to identify them.
+
+### Optional Requirements
+
+- [`xcpretty`](https://github.com/supermarin/xcpretty) can be used to make Xcode output easier to
+  read. It can be installed by running `gem install xcpretty`.
+- [`ffmpeg`](https://ffmpeg.org/) is used for test video recording. It can be installed using
+  [`brew`](https://brew.sh/): `brew install ffmpeg`
+- [`idb`](https://github.com/facebook/idb), [`go-ios`](https://github.com/danielpaulus/go-ios) and
+  [`tidevice`](https://github.com/alibaba/taobao-iphone-device) can be used to improve device interactions
+- [WIX AppleSimulatorUtils](https://github.com/wix/AppleSimulatorUtils) can be used to improve some
+  Simulator interactions
+- [`py-ios-device`](https://github.com/YueChen-C/py-ios-device) is required in several `mobile:`
+  extensions, and can improve the general testing experience for real devices
+
+## Appium Server Support
+
+If you are running an older version of Appium, make sure to install a supported driver version:
+
+| Appium server version | Supported XCUITest driver versions |
+| --- | --- |
+| Appium 3 | `>= 10.0.0` |
+| Appium 2 | `4.0.0 - 9.10.5` |
+| Appium 1 | `<= 3.62.0` (bundled with Appium) |
+
+## iOS Version Support
+
+Different driver versions support different ranges of iOS/iPadOS/tvOS versions. The following tables
+should help you decide which driver version to install. If you are upgrading/downgrading an
+existing installation, check that the [WebDriverAgent (WDA)](https://github.com/appium/WebDriverAgent)
+version on the device under test is also updated accordingly.
+
+For iOS/tvOS support in driver versions older than `4.0.0` (Appium 1), please refer to
+[the Appium 1 changelog](https://github.com/appium/appium/blob/1.x/CHANGELOG.md).
+
+!!! info "Background"
+
+    The XCUITest driver depends on the [WebDriverAgent (WDA)](https://github.com/appium/WebDriverAgent)
+    framework, which in turn [relies on Apple's XCTest framework](../overview.md). Changes in the
+    XCTest API are published in new Xcode and Apple device OS versions. These API changes may
+    add new features that the driver must implement in order to support the latest devices, as well
+    as modify or even remove support for existing features that the driver relies on. In both cases,
+    new driver and WDA versions are required.
+
+Generally, the driver/WDA aims to support the latest _two_ (2) major Xcode/iOS/iPadOS/tvOS versions,
+but may also work with older versions, unless specified below.
+
+The following are the minimum driver/WDA versions required for specific Xcode/iOS versions:
+
+| Xcode/iOS version | Minimum XCUITest driver & WDA version |
+| --- | --- |
+| Xcode 26 / iOS 26 | `9.5.0` (WDA `9.14.1`) |
+| Xcode 16-beta.5 / iOS 18 | `7.24.15` (WDA `8.9.1`) |
+| Xcode 15 / iOS 17 | `4.32.23` (WDA `5.6.0`) |
+| Xcode 14.3 / iOS 16.4 | `4.21.7` (WDA `4.13.1`) |
+| Xcode 14-beta.3 / iOS 16 Beta | `4.7.4` (WDA `4.8.1`) |
+
+The following are the last driver versions that are compatible with older Xcode versions:
+
+| Xcode version | Last supported XCUITest driver version |
+| --- | --- |
+| Xcode 12 | `4.27.2` (WDA `4.15.1`) |
+| Xcode 11 | `4.2.0` (WDA `4.0.0`) |
+
+The following are the last driver versions that are compatible with older iOS versions:
+
+| iOS version | Last supported XCUITest driver version |
+| --- | --- |
+| iOS 9 - iOS 14 | `4.27.2` (WDA `4.15.1`) |
+| iOS 8 | `4.2.0` (WDA `4.0.0`) |

package/src/resources/submodules/appium-xcuitest-driver/docs/overview.md

@@ -0,0 +1,19 @@
+---
+hide:
+  - navigation
+  - toc
+
+title: Overview
+---
+
+The XCUITest driver combines several different technologies to achieve its functionality:
+
+- Native testing is based on Apple's [XCTest](https://developer.apple.com/documentation/xctest) framework
+  and Appium's fork of Facebook's [WebDriverAgent](https://github.com/appium/WebDriverAgent) server
+  (the [original](https://github.com/facebookarchive/WebDriverAgent) project is not supported anymore)
+    - In native mode, the driver operates in scope of [WebDriver W3C protocol](https://w3c.github.io/webdriver)
+      with several platform-specific extensions
+- Webview communication is done via [Webkit remote debugger protocol](https://github.com/appium/appium-remote-debugger)
+    - In webview mode, the driver can only operate in scope of the obsolete [JSONWP protocol](https://webdriver.io/docs/api/jsonwp.html)
+- Real device communication is provided by the [`appium-ios-device`](https://github.com/appium/appium-ios-device) library
+- Simulator communication is provided by the [`appium-ios-simulator`](https://github.com/appium/appium-ios-simulator) library

package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/index.md

@@ -0,0 +1,51 @@
+---
+title: Device Preparation
+---
+
+Before using the XCUITest driver with a simulator or real device, some device preparation is required.
+
+## Automatic Adjustments
+
+The XCUITest driver automatically adjusts some device preferences for testing purposes.
+
+### Keyboard Configuration
+
+Some keyboard preferences are changed in order to make test runs more stable. You can change some
+of them via the [Settings API](https://appium.io/docs/en/latest/guides/settings/).
+
+- _Settings -> General -> Keyboard -> Auto-Correction_ is turned OFF
+- _Settings -> General -> Keyboard -> Predictive Text_ is turned OFF
+- The keyboard tutorial is marked as complete
+- (Simulator Only) Software keyboard is turned ON
+
+## Manual Adjustments
+
+Unfortunately, not all configuration can be done automatically, and some changes must be applied manually.
+
+### Accessibility Settings
+
+- To avoid miscalculation of element coordinates, please make sure the zoom preference is turned off
+  in _Settings -> Accessibility -> Zoom_.
+- Some accessibility settings may expose additional view elements. Appium does not modify these
+  settings automatically, since they could affect the way your application under test performs.
+  Please change them manually if needed. Note that the available accessibility content depends on
+  the OS version.
+    - _Settings -> Accessibility -> Spoken Content -> Speak Selection_
+
+### Webview Testing
+
+- Webviews on iOS/iPadOS 16.4 or above may require additional configuration from the application developer.
+  Specifically, the destination `WKWebView` and/or `JSContext` component must have the
+  [`isInspectable`](https://developer.apple.com/documentation/webkit/wkwebview/4111163-isinspectable)
+  property set to `true`. Please read [the WebKit documentation page](https://webkit.org/blog/13936/enabling-the-inspection-of-web-content-in-apps/)
+  for more details on this property.
+  - WebViews on iOS/iPadOS below version 16.4 must have the [`get-task-allow` entitlement](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_debugger) present as `true` in the application manifest.
+- Starting from iOS/iPadOS 16.4, the Google Chrome browser also supports webview testing. This feature
+  requires Chrome version 115 or newer. Please read
+  [the Chrome Developer documentation page](https://developer.chrome.com/blog/debugging-chrome-on-ios/)
+  for details on the necessary configuration.
+
+### Real Devices
+
+Some settings are enabled by default on simulators, but need to be manually changed for real devices.
+See the [Real Device Configuration](./real-device-config.md) document for details.

package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-basic-auto.md

@@ -0,0 +1,49 @@
+---
+hide:
+  - toc
+
+title: Basic Automatic Configuration
+---
+
+If you have a paid Apple Developer account, the easiest way to create the provisioning profile is
+to use the automatic configuration strategy. There are two ways to do this:
+
+* Use the `xcodeOrgId` and `xcodeSigningId` [capabilities](../reference/capabilities.md):
+    ```json
+    {
+      "appium:xcodeOrgId": "<Team ID>",
+      "appium:xcodeSigningId": "Apple Developer",
+      "appium:updatedWDABundleId": "<bundle id your provisioning profile can accept>"
+    }
+    ```
+* Create a `.xcconfig` file somewhere on your file system and add the following to it:
+  ```ini
+  DEVELOPMENT_TEAM = <Team ID>
+  CODE_SIGN_IDENTITY = Apple Developer
+  ```
+  Then use the `xcodeConfigFile` capability to specify the path to this file:
+  ```json
+  {
+    "appium:xcodeConfigFile": "/path/to/xcconfig/file"
+  }
+  ```
+
+Note that these are mutually exclusive strategies; use _either_ the `appium:xcodeConfigFile` capability
+_or_ the combination of `appium:xcodeOrgId` and `appium:xcodeSigningId`.
+
+* `appium:xcodeOrgId` / `DEVELOPMENT_TEAM` is a unique 10-character string generated by Apple that is
+  assigned to your team.
+    * To find this string (your Team ID), sign in to [developer.apple.com/account](https://developer.apple.com/account),
+      and click Membership in the sidebar. Your Team ID appears in the Membership Information
+      section under the team name. You can also find your Team ID listed under the "Organizational
+      Unit" field in your iPhone Developer certificate in your keychain.
+* `appium:xcodeSigningId` / `CODE_SIGN_IDENTITY` is usually either `Apple Developer` or `iPhone Developer`.
+* `appium:updatedWDABundleId` is the bundle id you would like to use for the built WebDriverAgent.
+    * Appium replaces the existing placeholder of `com.facebook.WebDriverAgentRunner` in `WebDriverAgent.xcodeproj` with the given capability value.
+    * `xcodebuild` adds `.xctrunner` automatically for XCTest package. Thus, the provisioning profile you're using should have the suffix explicitly, or it can be for bundle id which has `*`.
+        * For instance, when the `appium:updatedWDABundleId` is `io.appium.WebDriverAgentRunner`, the given provisioning profile should be for `io.appium.WebDriverAgentRunner.xctrunner`, `io.appium.WebDriverAgentRunner.*` or `*`.
+    * `appium:allowProvisioningDeviceRegistration` lets XCUITest driver set `-allowProvisioningUpdates` and `-allowProvisioningDeviceRegistration` flags for the `xcodebuild` command. They will help register the target device to the matched provisioning profile if it still doesn't have the device. Please check `man xcodebuild` output for more details.
+
+Once this configuration is done, you should specify your real device UDID with the `udid` desired
+capability, after which you should be able to start your test. Proceed with
+[Validating the WDA Install](./real-device-config.md#validating-the-wda-install) for the next steps.

package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-basic-manual.md

@@ -0,0 +1,40 @@
+---
+hide:
+  - toc
+
+title: Basic Manual Configuration
+---
+
+There are many cases in which the basic automatic configuration is not enough. Often this happens
+when the development account being used is a "Free" one, in which case it is not possible to create
+a wildcard provisioning profile.
+
+You can confirm this by opening the WDA project in Xcode. The issue will manifest as something like
+an error that Xcode failed to create provisioning profile:
+
+![No provisioning profile](./assets/images/no-prov-prof.png)
+
+The easiest way around this is to create a new project:
+
+![Create new project](./assets/images/create-new-project.png)
+
+The type does not matter, other than it being "iOS". "Single View Application" is the easiest:
+
+![Create single page](./assets/images/create-single-page.png)
+
+The important part is to use a unique "Product Name" and "Organization Name". Also, at this point,
+specify your "Team".
+
+![Setup bundle](./assets/images/set-up-bundle.png)
+
+You can confirm that the provisioning profile was created by looking at the "Project" tab:
+
+![Project pane](./assets/images/project-prov-prof.png)
+
+Or by going into your account preferences and seeing the provisioning profile:
+
+![Check provisioning profile](./assets/images/check-prov-prof.png)
+
+At this point you have a valid provisioning profile. Make note of the bundle identifier
+you associated with it, and add that in the `updatedWDABundleId` capability for your tests.
+Then follow the [initial instructions for automatic configuration](./prov-profile-basic-auto.md).

package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-full-manual.md

@@ -0,0 +1,50 @@
+---
+hide:
+  - toc
+
+title: Full Manual Configuration
+---
+
+The provisioning profile can also be manually associated with the WDA project. Keep in mind that
+this will have to be done each time WDA is updated (such as when updating the XCUITest driver),
+and is _not_ recommended:
+
+* In the terminal, open the directory where WDA is located. Run the following to set the project up:
+  ```bash
+  mkdir -p Resources/WebDriverAgent.bundle
+  ```
+* Open `WebDriverAgent.xcodeproj` in Xcode. This will likely open a screen with an empty editor.
+* In the file browser on the left side, select the root _WebDriverAgent_ project, which will open
+  it in the editor. Then, under _Targets_, select _WebDriverAgentRunner_ (or
+  _WebDriverAgentRunner\_tvOS_ for tvOS), and switch to the _Signing & Capabilities_ tab.
+* Check _Automatically manage signing_, and then select your _Team_ (you may need to first sign
+  into Xcode). The outcome should be similar to the following:
+
+    ![WebDriverAgent in Xcode project](./assets/images/xcode-config.png)
+
+* Xcode will likely fail to create a provisioning profile due to an invalid bundle identifier:
+
+    ![Xcode provisioning fail](./assets/images/xcode-facebook-fail.png)
+
+* Change the _Bundle Identifier_ from `com.facebook.WebDriverAgentRunner` to something that Xcode
+  will accept. You can also do this in the _Build Settings_ tab:
+
+    ![Xcode bundle id](./assets/images/xcode-bundle-id.png)
+  
+!!! note
+
+    Versions of Xcode older than 11 have a different naming convention. This feature may not work
+    for a package which is built by Xcode versions below 12.
+
+* If your bundle identifier is accepted, you should see that Xcode has created a provisioning
+  profile and all is well:
+
+    ![Xcode provisioning profile](./assets/images/xcode-facebook-succeed.png)
+
+* Finally, you can verify that everything works:
+    * Select the scheme as _Product -> Scheme -> WebDriverAgentRunner_
+    * Select your real device in _Product -> Destination_
+    * Select _Product -> Test_ to build and install the WDA app
+
+Proceed with [Validating the WDA Install](./real-device-config.md#validating-the-wda-install) for
+the next steps!

package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-generic-manual.md

@@ -0,0 +1,49 @@
+---
+hide:
+  - toc
+
+title: Manual Configuration for a Generic Device
+---
+
+It is possible to build `WebDriverAgentRunner` for a generic iOS/iPadOS/tvOS device, and install the
+generated `.app` package to a real device.
+
+```bash
+# iOS/iPadOS
+$ xcodebuild clean build-for-testing -project WebDriverAgent.xcodeproj -derivedDataPath appium_wda_ios -scheme WebDriverAgentRunner -destination generic/platform=iOS CODE_SIGNING_ALLOWED=YES
+
+# tvOS
+$ xcodebuild clean build-for-testing -project WebDriverAgent.xcodeproj -derivedDataPath appium_wda_tvos -scheme WebDriverAgentRunner_tvOS -destination generic/platform=tvOS CODE_SIGNING_ALLOWED=YES
+```
+
+On successful completion the resulting package `WebDriverAgentRunner-Runner.app` should be located
+in the `Build/Products/Debug-iphoneos/` subfolder under WebDriverAgent sources root, or in the path
+provided as `derivedDataPath` argument.
+
+!!! note
+
+    If the build fails, please make sure `WebDriverAgent.xcodeproj` has codesigning properties
+    configured properly. For example, you may need to change the bundle id for the provisioning profile.
+
+The `WebDriverAgentRunner-Runner.app` can now be installed to any real device as allowed by the
+provisioning profile.
+
+You can install the package with 3rd party tools and manage it separately as explained in
+[How To Set Up And Customize WebDriverAgent Server](../guides/wda-custom-server.md). Note that if
+the codesigning was not correct, the installation will fail.
+
+As a more advanced method, you can generate the package with `CODE_SIGNING_ALLOWED=NO` and do
+[`codesign`](https://developer.apple.com/documentation/xcode/using-the-latest-code-signature-format)
+by yourself. This would make the device management more flexible, but you would need to know about
+advanced codesign usage scenarios.
+
+!!! note
+
+    The Appium team distributes generic builds with `CODE_SIGNING_ALLOWED=NO` at
+    [WebDriverAgent package releases](https://github.com/appium/WebDriverAgent/releases).
+    It is recommended to sign packages with a wildcard (`*`) provisioning profile,
+    although such profiles require a paid Apple Developer account.
+    For example, if you're preparing such a provisioning profile for `io.appium.WebDriverAgentRunner.xctrunner`, it will be for `io.appium.*`, `io.appium.WebDriverAgentRunner.*` or `*`.
+    In case of a free account, you may need to update the bundle id before building
+    the WebDriverAgent package to prepare a properly signed WebDriverAgent package
+    by `xcodebuild`.

package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/real-device-config.md

@@ -0,0 +1,100 @@
+---
+title: Real Device Configuration
+---
+
+In order to communicate with the device under test, the XCUITest driver automatically installs the
+`WebDriverAgentRunner-Runner` (WDA) application on it, using Xcode's command-line utility `xcodebuild`.
+Unlike simulators, real devices have several security restrictions that need to be manually
+configured, before this can work:
+
+- Devices need to be trusted. This can be done by opening Xcode and afterwards physically connecting
+  the device under test to the computer. The device should have a popup asking to trust the computer,
+  which you should accept.
+- Devices using iOS/iPadOS 16 or above require enabling Developer Mode. Please read
+  [Apple's documentation on Developer Mode](https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device)
+  for more details. `devmodectl streaming` CLI on macOS 13+ and installing development signed apps
+  also help enabling the mode.
+- After enabling Developer Mode (if applicable), please turn on _Settings -> Developer -> Enable UI Automation_
+- Webviews will not be testable unless the Safari Inspector is enabled. Please turn it on in
+  _Settings -> Safari -> Advanced -> Web Inspector_. Similarly, you may want to turn on the adjacent
+  option _Settings -> Safari -> Advanced -> Remote Automation_.
+
+Finally, the WDA application must have a valid provisioning profile, which includes signing the app
+and linking it to a development team.
+
+## Provisioning Profile Setup
+
+Generally, unless your device under test [already has WDA installed](../guides/run-preinstalled-wda.md),
+or you already have [a prebuilt WDA](../guides/run-prebuilt-wda.md) on your local system, you will
+need an Apple ID to be able to sign the app.
+
+Once you have an Apple ID, there are several approaches you can take.
+
+* [__Basic Automatic Configuration__](./prov-profile-basic-auto.md): the easiest approach, but
+  requires you to have a paid Apple Developer account
+
+If the automatic configuration did not work or does not apply to you, you will need to follow one of
+the manual configuration approaches. All of these involve the WDA Xcode project, so at the very
+least, you must know the local path to the project file - `WebDriverAgent.xcodeproj`:
+
+* The WDA project is included in `appium-webdriveragent`, which is installed as a dependency of the
+  XCUITest driver. You can therefore find the project file in
+  `/path/to/xcuitest/driver/node_modules/appium-webdriveragent/WebDriverAgent.xcodeproj`.
+  By default, drivers are installed in `~/.appium`, so the project would be located at
+  `~/.appium/node_modules/appium-xcuitest-driver/node_modules/appium-webdriveragent/WebDriverAgent.xcodeproj`.
+* If using XCUITest driver v4.13.0 or newer, you can run the `appium driver run xcuitest open-wda`
+  [driver script](../reference/scripts.md) to directly open `WebDriverAgent.xcodeproj` in Xcode.
+
+The WDA project file can now be used in the manual configuration approaches:
+
+* [__Basic Manual Configuration__](./prov-profile-basic-manual.md): create a new project, then use
+  its provisioning profile and bundle ID
+* [__Full Manual Configuration__](./prov-profile-full-manual.md): associate the provisioning profile
+  directly with the WDA project
+* [__Manual Configuration for a Generic Device__](./prov-profile-generic-manual.md): manually run
+  `xcodebuild` to build WDA, then manually install it
+
+### Validating the WDA Install
+
+Once you have configured the WDA project or have the app ready, you can try installing it. It is
+possible that you may encounter some errors:
+
+* `xcodebuild exited with code '65' and signal 'null'`
+
+    This usually happens when attempting the automatic configuration, and it means that the necessary
+    code signing is not set up correctly. Follow the steps in any of the manual configuration
+    approaches to fix this.
+
+* `Unable to launch <your-bundle-id>.WebDriverAgentRunner-Runner because it has an invalid code
+  signature, inadequate entitlements or its profile has not been explicitly trusted by the user.`
+
+    This means that the developer is not trusted on the device. If you manually try to open the WDA
+    app on the device, you will see a popup message:
+
+    ![Untrusted developer](./assets/images/untrusted-dev.png)
+
+    To fix this, you need to open _Settings -> General -> VPN & Device Management_ on the device, then
+    select your development team and trust it. Afterwards you should be able to open/launch the app.
+    See [Apple documentation for more information](https://support.apple.com/en-us/HT204460).
+
+* For other issues, please refer to the [Troubleshooting](../guides/troubleshooting.md) page
+
+
+### Create an Offline Provisioning Profile
+
+Since iOS 16, Apple requires a device to have a live internet connection for validating the code
+signing. It is possible to set up an offline enabled provisioning profile, which allows you to avoid
+the limitation. Please read [this issue](https://github.com/appium/appium/issues/18378#issuecomment-1482678074)
+regarding detailed configuration steps.
+
+## Tune WebDriverAgent to improve session startup performance
+
+Running `xcodebuild` every time takes much longer time to complete a session startup.
+XCUITest driver offers a few methods to improve the performance with, or without using `xcodebuild`.
+
+Some might require deeper understanding of iOS development environment,
+but they help to improve speedup your test execution speed.
+
+- [Run Preinstalled WebDriverAgentRunner](./../guides/run-preinstalled-wda.md)
+- [Run Prebuilt WebDriverAgentRunner](./../guides/run-prebuilt-wda.md)
+- [Attach to a Running WebDriverAgent](./../guides/attach-to-running-wda.md)

package/src/resources/submodules/appium-xcuitest-driver/docs/reference/bidi.md

@@ -0,0 +1,75 @@
+---
+title: BiDi Protocol Support
+---
+
+XCUITest driver has partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0.
+Only events and commands mentioned below are supported.
+All other entities described in the spec throw not implemented errors.
+
+# Supported Events
+
+## log.entryAdded
+
+This event is emitted if the driver retrieves a new entry for any of the below log types. Logs collection might be disabled by the `appium:skipLogCapture` capability.
+
+### crashlog
+
+Events are emitted for both emulator and real devices. The latter only works if [py-ios-device](https://github.com/YueChen-C/py-ios-device) is installed on the server host. Each event contains a particular device crash report entry.
+Events are always emitted with the `NATIVE_APP` context.
+
+### syslog
+
+Events are emitted for both emulator and real devices. Each event contains a single device system log line.
+Events are always emitted with the `NATIVE_APP` context.
+
+### safariConsole
+
+Events are emitted for both emulator and real devices. Each event contains a single Safari console log line.
+Events are always emitted with the appropriate web context name from which they were generated.
+Events are only emitted if the `appium:showSafariConsoleLog` capability value is provided.
+
+### safariNetwork
+
+Events are emitted for both emulator and real devices. Each event contains a single Safari network log line.
+Events are always emitted with the appropriate web context name from which they were generated.
+Events are only emitted if the `appium:showSafariNetworkLog` capability value is provided.
+
+### performance
+
+Events are emitted for both emulator and real devices. Each event contains a single Safari performance log line.
+Events are always emitted with the appropriate web context name from which they were generated.
+Events are only emitted if the `appium:enablePerformanceLogging` capability value is provided.
+
+### server
+
+Events are emitted for both emulator and real devices. Each event contains a single Appium server log line.
+Events are always emitted with the `NATIVE_APP` context.
+Events are only emitted if the `get_server_logs` server security feature is enabled.
+
+## appium:xcuitest.contextUpdate
+
+This event is emitted upon the context change, either explicit or implicit.
+The event is always emitted upon new session initialization.
+See the [GitHub feature ticket](https://github.com/appium/appium/issues/20741) for more details.
+
+### CDDL
+
+```cddl
+appium:xcuitest.contextUpdated = {
+  method: "appium:xcuitest.contextUpdated",
+  params: {
+    name: text,
+    type: "NATIVE" / "WEB",
+  },
+}
+```
+
+The event contains the following params:
+
+### name
+
+Contains the actual name of the new context, for example `NATIVE_APP`.
+
+### type
+
+Either `NATIVE` or `WEB` depending on which context is currently active in the driver session.