chore: publish

- appium@2.0.0-beta.65 - @appium/docutils@0.3.8 - @appium/typedoc-plugin-appium@0.6.3
chore(typedoc-plugin-appium): add basic snapshot tests
2026-10-31 14:00:08 +08:00 · 2023-04-18 16:52:19 -07:00 · 2023-04-18 16:51:15 -07:00 · 2023-04-18 16:51:15 -07:00 · 2023-04-18 14:12:07 +00:00 · 2023-04-18 08:05:39 +00:00
100 changed files with 5123 additions and 605 deletions
@@ -147,3 +147,8 @@ labels:
    sync: true
    matcher:
      files: ['packages/universal-xml-plugin/**']
+  
+  - label: '@appium/strongbox'
+    sync: true
+    matcher:
+      files: ['packages/strongbox/**']
@@ -50,7 +50,7 @@ jobs:
        node-version: [14.x, 16.x, 18.x]

    steps:
-      - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
        with:
@@ -70,7 +70,7 @@ jobs:
    name: Lint
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
      - name: Install dependencies
        uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
        with:
@@ -78,7 +78,3 @@ jobs:
          install-command: npm ci
      - name: ESLint
        run: npm run lint:ci
-      - name: Validate Renovate Config
-        uses: rinchsan/renovate-config-validator@1ea1e8514f6a33fdd71c40b0a5fa3512b9e7b936 # tag=v0
-        with:
-          pattern: '{.renovaterc.json,renovate/default.json}'
@@ -12,7 +12,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
-        uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3

      - name: Cleanup
        run: |
@@ -1,22 +1,6 @@
 name: Build Docs

 on:
-  push:
-    # this list of paths could potentially impact doc generation.
-    paths:
-      - '**/typedoc.json'
-      - '**/tsconfig*.json'
-      - '**/package*.json'
-      - '**/*mkdocs*.ya?ml'
-      - 'packages/docutils/requirements.txt'
-      - 'packages/*/README.md'
-      - 'packages/*/docs/**'
-      - 'packages/*/**/*.ts'
-      - 'packages/*/**/*.js'
-      - '.github/workflows/docs.yml' # this file
-      - '!**/test/**'
-      - '!**/sample-code/**'
-
  pull_request:
    paths:
      - '**/typedoc.json'
@@ -31,17 +15,27 @@ on:
      - '.github/workflows/docs.yml' # this file
      - '!**/test/**'
      - '!**/sample-code/**'
-
-    branches: [master]
-
-concurrency: preview-${{ github.ref }}
+  push:
+    paths:
+      - '**/typedoc.json'
+      - '**/tsconfig*.json'
+      - '**/package*.json'
+      - '**/*mkdocs*.ya?ml'
+      - 'packages/docutils/requirements.txt'
+      - 'packages/*/README.md'
+      - 'packages/*/docs/**'
+      - 'packages/*/**/*.ts'
+      - 'packages/*/**/*.js'
+      - '.github/workflows/docs.yml' # this file
+      - '!**/test/**'
+      - '!**/sample-code/**'

 jobs:
  docs:
    name: Docs
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
      - name: Install dependencies (Node.js)
        uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
        with:
@@ -55,8 +49,3 @@ jobs:
          git config --local user.name "github-actions[bot]"
      - name: Build Docs
        run: npm run docs:preview
-      - name: Deploy Preview
-        uses: rossjrw/pr-preview-action@v1 # v1
-        with:
-          source-dir: ./packages/appium/docs/site
-          custom-url: 'appium.github.io/appium'
@@ -11,7 +11,7 @@ jobs:
    name: Run FOSSA Analysis
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
        with:
          ref: master
      - name: Install dependencies
@@ -4,17 +4,12 @@ on:
    types: [opened, labeled, unlabeled, synchronize]
    branches: [master]

-permissions: read-all
-
 jobs:
  label-check:
-    permissions:
-      pull-requests: write
-      checks: write
    runs-on: ubuntu-latest
    steps:
-      - uses: danielchabr/pr-labels-checker@e1d7e79aa0933af1728011705a30528a279874fd # v3.1
+      - name: Check for "On Hold" label
+        uses: egmacke/action-check-label@0eb29f801fb482a95c9bd2dd22834ecc8f4e8af9 # v2
        with:
-          id: check-labels
-          hasNone: On Hold
-          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          label: On Hold
+          state: absent
@@ -0,0 +1,26 @@
+name: Validate Renovate Configs
+on:
+  push:
+    paths:
+      - '.github/workflows/renovate.yml' # this file
+      - '.renovaterc.json'
+      - 'renovate/default.json'
+  pull_request:
+    paths:
+      - '.github/workflows/renovate.yml' # this file
+      - '.renovaterc.json'
+      - 'renovate/default.json'
+
+permissions:
+  contents: read
+
+jobs:
+  renovate:
+    name: Check Renovate Configs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - name: Validate Renovate Config
+        uses: rinchsan/renovate-config-validator@1ea1e8514f6a33fdd71c40b0a5fa3512b9e7b936 # tag=v0
+        with:
+          pattern: '{.renovaterc.json,renovate/default.json}'
@@ -17,9 +17,9 @@ module.exports = (wallaby) => {
    },
    files: [
      './packages/*/build/**/*',
-      './packages/*/lib/**/*.(j|t)s',
-      './packages/*/test/**/*helper*.(j|t)s',
-      './packages/*/test/**/*mock*.(j|t)s',
+      './packages/*/lib/**/*.{js,ts}',
+      './packages/*/test/**/*helper*.{js,ts}',
+      './packages/*/test/**/*mock*.{js,ts}',
      './packages/*/package.json',
      './packages/*/tsconfig*.json',
      './packages/*/test/**/fixture?(s)/**/*',
@@ -44,11 +44,11 @@ module.exports = (wallaby) => {
        pattern: './packages/typedoc-plugin-appium/lib/theme/resources/**',
      },
      '!./packages/*/test/**/*-specs.js',
-      '!./packages/*/test/**/*.e2e.spec.(j|t)s',
+      '!./packages/*/test/**/*.e2e.spec.{js,ts}',
      '!**/local_appium_home/**',
    ],
    testFramework: 'mocha',
-    tests: ['./packages/*/test/unit/**/*.spec.(j|t)s', '!**/local_appium_home/**'],
+    tests: ['./packages/*/test/unit/**/*.spec.{js,ts}', '!**/local_appium_home/**'],
    workers: {
      // restart: true,
    },
