appium-geckodriver 3.0.2 → 3.0.4

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [3.0.4](https://github.com/appium/appium-geckodriver/compare/v3.0.3...v3.0.4) (2026-06-22)
+
+### Bug Fixes
+
+* actually enable doctor checks ([#176](https://github.com/appium/appium-geckodriver/issues/176)) ([ca23c16](https://github.com/appium/appium-geckodriver/commit/ca23c16db720d4443b3f9458ed22190994238a41))
+
+## [3.0.3](https://github.com/appium/appium-geckodriver/compare/v3.0.2...v3.0.3) (2026-06-19)
+
+### Miscellaneous Chores
+
+* **deps:** bump actions/checkout from 6 to 7 ([#171](https://github.com/appium/appium-geckodriver/issues/171)) ([c3f8387](https://github.com/appium/appium-geckodriver/commit/c3f8387d2e7a2a19299673829b6a9134a7c4feae))
+
 ## [3.0.2](https://github.com/appium/appium-geckodriver/compare/v3.0.1...v3.0.2) (2026-06-19)
 
 ### Miscellaneous Chores

package/README.md

@@ -1,180 +1,36 @@
-Appium Geckodriver
-====
+## Appium Geckodriver
+
+<p align="center">
+   <a href="https://appium.github.io/appium-geckodriver/">
+      <img alt="Appium Geckodriver" src="./docs/assets/images/appium-plus-gecko.png" width="400">
+   </a>
+</p>
+
+<div align="center">
 
 [![NPM version](http://img.shields.io/npm/v/appium-geckodriver.svg)](https://npmjs.org/package/appium-geckodriver)
 [![Downloads](http://img.shields.io/npm/dm/appium-geckodriver.svg)](https://npmjs.org/package/appium-geckodriver)
-
 [![Release](https://github.com/appium/appium-geckodriver/actions/workflows/publish.js.yml/badge.svg)](https://github.com/appium/appium-geckodriver/actions/workflows/publish.js.yml)
 
-This is Appium driver for automating Firefox on different platforms, including Android.
-The driver only supports Firefox and Gecko-based web views (Android only) automation using [W3C WebDriver protocol](https://www.w3.org/TR/webdriver/).
-Under the hood this driver is a wrapper/proxy over `geckodriver` binary. Check the driver [release notes](https://github.com/mozilla/geckodriver/releases) and the [official documentation](https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities) to get more details on the supported features and possible pitfalls.
-
-> [!IMPORTANT]
-> Since major version *2.0.0*, this driver is only compatible with Appium 3. Use the `appium driver install gecko`
-> command to add it to your distribution.
-
-## Requirements
-
-It is mandatory to have both Firefox browser installed and the geckodriver binary downloaded on the platform where automated tests are going to be executed. Firefox could be downloaded from the [official download site](https://www.mozilla.org/en-GB/firefox/all/) and the driver binary could be retrieved from the GitHub [releases page](https://github.com/mozilla/geckodriver/releases). The binary must be put into one of the folders included to PATH environment variable. On macOS it also might be necessary to run `xattr -cr "<binary_path>"` to avoid [notarization](https://firefox-source-docs.mozilla.org/testing/geckodriver/Notarization.html) issues.
-
-Since driver version 1.4.0 the geckodriver binary deployment could be automated via the
-[install-geckodriver](#install-geckodriver) driver script.
-
-Then you need to decide where the automated test is going to be executed. Gecko driver supports the following target platforms:
- - macOS
- - Windows
- - Linux
- - Android (note that `android` *cannot* be passed as a value to `platformName` capability; it should always equal to the *host* platform name)
-
-In order to run your automated tests on an Android device it is necessary to have [Android SDK](https://developer.android.com/studio) installed, so the destination device is marked as `online` in the `adb devices -l` command output.
-
-### Doctor
-
-Since driver version 1.3.0 you can automate the validation for the most of the above
-requirements as well as various optional ones needed by driver extensions by running the
-`appium driver doctor gecko` server command.
-
-## Capabilities
-
-Gecko driver allows defining of multiple criterions for platform selection and also to fine-tune your automation session properties. This could be done via the following session capabilities:
-
-Capability Name | Description
---- | ---
-platformName | Gecko Driver supports the following platforms: `mac`, `linux`, `windows`. The fact your test must be executed on Android is detected based on `moz:firefoxOptions` entry values. Values of platformName are compared case-insensitively.
-browserName | Any value passed to this capability will be changed to 'firefox'.
-browserVersion | Provide the version number of the browser to automate if there are multiple versions installed on the same machine where the driver is running.
-appium:automationName | Must always be set to `Gecko`.
-appium:noReset | Being set to `true` adds the `--connect-existing` argument to the server, that allows to connect to an existing browser instance instead of starting a new browser instance on session startup.
-appium:marionettePort | Selects the port for Geckodriver’s connection to the Marionette remote protocol. The existing Firefox instance must have Marionette enabled. To enable the remote protocol in Firefox, you can pass the `-marionette` flag. Unless the `marionette.port` preference has been user-set, Marionette will listen on port `2828`, which is the default value for this capability.
-appium:systemPort | The number of the port for the driver to listen on. Must be unique for each session. If not provided then Appium will try to detect it automatically.
-appium:verbosity | The verbosity level of driver logging. By default minimum verbosity is applied. Possible values are `debug` or `trace`.
-appium:androidStorage | See https://firefox-source-docs.mozilla.org/testing/geckodriver/Flags.html#code-android-storage-var-android-storage-var-code
-appium:geckodriverExecutable | Optional full path to the `geckodriver` binary to be used for this session instead of resolving it from `PATH`. Using this capability is considered an insecure feature and requires the Appium server to be started with the `custom_geckodriver_executable` insecure feature enabled (for example via `--allow-insecure gecko:custom_geckodriver_executable` or `--relaxed-security`). If the capability is provided but the insecure feature is not enabled, session creation will fail with a capability validation error.
-moz:firefoxOptions | See https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions
-acceptInsecureCerts | See https://www.w3.org/TR/webdriver/#capabilities
-pageLoadStrategy | See https://www.w3.org/TR/webdriver/#capabilities
-proxy | See https://www.w3.org/TR/webdriver/#capabilities
-setWindowRect | See https://www.w3.org/TR/webdriver/#capabilities
-timeouts | See https://www.w3.org/TR/webdriver/#capabilities
-unhandledPromptBehavior | See https://www.w3.org/TR/webdriver/#capabilities
-
-## Scripts
+</div>
 
-### install-geckodriver
+---
 
-This script is used to install the given or latest stable version of Geckodriver server from
-the [GitHub releases](https://github.com/mozilla/geckodriver/release) page.
-Run `appium driver run gecko install-geckodriver <optional_version>`, where `optional_version`
-must be either valid Geckodriver version number or should not be present (the latest stable version is used then).
-By default, the script will download and unpack the binary into `/usr/local/bin/geckodriver`
-on macOS and Linux or into `%LOCALAPPDATA%\Mozilla\geckodriver.exe` on Windows.
-You must also make sure the `%LOCALAPPDATA%\Mozilla` (Windows) or `/usr/local/bin/` (Linux & macOS)
-folder is present in the PATH environment variable before
-starting an actual automation session. The deployment script should also show a warning message if
-it is unable to find the parent folder in the PATH folders list.
+<p align="center"><b>
+   <a href="https://appium.github.io/appium-geckodriver/">Documentation</a> |
+   <a href="https://appium.github.io/appium-geckodriver/latest/getting-started/">Get Started</a> |
+   <a href="https://github.com/appium/appium-geckodriver/blob/master/CHANGELOG.md">Changelog</a>
+</b></p>
 
-## Example
+---
 
-```python
-# Python3 + PyTest
-import pytest
-import time
+This is Appium driver for automating Gecko-based browsers (such as Firefox) and webviews on different
+platforms, including Android.
 
-from appium import webdriver
-# Options are available in Python client since v2.6.0
-from appium.options.gecko import GeckoOptions
-from selenium.webdriver.common.by import By
-
-
-def generate_options():
-    common_caps = {
-        # It does not really matter what to put there, although setting 'Firefox' might cause a failure
-        # depending on the particular client library
-        'browserName': 'MozillaFirefox',
-        # Should have the name of the host platform, where the geckodriver binary is deployed
-        'platformName': 'mac',
-    }
-    android_options = GeckoOptions().load_capabilities(common_caps)
-    android_options.firefox_options = {
-        'androidDeviceSerial': '<device/emulator serial>',
-        # These capabilities depend on what you are going to automate
-        # Refer Mozilla documentation at https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions for more details
-        'androidPackage': 'org.mozilla.firefox',
-    }
-    desktop_options = GeckoOptions().load_capabilities(common_caps)
-    return [android_options, desktop_options]
-
-
-@pytest.fixture(params=generate_options())
-def driver(request):
-    # The default URL is http://127.0.0.1:4723/wd/hub in Appium1
-    drv = webdriver.Remote('http://127.0.0.1:4723', options=request.param)
-    yield drv
-    drv.quit()
-
-
-class TimeoutError(Exception):
-    pass
-
-
-def wait_until_truthy(func, timeout_sec=5.0, interval_sec=0.5):
-    started = time.time()
-    original_error = None
-    while time.time() - started < timeout_sec:
-        original_error = None
-        try:
-            result = func()
-            if result:
-                return result
-        except Exception as e:
-            original_error = e
-        time.sleep(interval_sec)
-    if original_error is None:
-        raise TimeoutError(f'Condition unmet after {timeout_sec}s timeout')
-    raise original_error
-
-
-def test_feature_status_page_search(driver):
-    driver.get('https://webkit.org/status/')
-
-    # Enter "CSS" into the search box.
-    # Ensures that at least one result appears in search
-    # !!! Remember there are no ID and NAME locators in W3C standard
-    # These two have been superseded by CSS ones
-    search_box = driver.find_element_by_css('#search')
-    search_box.send_keys('CSS')
-    value = search_box.get_attribute('value')
-    assert len(value) > 0
-    search_box.submit()
-    # Count the visible results when filters are applied
-    # so one result shows up in at most one filter
-    assert wait_until_truthy(
-        lambda: len(driver.execute_script("return document.querySelectorAll('li.feature:not(.is-hidden)')")) > 0)
-
-
-def test_feature_status_page_filters(driver):
-    driver.get('https://webkit.org/status/')
-
-    assert wait_until_truthy(
-        lambda: len(driver.execute_script("return document.querySelectorAll('.filter-toggle')")) == 7)
-
-    # Make sure every filter is turned off.
-    for checked_filter in filter(lambda f: f.is_selected(), filters):
-        checked_filter.click()
+> [!IMPORTANT]
+> Since major version *2.0.0*, this driver is only compatible with Appium 3.
 
-    # Make sure you can select every filter.
-    for filt in filters:
-        filt.click()
-        assert filt.is_selected()
-        filt.click()
-```
 
-## Development
+## Documentation
 
-```bash
-# clone repo, then in repo dir:
-npm install
-npm run lint
-npm run test
-```
+You can access the documentation here: [**https://appium.github.io/appium-geckodriver**](https://appium.github.io/appium-geckodriver)

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-geckodriver",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-geckodriver",
-      "version": "3.0.2",
+      "version": "3.0.4",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^15.0.0",
@@ -19,6 +19,7 @@
         "teen_process": "^4.0.4"
       },
       "devDependencies": {
+        "@appium/docutils": "^2.5.0",
         "@appium/eslint-config-appium-ts": "^3.0.0",
         "@appium/tsconfig": "^1.0.0-rc.1",
         "@appium/types": "^1.0.0-rc.1",
@@ -41,6 +42,44 @@
         "appium": "^3.0.0-rc.2"
       }
     },
+    "node_modules/@appium/docutils": {
+      "version": "2.5.1",
+      "resolved": "https://registry.npmjs.org/@appium/docutils/-/docutils-2.5.1.tgz",
+      "integrity": "sha512-P2Kveb4I68KGC6gAY0TRTVgvqBaZW3WqpnHgK0iiN+lLhaxBoRrqoaGJR95oPb93sgkZQT59ZexdZ5KXf8wFtA==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@appium/support": "7.2.5",
+        "consola": "3.4.2",
+        "diff": "9.0.0",
+        "lilconfig": "3.1.3",
+        "normalize-package-data": "8.0.0",
+        "teen_process": "4.1.3",
+        "type-fest": "5.7.0",
+        "yaml": "2.9.0",
+        "yargs": "18.0.0",
+        "yargs-parser": "22.0.0"
+      },
+      "bin": {
+        "appium-docs": "bin/appium-docs.js"
+      },
+      "engines": {
+        "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+        "npm": ">=10"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/teen_process": {
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/teen_process/-/teen_process-4.1.3.tgz",
+      "integrity": "sha512-8W7Xp7WtJ5ZXjv0iHMsCgPPKzUt6ACfG/rDWX0tMIlMJaYcTYsPw3ZQQ9+hG7YsY+gm+DUATiyah3AraJ9JYpg==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "shell-quote": "^1.8.1"
+      },
+      "engines": {
+        "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+        "npm": ">=10"
+      }
+    },
     "node_modules/@appium/logger": {
       "version": "2.0.9",
       "resolved": "https://registry.npmjs.org/@appium/logger/-/logger-2.0.9.tgz",
@@ -106,6 +145,31 @@
         "sharp": "0.35.1"
       }
     },
+    "node_modules/@appium/support/node_modules/semver": {
+      "version": "7.8.4",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.4.tgz",
+      "integrity": "sha512-rUCObTnP32Q08R2uuIrt7r9PlEonuTmtuXYcW6s5kjdlj3xbnwe+21yXptAUYcMAABLkYYTtnmzb3w3EDZfueA==",
+      "license": "ISC",
+      "bin": {
+        "semver": "bin/semver.js"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/@appium/support/node_modules/teen_process": {
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/teen_process/-/teen_process-4.1.3.tgz",
+      "integrity": "sha512-8W7Xp7WtJ5ZXjv0iHMsCgPPKzUt6ACfG/rDWX0tMIlMJaYcTYsPw3ZQQ9+hG7YsY+gm+DUATiyah3AraJ9JYpg==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "shell-quote": "^1.8.1"
+      },
+      "engines": {
+        "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+        "npm": ">=10"
+      }
+    },
     "node_modules/@appium/types": {
       "version": "1.5.1",
       "resolved": "https://registry.npmjs.org/@appium/types/-/types-1.5.1.tgz",
@@ -214,7 +278,6 @@
       "version": "6.2.2",
       "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz",
       "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==",
-      "extraneous": true,
       "license": "MIT",
       "engines": {
         "node": ">=12"
@@ -240,9 +303,9 @@
       }
     },
     "node_modules/appium-adb": {
-      "version": "15.0.0",
-      "resolved": "https://registry.npmjs.org/appium-adb/-/appium-adb-15.0.0.tgz",
-      "integrity": "sha512-RIRCcBzVlFlO2VHXmXPzComPFQL05fs+qEtK1ftVtB4kEggk+ewfD8VSI0ZuUGOD8NQlNusDgRQV8p/LKlNryg==",
+      "version": "15.0.1",
+      "resolved": "https://registry.npmjs.org/appium-adb/-/appium-adb-15.0.1.tgz",
+      "integrity": "sha512-s2B9p78PLjLn59QeO8QNVcbqu+QIXT1uDBFsbHJbUp0vci0gKXenpoF7jRDgbgwYPs7AqlILMRmFUml6/P5ZxA==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/support": "^7.2.2",
@@ -554,7 +617,6 @@
       "version": "9.0.1",
       "resolved": "https://registry.npmjs.org/cliui/-/cliui-9.0.1.tgz",
       "integrity": "sha512-k7ndgKhwoQveBL+/1tqGJYNz097I7WOvwbmmU2AR5+magtbjPWQTS1C5vzGkBC8Ym8UWRzfKUzUUqFLypY4Q+w==",
-      "extraneous": true,
       "license": "ISC",
       "dependencies": {
         "string-width": "^7.2.0",
@@ -569,14 +631,12 @@
       "version": "10.6.0",
       "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz",
       "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==",
-      "extraneous": true,
       "license": "MIT"
     },
     "node_modules/cliui/node_modules/string-width": {
       "version": "7.2.0",
       "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz",
       "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "emoji-regex": "^10.3.0",
@@ -594,7 +654,6 @@
       "version": "7.2.0",
       "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz",
       "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "ansi-regex": "^6.2.2"
@@ -663,6 +722,15 @@
         "node": ">=18"
       }
     },
+    "node_modules/consola": {
+      "version": "3.4.2",
+      "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz",
+      "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==",
+      "license": "MIT",
+      "engines": {
+        "node": "^14.18.0 || >=16.10.0"
+      }
+    },
     "node_modules/core-util-is": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz",
@@ -730,6 +798,15 @@
         "node": ">=8"
       }
     },
+    "node_modules/diff": {
+      "version": "9.0.0",
+      "resolved": "https://registry.npmjs.org/diff/-/diff-9.0.0.tgz",
+      "integrity": "sha512-svtcdpS8CgJyqAjEQIXdb3OjhFVVYjzGAPO8WGCmRbrml64SPw/jJD4GoE98aR7r25A0XcgrK3F02yw9R/vhQw==",
+      "license": "BSD-3-Clause",
+      "engines": {
+        "node": ">=0.3.1"
+      }
+    },
     "node_modules/dunder-proto": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz",
@@ -799,7 +876,6 @@
       "version": "3.2.0",
       "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz",
       "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==",
-      "extraneous": true,
       "license": "MIT",
       "engines": {
         "node": ">=6"
@@ -953,7 +1029,6 @@
       "version": "2.0.5",
       "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
       "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
-      "extraneous": true,
       "license": "ISC",
       "engines": {
         "node": "6.* || 8.* || >= 10.*"
@@ -963,7 +1038,6 @@
       "version": "1.6.0",
       "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.6.0.tgz",
       "integrity": "sha512-QRbvDIbx6YklUe6RxeTeleMR0yv3cYH6PsPZHcnVn7xv7zO1BHN8r0XETu8n6Ye3Q+ahtSarc3WgtNWmehIBfA==",
-      "extraneous": true,
       "license": "MIT",
       "engines": {
         "node": ">=18"
@@ -1260,6 +1334,18 @@
         "safe-buffer": "~5.1.0"
       }
     },
+    "node_modules/lilconfig": {
+      "version": "3.1.3",
+      "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.3.tgz",
+      "integrity": "sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=14"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/antonk52"
+      }
+    },
     "node_modules/lockfile": {
       "version": "1.0.4",
       "resolved": "https://registry.npmjs.org/lockfile/-/lockfile-1.0.4.tgz",
@@ -1579,9 +1665,9 @@
       }
     },
     "node_modules/semver": {
-      "version": "7.8.4",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.4.tgz",
-      "integrity": "sha512-rUCObTnP32Q08R2uuIrt7r9PlEonuTmtuXYcW6s5kjdlj3xbnwe+21yXptAUYcMAABLkYYTtnmzb3w3EDZfueA==",
+      "version": "7.8.5",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz",
+      "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==",
       "license": "ISC",
       "bin": {
         "semver": "bin/semver.js"
@@ -1805,9 +1891,9 @@
       }
     },
     "node_modules/teen_process": {
-      "version": "4.1.3",
-      "resolved": "https://registry.npmjs.org/teen_process/-/teen_process-4.1.3.tgz",
-      "integrity": "sha512-8W7Xp7WtJ5ZXjv0iHMsCgPPKzUt6ACfG/rDWX0tMIlMJaYcTYsPw3ZQQ9+hG7YsY+gm+DUATiyah3AraJ9JYpg==",
+      "version": "4.1.5",
+      "resolved": "https://registry.npmjs.org/teen_process/-/teen_process-4.1.5.tgz",
+      "integrity": "sha512-XQ4MDij09YygEZyXD6QFKfWhAi7efiEQ4fM2ACNDgkj/LO5mZWi2bR5ghNEU232mMx4+MLrNwV95BV4S+4PGsg==",
       "license": "Apache-2.0",
       "dependencies": {
         "shell-quote": "^1.8.1"
@@ -1945,7 +2031,6 @@
       "version": "9.0.2",
       "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.2.tgz",
       "integrity": "sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "ansi-styles": "^6.2.1",
@@ -1963,7 +2048,6 @@
       "version": "6.2.3",
       "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz",
       "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==",
-      "extraneous": true,
       "license": "MIT",
       "engines": {
         "node": ">=12"
@@ -1976,14 +2060,12 @@
       "version": "10.6.0",
       "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz",
       "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==",
-      "extraneous": true,
       "license": "MIT"
     },
     "node_modules/wrap-ansi/node_modules/string-width": {
       "version": "7.2.0",
       "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz",
       "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "emoji-regex": "^10.3.0",
@@ -2001,7 +2083,6 @@
       "version": "7.2.0",
       "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz",
       "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "ansi-regex": "^6.2.2"
@@ -2054,17 +2135,30 @@
       "version": "5.0.8",
       "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
       "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
-      "extraneous": true,
       "license": "ISC",
       "engines": {
         "node": ">=10"
       }
     },
+    "node_modules/yaml": {
+      "version": "2.9.0",
+      "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz",
+      "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==",
+      "license": "ISC",
+      "bin": {
+        "yaml": "bin.mjs"
+      },
+      "engines": {
+        "node": ">= 14.6"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/eemeli"
+      }
+    },
     "node_modules/yargs": {
       "version": "18.0.0",
       "resolved": "https://registry.npmjs.org/yargs/-/yargs-18.0.0.tgz",
       "integrity": "sha512-4UEqdc2RYGHZc7Doyqkrqiln3p9X2DZVxaGbwhn2pi7MrRagKaOcIKe8L3OxYcbhXLgLFUS3zAYuQjKBQgmuNg==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "cliui": "^9.0.1",
@@ -2082,7 +2176,6 @@
       "version": "22.0.0",
       "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-22.0.0.tgz",
       "integrity": "sha512-rwu/ClNdSMpkSrUb+d6BRsSkLUq1fmfsY6TOpYzTwvwkg1/NRG85KBy3kq++A8LKQwX6lsu+aWad+2khvuXrqw==",
-      "extraneous": true,
       "license": "ISC",
       "engines": {
         "node": "^20.19.0 || ^22.12.0 || >=23"
@@ -2092,14 +2185,12 @@
       "version": "10.6.0",
       "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz",
       "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==",
-      "extraneous": true,
       "license": "MIT"
     },
     "node_modules/yargs/node_modules/string-width": {
       "version": "7.2.0",
       "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz",
       "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "emoji-regex": "^10.3.0",
@@ -2117,7 +2208,6 @@
       "version": "7.2.0",
       "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz",
       "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==",
-      "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "ansi-regex": "^6.2.2"

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "appium-geckodriver",
+  "version": "3.0.4",
   "description": "Appium driver for Gecko-based browsers and web views",
   "keywords": [
     "appium",
     "gecko",
-    "seamonkey",
+    "geckodriver",
     "firefox"
   ],
-  "version": "3.0.2",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
+  "homepage": "https://appium.github.io/appium-geckodriver",
   "repository": {
     "type": "git",
     "url": "https://github.com/appium/appium-geckodriver.git"
@@ -17,29 +18,6 @@
   "bugs": {
     "url": "https://github.com/appium/appium-geckodriver/issues"
   },
-  "engines": {
-    "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
-    "npm": ">=10"
-  },
-  "prettier": {
-    "bracketSpacing": false,
-    "printWidth": 100,
-    "singleQuote": true
-  },
-  "appium": {
-    "driverName": "gecko",
-    "automationName": "Gecko",
-    "platformNames": [
-      "Linux",
-      "Mac",
-      "Android",
-      "Windows"
-    ],
-    "scripts": {
-      "install-geckodriver": "./scripts/install-geckodriver.mjs"
-    },
-    "mainClass": "GeckoDriver"
-  },
   "type": "module",
   "main": "./build/lib/index.js",
   "types": "./build/lib/index.d.ts",
@@ -57,23 +35,36 @@
   "files": [
     "lib",
     "build/lib",
+    "README.md",
     "CHANGELOG.md",
     "LICENSE",
     "npm-shrinkwrap.json",
     "scripts/*.mjs"
   ],
-  "peerDependencies": {
-    "appium": "^3.0.0-rc.2"
+  "appium": {
+    "driverName": "gecko",
+    "automationName": "Gecko",
+    "platformNames": [
+      "Linux",
+      "Mac",
+      "Android",
+      "Windows"
+    ],
+    "mainClass": "GeckoDriver",
+    "scripts": {
+      "install-geckodriver": "./scripts/install-geckodriver.mjs"
+    },
+    "doctor": {
+      "checks": [
+        "./build/lib/doctor/required-checks.js",
+        "./build/lib/doctor/optional-checks.js"
+      ]
+    }
   },
-  "dependencies": {
-    "appium-adb": "^15.0.0",
-    "asyncbox": "^6.3.0",
-    "axios": "^1.16.1",
-    "commander": "^14.0.3",
-    "portscanner": "^2.2.0",
-    "semver": "^7.6.3",
-    "tar-stream": "^3.1.7",
-    "teen_process": "^4.0.4"
+  "prettier": {
+    "bracketSpacing": false,
+    "printWidth": 100,
+    "singleQuote": true
   },
   "scripts": {
     "build": "tsc -b",
@@ -85,11 +76,29 @@
     "prepare": "npm run build",
     "format": "prettier -w ./lib ./test",
     "format:check": "prettier --check ./lib ./test",
+    "build:docs": "appium-docs build",
+    "dev:docs": "appium-docs build --serve",
+    "publish:docs": "appium-docs build --deploy --push -b docs-site -m 'docs: build docs for appium-geckodriver@%s' --alias latest --use-prefixed-major-deploy-version",
+    "install-docs-deps": "appium-docs init --no-mkdocs",
     "pretest": "npm run build",
     "test": "node --test --test-timeout=60000 \"build/test/unit/**/*.test.js\"",
     "e2e-test": "npm run build && node --test --test-timeout=300000 \"build/test/functional/**/*.test.js\""
   },
+  "dependencies": {
+    "appium-adb": "^15.0.0",
+    "asyncbox": "^6.3.0",
+    "axios": "^1.16.1",
+    "commander": "^14.0.3",
+    "portscanner": "^2.2.0",
+    "semver": "^7.6.3",
+    "tar-stream": "^3.1.7",
+    "teen_process": "^4.0.4"
+  },
+  "peerDependencies": {
+    "appium": "^3.0.0-rc.2"
+  },
   "devDependencies": {
+    "@appium/docutils": "^2.5.0",
     "@appium/eslint-config-appium-ts": "^3.0.0",
     "@appium/tsconfig": "^1.0.0-rc.1",
     "@appium/types": "^1.0.0-rc.1",
@@ -104,10 +113,8 @@
     "typescript": "^6.0.2",
     "webdriverio": "^9.0.5"
   },
-  "doctor": {
-    "checks": [
-      "./build/lib/doctor/required-checks.js",
-      "./build/lib/doctor/optional-checks.js"
-    ]
+  "engines": {
+    "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+    "npm": ">=10"
   }
 }