@@ -13,16 +13,16 @@ Appium is an open-source, cross-platform test automation tool for native,
 hybrid, mobile web and desktop apps. Initially created to automate iOS and Android mobile
 applications Appium has grown to a full-featured platform that provides [WebDriver](https://www.w3.org/TR/webdriver/)-based automation possibilities for the whole set of different mobile and desktop platforms.
 See the full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers for more details.

 :bangbang: Major documentation revision in progress

-:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.github.io/appium/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
+:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.

 Appium is in the final stages of a major revision (to version 2.0). As such, the documentation
 found around the web may not be correct. The current Appium 2.0 documentation is very much in
-progress. Currently, it can be found [here](https://appium.github.io/appium/docs/en/latest/).
+progress. Currently, it can be found [here](https://appium.io/docs/en/latest/).

 ### Requirements

@@ -71,8 +71,8 @@ appium driver uninstall xcuitest
 ```

 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers at
 the current Appium 2.0 documentation.

 ### Plugins
@@ -104,8 +104,8 @@ appium server --use-plugins=device-farm,images
 ```

 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#plugins) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-plugins) plugins at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#plugins) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-plugins) plugins at
 the current Appium 2.0 documentation.


@@ -169,11 +169,11 @@ Java/Kotlin. Appium opens up the possibility of true cross-platform native app
 automation, for mobile and beyond. Finally!

 If you're new to Appium or want a more comprehensive description of what this is all
-about, please read our [Intro to Appium](https://appium.github.io/appium/docs/en/latest/intro/).
+about, please read our [Intro to Appium](https://appium.io/docs/en/latest/intro/).

 ### Quickstart

-Check out our [Quickstart](https://appium.github.io/appium/docs/en/latest/quickstart/) guide
+Check out our [Quickstart](https://appium.io/docs/en/latest/quickstart/) guide
 to get going with Appium.

 There is also a sample code that contains [many examples of tests in a variety
@@ -181,7 +181,7 @@ of different languages](https://github.com/appium/appium/tree/1.x/sample-code)!

 ### Documentation

-For prettily-rendered docs, please visit [Appium Documentation](https://appium.github.io/appium).
+For prettily-rendered docs, please visit [Appium Documentation](https://appium.io).
 You can always find the full list of Appium doc pages at [Appium's GitHub
 Repo](https://github.com/appium/appium/tree/master/packages/appium/docs) as well.

@@ -196,7 +196,7 @@ Interested in where Appium is heading in the future? Check out the [Roadmap](ROA

 ### Project History, Credits & Inspiration

-* [History](https://appium.github.io/appium/docs/en/latest/intro/history/)
+* [History](https://appium.io/docs/en/latest/intro/history/)

 ### User Forums

@@ -1,6 +1,13 @@
 {
  "$schema": "https://json.schemastore.org/lerna",
+  "changelogPreset": "conventional-changelog-conventionalcommits",
  "command": {
+    "add": {
+      "exact": true
+    },
+    "publish": {
+      "message": "chore: publish"
+    },
    "run": {
      "concurrency": 8
    },
@@ -10,16 +17,10 @@
      "version": {
        "allowBranch": "master"
      }
-    },
-    "add": {
-      "exact": true
-    },
-    "publish": {
-      "message": "chore: publish"
    }
  },
  "ignoreChanges": ["**/test/**", "**/*.md"],
-  "version": "independent",
+  "useNx": false,
  "useWorkspaces": true,
-  "useNx": false
+  "version": "independent"
 }
@@ -85,8 +85,8 @@
  },
  "devDependencies": {
    "@colors/colors": "1.5.0",
-    "@commitlint/cli": "17.5.1",
-    "@commitlint/config-conventional": "17.4.4",
+    "@commitlint/cli": "17.6.1",
+    "@commitlint/config-conventional": "17.6.1",
    "@tsconfig/node14": "1.0.3",
    "@types/chai": "4.3.4",
    "@types/chai-as-promised": "7.1.5",
@@ -94,22 +94,23 @@
    "@types/mocha": "10.0.1",
    "@types/node": "18.15.11",
    "@types/semver": "7.3.13",
-    "@types/sinon": "10.0.13",
+    "@types/sinon": "10.0.14",
    "@types/sinon-chai": "3.2.9",
    "@types/teen_process": "2.0.0",
    "@types/ws": "8.5.4",
    "@types/yargs": "17.0.24",
-    "@typescript-eslint/eslint-plugin": "5.57.1",
-    "@typescript-eslint/parser": "5.57.1",
+    "@typescript-eslint/eslint-plugin": "5.58.0",
+    "@typescript-eslint/parser": "5.58.0",
    "asyncbox": "2.9.4",
    "chai": "4.3.7",
    "chai-as-promised": "7.1.1",
    "chai-webdriverio-async": "2.7.0",
+    "conventional-changelog-conventionalcommits": "5.0.0",
    "cpy-cli": "4.2.0",
-    "eslint": "8.37.0",
+    "eslint": "8.38.0",
    "eslint-config-prettier": "8.8.0",
    "eslint-find-rules": "4.1.0",
-    "eslint-import-resolver-typescript": "3.5.4",
+    "eslint-import-resolver-typescript": "3.5.5",
    "eslint-plugin-import": "2.27.5",
    "eslint-plugin-mocha": "10.1.0",
    "eslint-plugin-promise": "6.1.1",
@@ -120,12 +121,13 @@
    "husky": "8.0.3",
    "json-schema-to-typescript": "12.0.0",
    "lerna": "6.6.1",
-    "lint-staged": "13.2.0",
+    "lint-staged": "13.2.1",
    "log-symbols": "4.1.0",
-    "midnight-smoker": "2.0.1",
+    "midnight-smoker": "2.0.3",
    "mjpeg-consumer": "2.0.0",
    "mjpeg-server": "0.3.1",
    "mocha": "10.2.0",
+    "mocha-chai-jest-snapshot": "1.1.4",
    "npm-run-all": "4.1.5",
    "prettier": "2.8.7",
    "rewiremock": "3.14.5",
@@ -3,6 +3,48 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [2.0.0-beta.65](https://github.com/appium/appium/compare/appium@2.0.0-beta.64...appium@2.0.0-beta.65) (2023-04-18)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
+## [2.0.0-beta.64](https://github.com/appium/appium/compare/appium@2.0.0-beta.63...appium@2.0.0-beta.64) (2023-04-14)
+
+
+### Bug Fixes
+
+* **support:** update dependency semver to v7.4.0 ([6ae86bd](https://github.com/appium/appium/commit/6ae86bd5c7be879a4d8852951d73eb2f68128df3))
+
+
+
+## [2.0.0-beta.63](https://github.com/appium/appium/compare/appium@2.0.0-beta.62...appium@2.0.0-beta.63) (2023-04-12)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
+# [2.0.0-beta.62](https://github.com/appium/appium/compare/appium@2.0.0-beta.61...appium@2.0.0-beta.62) (2023-04-10)
+
+
+### Bug Fixes
+
+* **support:** update dependency axios to v1.3.5 ([6cf1480](https://github.com/appium/appium/commit/6cf14802b70a462beffc12a1134476596060c005))
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+### Features
+
+* **appium:** make "ls" alias of "list" ([5ab2fea](https://github.com/appium/appium/commit/5ab2fea5768ef8c67270d49c920b9515ca1ff1e4))
+
+
+
+
+
 # [2.0.0-beta.61](https://github.com/appium/appium/compare/appium@2.0.0-beta.60...appium@2.0.0-beta.61) (2023-04-05)

 **Note:** Version bump only for package appium
@@ -13,16 +13,16 @@ Appium is an open-source, cross-platform test automation tool for native,
 hybrid, mobile web and desktop apps. Initially created to automate iOS and Android mobile
 applications Appium has grown to a full-featured platform that provides [WebDriver](https://www.w3.org/TR/webdriver/)-based automation possibilities for the whole set of different mobile and desktop platforms.
 See the full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers for more details.

 :bangbang: Major documentation revision in progress

-:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.github.io/appium/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
+:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.

 Appium is in the final stages of a major revision (to version 2.0). As such, the documentation
 found around the web may not be correct. The current Appium 2.0 documentation is very much in
-progress. Currently, it can be found [here](https://appium.github.io/appium/docs/en/latest/).
+progress. Currently, it can be found [here](https://appium.io/docs/en/latest/).

 ### Requirements

@@ -71,8 +71,8 @@ appium driver uninstall xcuitest
 ```

 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#drivers) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-drivers) drivers at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers at
 the current Appium 2.0 documentation.

 ### Plugins
@@ -104,8 +104,8 @@ appium server --use-plugins=device-farm,images
 ```

 You can find a full list of
-[officially-supported](https://appium.github.io/appium/docs/en/latest/ecosystem/#plugins) and
-[third-party](https://appium.github.io/appium/docs/en/latest/ecosystem/#other-plugins) plugins at
+[officially-supported](https://appium.io/docs/en/latest/ecosystem/#plugins) and
+[third-party](https://appium.io/docs/en/latest/ecosystem/#other-plugins) plugins at
 the current Appium 2.0 documentation.


@@ -169,11 +169,11 @@ Java/Kotlin. Appium opens up the possibility of true cross-platform native app
 automation, for mobile and beyond. Finally!

 If you're new to Appium or want a more comprehensive description of what this is all
-about, please read our [Intro to Appium](https://appium.github.io/appium/docs/en/latest/intro/).
+about, please read our [Intro to Appium](https://appium.io/docs/en/latest/intro/).

 ### Quickstart

-Check out our [Quickstart](https://appium.github.io/appium/docs/en/latest/quickstart/) guide
+Check out our [Quickstart](https://appium.io/docs/en/latest/quickstart/) guide
 to get going with Appium.

 There is also a sample code that contains [many examples of tests in a variety
@@ -181,7 +181,7 @@ of different languages](https://github.com/appium/appium/tree/1.x/sample-code)!

 ### Documentation

-For prettily-rendered docs, please visit [Appium Documentation](https://appium.github.io/appium).
+For prettily-rendered docs, please visit [Appium Documentation](https://appium.io).
 You can always find the full list of Appium doc pages at [Appium's GitHub
 Repo](https://github.com/appium/appium/tree/master/packages/appium/docs) as well.

@@ -196,7 +196,7 @@ Interested in where Appium is heading in the future? Check out the [Roadmap](ROA

 ### Project History, Credits & Inspiration

-* [History](https://appium.github.io/appium/docs/en/latest/intro/history/)
+* [History](https://appium.io/docs/en/latest/intro/history/)

 ### User Forums

@@ -64,7 +64,7 @@ the Appium client depends on) since that is what you will use as your primary in
 |[Appium Java client](https://github.com/appium/java-client)|Java|Appium Team|
 |[Appium Python client](https://github.com/appium/python-client)|Python|Appium Team|
 |[Appium Ruby Core client](https://github.com/appium/ruby_lib_core) (Recommended)<br>[Appium Ruby client](https://github.com/appium/ruby_lib)|Ruby|Appium Team|
-|[WebDriverIO](https://webdriver.io)|Node.js|Community|
+|[WebDriverIO](https://webdriver.io)<br>[Nightwatch](https://nightwatchjs.org/)|Node.js|Community|
 |[Appium .NET client](https://github.com/appium/dotnet-client)|C#|Appium Team*|
 |[RobotFramework](https://github.com/serhatbolsu/robotframework-appiumlibrary)|DSL|Community|

@@ -1,5 +1,5 @@
 INHERIT: ./base-mkdocs.yml
-site_url: https://appium.github.io/appium/docs/en
+site_url: https://appium.io/docs/en
 edit_uri: edit/master/packages/appium/docs/en
 site_description: The Appium automation project documentation
 docs_dir: en
@@ -1,5 +1,5 @@
 INHERIT: ./base-mkdocs.yml
-site_url: https://appium.github.io/appium/docs/ja
+site_url: https://appium.io/docs/ja
 edit_uri: edit/master/packages/appium/docs/ja
 site_description: The Appium automation project documentation
 docs_dir: ja
@@ -1,5 +1,5 @@
 INHERIT: ./base-mkdocs.yml
-site_url: https://appium.github.io/appium/docs/zh
+site_url: https://appium.io/docs/zh
 edit_uri: edit/master/packages/appium/docs/zh
 site_description: The Appium automation project documentation
 docs_dir: zh
@@ -294,5 +294,5 @@ export {getServerArgs, getExtensionArgs};

 /**
 * A tuple of argument aliases and argument options
- * @typedef {Map<string[],import('argparse').ArgumentOptions>} ArgumentDefinitions
+ * @typedef {Map<[name: string]|[name: string, alias: string],import('argparse').ArgumentOptions>} ArgumentDefinitions
 */
@@ -424,7 +424,7 @@ class ExtensionCliCommand {
   * @param {ExtensionArgs} args
   * @returns {string}
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  getPostInstallText(args) {
    throw this._createFatalError('Must be implemented in final class');
  }
@@ -505,7 +505,7 @@ class ExtensionCliCommand {
   * @param {ExtMetadata<ExtType>} extMetadata - the data in the "appium" field of `package.json` for an extension
   * @param {string} installSpec - Extension name/spec
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  validateExtensionFields(extMetadata, installSpec) {
    throw this._createFatalError('Must be implemented in final class');
  }
@@ -101,6 +101,13 @@ class ArgParser {
    try {
      const parsed = this.parser.parse_known_args(args);
      const [knownArgs, unknownArgs] = parsed;
+      // XXX: you'd think that argparse, when given an alias for a subcommand,
+      // would set this value to the original subcommand name, but it doesn't.
+      if (knownArgs?.driverCommand === 'ls') {
+        knownArgs.driverCommand = 'list';
+      } else if (knownArgs?.pluginCommand === 'ls') {
+        knownArgs.pluginCommand = 'list';
+      }
      if (
        unknownArgs?.length &&
        (knownArgs.driverCommand === 'run' || knownArgs.pluginCommand === 'run')
@@ -210,13 +217,14 @@ class ArgParser {
      });
      const extensionArgs = getExtensionArgs();
      /**
-       * @type { {command: import('appium/types').CliExtensionSubcommand, args: import('./args').ArgumentDefinitions, help: string}[] }
+       * @type { {command: import('appium/types').CliExtensionSubcommand, args: import('./args').ArgumentDefinitions, help: string, aliases?: import('argparse').SubArgumentParserOptions['aliases']}[] }
       */
      const parserSpecs = [
        {
          command: 'list',
          args: extensionArgs[type].list,
          help: `List available and installed ${type}s`,
+          aliases: ['ls'],
        },
        {
          command: 'install',
@@ -242,15 +250,18 @@ class ArgParser {
        },
      ];

-      for (const {command, args, help} of parserSpecs) {
-        const parser = extSubParsers.add_parser(command, {help});
+      for (const {command, args, help, aliases} of parserSpecs) {
+        const parser = extSubParsers.add_parser(command, {help, aliases: aliases ?? []});

        ArgParser._patchExit(parser);

        for (const [flagsOrNames, opts] of args) {
          // add_argument mutates params so make sure to send in copies instead
-          // @ts-ignore
-          parser.add_argument(...flagsOrNames, {...opts});
+          if (flagsOrNames.length === 2) {
+            parser.add_argument(flagsOrNames[0], flagsOrNames[1], {...opts});
+          } else {
+            parser.add_argument(flagsOrNames[0], {...opts});
+          }
        }
      }
    }
@@ -139,7 +139,7 @@ export class ExtensionConfig {
   * @param {ExtName<ExtType>} extName
   * @returns {Promise<string[]>}
   */
-  // eslint-disable-next-line no-unused-vars,require-await
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  async getConfigWarnings(extManifest, extName) {
    return [];
  }
@@ -421,7 +421,7 @@ export class ExtensionConfig {
   * @param {ExtName<ExtType>} extName - Extension name (from manifest)
   * @returns {ExtManifestProblem[]}
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  getGenericConfigProblems(extManifest, extName) {
    const {version, pkgName, mainClass} = extManifest;
    const problems = [];
@@ -456,7 +456,7 @@ export class ExtensionConfig {
   * @param {ExtName<ExtType>} extName
   * @returns {ExtManifestProblem[]}
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  getConfigProblems(extManifest, extName) {
    // shoud override this method if special validation is necessary for this extension type
    return [];
@@ -509,7 +509,7 @@ export class ExtensionConfig {
   * @param {ExtName<ExtType>[]} [activeNames]
   * @returns {void}
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  print(activeNames) {
    if (_.isEmpty(this.installedExtensions)) {
      log.info(
@@ -534,7 +534,7 @@ export class ExtensionConfig {
   * @returns {string}
   * @abstract
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  extensionDesc(extName, extManifest) {
    throw new Error('This must be implemented in a subclass');
  }
@@ -3,7 +3,7 @@
 import {init as logsinkInit} from './logsink'; // this import needs to come first since it sets up global npmlog
 import logger from './logger'; // logger needs to remain second
 import {routeConfiguringFunction as makeRouter, server as baseServer} from '@appium/base-driver';
-import {logger as logFactory, util, env} from '@appium/support';
+import {logger as logFactory, util, env, fs} from '@appium/support';
 import {asyncify} from 'asyncbox';
 import _ from 'lodash';
 import {AppiumDriver} from './appium';
@@ -33,6 +33,7 @@ import {
  isPluginCommandArgs,
  isServerCommandArgs,
 } from './utils';
+import os from 'node:os';

 const {resolveAppiumHome} = env;

@@ -138,6 +139,52 @@ function getExtraMethodMap(driverClasses, pluginClasses) {
    {}
  );
 }
+
+/**
+ * Prepares and validates appium home path folder
+ *
+ * @param {string} name The name of the appium home source (needed for error messages)
+ * @param {string} appiumHome The actual value to be verified
+ * @returns {Promise<string>} Same appiumHome value
+ * @throws {Error} If the validation has failed
+ */
+async function prepareAppiumHome(name, appiumHome) {
+  let stat;
+  try {
+    stat = await fs.stat(appiumHome);
+  } catch (e) {
+    let err = e;
+    if (e.code === 'ENOENT') {
+      try {
+        await fs.mkdir(appiumHome, {recursive: true});
+        return appiumHome;
+      } catch (e1) {
+        err = e1;
+      }
+    }
+    throw new Error(
+      `The path '${appiumHome}' provided in the ${name} must point ` +
+      `to a valid folder writeable for the current user account '${os.userInfo().username}'. ` +
+      `Original error: ${err.message}`
+    );
+  }
+  if (!stat.isDirectory()) {
+    throw new Error(
+      `The path '${appiumHome}' provided in the ${name} must point to a valid folder`
+    );
+  }
+  try {
+    await fs.access(appiumHome, fs.constants.W_OK);
+  } catch (e) {
+    throw new Error(
+      `The folder path '${appiumHome}' provided in the ${name} must be ` +
+      `writeable for the current user account '${os.userInfo().username}. ` +
+      `Original error: ${e.message}`
+    );
+  }
+  return appiumHome;
+}
+
 /**
 * Initializes Appium, but does not start the server.
 *
@@ -157,6 +204,13 @@ function getExtraMethodMap(driverClasses, pluginClasses) {
 */
 async function init(args) {
  const appiumHome = args?.appiumHome ?? (await resolveAppiumHome());
+  let appiumHomeSourceName = 'autodetected appium home path';
+  if (!_.isNil(args?.appiumHome)) {
+    appiumHomeSourceName = 'appiumHome config value';
+  } else if (process.env.APPIUM_HOME) {
+    appiumHomeSourceName = 'APPIUM_HOME environment variable';
+  }
+  await prepareAppiumHome(appiumHomeSourceName, appiumHome);

  adjustNodePath();

@@ -94,7 +94,7 @@ function makeDescription(schema) {
 * as understood by `argparse`.
 * @param {AppiumJSONSchema} subSchema - JSON schema for the option
 * @param {ArgSpec} argSpec - Argument spec tuple
- * @returns {[string[], import('argparse').ArgumentOptions]} Tuple of flag and options
+ * @returns {[[string]|[string, string], import('argparse').ArgumentOptions]} Tuple of flag and options
 */
 function subSchemaToArgDef(subSchema, argSpec) {
  let {type, appiumCliAliases, appiumCliTransformer, enum: enumValues} = subSchema;
@@ -207,7 +207,10 @@ function subSchemaToArgDef(subSchema, argSpec) {
    }
  }

-  return [aliases, argOpts];
+  // TODO: argparse only accepts the command name and a single alias; any extra aliases
+  // will be silently discarded.
+  const finalAliases = /** @type {[string]|[string, string]} */ (aliases);
+  return [finalAliases, argOpts];
 }

 /**
@@ -28,7 +28,7 @@ export class RoachHotelMap extends Map {
  /**
   * @param {K} key
   */
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  delete(key) {
    return false;
  }
@@ -1,6 +1,6 @@
 {
  "name": "appium",
-  "version": "2.0.0-beta.61",
+  "version": "2.0.0-beta.65",
  "description": "Automation for Apps.",
  "keywords": [
    "automation",
@@ -60,12 +60,12 @@
    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
  },
  "dependencies": {
-    "@appium/base-driver": "^9.3.5",
-    "@appium/base-plugin": "^2.2.5",
-    "@appium/docutils": "^0.3.4",
+    "@appium/base-driver": "^9.3.7",
+    "@appium/base-plugin": "^2.2.7",
+    "@appium/docutils": "^0.3.8",
    "@appium/schema": "^0.2.6",
-    "@appium/support": "^3.1.9",
-    "@appium/types": "^0.10.3",
+    "@appium/support": "^3.1.11",
+    "@appium/types": "^0.11.0",
    "@sidvind/better-ajv-errors": "2.1.0",
    "@types/argparse": "2.0.10",
    "@types/bluebird": "3.5.38",
@@ -78,7 +78,7 @@
    "argparse": "2.0.1",
    "async-lock": "1.4.0",
    "asyncbox": "2.9.4",
-    "axios": "1.3.4",
+    "axios": "1.3.5",
    "bluebird": "3.7.2",
    "cross-env": "7.0.3",
    "find-up": "5.0.0",
@@ -89,10 +89,10 @@
    "ora": "5.4.1",
    "package-changed": "3.0.0",
    "resolve-from": "5.0.0",
-    "semver": "7.3.8",
+    "semver": "7.4.0",
    "source-map-support": "0.5.21",
    "teen_process": "2.0.2",
-    "type-fest": "3.7.2",
+    "type-fest": "3.8.0",
    "winston": "3.8.2",
    "wrap-ansi": "7.0.0",
    "yaml": "2.2.1"
@@ -264,6 +264,14 @@ describe('parser', function () {
        const args = p.parseArgs([DRIVER_TYPE, 'list', '--updates']);
        args.showUpdates.should.eql(true);
      });
+      it('should allow "ls" as an alias for "list"', function () {
+        const args = p.parseArgs([DRIVER_TYPE, 'ls']);
+        args.subcommand.should.eql(DRIVER_TYPE);
+        args.driverCommand.should.eql('list');
+        args.showInstalled.should.eql(false);
+        args.showUpdates.should.eql(false);
+        args.json.should.eql(false);
+      });
    });
    describe('install', function () {
      it('should not allow an empty argument list', function () {
@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [9.3.7](https://github.com/appium/appium/compare/@appium/base-driver@9.3.6...@appium/base-driver@9.3.7) (2023-04-14)
+
+
+### Bug Fixes
+
+* **basedriver:** allow arbitrary session data to be returned by getSession ([6245022](https://github.com/appium/appium/commit/6245022be953b69acad70d0a4c877bc65eed2d3a))
+
+
+
+## [9.3.6](https://github.com/appium/appium/compare/@appium/base-driver@9.3.5...@appium/base-driver@9.3.6) (2023-04-10)
+
+
+### Bug Fixes
+
+* **support:** update dependency axios to v1.3.5 ([6cf1480](https://github.com/appium/appium/commit/6cf14802b70a462beffc12a1134476596060c005))
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+
+
+
 ## [9.3.5](https://github.com/appium/appium/compare/@appium/base-driver@9.3.4...@appium/base-driver@9.3.5) (2023-04-03)


@@ -1,7 +1,6 @@
 import './event';
 import './find';
 import './log';
-import './session';
 import './settings';
 import './timeout';
 import './execute';
@@ -1,36 +0,0 @@
-import {Constraints, ISessionCommands, MultiSessionData, SingularSessionData} from '@appium/types';
-import {BaseDriver} from '../driver';
-import {mixin} from './mixin';
-
-declare module '../driver' {
-  interface BaseDriver<
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    C extends Constraints
-  > extends ISessionCommands {}
-}
-
-const SessionCommands: ISessionCommands = {
-  async getSessions<C extends Constraints>(this: BaseDriver<C>) {
-    const ret: MultiSessionData<C>[] = [];
-
-    if (this.sessionId) {
-      ret.push({
-        id: this.sessionId,
-        capabilities: this.caps,
-      });
-    }
-
-    return ret;
-  },
-
-  /**
-   * Returns capabilities for the session and event history (if applicable)
-   */
-  async getSession<C extends Constraints>(this: BaseDriver<C>) {
-    return <SingularSessionData<C>>(
-      (this.caps.eventTimings ? {...this.caps, events: this.eventHistory} : this.caps)
-    );
-  },
-};
-
-mixin(SessionCommands);
@@ -17,7 +17,9 @@ import {
  DriverCaps,
  DriverData,
  DriverOpts,
+  MultiSessionData,
  ServerArgs,
+  SingularSessionData,
  StringRecord,
  W3CDriverCaps,
 } from '@appium/types';
@@ -31,7 +33,8 @@ const ON_UNEXPECTED_SHUTDOWN_EVENT = 'onUnexpectedShutdown';
 export class BaseDriver<
    C extends Constraints,
    CArgs extends StringRecord = StringRecord,
-    Settings extends StringRecord = StringRecord
+    Settings extends StringRecord = StringRecord,
+    SessionData extends StringRecord = StringRecord
  >
  extends DriverCore<C, Settings>
  implements Driver<C, CArgs>
@@ -310,6 +313,25 @@ export class BaseDriver<

    return [this.sessionId, caps];
  }
+  async getSessions() {
+    const ret: MultiSessionData<C>[] = [];
+
+    if (this.sessionId) {
+      ret.push({
+        id: this.sessionId,
+        capabilities: this.caps,
+      });
+    }
+
+    return ret;
+  }
+
+  /**
+   * Returns capabilities for the session and event history (if applicable)
+   */
+  async getSession() {
+    return this.caps.eventTimings ? {...this.caps, events: this.eventHistory} : this.caps;
+  }

  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  async deleteSession(sessionId?: string | null) {
@@ -1,6 +1,6 @@
 {
  "name": "@appium/base-driver",
-  "version": "9.3.5",
+  "version": "9.3.7",
  "description": "Base driver class for Appium drivers",
  "keywords": [
    "automation",
@@ -44,8 +44,8 @@
    "test:types": "tsd"
  },
  "dependencies": {
-    "@appium/support": "^3.1.9",
-    "@appium/types": "^0.10.3",
+    "@appium/support": "^3.1.11",
+    "@appium/types": "^0.11.0",
    "@colors/colors": "1.5.0",
    "@types/async-lock": "1.4.0",
    "@types/bluebird": "3.5.38",
@@ -54,7 +54,7 @@
    "@types/serve-favicon": "2.5.3",
    "async-lock": "1.4.0",
    "asyncbox": "2.9.4",
-    "axios": "1.3.4",
+    "axios": "1.3.5",
    "bluebird": "3.7.2",
    "body-parser": "1.20.2",
    "es6-error": "4.1.1",
@@ -66,7 +66,7 @@
    "morgan": "1.10.0",
    "serve-favicon": "2.5.0",
    "source-map-support": "0.5.21",
-    "type-fest": "3.7.2",
+    "type-fest": "3.8.0",
    "validate.js": "0.13.1"
  },
  "engines": {
@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [2.2.7](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.6...@appium/base-plugin@2.2.7) (2023-04-14)
+
+**Note:** Version bump only for package @appium/base-plugin
+
+
+
+
+
+## [2.2.6](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.5...@appium/base-plugin@2.2.6) (2023-04-10)
+
+**Note:** Version bump only for package @appium/base-plugin
+
+
+
+
+
 ## [2.2.5](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.4...@appium/base-plugin@2.2.5) (2023-04-03)

 **Note:** Version bump only for package @appium/base-plugin
@@ -1,3 +1,3 @@
 # Appium Base Plugin

-The base class used to create Appium plugins. This plugin should not be installed directly as it does nothing. Instead, you extend this plugin when creating your *own* Appium plugins. Check out the [Building Plugins](https://appium.github.io/appium/docs/en/latest/ecosystem/build-plugins/) to learn how to make use of this base class to develop Appium plugins.
+The base class used to create Appium plugins. This plugin should not be installed directly as it does nothing. Instead, you extend this plugin when creating your *own* Appium plugins. Check out the [Building Plugins](https://appium.io/docs/en/latest/ecosystem/build-plugins/) to learn how to make use of this base class to develop Appium plugins.
@@ -1,6 +1,6 @@
 {
  "name": "@appium/base-plugin",
-  "version": "2.2.5",
+  "version": "2.2.7",
  "description": "The base plugin used to create Appium 2.0 plugins",
  "keywords": [
    "automation",
@@ -40,8 +40,8 @@
    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
  },
  "dependencies": {
-    "@appium/base-driver": "^9.3.5",
-    "@appium/support": "^3.1.9"
+    "@appium/base-driver": "^9.3.7",
+    "@appium/support": "^3.1.11"
  },
  "engines": {
    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [2.0.13](https://github.com/appium/appium/compare/@appium/doctor@2.0.12...@appium/doctor@2.0.13) (2023-04-14)
+
+**Note:** Version bump only for package @appium/doctor
+
+
+
+
+
+## [2.0.12](https://github.com/appium/appium/compare/@appium/doctor@2.0.11...@appium/doctor@2.0.12) (2023-04-10)
+
+**Note:** Version bump only for package @appium/doctor
+
+
+
+
+
 ## [2.0.11](https://github.com/appium/appium/compare/@appium/doctor@2.0.10...@appium/doctor@2.0.11) (2023-04-03)


@@ -1,6 +1,6 @@
 {
  "name": "@appium/doctor",
-  "version": "2.0.11",
+  "version": "2.0.13",
  "description": "Test environment for fitness to run Appium",
  "keywords": [
    "automation",
@@ -44,7 +44,7 @@
    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
  },
  "dependencies": {
-    "@appium/support": "^3.1.9",
+    "@appium/support": "^3.1.11",
    "@colors/colors": "1.5.0",
    "@types/bluebird": "3.5.38",
    "@types/teen_process": "2.0.0",
@@ -3,6 +3,43 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [0.3.8](https://github.com/appium/appium/compare/@appium/docutils@0.3.7...@appium/docutils@0.3.8) (2023-04-18)
+
+**Note:** Version bump only for package @appium/docutils
+
+
+
+
+
+## [0.3.7](https://github.com/appium/appium/compare/@appium/docutils@0.3.6...@appium/docutils@0.3.7) (2023-04-14)
+
+
+### Bug Fixes
+
+* **support:** update dependency semver to v7.4.0 ([6ae86bd](https://github.com/appium/appium/commit/6ae86bd5c7be879a4d8852951d73eb2f68128df3))
+
+
+
+## [0.3.6](https://github.com/appium/appium/compare/@appium/docutils@0.3.5...@appium/docutils@0.3.6) (2023-04-12)
+
+**Note:** Version bump only for package @appium/docutils
+
+
+
+
+
+## [0.3.5](https://github.com/appium/appium/compare/@appium/docutils@0.3.4...@appium/docutils@0.3.5) (2023-04-10)
+
+
+### Bug Fixes
+
+* **docutils:** properly respects log levels ([e9426fc](https://github.com/appium/appium/commit/e9426fcfecc1d47ab503fc72af4236c4f1ac4b1e))
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+
+
+
 ## [0.3.4](https://github.com/appium/appium/compare/@appium/docutils@0.3.3...@appium/docutils@0.3.4) (2023-04-05)

 **Note:** Version bump only for package @appium/docutils
@@ -17,10 +17,10 @@ import {
 } from '../constants';
 import {DocutilsError} from '../error';
 import {findMkDocsYml, readPackageJson, whichMike} from '../fs';
-import logger from '../logger';
+import {getLogger} from '../logger';
 import {argify, spawnBackgroundProcess, SpawnBackgroundProcessOpts, stopwatch} from '../util';

-const log = logger.withTag('builder:deploy');
+const log = getLogger('builder:deploy');

 /**
 * Runs `mike serve`
@@ -124,6 +124,7 @@ export async function deploy({
    // unsure about how SIGHUP is handled here
    await doServe(mikeArgs, serveOpts);
  } else {
+    log.info('Deploying into branch %s', branch);
    const mikeArgs = [
      ...argify(
        _.omitBy(
@@ -138,7 +139,7 @@ export async function deploy({
    }
    await doDeploy(mikeArgs, execOpts);

-    log.success('Mike finished deployment into branch %s (%dms)', branch, stop());
+    log.success('Finished deployment into branch %s (%dms)', branch, stop());
  }
 }

@@ -25,11 +25,11 @@ import {
  safeWriteFile,
  stringifyYaml,
 } from '../fs';
-import logger from '../logger';
+import {getLogger} from '../logger';
 import {MkDocsYml, MkDocsYmlNav} from '../model';
 import {relative} from '../util';

-const log = logger.withTag('builder:nav');
+const log = getLogger('builder:nav');

 /**
 * Gets a list of `.md` files relative to `docs_dir`
@@ -16,10 +16,10 @@ import {
 } from '../constants';
 import {DocutilsError} from '../error';
 import {findTypeDocJsonPath, readTypedocJson} from '../fs';
-import logger from '../logger';
+import {getLogger} from '../logger';
 import {argify, relative, stopwatch} from '../util';

-const log = logger.withTag('builder:reference');
+const log = getLogger('builder:reference');

 /**
 * Executes TypeDoc _in the current process_
@@ -5,16 +5,15 @@
 * @module
 */

-import {spawn, SpawnOptions} from 'node:child_process';
 import path from 'node:path';
 import {exec, TeenProcessExecOptions} from 'teen_process';
-import {NAME_BIN, NAME_MKDOCS, NAME_MKDOCS_YML, NAME_THEME} from '../constants';
+import {NAME_BIN, NAME_MKDOCS_YML, NAME_THEME} from '../constants';
 import {DocutilsError} from '../error';
 import {findMkDocsYml, readMkDocsYml, whichMkDocs} from '../fs';
-import logger from '../logger';
+import {getLogger} from '../logger';
 import {relative, spawnBackgroundProcess, SpawnBackgroundProcessOpts, stopwatch} from '../util';

-const log = logger.withTag('mkdocs');
+const log = getLogger('mkdocs');

 /**
 * Runs `mkdocs serve`
@@ -81,6 +80,7 @@ export async function buildSite({
    // unsure about how SIGHUP is handled here
    await doServe(mkdocsArgs, serveOpts);
  } else {
+    log.info('Building site into %s (%dms)');
    await doBuild(mkdocsArgs, execOpts);
    let relSiteDir;
    if (siteDir) {
@@ -90,7 +90,7 @@ export async function buildSite({
      log.debug('Found site_dir %s', siteDir);
      relSiteDir = relative(path.dirname(mkDocsYmlPath), siteDir!);
    }
-    log.success('MkDocs finished building into %s (%dms)', relSiteDir, stop());
+    log.success('Finnished building site into %s (%dms)', relSiteDir, stop());
  }
 }

@@ -6,9 +6,9 @@
 import {fs, util} from '@appium/support';
 import _ from 'lodash';
 import type {Options} from 'yargs';
-import logger from '../logger';
+import {getLogger} from '../logger';

-const log = logger.withTag('check');
+const log = getLogger('check');

 /**
 * Given a list of objects with `id` and `path` props, filters out the ones that do not exist
@@ -7,11 +7,11 @@ import path from 'node:path';
 import type {CommandModule, InferredOptionTypes, Options} from 'yargs';
 import {buildReferenceDocs, buildSite, deploy, updateNav} from '../../builder';
 import {NAME_BIN} from '../../constants';
-import logger from '../../logger';
+import {getLogger} from '../../logger';
 import {stopwatch} from '../../util';
 import {checkMissingPaths} from '../check';

-const log = logger.withTag('build');
+const log = getLogger('build');

 enum BuildCommandGroup {
  Build = 'Build Config:',
@@ -220,6 +220,7 @@ export default {
      );
  },
  async handler(args) {
+    log.info('Building docs...');
    const stop = stopwatch('build');
    log.debug('Build command called with args: %O', args);
    if (!args.site && !args.reference) {
@@ -6,11 +6,11 @@
 import _ from 'lodash';
 import type {CommandModule, InferredOptionTypes, Options} from 'yargs';
 import {init} from '../../init';
-import logger from '../../logger';
+import {getLogger} from '../../logger';
 import {stopwatch} from '../../util';
 import {checkMissingPaths} from '../check';

-const log = logger.withTag('init');
+const log = getLogger('init');

 enum InitCommandGroup {
  MkDocs = 'MkDocs Config:',
@@ -7,10 +7,10 @@ import {util} from '@appium/support';
 import type {CommandModule, InferredOptionTypes, Options} from 'yargs';
 import {DocutilsError} from '../../error';
 import {DocutilsValidator, ValidationKind} from '../../validate';
-import logger from '../../logger';
+import {getLogger} from '../../logger';
 import {checkMissingPaths} from '../check';

-const log = logger.withTag('validate');
+const log = getLogger('validate');

 enum ValidateCommandGroup {
  Behavior = 'Validation Behavior:',
@@ -11,10 +11,11 @@ import path from 'node:path';
 import YAML from 'yaml';
 import parser from 'yargs-parser';
 import {hideBin} from 'yargs/helpers';
-import {NAME_BIN} from '../constants';
-import logger from '../logger';
+import {DEFAULT_LOG_LEVEL, LogLevelMap, NAME_BIN} from '../constants';
+import {getLogger, initLogger, isLogLevelString} from '../logger';
 import {relative} from '../util';
-const log = logger.withTag('config');
+
+const log = getLogger('config');

 /**
 * `lilconfig` loader for YAML
@@ -43,8 +44,19 @@ const loadEsm: Loader = (filepath: string) => import(filepath);
 export async function findConfig(argv: string[] = hideBin(process.argv)) {
  const preArgs = parser(argv);

-  if (preArgs.verbose || preArgs.logLevel === 'debug') {
-    log.level = LogLevel.Debug;
+  // if --verbose is used, set the log level to debug.
+  // otherwise use --log-level or the default.
+  let logLevel: LogLevel | keyof typeof LogLevelMap;
+  if (preArgs.verbose) {
+    logLevel = LogLevel.Debug;
+  } else {
+    // if the loglevel is valid, use it, otherwise use the default
+    logLevel = isLogLevelString(preArgs.logLevel) ? preArgs.logLevel : DEFAULT_LOG_LEVEL;
+  }
+  initLogger(logLevel);
+
+  if (preArgs.noConfig) {
+    log.debug('Not loading config because --no-config was provided');
  }

  return preArgs.noConfig || preArgs.help || preArgs.version
@@ -6,7 +6,7 @@
 * @module
 */

-import logger from '../logger';
+import {getLogger} from '../logger';

 import _ from 'lodash';
 import {hideBin} from 'yargs/helpers';
@@ -20,7 +20,7 @@ import {sync as readPkg} from 'read-pkg';

 const pkg = readPkg({cwd: fs.findRoot(__dirname)});

-const log = logger.withTag('cli');
+const log = getLogger('cli');
 export async function main(argv = hideBin(process.argv)) {
  const config = await findConfig(argv);

@@ -56,24 +56,14 @@ export async function main(argv = hideBin(process.argv)) {
        describe: 'Disable config file discovery',
      },
    })
-    .middleware([
+    .middleware(
      /**
-       * Configures logging; `--verbose` implies `--log-level=debug`
+       * Writes a startup message
       */
-      (argv) => {
-        if (argv.verbose) {
-          argv.logLevel = 'debug';
-          log.debug('Debug logging enabled via --verbose');
-        }
-        log.level = LogLevelMap[argv.logLevel];
-      },
-      /**
-       * Writes a startup message, if logging is enabled
-       */
-      async () => {
+      () => {
        log.info(`${pkg.name} @ v${pkg.version} (Node.js ${process.version})`);
-      },
-    ])
+      }
+    )
    .epilog(`Please report bugs at ${pkg.bugs?.url}`)
    .fail(
      /**
@@ -85,8 +75,7 @@ export async function main(argv = hideBin(process.argv)) {
          log.error(error.message);
        } else {
          y.showHelp();
-          console.log();
-          log.error(msg ?? error.message);
+          log.error(`\n\n${msg ?? error.message}`);
        }
        y.exit(1, error);
      }
@@ -12,7 +12,7 @@ import {fs} from '@appium/support';
 import * as JSON5 from 'json5';
 import _ from 'lodash';
 import _pkgDir from 'pkg-dir';
-import logger from './logger';
+import {getLogger} from './logger';
 import {Application, TypeDocReader} from 'typedoc';
 import {
  NAME_TYPEDOC_JSON,
@@ -26,7 +26,7 @@ import {
 import {DocutilsError} from './error';
 import {MkDocsYml} from './model';

-const log = logger.withTag('fs');
+const log = getLogger('fs');

 /**
 * Finds path to closest `package.json`
@@ -8,3 +8,4 @@ export * from './builder';
 export * from './validate';
 export * from './scaffold';
 export * from './constants';
+export * from './logger';
@@ -17,7 +17,7 @@ import {exec} from 'teen_process';
 import {Simplify} from 'type-fest';
 import {DocutilsError} from './error';
 import {createScaffoldTask, ScaffoldTaskOptions} from './scaffold';
-import logger from './logger';
+import {getLogger} from './logger';
 import {MkDocsYml, TsConfigJson, TypeDocJson} from './model';
 import _ from 'lodash';
 import {stringifyJson5, stringifyYaml} from './fs';
@@ -54,8 +54,8 @@ const BASE_TSCONFIG_JSON: Readonly<TsConfigJson> = Object.freeze({
  },
 });

-const log = logger.withTag('init');
-const dryRunLog = log.withTag('dry-run');
+const log = getLogger('init');
+const dryRunLog = getLogger('dry-run', log);

 const DEFAULT_INCLUDE = ['lib', 'test', 'index.js'];
 /**
@@ -137,57 +137,58 @@ class DocutilsReporter extends FancyReporter {
 let globalLevel: LogLevel = LogLevelMap[DEFAULT_LOG_LEVEL];

 /**
- * The logger from which all loggers are created.  This one uses a unique tag and our custom reporter.
+ * Type guard to see if a string is a recognized log level
+ * @param level any value
 */
-const rootLogger = createLogProxy(
-  consola.create({defaults: {tag: 'docutils'}, reporters: [new DocutilsReporter()]})
-);
-
-/**
- * @summary Creates a log-level-propagating proxy for a {@linkcode Consola} logger.
- * @description
- * Alright.  So when you create a new logger via {@linkcode Consola.create}, it's basically a clone
- * of its parent with a new set of options.
- *
- * If we change the log level of the root logger (which we do: see `cli/index.ts`), we may (almost
- * certainly) have
- * child loggers which: a) have already been created and b) have inherited the old/default log level
- * from the root logger. We don't _want_ that (though this is likely a reasonable use case) for our
- * purposes.
- *
- * The implementation below solves the problem by maintaining its own singleton log level value, and
- * intercepts the `level` property of any logger created from the root logger.
- *
- * There are other ways to go about this which may be better, but this seemed pretty straightforward.
- */
-function createLogProxy(logger: Consola): Consola {
-  return new Proxy(logger, {
-    get(target, prop, receiver) {
-      if (prop === 'level') {
-        return globalLevel;
-      }
-      if (prop === 'create') {
-        const create = Reflect.get(target, prop, receiver) as Consola['create'];
-        return (opts: ConsolaOptions) => createLogProxy(create.call(receiver, opts));
-      }
-      if (prop === '_defaults') {
-        const defaults = Reflect.get(target, prop, receiver);
-        return {...defaults, level: globalLevel};
-      }
-      return Reflect.get(target, prop, receiver);
-    },
-    set(target, prop, value, receiver) {
-      if (prop === 'level') {
-        globalLevel = value as LogLevel;
-        return true;
-      }
-      return Reflect.set(target, prop, value, receiver);
-    },
-  });
+export function isLogLevelString(level: any): level is keyof typeof LogLevelMap {
+  return level in LogLevelMap;
 }

 /**
- * The proxied root logger
- * @see {createLogProxy}
+ * The logger from which all loggers are created.  This one uses a unique tag and our custom reporter.
 */
-export default rootLogger;
+const rootLogger = consola.create({
+  defaults: {tag: 'docutils'},
+  reporters: [new DocutilsReporter()],
+  level: globalLevel,
+});
+// this prevents logging before `initLogger` is called
+rootLogger.pause();
+
+/**
+ * A map of tags to loggers
+ */
+const loggers: Map<string, WeakRef<Consola>> = new Map();
+
+export function getLogger(tag: string, parent = rootLogger) {
+  if (loggers.has(tag)) {
+    const logger = loggers.get(tag)?.deref();
+    if (logger) {
+      return logger;
+    }
+  }
+  const logger = parent.withTag(tag);
+  logger.level = globalLevel;
+  loggers.set(tag, new WeakRef(logger));
+  return logger;
+}
+
+/**
+ * Initialize the logging system.
+ *
+ * This should only be called once. The loglevel cannot be changed once it is set.
+ *
+ * @remarks Child loggers seem to inherit the "paused" state of the parent, so when this is called, we must resume all of them.
+ */
+export const initLogger = _.once((level: keyof typeof LogLevelMap | LogLevel) => {
+  globalLevel = isLogLevelString(level) ? LogLevelMap[level] : level;
+  rootLogger.level = globalLevel;
+  rootLogger.resume();
+  for (const ref of loggers.values()) {
+    const logger = ref.deref();
+    if (logger) {
+      logger.level = globalLevel;
+      logger.resume();
+    }
+  }
+});
@@ -4,7 +4,7 @@
 */

 import {fs} from '@appium/support';
-import logger from './logger';
+import {getLogger} from './logger';
 import path from 'node:path';
 import {createPatch} from 'diff';
 import {NormalizedPackageJson} from 'read-pkg';
@@ -15,8 +15,8 @@ import _ from 'lodash';
 import {stringifyJson, readPackageJson, safeWriteFile} from './fs';
 import {NAME_ERR_ENOENT, NAME_ERR_EEXIST} from './constants';

-const log = logger.withTag('init');
-const dryRunLog = log.withTag('dry-run');
+const log = getLogger('init');
+const dryRunLog = getLogger('dry-run', log);

 /**
 * Creates a unified patch for display in "dry run" mode
@@ -40,7 +40,7 @@ import {
  whichPython,
  readMkDocsYml,
 } from './fs';
-import logger from './logger';
+import {getLogger} from './logger';
 import {MkDocsYml, PipPackage, TypeDocJson} from './model';
 import {relative} from './util';

@@ -64,7 +64,7 @@ const TYPEDOC_VERSION_REGEX = /TypeDoc\s(\d+\.\d+\..+)/;
 */
 const MKDOCS_VERSION_REGEX = /mkdocs,\s+version\s+(\d+\.\d+\.\S+)/;

-const log = logger.withTag('validate');
+const log = getLogger('validate');

 /**
 * The "kinds" of validation which were requested to be performed
@@ -1,6 +1,6 @@
 {
  "name": "@appium/docutils",
-  "version": "0.3.4",
+  "version": "0.3.8",
  "description": "Documentation generation utilities for Appium and related projects",
  "keywords": [
    "automation",
@@ -49,9 +49,9 @@
    "start": "node ./build/lib/cli/index.js"
  },
  "dependencies": {
-    "@appium/support": "^3.1.9",
-    "@appium/tsconfig": "^0.2.4",
-    "@appium/typedoc-plugin-appium": "^0.6.0",
+    "@appium/support": "^3.1.11",
+    "@appium/tsconfig": "^0.3.0",
+    "@appium/typedoc-plugin-appium": "^0.6.3",
    "@sliphua/lilconfig-ts-loader": "3.2.2",
    "chalk": "4.1.2",
    "consola": "2.15.3",
@@ -64,10 +64,10 @@
    "log-symbols": "4.1.0",
    "pkg-dir": "5.0.0",
    "read-pkg": "5.2.0",
-    "semver": "7.3.8",
+    "semver": "7.4.0",
    "source-map-support": "0.5.21",
    "teen_process": "2.0.2",
-    "type-fest": "3.7.2",
+    "type-fest": "3.8.0",
    "typedoc": "0.23.28",
    "typedoc-plugin-markdown": "3.14.0",
    "typedoc-plugin-resolve-crossmodule-references": "0.3.3",
@@ -1,4 +1,4 @@
 mkdocs==1.4.2
-mkdocs-material==9.1.5
+mkdocs-material==9.1.6
 mkdocs-material-extensions==1.1.1
 mike==1.1.2
@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [0.4.5](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.4...@appium/driver-test-support@0.4.5) (2023-04-14)
+
+
+### Bug Fixes
+
+* **driver-test-support:** update dependency @types/lodash to v4.14.194 ([78bc092](https://github.com/appium/appium/commit/78bc0926db83f586db4683b008737b6254ec6ebe))
+
+
+
+## [0.4.4](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.3...@appium/driver-test-support@0.4.4) (2023-04-10)
+
+
+### Bug Fixes
+
+* **support:** update dependency axios to v1.3.5 ([6cf1480](https://github.com/appium/appium/commit/6cf14802b70a462beffc12a1134476596060c005))
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+
+
+
 ## [0.4.3](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.2...@appium/driver-test-support@0.4.3) (2023-04-03)


@@ -1,6 +1,6 @@
 {
  "name": "@appium/driver-test-support",
-  "version": "0.4.3",
+  "version": "0.4.5",
  "description": "Test utilities for Appium drivers",
  "keywords": [
    "automation",
@@ -41,10 +41,10 @@
  },
  "types": "./build/lib/index.d.ts",
  "dependencies": {
-    "@appium/types": "^0.10.3",
-    "@types/lodash": "4.14.192",
+    "@appium/types": "^0.11.0",
+    "@types/lodash": "4.14.194",
    "@types/stoppable": "1.1.1",
-    "axios": "1.3.4",
+    "axios": "1.3.5",
    "bluebird": "3.7.2",
    "chai": "4.3.7",
    "get-port": "5.1.1",
@@ -52,7 +52,7 @@
    "sinon": "15.0.3",
    "source-map-support": "0.5.21",
    "stoppable": "1.1.0",
-    "type-fest": "3.7.2"
+    "type-fest": "3.8.0"
  },
  "peerDependencies": {
    "appium": "^2.0.0-beta.43",
@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [3.0.12](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.11...@appium/execute-driver-plugin@3.0.12) (2023-04-12)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency vm2 to v3.9.16 ([d6c70f2](https://github.com/appium/appium/commit/d6c70f2f526af4d91e6c2de940bbfa3208a7ffa4))
+
+
+
+## [3.0.11](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.10...@appium/execute-driver-plugin@3.0.11) (2023-04-10)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency vm2 to v3.9.15 ([5790924](https://github.com/appium/appium/commit/5790924bf89d55352bd5e20b14377b2bffc0cbf1))
+
+
+
+
+
 ## [3.0.10](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.9...@appium/execute-driver-plugin@3.0.10) (2023-04-03)

 **Note:** Version bump only for package @appium/execute-driver-plugin
@@ -1,6 +1,6 @@
 {
  "name": "@appium/execute-driver-plugin",
-  "version": "3.0.10",
+  "version": "3.0.12",
  "description": "Plugin for batching and executing driver commands with Appiums",
  "keywords": [
    "automation",
@@ -42,7 +42,7 @@
    "bluebird": "3.7.2",
    "lodash": "4.17.21",
    "source-map-support": "0.5.21",
-    "vm2": "3.9.14",
+    "vm2": "3.9.16",
    "webdriverio": "7.30.2"
  },
  "peerDependencies": {
@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [3.1.11](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.10...@appium/fake-plugin@3.1.11) (2023-04-14)
+
+**Note:** Version bump only for package @appium/fake-plugin
+
+
+
+
+
+## [3.1.10](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.9...@appium/fake-plugin@3.1.10) (2023-04-10)
+
+**Note:** Version bump only for package @appium/fake-plugin
+
+
+
+
+
 ## [3.1.9](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.8...@appium/fake-plugin@3.1.9) (2023-04-03)

 **Note:** Version bump only for package @appium/fake-plugin
@@ -59,7 +59,7 @@ class FakePlugin extends BasePlugin {
    FakePlugin._unexpectedData = null;
  }

-  // eslint-disable-next-line no-unused-vars,require-await
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars,require-await
  static async updateServer(expressApp, httpServer, cliArgs) {
    expressApp.all('/fake', FakePlugin.fakeRoute);
    expressApp.all('/unexpected', FakePlugin.unexpectedData);
@@ -1,6 +1,6 @@
 {
  "name": "@appium/fake-plugin",
-  "version": "3.1.9",
+  "version": "3.1.11",
  "description": "A fake Appium 2.0 plugin",
  "keywords": [
    "automation",
@@ -39,8 +39,8 @@
    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
  },
  "dependencies": {
-    "@appium/base-plugin": "^2.2.5",
-    "@appium/support": "^3.1.9",
+    "@appium/base-plugin": "^2.2.7",
+    "@appium/support": "^3.1.11",
    "@types/bluebird": "3.5.38",
    "bluebird": "3.7.2",
    "lodash": "4.17.21",
@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [0.3.13](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.12...@appium/plugin-test-support@0.3.13) (2023-04-14)
+
+**Note:** Version bump only for package @appium/plugin-test-support
+
+
+
+
+
+## [0.3.12](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.11...@appium/plugin-test-support@0.3.12) (2023-04-10)
+
+**Note:** Version bump only for package @appium/plugin-test-support
+
+
+
+
+
 ## [0.3.11](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.10...@appium/plugin-test-support@0.3.11) (2023-04-03)

 **Note:** Version bump only for package @appium/plugin-test-support
@@ -1,6 +1,6 @@
 {
  "name": "@appium/plugin-test-support",
-  "version": "0.3.11",
+  "version": "0.3.13",
  "description": "Testing utilities for Appium plugins",
  "keywords": [
    "automation",
@@ -41,7 +41,7 @@
    "test:unit": "exit 0"
  },
  "dependencies": {
-    "@appium/types": "^0.10.3",
+    "@appium/types": "^0.11.0",
    "get-port": "5.1.1",
    "log-symbols": "4.1.0",
    "source-map-support": "0.5.21",
@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.2.0 (2023-04-10)
+
+
+### Features
+
+* **strongbox:** create @appium/strongbox ([fd91234](https://github.com/appium/appium/commit/fd912346fade8f29f5b4d1458828ea677d7e9fcc))
+* **strongbox:** export BaseItem ([377e982](https://github.com/appium/appium/commit/377e9825de74d9929631fb331e6d348c9df0964e))
@@ -0,0 +1,96 @@
+# @appium/strongbox
+
+> Persistent storage for Appium extensions
+
+## Summary
+
+This package is intended to be used in [Appium](https://appium.io) extensions which need to persist data between Appium runs.  An example of such data may be a device token or key.  
+
+`@appium/strongbox` provides a simple and extensible API for managing such data, while abstracting the underlying storage mechanism.
+
+_Note:_ This module is not intended for storing sensitive data.
+
+## Usage
+
+First, create an instance of `Strongbox`:
+
+```ts
+import {strongbox} from '@appium/strongbox';
+
+const box = strongbox('my-pkg');
+```
+
+This instance corresponds to a unique collection of data.
+
+From here, create a placeholder for data (you will need to provide the type of data you intend to store):
+
+```ts
+const item = await box.createItem<string>('my unique name');
+```
+
+...or, if you already have the data on-hand:
+
+```ts
+const item: Buffer|string = getSomeData();
+
+const item = await box.createItemWithContents('my unique name', data);
+```
+
+Either way, you can read its contents:
+
+```ts
+// if the item doesn't exist, this result will be undefined
+const contents = await item.read();
+```
+
+Or write new data to the item:
+
+```ts
+await item.write('new stuff');
+```
+
+The last-read contents of the `Item` will be available on the `contents` property, but the value of this property is only current as of the last `read()`:
+
+```ts
+const {contents} = item;
+```
+
+## API
+
+In lieu of actual documentation, look at the type definitions that this package ships.
+
+## Customization
+
+1. Create a class that implements the `Item` interface:
+
+    ```ts
+    import {strongbox, Item} from '@appium/strongbox';
+    import {Foo, getFoo} from 'somewhere/else';
+
+    class FooItem implements Item<Foo> {
+      // ...
+    }
+    ```
+
+2. Provide this class as the `defaultCtor` option to `strongbox()`:
+
+    ```ts
+    const box = strongbox('my-pkg', {defaultCtor: FooItem});
+    ```
+
+3. Use like you would any other `Strongbox` instance:
+
+    ```ts
+    const foo: Foo = getFoo();
+    const item = await box.createItemWithValue('my unique name', Foo);
+    ```
+
+## Default Behavior, For the Curious
+
+Out-of-the-box, a `Strongbox` instance corresponds to a directory on-disk, and each `Item` (returned by `createItem()/createItemWithContents()`) corresponds to a file within that directory.  
+
+The directory of the `Strongbox` instance is determined by the [env-paths](https://www.npmjs.com/package/env-paths) package, and is platform-specific.
+
+## License
+
+Copyright © 2023 OpenJS Foundation. Licensed Apache-2.0
@@ -0,0 +1,95 @@
+import {mkdir, readFile, unlink, writeFile} from 'node:fs/promises';
+import path from 'node:path';
+import type {Item, ItemEncoding, Value} from '.';
+import {slugify} from './util';
+
+/**
+ * Base item implementation
+ *
+ * @remarks This class is not intended to be instantiated directly
+ * @typeParam T - Type of data stored in the `Item`
+ */
+export class BaseItem<T extends Value> implements Item<T> {
+  /**
+   * {@inheritdoc Item.value}
+   */
+  protected _value?: T | undefined;
+
+  /**
+   * Unique slugified identifier
+   */
+  public readonly id: string;
+
+  /**
+   * {@inheritdoc Item.value}
+   */
+  public readonly value: T | undefined;
+
+  /**
+   * Slugifies the name
+   * @param name Name of instance
+   * @param container Slugified name of container
+   * @param encoding Defaults to `utf8`
+   */
+  constructor(
+    public readonly name: string,
+    public readonly container: string,
+    public readonly encoding: ItemEncoding = 'utf8'
+  ) {
+    this.id = path.join(container, slugify(name));
+
+    Object.defineProperties(this, {
+      value: {
+        get() {
+          return this._value;
+        },
+        enumerable: true,
+      },
+      _value: {
+        enumerable: false,
+        writable: true,
+      },
+    });
+  }
+
+  /**
+   * {@inheritdoc Item.read}
+   */
+  public async read(): Promise<T | undefined> {
+    try {
+      this._value = (await readFile(this.id, {
+        encoding: this.encoding,
+      })) as T;
+    } catch (e) {
+      if ((e as NodeJS.ErrnoException).code !== 'ENOENT') {
+        throw e;
+      }
+    }
+    return this._value;
+  }
+
+  /**
+   * {@inheritdoc Item.write}
+   */
+  public async write(value: T): Promise<void> {
+    if (this._value !== value) {
+      await mkdir(path.dirname(this.id), {recursive: true});
+      await writeFile(this.id, value, this.encoding);
+      this._value = value;
+    }
+  }
+
+  /**
+   * {@inheritdoc Item.clear}
+   */
+  public async clear(): Promise<void> {
+    try {
+      await unlink(this.id);
+      this._value = undefined;
+    } catch (e) {
+      if ((e as NodeJS.ErrnoException).code !== 'ENOENT') {
+        throw e;
+      }
+    }
+  }
+}
@@ -0,0 +1,293 @@
+import envPaths from 'env-paths';
+import path from 'node:path';
+import {BaseItem} from './base-item';
+import {slugify, slugifyPath} from './util';
+
+/**
+ * Valid file encodings.
+ *
+ * `null` means the file should be read and written as a `Buffer`.
+ */
+export type ItemEncoding = BufferEncoding | null;
+
+/**
+ * Valid value wrapped by {@linkcode Item}. Can be an encoded string or `Buffer`
+ */
+export type Value = string | Buffer;
+
+/**
+ * An object representing a persisted item containing something of type `T` (which can be a {@linkcode Buffer} or an encoded string; see {@linkcode ItemEncoding}).
+ *
+ * A {@linkcode Item} does not know anything about where it is stored, or how it is stored.
+ * @typeParam T - Type of data stored in the item
+ */
+export interface Item<T extends Value> {
+  /**
+   * Encoding of underlying value
+   */
+  encoding: ItemEncoding;
+  /**
+   * Slugified name
+   */
+  id: string;
+  /**
+   * Name of item
+   */
+  name: string;
+
+  /**
+   * Reads value
+   */
+  read(): Promise<T | undefined>;
+  /**
+   * Writes value
+   * @param value New value
+   */
+  write(value: T): Promise<void>;
+
+  /**
+   * Deletes the item.
+   */
+  clear(): Promise<void>;
+
+  /**
+   * Last known value (stored in memory)
+   *
+   * @remarks A custom {@linkcode Item} meant to handle very large files should probably not implement this.
+   */
+  value?: T | undefined;
+}
+
+/**
+ * Set of known `Item` encodings
+ * @internal
+ */
+const ITEM_ENCODINGS: Readonly<Set<ItemEncoding>> = new Set([
+  'ascii',
+  'utf8',
+  'utf-8',
+  'utf16le',
+  'ucs2',
+  'ucs-2',
+  'base64',
+  'base64url',
+  'latin1',
+  'binary',
+  'hex',
+  null,
+]);
+
+/**
+ * Type guard for encodings
+ * @param value any
+ * @returns `true` is `value` is a valid file encoding
+ */
+function isEncoding(value: any): value is ItemEncoding {
+  return ITEM_ENCODINGS.has(value);
+}
+
+/**
+ * @see {@linkcode StrongboxOpts}
+ */
+export const DEFAULT_SUFFIX = 'strongbox';
+
+/**
+ * A constructor function which instantiates a {@linkcode Item}.
+ */
+export type ItemCtor<T extends Value> = new (
+  name: string,
+  container: string,
+  encoding?: ItemEncoding
+) => Item<T>;
+
+/**
+ * Main entry point for use of this module
+ *
+ * Manages multiple {@linkcode Item}s.
+ */
+export class Strongbox {
+  /**
+   * Default {@linkcode ItemCtor} to use when creating new {@linkcode Item}s
+   */
+  protected defaultItemCtor: ItemCtor<any>;
+  /**
+   * Slugified name of this instance; corresponds to the directory name.
+   *
+   * If `dir` is provided, this value is unused.
+   * If `suffix` is provided, then this will be the parent directory of `suffix`.
+   */
+  public readonly id: string;
+
+  /**
+   * Override the directory of this container.
+   *
+   * If this is present, both `suffix` and `containerId` are unused.
+   */
+  public readonly container: string;
+
+  /**
+   * Store of known {@linkcode Item}s
+   * @internal
+   */
+  protected items: Map<string, WeakRef<Item<any>>>;
+
+  /**
+   * Slugifies the name & determines the directory
+   * @param name Name of instance
+   * @param opts Options
+   */
+  protected constructor(
+    public readonly name: string,
+    {
+      container,
+      suffix = DEFAULT_SUFFIX,
+      defaultItemCtor: defaultCtor = BaseItem,
+    }: StrongboxOpts = {}
+  ) {
+    this.id = slugify(name);
+    this.defaultItemCtor = defaultCtor;
+    this.items = new Map();
+    this.container = container
+      ? slugifyPath(container)
+      : path.join(envPaths(this.id).data, slugify(suffix));
+  }
+
+  /**
+   * Creates a new {@linkcode Strongbox}
+   * @param name Name of instance
+   * @param opts Options
+   * @returns New instance
+   */
+  public static create(name: string, opts?: StrongboxOpts) {
+    return new Strongbox(name, opts);
+  }
+
+  /**
+   * Create a new {@linkcode Item}.
+   *
+   * Reads the item, if it is already persisted. Does not throw if missing.
+   * @param name Unique name of item
+   * @param encoding Encoding of item; defaults to `utf8`
+   * @returns New `Item`
+   * @typeParam T - Type of data stored in the `Item`
+   */
+  async createItem<T extends Value>(
+    name: string,
+    ctor?: ItemCtor<T>,
+    encoding?: ItemEncoding
+  ): Promise<Item<T>>;
+  async createItem<T extends Value>(name: string, encoding?: ItemEncoding): Promise<Item<T>>;
+  async createItem<T extends Value>(
+    name: string,
+    encodingOrCtor?: ItemEncoding | ItemCtor<T>,
+    encoding?: ItemEncoding
+  ): Promise<Item<T>> {
+    if (isEncoding(encodingOrCtor)) {
+      encoding = encodingOrCtor;
+      encodingOrCtor = this.defaultItemCtor;
+    }
+    const item = new (encodingOrCtor ?? (this.defaultItemCtor as ItemCtor<T>))(
+      name,
+      this.container,
+      encoding
+    );
+    if (this.items.has(item.id)) {
+      throw new ReferenceError(`Item with id "${item.id}" already exists`);
+    }
+    try {
+      await item.read();
+    } catch (e) {
+      if ((e as NodeJS.ErrnoException).code !== 'ENOENT') {
+        throw e;
+      }
+    }
+    this.items.set(item.id, new WeakRef(item));
+    return item;
+  }
+
+  /**
+   * Creates a {@linkcode Item} then immediately writes value to it.
+   *
+   * If it exists already, it will be overwritten.
+   * @param name Name of `Item`
+   * @param value File value to write
+   * @param ctor Specific {@linkcode ItemCtor} to use
+   * @param encoding File encoding
+   * @returns New `Item` w/ value of `value`
+   */
+  async createItemWithValue<T extends Value>(
+    name: string,
+    value: T,
+    ctor: ItemCtor<T>,
+    encoding?: ItemEncoding
+  ): Promise<Item<T>>;
+  async createItemWithValue<T extends Value>(
+    name: string,
+    value: T,
+    encoding?: ItemEncoding
+  ): Promise<Item<T>>;
+  async createItemWithValue<T extends Value>(
+    name: string,
+    value: T,
+    encodingOrCtor?: ItemEncoding | ItemCtor<T>,
+    encoding?: ItemEncoding
+  ): Promise<Item<T>> {
+    const item = isEncoding(encodingOrCtor)
+      ? await this.createItem<T>(name, encodingOrCtor)
+      : await this.createItem<T>(name, encodingOrCtor, encoding);
+    await item.write(value);
+    return item;
+  }
+
+  /**
+   * Attempts to retrieve an {@linkcode Item} by its `id`.
+   * @param id ID of item
+   * @returns An `Item`, if found
+   */
+  public getItem(id: string): Item<any> | undefined {
+    const ref = this.items.get(id);
+    return ref?.deref();
+  }
+
+  /**
+   * Clears _all_ items, as well as the container.
+   */
+  public async clearAll(): Promise<void> {
+    const items = [...this.items.values()].map((ref) => ref.deref()).filter(Boolean) as Item<any>[];
+    await Promise.all(items.map((item) => item.clear()));
+  }
+}
+
+/**
+ * Options for {@linkcode strongbox}
+ */
+export interface StrongboxOpts {
+  /**
+   * Default {@linkcode Item} constructor.
+   *
+   * Unless a constructor is specified when calling {@linkcode Strongbox.createItem} or {@linkcode Strongbox.createItemWithValue}, this will be used.
+   * @defaultValue BaseItem
+   */
+  defaultItemCtor?: ItemCtor<any>;
+  /**
+   * Override default container, which is chosen according to environment
+   */
+  container?: string;
+  /**
+   * Extra subdir to append to the auto-generated file directory hierarchy.
+   *
+   * This is ignored if `container` is provided.
+   * @defaultValue 'strongbox'
+   */
+  suffix?: string;
+}
+
+/**
+ * {@inheritdoc Strongbox.create}
+ */
+export const strongbox = Strongbox.create;
+
+/**
+ * This can be subclassed if needed.
+ */
+export {BaseItem};
@@ -0,0 +1,10 @@
+import path from 'node:path';
+import slug from 'slugify';
+
+export function slugify(value: string) {
+  return slug(value, {lower: true});
+}
+
+export function slugifyPath(filepath: string) {
+  return filepath.split(path.sep).map(slugify).join(path.sep);
+}
@@ -0,0 +1,56 @@
+{
+  "name": "@appium/strongbox",
+  "version": "0.2.0",
+  "description": "Persistent storage for Appium extensions",
+  "keywords": [
+    "automation",
+    "javascript",
+    "selenium",
+    "webdriver",
+    "ios",
+    "android",
+    "firefoxos",
+    "testing"
+  ],
+  "homepage": "https://appium.io",
+  "bugs": {
+    "url": "https://github.com/appium/appium/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/appium/appium.git",
+    "directory": "packages/strongbox"
+  },
+  "license": "Apache-2.0",
+  "author": "https://github.com/appium",
+  "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "build/lib",
+    "lib",
+    "tsconfig.json"
+  ],
+  "scripts": {
+    "test": "run-p test:unit test:types",
+    "test:smoke": "node .",
+    "test:unit": "mocha \"test/unit/**/*.spec.ts\"",
+    "test:types": "tsd"
+  },
+  "dependencies": {
+    "env-paths": "2.2.1",
+    "slugify": "1.6.6"
+  },
+  "engines": {
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+    "npm": ">=8"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "tsd": {
+    "directory": "test/types"
+  }
+}
@@ -0,0 +1,10 @@
+import {expectAssignable, expectNotAssignable} from 'tsd';
+import {Item, BaseItem, Value} from '../..';
+
+expectAssignable<Item<string>>(new BaseItem('foo', 'some-container'));
+
+expectNotAssignable<Value>(1);
+expectAssignable<Value>('foo');
+expectNotAssignable<Value>(true);
+expectAssignable<Value>(Buffer.from('foo'));
+expectNotAssignable<Value>({});
@@ -0,0 +1,156 @@
+import path from 'node:path';
+import rewiremock from 'rewiremock/node';
+import type {Strongbox as TStrongbox, StrongboxOpts} from '../../lib';
+import {createSandbox, SinonSandbox, SinonStubbedMember} from 'sinon';
+import type fs from 'node:fs/promises';
+
+const {expect} = chai;
+type MockFs = {
+  [K in keyof typeof fs]: SinonStubbedMember<(typeof fs)[K]>;
+};
+
+describe('Strongbox', function () {
+  let strongbox: (name: string, opts?: StrongboxOpts) => TStrongbox;
+  let Strongbox: new (name: string, opts?: StrongboxOpts) => TStrongbox;
+  let sandbox: SinonSandbox;
+  let DEFAULT_SUFFIX: string;
+  let MockFs: MockFs = {} as any;
+
+  const DATA_DIR = '/some/dir';
+
+  beforeEach(function () {
+    sandbox = createSandbox();
+    ({strongbox, DEFAULT_SUFFIX, Strongbox} = rewiremock.proxy(() => require('../../lib'), (r) => ({
+      // all of these props are async functions
+      'node:fs/promises': r
+        .mockThrough((prop) => {
+          MockFs = {...MockFs, [prop]: sandbox.stub().resolves()};
+          return MockFs[prop as keyof typeof fs];
+        })
+        .dynamic(), // this allows us to change the mock behavior on-the-fly
+      'env-paths': sandbox.stub().returns({data: DATA_DIR}),
+    })));
+  });
+
+  describe('static method', function () {
+    describe('create()', function () {
+      it('should return a new Strongbox', function () {
+        const box = strongbox('test');
+        expect(box).to.be.an.instanceOf(Strongbox);
+      });
+    });
+  });
+
+  describe('instance method', function () {
+    let box: TStrongbox;
+
+    beforeEach(function () {
+      box = strongbox('test');
+    });
+
+    describe('createItem()', function () {
+      describe('when a Item with the same id does not exist', function () {
+        describe('when the file does not exist', function () {
+          it('should create an empty Item', async function () {
+            const item = await box.createItem('SLUG test');
+            expect(item).to.eql({
+              id: '/some/dir/strongbox/slug-test',
+              name: 'SLUG test',
+              encoding: 'utf8',
+              value: undefined,
+              container: '/some/dir/strongbox',
+            });
+          });
+        });
+
+        describe('when the file exists', function () {
+          beforeEach(function () {
+            MockFs.readFile.resolves('foo bar');
+          });
+          it('should read its value', async function () {
+            const item = await box.createItem('SLUG test');
+            expect(item).to.eql({
+              id: '/some/dir/strongbox/slug-test',
+              name: 'SLUG test',
+              encoding: 'utf8',
+              value: 'foo bar',
+              container: '/some/dir/strongbox',
+            });
+          });
+        });
+
+        describe('when a value is written to the Item', function () {
+          it('should write a string value to the underlying file', async function () {
+            const item = await box.createItem('test');
+            await item.write('boo bah');
+
+            expect(MockFs.writeFile).to.have.been.calledWith(
+              path.join(DATA_DIR, DEFAULT_SUFFIX, 'test'),
+              'boo bah',
+              'utf8'
+            );
+          });
+
+          it('should update the underlying value', async function () {
+            const item = await box.createItem('test');
+            await item.write('boo bah');
+            expect(item.value).to.equal('boo bah');
+          });
+        });
+      });
+
+      describe('when a Item with the same id already exists', function () {
+        it('should throw an error', async function () {
+          await box.createItem('test');
+          await expect(box.createItem('test')).to.be.rejectedWith(
+            Error,
+            'Item with id "/some/dir/strongbox/test" already exists'
+          );
+        });
+      });
+    });
+
+    describe('clearAll()', function () {
+      let clear: sinon.SinonStub<never[], Promise<void>>;
+
+      beforeEach(async function () {
+        const item = await box.createItem<string>('SLUG test');
+        clear = sandbox.stub(item, 'clear');
+      });
+
+      it('should call clear() on each item', async function () {
+        await box.clearAll();
+        expect(clear).to.have.been.calledOnce;
+      });
+
+      describe('when there is some other error', function () {
+        beforeEach(function () {
+          clear.rejects(new Error('ETOOMANYGOATS'));
+        });
+
+        it('should reject', async function () {
+          await expect(box.clearAll()).to.be.rejected;
+        });
+      });
+    });
+
+    describe('createItemWithValue()', function () {
+      it('should create a Item with the given value', async function () {
+        const item = await box.createItemWithValue('test', 'value');
+        expect(item.value).to.equal('value');
+      });
+
+      it('should write the value to disk', async function () {
+        await box.createItemWithValue('test', 'value');
+        expect(MockFs.writeFile).to.have.been.calledWith(
+          path.join(DATA_DIR, DEFAULT_SUFFIX, 'test'),
+          'value'
+        );
+      });
+    });
+  });
+
+  afterEach(function () {
+    sandbox.restore();
+  });
+});
@@ -0,0 +1,11 @@
+{
+  "extends": "@appium/tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "build",
+    "strict": true,
+    "types": ["node", "mocha", "chai", "chai-as-promised", "sinon-chai"]
+  },
+  "include": ["lib", "test"],
+  "exclude": ["**/*.test-d.ts"]
+}
@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [3.1.11](https://github.com/appium/appium/compare/@appium/support@3.1.10...@appium/support@3.1.11) (2023-04-14)
+
+
+### Bug Fixes
+
+* **support:** prevent s3 presigned post request failing in http upload ([#18519](https://github.com/appium/appium/issues/18519)) ([59e4367](https://github.com/appium/appium/commit/59e4367cc832ced431259b476dc3c20775595e37))
+* **support:** update dependency semver to v7.4.0 ([6ae86bd](https://github.com/appium/appium/commit/6ae86bd5c7be879a4d8852951d73eb2f68128df3))
+
+
+
+## [3.1.10](https://github.com/appium/appium/compare/@appium/support@3.1.9...@appium/support@3.1.10) (2023-04-10)
+
+
+### Bug Fixes
+
+* **support:** update dependency axios to v1.3.5 ([6cf1480](https://github.com/appium/appium/commit/6cf14802b70a462beffc12a1134476596060c005))
+* **support:** update dependency shell-quote to v1.8.1 ([c39be81](https://github.com/appium/appium/commit/c39be81d04b9738cd639bb5dd82adf584f691f8f))
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+
+
+
 ## [3.1.9](https://github.com/appium/appium/compare/@appium/support@3.1.8...@appium/support@3.1.9) (2023-04-03)


@@ -70,7 +70,6 @@ async function uploadFileToHttp(
  }
  if (fileFieldName) {
    const form = new FormData();
-    form.append(fileFieldName, localFileStream);
    if (formFields) {
      let pairs = [];
      if (_.isArray(formFields)) {
@@ -84,6 +83,7 @@ async function uploadFileToHttp(
        }
      }
    }
+    form.append(fileFieldName, localFileStream); // AWS S3 POST upload requires this to be the last field
    requestOpts.headers = {
      ...(_.isPlainObject(headers) ? headers : {}),
      ...form.getHeaders(),
@@ -1,6 +1,6 @@
 {
  "name": "@appium/support",
-  "version": "3.1.9",
+  "version": "3.1.11",
  "description": "Support libs used across appium packages",
  "keywords": [
    "automation",
@@ -41,8 +41,8 @@
    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
  },
  "dependencies": {
-    "@appium/tsconfig": "^0.2.4",
-    "@appium/types": "^0.10.3",
+    "@appium/tsconfig": "^0.3.0",
+    "@appium/types": "^0.11.0",
    "@colors/colors": "1.5.0",
    "@types/archiver": "5.3.2",
    "@types/base64-stream": "1.0.2",
@@ -63,7 +63,7 @@
    "@types/teen_process": "2.0.0",
    "@types/uuid": "9.0.1",
    "archiver": "5.3.1",
-    "axios": "1.3.4",
+    "axios": "1.3.5",
    "base64-stream": "1.0.0",
    "bluebird": "3.7.2",
    "bplist-creator": "0.1.1",
@@ -90,12 +90,12 @@
    "resolve-from": "5.0.0",
    "rimraf": "3.0.2",
    "sanitize-filename": "1.6.3",
-    "semver": "7.3.8",
-    "shell-quote": "1.8.0",
+    "semver": "7.4.0",
+    "shell-quote": "1.8.1",
    "source-map-support": "0.5.21",
    "supports-color": "8.1.1",
    "teen_process": "2.0.2",
-    "type-fest": "3.7.2",
+    "type-fest": "3.8.0",
    "uuid": "9.0.0",
    "which": "3.0.0",
    "yauzl": "2.10.0"
@@ -16,7 +16,10 @@ describe('#net', function () {
  describe('downloadFile()', function () {
    it('should download file into the target folder', async function () {
      const dstPath = path.join(tmpRoot, 'download.tmp');
-      await downloadFile('https://appium.io/ico/apple-touch-icon-114x114-precomposed.png', dstPath);
+      await downloadFile(
+        'https://appium.io/docs/en/2.0/assets/images/appium-logo-white.png',
+        dstPath
+      );
      await fs.exists(dstPath).should.eventually.be.true;
    });
  });
@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [3.0.13](https://github.com/appium/appium/compare/@appium/test-support@3.0.12...@appium/test-support@3.0.13) (2023-04-14)
+
+**Note:** Version bump only for package @appium/test-support
+
+
+
+
+
+## [3.0.12](https://github.com/appium/appium/compare/@appium/test-support@3.0.11...@appium/test-support@3.0.12) (2023-04-10)
+
+**Note:** Version bump only for package @appium/test-support
+
+
+
+
+
 ## [3.0.11](https://github.com/appium/appium/compare/@appium/test-support@3.0.10...@appium/test-support@3.0.11) (2023-04-03)

 **Note:** Version bump only for package @appium/test-support
@@ -1,6 +1,6 @@
 {
  "name": "@appium/test-support",
-  "version": "3.0.11",
+  "version": "3.0.13",
  "description": "A collection of test utilities used across Appium packages",
  "keywords": [
    "automation",
@@ -45,7 +45,7 @@
    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
  },
  "dependencies": {
-    "@appium/support": "^3.1.9",
+    "@appium/support": "^3.1.11",
    "@colors/colors": "1.5.0",
    "bluebird": "3.7.2",
    "lodash": "4.17.21",
@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+# [0.3.0](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.4...@appium/tsconfig@0.3.0) (2023-04-10)
+
+
+### Features
+
+* **strongbox:** create @appium/strongbox ([fd91234](https://github.com/appium/appium/commit/fd912346fade8f29f5b4d1458828ea677d7e9fcc))
+
+
+
+
+
 ## [0.2.4](https://github.com/appium/appium/compare/@appium/tsconfig@0.2.3...@appium/tsconfig@0.2.4) (2023-02-09)


@@ -1,6 +1,6 @@
 {
  "name": "@appium/tsconfig",
-  "version": "0.2.4",
+  "version": "0.3.0",
  "description": "Shared TypeScript Config for Appium",
  "main": "tsconfig.json",
  "keywords": [
@@ -16,6 +16,7 @@
    "sourceMap": true,
    "removeComments": false,
    "strict": false,
-    "types": ["node"]
+    "types": ["node"],
+    "lib": ["es2020", "ES2021.WeakRef"]
  }
 }
@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [0.6.3](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.2...@appium/typedoc-plugin-appium@0.6.3) (2023-04-18)
+
+
+### Bug Fixes
+
+* **typedoc-plugin-appium:** fix parameter display for execute methods ([5a70d7c](https://github.com/appium/appium/commit/5a70d7ce78ce12ef8b9209a2a17c52b02ac0fc80))
+
+
+
+## [0.6.2](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.1...@appium/typedoc-plugin-appium@0.6.2) (2023-04-12)
+
+
+### Bug Fixes
+
+* **typedoc-plugin-appium:** restrict peer deps ([63e28a0](https://github.com/appium/appium/commit/63e28a014cf9af8bba9595d83f513bfb7026ae9a))
+
+
+
+## [0.6.1](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.0...@appium/typedoc-plugin-appium@0.6.1) (2023-04-10)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+
+
+
 # [0.6.0](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.5.4...@appium/typedoc-plugin-appium@0.6.0) (2023-04-05)


@@ -2,8 +2,8 @@ import _ from 'lodash';
 import {Context, DeclarationReflection, ReflectionKind} from 'typedoc';
 import {
  isCommandPropDeclarationReflection,
-  isExecMethodDefParamsPropDeclarationReflection,
  isHTTPMethodDeclarationReflection,
+  isMethodDefParamsPropDeclarationReflection,
  isRoutePropDeclarationReflection,
 } from '../guards';
 import {AppiumPluginLogger} from '../logger';
@@ -134,7 +134,7 @@ export function convertMethodMap({

      const payloadParamsProp = findChildByGuard(
        httpMethodProp,
-        isExecMethodDefParamsPropDeclarationReflection
+        isMethodDefParamsPropDeclarationReflection
      );

      const requiredParams = convertRequiredCommandParams(payloadParamsProp);
@@ -238,7 +238,7 @@ export function isExecMethodData(value: any): value is ExecMethodData {
 export function isMethodDefParamsPropDeclarationReflection(
  value: any
 ): value is MethodDefParamsPropDeclarationReflection {
-  return isReflectionWithReflectedType(value) && value.name === NAME_PARAMS;
+  return isReflectionWithReflectedType(value) && value.name === NAME_PAYLOAD_PARAMS;
 }

 /**
@@ -248,7 +248,7 @@ export function isMethodDefParamsPropDeclarationReflection(
 export function isExecMethodDefParamsPropDeclarationReflection(
  value: any
 ): value is ExecMethodDefParamsPropDeclarationReflection {
-  return isReflectionWithReflectedType(value) && value.name === NAME_PAYLOAD_PARAMS;
+  return isReflectionWithReflectedType(value) && value.name === NAME_PARAMS;
 }

 /**
@@ -20,6 +20,7 @@
 {{/with}}

 {{else}}
+{{! the required/optional parameters bits are fallbacks }}
 {{#if hasRequiredParams}}

 ##### Required Parameters
@@ -53,8 +54,8 @@

 <!-- END:EXAMPLE -->
 {{/each}}
-{{/if}}
 <!-- END:EXAMPLES -->
+{{/if}}
 {{#if signature}}

 #### Response
@@ -3,35 +3,93 @@
 ### {{#ifNamedAnchors}} <a id="{{anchor}}" name="{{this.anchor}}"></a> {{/ifNamedAnchors}}Script: `{{name}}`

 {{#if hasComment}}
-
 {{> comment}}
-
+<!-- comment source: {{commentSource}} -->
 {{/if}}

 #### Route

 `{{httpMethod}} {{route}}`

-{{#if hasRequiredParams}}  
+{{#if parameters}}

-#### Required Parameters
+#### Parameters
+
+{{#with parameters}}
+
+{{{parameterTable}}}
+
+{{/with}}
+
+{{else}}
+{{! the required/optional parameters bits are fallbacks }}
+{{#if hasRequiredParams}}
+
+##### Required Parameters

 {{#each requiredParams}}
-
 - `{{this}}`
-
 {{/each}}

 {{/if}}

 {{#if hasOptionalParams}}

-#### Optional Parameters
+##### Optional Parameters

 {{#each optionalParams}}
 - `{{this}}`
 {{/each}}

 {{/if}}
-  
+{{/if}}
+
+{{#if hasExample}}
+#### {{pluralize 'Example' examples.length}}
+
+<!-- BEGIN:EXAMPLES -->
+{{#each examples}}
+##### {{lang}}
+<!-- BEGIN:EXAMPLE lang={{lang}} -->
+
+{{{text}}}
+
+<!-- END:EXAMPLE -->
+{{/each}}
+<!-- END:EXAMPLES -->
+{{/if}}
+{{#if signature}}
+
+#### Response
+
+{{#with signature}}
+
+{{#with type}}
+
+{{{type 'all'}}}
+
+{{/with}}
+
+{{#with comment}}
+
+{{{returns this}}}
+
+{{/with}}
+
+{{#with type}}
+
+{{#if declaration.signatures}}
+
+{{#each declaration.signatures}}
+
+{{> member.signature showSources=false }}
+
+{{/each}}
+
+{{/if}}
+
+{{/with}}
+
+{{/with}}
+{{/if}}
 {{/unless}}
@@ -5,12 +5,17 @@

 import _ from 'lodash';
 import {DeclarationReflection} from 'typedoc';
-import {isCallSignatureReflection} from './guards';
+import {isCallSignatureReflection, isReflectionWithReflectedType} from './guards';

 /**
 * Loops through signatures of the command's method declaration and returns the first that is a
 * `CallSignatureReflection` (if any).  This is what we think of when we think "function signature"
+ * This also works on DeclarationReflections that have a reflected type; in other words, some value that is the type of a function, but is not a function itself (such as a property assigned to a function).
 */
-export const findCallSignature = _.memoize((refl?: DeclarationReflection) =>
-  refl?.getAllSignatures()?.find(isCallSignatureReflection)
+export const findCallSignature = _.memoize(
+  (refl?: DeclarationReflection) =>
+    refl?.getAllSignatures()?.find(isCallSignatureReflection) ??
+    (isReflectionWithReflectedType(refl)
+      ? refl.type.declaration.getAllSignatures()?.find(isCallSignatureReflection)
+      : undefined)
 );
@@ -1,6 +1,6 @@
 {
  "name": "@appium/typedoc-plugin-appium",
-  "version": "0.6.0",
+  "version": "0.6.3",
  "description": "TypeDoc plugin for Appium & its extensions",
  "homepage": "https://appium.io",
  "license": "Apache-2.0",
@@ -26,7 +26,7 @@
    "build": "cpy lib/theme/resources build",
    "clean": "npx rimraf build",
    "test": "run-s test:unit",
-    "test:e2e": "mocha --timeout 20s \"test/e2e/index.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-external-driver.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-method-map.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/converter.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/external.e2e.spec.ts\"",
+    "test:e2e": "mocha --timeout 20s \"test/e2e/index.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-external-driver.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/builtin-method-map.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/converter.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/converter/external.e2e.spec.ts\" && mocha --timeout 20s \"test/e2e/theme/output.e2e.spec.ts\"",
    "test:smoke": "node ./index.js",
    "test:unit": "mocha --timeout 2s \"test/unit/**/*.spec.ts\""
  },
@@ -54,8 +54,8 @@
  },
  "peerDependencies": {
    "appium": "^2.0.0-beta.48",
-    "typedoc": "^0.23.14",
-    "typedoc-plugin-markdown": "^3.14.0",
+    "typedoc": "~0.23.14",
+    "typedoc-plugin-markdown": "3.14.0",
    "typedoc-plugin-resolve-crossmodule-references": "~0.3.3",
    "typescript": "^4.7.0 || ^5.0.0"
  },
@@ -63,7 +63,7 @@
    "handlebars": "4.7.7",
    "lodash": "4.17.21",
    "pluralize": "8.0.0",
-    "type-fest": "3.7.2"
+    "type-fest": "3.8.0"
  },
  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }
@@ -10,8 +10,8 @@ import {
  TSConfigReader,
  TypeDocOptions,
 } from 'typedoc';
-import {THEME_NAME} from '../../lib';
-import {BaseConverter} from '../../lib/converter';
+import {THEME_NAME, setup} from '../../lib';
+import {BaseConverter, NAME_BUILTIN_COMMAND_MODULE, NAME_TYPES_MODULE} from '../../lib/converter';
 import {AppiumPluginLogger} from '../../lib/logger';

 const {expect} = chai;
@@ -175,3 +175,13 @@ export interface InitConverterOptions<Args extends readonly any[] = any[]>
 type ConverterConstructor<T, C extends BaseConverter<T>, Args extends readonly any[] = any[]> =
  | Constructor<C, [Context, AppiumPluginLogger, ...Args]>
  | Constructor<C, [Context, AppiumPluginLogger]>;
+
+/**
+ * Creates a new TypeDoc application and/or resets it
+ */
+export function reset({
+  entryPoints = [NAME_TYPES_MODULE, NAME_FAKE_DRIVER_MODULE, NAME_BUILTIN_COMMAND_MODULE],
+  ...opts
+}: Partial<TypeDocOptions> = {}): Application {
+  return setup(initAppForPkgs({entryPoints, ...opts}));
+}
@@ -1,16 +1,9 @@
 import _ from 'lodash';
-import {
-  Application,
-  Context,
-  DeclarationReflection,
-  ProjectReflection,
-  ReflectionKind,
-  TypeDocOptions,
-} from 'typedoc';
-import {convert, ConvertResult, postProcess, PostProcessResult, setup} from '../../lib';
+import {Context, DeclarationReflection, ProjectReflection, ReflectionKind} from 'typedoc';
+import {convert, ConvertResult, postProcess, PostProcessResult} from '../../lib';
 import {NAME_BUILTIN_COMMAND_MODULE, NAME_TYPES_MODULE} from '../../lib/converter';
 import {AppiumPluginReflectionKind, CommandReflection, ExtensionReflection} from '../../lib/model';
-import {initAppForPkgs, NAME_FAKE_DRIVER_MODULE} from './helpers';
+import {reset} from './helpers';

 const {expect} = chai;

@@ -34,16 +27,6 @@ describe('@appium/typedoc-plugin-appium', function () {
   */
  let extensionReflections!: ExtensionReflection[];

-  /**
-   * Creates a new TypeDoc application and/or resets it
-   */
-  function reset({
-    entryPoints = [NAME_TYPES_MODULE, NAME_FAKE_DRIVER_MODULE, NAME_BUILTIN_COMMAND_MODULE],
-    ...opts
-  }: Partial<TypeDocOptions> = {}): Application {
-    return setup(initAppForPkgs({entryPoints, ...opts}));
-  }
-
  describe('convert()', function () {
    describe('when "theme" is not "markdown" or "appium"', function () {
      it('should do nothing', async function () {
@@ -0,0 +1,49 @@
+import path from 'node:path';
+import {tempDir, fs} from 'appium/support';
+import {jestSnapshotPlugin} from 'mocha-chai-jest-snapshot';
+import {convert} from '../../../lib';
+import {reset} from '../helpers';
+
+chai.use(jestSnapshotPlugin());
+
+const {expect} = chai;
+
+describe('@appium/typedoc-plugin-appium', function () {
+  let tmpDir: string;
+  before(async function () {
+    const app = reset({
+      plugin: ['typedoc-plugin-markdown', 'typedoc-plugin-crossmodule-references'],
+    });
+    const promise = convert(app);
+    const project = app.convert();
+    await promise;
+    expect(project).to.exist;
+    tmpDir = await tempDir.openDir();
+    await app.generateDocs(project!, tmpDir);
+  });
+
+  after(async function () {
+    await fs.rimraf(tmpDir);
+  });
+
+  describe('theme', function () {
+    describe('command output', function () {
+      it('should generate expected markdown', async function () {
+        const baseDriverMd = await fs.readFile(
+          path.join(tmpDir, 'commands', 'base-driver.md'),
+          'utf8'
+        );
+        expect(baseDriverMd).toMatchSnapshot();
+      });
+    });
+    describe('execute method output', function () {
+      it('should generate expected markdown', async function () {
+        const fakeDriverMd = await fs.readFile(
+          path.join(tmpDir, 'commands', 'fake-driver.md'),
+          'utf8'
+        );
+        expect(fakeDriverMd).toMatchSnapshot();
+      });
+    });
+  });
+});
@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

+## [0.11.0](https://github.com/appium/appium/compare/@appium/types@0.10.4...@appium/types@0.11.0) (2023-04-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* **types:** `Driver.proxyCommand` now returns `Promise<unknown>` by default.  In strict mode, this forces an extension calling `this.proxyCommand()` to explicitly type the return value (because it's unknown!).
+
+Otherwise, this concerns the `SingularSessionData` type and the function which returns it (`getSession()`).  `Driver` now accepts a type param to add arbitrary properties to the value returned by `getSession()`--as this is in-line with `XCUITestDriver` is doing.  This param is provided as the new optional second type param to `SingularSessionData`.
+
+Further, it removes the `ISessionCommands` interface, because I didn't understand how to write it such that an isolated implementation could use the type parameter from the class it belongs to. This is probably doable, but seems icky, and I didn't want to fight with it.  It's easier to just move the implementation into the class itself, which is what will happen in `BaseDriver` (see next changeset).
+
+### Bug Fixes
+
+* **types:** driver-specific session data now allowed ([91abd5b](https://github.com/appium/appium/commit/91abd5b598dd55e8d7fd12d2e683703aa8ac290a))
+
+
+
+## [0.10.4](https://github.com/appium/appium/compare/@appium/types@0.10.3...@appium/types@0.10.4) (2023-04-10)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.8.0 ([d6c42e9](https://github.com/appium/appium/commit/d6c42e99c08efce0b34796d5982ce379fca044d3))
+
+
+
+
+
 ## [0.10.3](https://github.com/appium/appium/compare/@appium/types@0.10.2...@appium/types@0.10.3) (2023-04-03)


@@ -157,22 +157,6 @@ export interface IEventCommands {
  getLogEvents(type?: string | string[]): Promise<EventHistory | Record<string, number>>;
 }

-export interface ISessionCommands {
-  /**
-   * Get data for all sessions running on an Appium server
-   *
-   * @returns A list of session data objects
-   */
-  getSessions(): Promise<MultiSessionData[]>;
-
-  /**
-   * Get the data for the current session
-   *
-   * @returns A session data object
-   */
-  getSession<C extends Constraints>(): Promise<SingularSessionData<C>>;
-}
-
 export interface IExecuteCommands {
  /**
   * Call an `Execute Method` by its name with the given arguments. This method will check that the
@@ -197,10 +181,20 @@ export interface MultiSessionData<C extends Constraints = Constraints> {
  capabilities: DriverCaps<C>;
 }

-export type SingularSessionData<C extends Constraints = Constraints> = DriverCaps<C> & {
+/**
+ * Data returned by {@linkcode ISessionCommands.getSession}.
+ *
+ * @typeParam C - The driver's constraints
+ * @typeParam T - Any extra data the driver stuffs in here
+ * @privateRemarks The content of this object looks implementation-specific and in practice is not well-defined.  It's _possible_ to fully type this in the future.
+ */
+export type SingularSessionData<
+  C extends Constraints = Constraints,
+  T extends StringRecord = StringRecord
+> = DriverCaps<C> & {
  events?: EventHistory;
  error?: string;
-};
+} & T;

 export interface IFindCommands {
  /**
@@ -411,7 +405,8 @@ export type DefaultDeleteSessionResult = void;
 export interface ISessionHandler<
  C extends Constraints = Constraints,
  CreateResult = DefaultCreateSessionResult<C>,
-  DeleteResult = DefaultDeleteSessionResult
+  DeleteResult = DefaultDeleteSessionResult,
+  SessionData extends StringRecord = StringRecord
 > {
  /**
   * Start a new automation session
@@ -445,6 +440,20 @@ export interface ISessionHandler<
   * @param driverData - the driver data for other currently-running sessions
   */
  deleteSession(sessionId?: string, driverData?: DriverData[]): Promise<DeleteResult>;
+
+  /**
+   * Get data for all sessions running on an Appium server
+   *
+   * @returns A list of session data objects
+   */
+  getSessions(): Promise<MultiSessionData[]>;
+
+  /**
+   * Get the data for the current session
+   *
+   * @returns A session data object
+   */
+  getSession(): Promise<SingularSessionData<C, SessionData>>;
 }

 /**
@@ -675,15 +684,15 @@ export interface Driver<
  CArgs extends StringRecord = StringRecord,
  Settings extends StringRecord = StringRecord,
  CreateResult = DefaultCreateSessionResult<C>,
-  DeleteResult = DefaultDeleteSessionResult
-> extends ISessionCommands,
-    ILogCommands,
+  DeleteResult = DefaultDeleteSessionResult,
+  SessionData extends StringRecord = StringRecord
+> extends ILogCommands,
    IFindCommands,
    ISettingsCommands<Settings>,
    ITimeoutCommands,
    IEventCommands,
    IExecuteCommands,
-    ISessionHandler<C, CreateResult, DeleteResult>,
+    ISessionHandler<C, CreateResult, DeleteResult, SessionData>,
    Core<C, Settings> {
  /**
   * The set of command line arguments set for this driver
@@ -1992,14 +2001,19 @@ export interface ExternalDriver<C extends Constraints = Constraints, Ctx = strin
  /**
   * Proxy a command to a connected WebDriver server
   *
-   * @typeParam T - the type of the return value
+   * @typeParam TReq - the type of the incoming body
+   * @typeParam TRes - the type of the return value
   * @param url - the incoming URL
   * @param method - the incoming HTTP method
   * @param body - the incoming HTTP body
   *
   * @returns The return value of the proxied command
   */
-  proxyCommand?<T = any>(url: string, method: HTTPMethod, body?: string): Promise<T>;
+  proxyCommand?<TReq = any, TRes = unknown>(
+    url: string,
+    method: HTTPMethod,
+    body?: TReq
+  ): Promise<TRes>;
 }

 /**
@@ -1,6 +1,6 @@
 {
  "name": "@appium/types",
-  "version": "0.10.3",
+  "version": "0.11.0",
  "description": "Various type declarations used across Appium",
  "keywords": [
    "automation",
@@ -39,11 +39,11 @@
  },
  "dependencies": {
    "@appium/schema": "^0.2.6",
-    "@appium/tsconfig": "^0.2.4",
+    "@appium/tsconfig": "^0.3.0",
    "@types/express": "4.17.17",
    "@types/npmlog": "4.1.4",
    "@types/ws": "8.5.4",
-    "type-fest": "3.7.2"
+    "type-fest": "3.8.0"
  },
  "engines": {
    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -47,7 +47,7 @@
    },
    {
      "extends": ["packages:eslint"],
-      "matchPackageNames": ["@appium/eslint-config-appium"],
+      "matchPackagePrefixes": ["@appium/eslint-config-appium"],
      "groupName": "ESLint-related packages",
      "groupSlug": "eslint"
    },
@@ -58,7 +58,8 @@
    },
    {
      "matchPackagePrefixes": ["@appium/"],
-      "excludePackageNames": ["@appium/eslint-config-appium"],
+      "excludePackageNames": ["@appium/eslint-config-appium", "@appium/eslint-config-appium-ts"],
+      "matchPackageNames": "appium",
      "groupName": "Appium-related packages",
      "groupSlug": "appium"
    }
@@ -67,6 +67,9 @@
    },
    {
      "path": "packages/doctor"
+    },
+    {
+      "path": "packages/strongbox"
    }
  ]
 }
@@ -18,7 +18,8 @@
    "./packages/driver-test-support",
    "./packages/test-support",
    "./packages/plugin-test-support",
-    "./packages/opencv"
+    "./packages/opencv",
+    "./packages/strongbox"
  ],
  "name": "Appium",
  "out": "./packages/appium/docs/en/reference",
Author	SHA1	Message	Date
Christopher Hiller	b9ef676b73	chore: publish - appium@2.0.0-beta.65 - @appium/docutils@0.3.8 - @appium/typedoc-plugin-appium@0.6.3	2023-04-18 16:52:19 -07:00
Christopher Hiller	66459e991e	chore(typedoc-plugin-appium): add basic snapshot tests	2023-04-18 16:51:15 -07:00
Christopher Hiller	5a70d7ce78	fix(typedoc-plugin-appium): fix parameter display for execute methods	2023-04-18 16:51:15 -07:00
renovate[bot]	611a63f0ae	chore(deps): update dependency midnight-smoker to v2.0.3	2023-04-18 14:12:07 +00:00
renovate[bot]	e4863778c7	chore(deps): update dependency @types/sinon to v10.0.14	2023-04-18 08:05:39 +00:00
Jonathan Lipps	0ff735598a	test(support): update image path for download test	2023-04-17 16:15:17 -07:00
Vishal Shah	5d705851f2	docs(appium): adding nightwatch to client list in ecosystem (#18518 ) * docs: adding nightwatch to client list in ecosystem * docs: adding nightwatch to client list in ecosystem	2023-04-17 14:53:28 -07:00
Jonathan Lipps	6ba5c52e98	docs: just use appium.io for github page frontend	2023-04-17 14:31:08 -07:00
Christopher Hiller	a314166585	chore(renovate): improvements to appium group This ensures all Appium packages from the monorepo get updated at once.	2023-04-17 14:03:03 -07:00
Christopher Hiller	fe96af91f2	chore(ci): disable PR preview The PR preview won't work when run from forks because there's no safe way to let forks write to our own `gh-pages` branch. We'll need to find another strategy to get this working again. For now, the docs build just builds the docs, like it did before.	2023-04-17 14:01:38 -07:00
Christopher Hiller	52ae548ddc	chore(renovate): move renovate check into its own workflow This was causing checks to not happen because of the path filter.	2023-04-17 11:19:27 -07:00
renovate[bot]	9214c15d58	chore(deps): update commitlint monorepo to v17.6.1	2023-04-14 23:28:47 +00:00
Christopher Hiller	11406e4879	chore: publish - appium@2.0.0-beta.64 - @appium/base-driver@9.3.7 - @appium/base-plugin@2.2.7 - @appium/doctor@2.0.13 - @appium/docutils@0.3.7 - @appium/driver-test-support@0.4.5 - @appium/fake-plugin@3.1.11 - @appium/plugin-test-support@0.3.13 - @appium/support@3.1.11 - @appium/test-support@3.0.13 - @appium/types@0.11.0	2023-04-14 12:32:15 -07:00
Christopher Hiller	640e0ae30f	chore(appium,fake-plugin): squelch eslint warnings I am not sure why the `@typescript/eslint` rule overrides the ESLint one, but it does. Squelched!	2023-04-14 12:23:54 -07:00
Christopher Hiller	6245022be9	fix(basedriver): allow arbitrary session data to be returned by getSession This removes the implementation of `ISessionCommands` and moves the methods into the class proper (see previous changeset for reasoning).	2023-04-14 12:23:54 -07:00
Christopher Hiller	91abd5b598	fix(types): driver-specific session data now allowed BREAKING CHANGE: `Driver.proxyCommand` now returns `Promise<unknown>` by default. In strict mode, this forces an extension calling `this.proxyCommand()` to explicitly type the return value (because it's unknown!). Otherwise, this concerns the `SingularSessionData` type and the function which returns it (`getSession()`). `Driver` now accepts a type param to add arbitrary properties to the value returned by `getSession()`--as this is in-line with `XCUITestDriver` is doing. This param is provided as the new optional second type param to `SingularSessionData`. Further, it removes the `ISessionCommands` interface, because I didn't understand how to write it such that an isolated implementation could use the type parameter from the class it belongs to. This is probably doable, but seems icky, and I didn't want to fight with it. It's easier to just move the implementation into the class itself, which is what will happen in `BaseDriver` (see next changeset).	2023-04-14 12:23:54 -07:00
renovate[bot]	78bc0926db	fix(driver-test-support): update dependency @types/lodash to v4.14.194	2023-04-14 19:17:10 +00:00
Mohanjith Sudirikku Hannadige	59e4367cc8	fix(support): prevent s3 presigned post request failing in http upload (#18519 ) AWS S3 expects file field to be the last field in the POST request. Currently it is the first field and that prevents AWS from parsing the other POST fields and request gives 400 error. With the change, it makes it possible to provide formFields necessary for http upload to S3 from appium. Use case: mobile: stopMediaProjectionRecording can upload screen recording to S3 for further processing	2023-04-14 13:30:32 +02:00
renovate[bot]	c7d9a456d8	chore(workflows): update actions/checkout digest to 8e5e7e5	2023-04-14 09:17:28 +00:00
renovate[bot]	e8590c77e7	chore(workflows): update actions/checkout digest to 83b7061	2023-04-13 12:30:52 +00:00
renovate[bot]	6ae86bd5c7	fix(support): update dependency semver to v7.4.0	2023-04-12 22:39:18 +00:00
Christopher Hiller	a9a6b834bc	chore: publish - appium@2.0.0-beta.63 - @appium/docutils@0.3.6 - @appium/execute-driver-plugin@3.0.12 - @appium/typedoc-plugin-appium@0.6.2	2023-04-12 10:58:48 -07:00
Mykola Mokhnach	297f4995f8	chore(appium): Perform better validation of appiumHome values (#18462 )	2023-04-12 11:57:05 +02:00
renovate[bot]	f42374eb6d	chore(deps): update eslint-related packages to v5.58.0	2023-04-12 07:27:32 +00:00
renovate[bot]	d6c70f2f52	fix(execute-driver-plugin): update dependency vm2 to v3.9.16	2023-04-12 03:38:17 +00:00
Christopher Hiller	e35bc50454	chore: use conventionalcommit changelog This changes the changelog preset from "angular" to "conventional-changelog-conventionalcommits" which should be more appropriate for our workflow.	2023-04-11 16:55:04 -07:00
Christopher Hiller	63e28a014c	fix(typedoc-plugin-appium): restrict peer deps This restricts peer deps to non-breaking versions. This is not a breaking change, because if newer versions are installed, they break anyway.	2023-04-11 16:35:12 -07:00
Christopher Hiller	e9b50225dc	chore: publish - appium@2.0.0-beta.62 - @appium/base-driver@9.3.6 - @appium/base-plugin@2.2.6 - @appium/doctor@2.0.12 - @appium/docutils@0.3.5 - @appium/driver-test-support@0.4.4 - @appium/execute-driver-plugin@3.0.11 - @appium/fake-plugin@3.1.10 - @appium/plugin-test-support@0.3.12 - @appium/strongbox@0.2.0 - @appium/support@3.1.10 - @appium/test-support@3.0.12 - @appium/tsconfig@0.3.0 - @appium/typedoc-plugin-appium@0.6.1 - @appium/types@0.10.4	2023-04-10 16:43:21 -07:00
Christopher Hiller	e9426fcfec	fix(docutils): properly respects log levels The resulting solution keeps a bunch of weak refs to `Consola` objects and sets the log level on all of them if it ever changes. This is--at minimum--easier to understand than the broken `Proxy` implementation.	2023-04-10 15:58:58 -07:00
Christopher Hiller	5ab2fea576	feat(appium): make "ls" alias of "list" This makes `ls` an alias of `list`; e.g., `appium driver ls` While doing this I noticed a limitation of `argparser`, which is that an option (not a command) can only have a single (1) alias. I have noted this behavior in a comment. I also notice that we need to rewrite `ls` to be `list` ourselves, or we will have a bunch of conditionals checking for both values scattered around. We need to use yargs...	2023-04-10 15:36:34 -07:00
Christopher Hiller	377e9825de	feat(strongbox): export BaseItem This exports `BaseItem`, the builtin implementation of `Item`.	2023-04-10 13:28:51 -07:00
renovate[bot]	116c9a66e2	chore(workflows): update egmacke/action-check-label action to v2	2023-04-10 13:01:51 -07:00
renovate[bot]	04b542cfcd	chore(deps): update dependency eslint to v8.38.0	2023-04-09 08:21:43 +00:00
renovate[bot]	c39be81d04	fix(support): update dependency shell-quote to v1.8.1	2023-04-08 16:49:21 +00:00
renovate[bot]	efc847380a	chore(deps): update dependency lint-staged to v13.2.1	2023-04-08 12:27:01 +00:00
renovate[bot]	cf7b4d84af	chore(docutils): update dependency mkdocs-material to v9.1.6	2023-04-08 09:33:44 +00:00
renovate[bot]	5a3666f653	chore(workflows): update egmacke/action-check-label digest to b6f12c1	2023-04-08 09:26:17 +00:00
renovate[bot]	5790924bf8	fix(execute-driver-plugin): update dependency vm2 to v3.9.15	2023-04-08 00:25:27 +00:00
Christopher Hiller	39b7cd5084	chore: update wallaby config	2023-04-07 12:38:29 -07:00
Christopher Hiller	fd912346fa	feat(strongbox): create @appium/strongbox This PR creates a new package `@appium/strongbox`, which provides a generic persistence store for Appium extensions.	2023-04-07 12:38:29 -07:00
Christopher Hiller	1d5070e891	chore(ci): replace label checker action This replaces [danielchabr/pr-labels-checker](/danielchabr/pr-labels-checker) with [egmacke/action-check-label](/egmacke/action-check-label). There are many such actions. Maybe this one won't give us problems.	2023-04-07 11:38:31 -07:00
Christopher Hiller	42953b2add	chore(ci): revert to source repo of rossjrw/pr-preview-action A bugfix PR of mine was merged into this repo, so we can use it again.	2023-04-07 11:31:28 -07:00
renovate[bot]	d0f479f7a8	chore(workflows): update boneskull/pr-preview-action digest to 9dac5c4	2023-04-07 11:30:11 +00:00
Christopher Hiller	e67890f463	chore(ci): use boneskull fork of pr-preview-action My fork should fix the bug in the action. See https://github.com/rossjrw/pr-preview-action/pull/36	2023-04-06 16:06:32 -07:00
renovate[bot]	ff46dfa814	chore(workflows): pin rossjrw/pr-preview-action action to 9dac5c4	2023-04-06 16:06:32 -07:00
Christopher Hiller	afc7e34402	chore(ci): try to fix on-hold workflow permissions issues, but unclear which	2023-04-06 12:24:07 -07:00
Christopher Hiller	eef4e3447a	chore(ci): make docs preview job run in master only since it writes to gh-pages branch	2023-04-06 12:23:58 -07:00
renovate[bot]	d6c42e99c0	fix(types): update dependency type-fest to v3.8.0	2023-04-06 17:04:42 +00:00
renovate[bot]	6cf14802b7	fix(support): update dependency axios to v1.3.5	2023-04-06 13:47:58 +00:00
renovate[bot]	d5090155ad	chore(deps): update dependency eslint-import-resolver-typescript to v3.5.5	2023-04-06 09:56:04 +00:00