chore: publish

- appium@2.0.0-beta.65
 - @appium/docutils@0.3.8
 - @appium/typedoc-plugin-appium@0.6.3

.fossa.yml

@@ -53,4 +53,4 @@ targets:
       path: ./packages/docutils
 
 revision:
-  - branch: master
+  branch: master

.github/labeler.yml

@@ -25,6 +25,7 @@ labels:
     matcher:
       commits: '^chore.*?:'
       title: '^chore.*?:'
+      files: ['.github/**', '.husky/**', '.vscode/**', './.*', './*.js', '**/test/**']
 
   - label: 'SemVer:Breaking'
     sync: true
@@ -34,7 +35,7 @@ labels:
   - label: 'Dependencies'
     sync: true
     matcher:
-      files: ['**/package.json', '**/package-lock.json', '**/requirements.txt']
+      files: ['**/package.json', 'package-lock.json', '**/requirements.txt']
       author: 'renovate'
 
   - label: 'appium core'
@@ -52,6 +53,11 @@ labels:
     matcher:
       files: ['packages/eslint-config-appium/**']
 
+  - label: '@appium/eslint-config-appium-ts'
+    sync: true
+    matcher:
+      files: ['packages/eslint-config-appium-ts/**']
+
   - label: '@appium/base-plugin'
     sync: true
     matcher:
@@ -141,3 +147,8 @@ labels:
     sync: true
     matcher:
       files: ['packages/universal-xml-plugin/**']
+  
+  - label: '@appium/strongbox'
+    sync: true
+    matcher:
+      files: ['packages/strongbox/**']

.github/workflows/auto-labeler.yml

@@ -0,0 +1,16 @@
+name: Labeler
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+    branches: [master]
+
+permissions: read-all
+
+jobs:
+  labeler:
+    permissions:
+      pull-requests: write
+    name: Auto-Label PRs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: fuxingloh/multi-labeler@6704db0bcba106d07482efabbc79d3092af74fa2 # v2

.github/workflows/build.yml

@@ -1,5 +1,42 @@
 name: Appium Build
-on: [push, pull_request]
+on:
+  push:
+    # this list of paths could potentially impact the build
+    paths:
+      - '**/tsconfig*.json'
+      - 'packages/base-driver/static/**/*'
+      - 'packages/*/test/**'
+      - 'packages/*/bin'
+      - 'packages/**/*.ts'
+      - 'packages/**/*.json'
+      - 'packages/**/*.js'
+      - 'package*.json'
+      - 'lerna.json'
+      - '.npmrc'
+      - '.mocharc.js'
+      - '.github/workflows/build.yml' # this file
+      - '.eslintrc'
+      - '.eslintignore'
+      - '!**/sample-code/**'
+      - '!packages/*/docs/**'
+  pull_request:
+    paths:
+      - '**/tsconfig*.json'
+      - 'packages/base-driver/static/**/*'
+      - 'packages/*/test/**'
+      - 'packages/*/bin'
+      - 'packages/**/*.ts'
+      - 'packages/**/*.json'
+      - 'packages/**/*.js'
+      - 'package*.json'
+      - 'lerna.json'
+      - '.npmrc'
+      - '.mocharc.js'
+      - '.github/workflows/build.yml' # this file
+      - '.eslintrc'
+      - '.eslintignore'
+      - '!**/sample-code/**'
+      - '!packages/*/docs/**'
 
 permissions:
   contents: read
@@ -13,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:
@@ -33,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:
@@ -41,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}'

.github/workflows/clean-cache.yml

@@ -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: |

.github/workflows/docs.yml

@@ -2,30 +2,46 @@ name: Build Docs
 
 on:
   pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - closed
     paths:
-      - './packages/appium/docs/**'
-      - './packages/docutils/**'
-      - './packages/typedoc-plugin-appium/**'
-
-concurrency: preview-${{ github.ref }}
+      - '**/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/**'
+  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
-      - name: Install dependencies (node)
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - name: Install dependencies (Node.js)
         uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
         with:
           useRollingCache: true
           install-command: npm ci
-      - name: Install dependencies (python)
+      - name: Install dependencies (Python)
         run: pip install -r packages/docutils/requirements.txt
       - name: Configure Git User
         run: |
@@ -33,8 +49,3 @@ jobs:
           git config --local user.name "github-actions[bot]"
       - name: Build Docs
         run: npm run docs:preview
-      - name: Deploy Preview
-        if: ${{ github.repository == 'appium/appium' }}
-        uses: rossjrw/pr-preview-action@9dac5c4777c535516ebf819f93aeadac70f66488 # v1
-        with:
-          source-dir: ./packages/appium/docs/site

.github/workflows/fossa.yml

@@ -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

.github/workflows/labeler.yml

@@ -1,22 +0,0 @@
-name: 'Labeler'
-on:
-  pull_request:
-    types: [opened, synchronize]
-
-permissions:
-  contents: read
-  issues: read # change this if/when we want to label issues
-  pull-requests: write
-  statuses: read
-  checks: read
-
-jobs:
-  labeler:
-    if: ${{ github.repository == 'appium/appium' }}
-    name: Labeler
-    runs-on: ubuntu-latest
-    steps:
-      # follows semantic versioning. Lock to different version: v1, v1.5, v1.5.0 or use a commit hash.
-      - uses: fuxingloh/multi-labeler@6704db0bcba106d07482efabbc79d3092af74fa2 # v2
-        with:
-          github-token: ${{secrets.GITHUB_TOKEN}} # optional, default to '${{ github.token }}'

.github/workflows/on-hold.yml

@@ -1,15 +1,15 @@
 name: Disallow "On Hold" PRs
 on:
-  pull_request:
+  pull_request_target:
     types: [opened, labeled, unlabeled, synchronize]
+    branches: [master]
 
 jobs:
   label-check:
-    if: ${{ github.base_ref == 'master' && github.repository == 'appium/appium' }}
     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

.github/workflows/renovate.yml

@@ -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}'

.wallaby.js

@@ -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,
     },

README.md

@@ -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
 

lerna.json

@@ -1,5 +1,13 @@
 {
+  "$schema": "https://json.schemastore.org/lerna",
+  "changelogPreset": "conventional-changelog-conventionalcommits",
   "command": {
+    "add": {
+      "exact": true
+    },
+    "publish": {
+      "message": "chore: publish"
+    },
     "run": {
       "concurrency": 8
     },
@@ -9,13 +17,10 @@
       "version": {
         "allowBranch": "master"
       }
-    },
-    "add": {
-      "exact": true
     }
   },
   "ignoreChanges": ["**/test/**", "**/*.md"],
-  "version": "independent",
+  "useNx": false,
   "useWorkspaces": true,
-  "useNx": false
+  "version": "independent"
 }

package.json

@@ -27,47 +27,54 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "tsc -b",
-    "build:all": "run-s build build:packages",
-    "build:packages": "lerna run build",
-    "clean": "run-s clean:artifacts clean:workspaces",
-    "clean:artifacts": "run-p \"clean:artifacts:*\"",
-    "clean:artifacts:distfiles": "npx rimraf \"./packages/*/build\" \"./packages/*/.tsconfig.tsbuildinfo\"",
-    "clean:artifacts:packages": "lerna run clean || true",
-    "clean:workspaces": "lerna clean -y",
+    "build": "run-s build:*",
+    "build:compile": "tsc -b",
+    "build:workspaces": "lerna run build",
     "ci": "npm ci",
-    "dev": "run-s \"build -- --watch\"",
+    "clean": "run-s clean:distfiles clean:workspaces",
+    "clean:dangerously": "run-s clean:workspaces clean:force",
+    "clean:deps": "lerna clean --yes",
+    "clean:distfiles": "npx rimraf \"./packages/*/build\" \"./packages/*/**/.tsconfig.tsbuildinfo\"; npx nx reset",
+    "clean:interactive": "git clean -d -x -i",
+    "clean:force": "git clean -d -x -f",
+    "clean:workspaces": "lerna run clean || true",
+    "dev": "run-s build:compile \"build:workspaces\" \"build:compile -- --watch\"",
+    "dev:docs": "npm run -w packages/appium dev:docs",
     "docs": "npm run -w packages/appium build:docs",
     "docs:preview": "npm run -w packages/appium build:docs:preview",
     "doctor": "node ./packages/doctor",
-    "husky-install": "husky install",
     "generate-docs": "npm run --workspace=packages/appium generate-docs",
-    "prepare": "run-p husky-install build:all",
+    "husky-install": "husky install",
     "lint": "eslint .",
-    "lint:fix": "run-s \"lint -- --fix\"",
     "lint:ci": "eslint --quiet .",
     "lint:commit": "commitlint",
+    "lint:fix": "run-s \"lint -- --fix\"",
     "lint:staged": "lint-staged",
+    "prepare": "run-p husky-install rebuild",
     "prepublishOnly": "run-s rebuild",
-    "reinstall": "run-s clean ci",
-    "rebuild": "run-s clean:artifacts build:all",
+    "preversion": "run-s rebuild",
+    "version": "run-s sync-pkgs stage-synced-pkgs",
+    "rebuild": "run-s clean build",
+    "reinstall": "run-s clean clean:deps ci",
+    "reinstall:angry": "npm run clean:dangerously && npm ci",
+    "release": "lerna publish",
+    "stage-synced-pkgs": "git add -A packages/appium/README.md \"packages/*/package.json\"",
     "start": "appium",
     "sync-pkgs": "run-p sync-pkgs:*",
     "sync-pkgs:appium-readme": "sync-monorepo-packages --force --no-package-json --packages=packages/appium README.md",
     "sync-pkgs:common-fields": "sync-monorepo-packages --fields=author,license,bugs,homepage,engines",
     "sync-pkgs:keywords": "sync-monorepo-packages --field=keywords --packages=\"packages/*\" --packages=\"!packages/eslint-config-appium\" --packages=\"!packages/types\" --packages=\"!packages/typedoc-plugin-appium\" --packages=\"!packages/eslint-config-appium-ts\" ",
     "sync-pkgs:license": "sync-monorepo-packages --force --no-package-json LICENSE",
-    "stage-synced-pkgs": "git add -A packages/appium/README.md \"packages/*/package.json\"",
-    "test": "run-p lint build:all && run-p test:unit test:types",
-    "test:ci": "run-s test:smoke test:unit test:e2e",
+    "test": "run-s test:quick",
+    "test:ci": "run-s test:smoke test:unit test:types test:e2e",
     "test:e2e": "lerna run --concurrency=2 test:e2e",
+    "test:quick": "run-s lint test:unit test:types",
+    "test:slow": "run-s test:quick test:smoke test:e2e",
     "test:smoke": "smoker --all test:smoke",
     "test:types": "lerna run test:types",
     "test:unit": "lerna run test",
     "typedoc": "typedoc --logLevel Verbose",
     "upload": "gulp github-upload",
-    "preversion": "run-s sync-pkgs stage-synced-pkgs",
-    "prepack": "npm run rebuild",
     "zip": "zip -qr ./appium.zip ./packages/appium",
     "zip-and-upload": "run-s zip upload"
   },
@@ -78,31 +85,32 @@
   },
   "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",
     "@types/diff": "5.0.3",
     "@types/mocha": "10.0.1",
-    "@types/node": "18.15.10",
+    "@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.0",
-    "@typescript-eslint/parser": "5.57.0",
+    "@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.36.0",
+    "eslint": "8.38.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-find-rules": "4.1.0",
-    "eslint-import-resolver-typescript": "3.5.3",
+    "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",
@@ -113,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",

packages/appium/CHANGELOG.md

@@ -3,6 +3,76 @@
 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
+
+
+
+
+
+# [2.0.0-beta.60](https://github.com/appium/appium/compare/appium@2.0.0-beta.59...appium@2.0.0-beta.60) (2023-04-04)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
+# [2.0.0-beta.59](https://github.com/appium/appium/compare/appium@2.0.0-beta.58...appium@2.0.0-beta.59) (2023-04-03)
+
+
+### Bug Fixes
+
+* **appium:** update dependency package-changed to v3 ([bbcaec9](https://github.com/appium/appium/commit/bbcaec9c05e93d522ae72e30368cecc876e16db7))
+* **types:** update dependency type-fest to v3.7.2 ([5580539](https://github.com/appium/appium/commit/55805390b5a0c6aa718bb357b30f66651f3db281))
+
+
+
+
+
 # [2.0.0-beta.58](https://github.com/appium/appium/compare/appium@2.0.0-beta.57...appium@2.0.0-beta.58) (2023-03-28)
 
 

packages/appium/README.md

@@ -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
 

packages/appium/docs/en/ecosystem/index.md

@@ -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|
 

packages/appium/docs/mkdocs-en.yml

@@ -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

packages/appium/docs/mkdocs-ja.yml

@@ -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

packages/appium/docs/mkdocs-zh.yml

@@ -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

packages/appium/lib/cli/args.js

@@ -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
  */

packages/appium/lib/cli/extension-command.js

@@ -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');
   }

packages/appium/lib/cli/parser.js

@@ -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});
+          }
         }
       }
     }

packages/appium/lib/extension/extension-config.js

@@ -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');
   }

packages/appium/lib/main.js

@@ -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;
 
@@ -113,17 +114,6 @@ async function logStartupInfo(args) {
   // }
 }
 
-/**
- * Logs the address and port the server is listening on
- * @param {string} address - Address
- * @param {number} port - Port
- * @returns {void}
- */
-function logServerPort(address, port) {
-  let logMessage = `Appium REST http interface listener started on ` + `${address}:${port}`;
-  logger.info(logMessage);
-}
-
 /**
  * Gets a list of `updateServer` functions from all extensions
  * @param {DriverNameMap} driverClasses
@@ -149,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.
  *
@@ -168,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();
 
@@ -374,7 +417,10 @@ async function main(args) {
     });
   }
 
-  logServerPort(parsedArgs.address, parsedArgs.port);
+  logger.info(
+    `Appium REST http interface listener started on ${parsedArgs.address}:${parsedArgs.port}${parsedArgs.basePath}`
+  );
+
   driverConfig.print();
   pluginConfig.print([...pluginClasses.values()]);
 

packages/appium/lib/schema/cli-args.js

@@ -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];
 }
 
 /**

packages/appium/lib/schema/schema.js

@@ -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;
   }

packages/appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.58",
+  "version": "2.0.0-beta.65",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -49,9 +49,9 @@
     "build:docs:cli": "node docs/scripts/gen-cli-args-docs.js",
     "build:docs:reference": "node docs/scripts/build-reference.js",
     "dev:docs": "npm run build:docs:assets && npm run dev:docs:en",
-    "dev:docs:en": "mkdocs serve -f ./docs/mkdocs-en.yml",
-    "dev:docs:ja": "mkdocs serve -f ./docs/mkdocs-ja.yml",
-    "dev:docs:zh": "mkdocs serve -f ./docs/mkdocs-zh.yml",
+    "dev:docs:en": "appium-docs build --serve --mkdocs-yml ./docs/mkdocs-en.yml",
+    "dev:docs:ja": "appium-docs build --serve --mkdocs-yml ./docs/mkdocs-ja.yml",
+    "dev:docs:zh": "appium-docs build --serve --mkdocs-yml ./docs/mkdocs-zh.yml",
     "postinstall": "node ./scripts/autoinstall-extensions.js",
     "publish:docs": "cross-env APPIUM_DOCS_PUBLISH=1 npm run build:docs",
     "test": "npm run test:unit",
@@ -60,12 +60,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.3.4",
-    "@appium/base-plugin": "^2.2.4",
-    "@appium/docutils": "^0.3.1",
+    "@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.8",
-    "@appium/types": "^0.10.2",
+    "@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",
@@ -87,12 +87,12 @@
     "lodash": "4.17.21",
     "npmlog": "7.0.1",
     "ora": "5.4.1",
-    "package-changed": "2.0.0",
+    "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.1",
+    "type-fest": "3.8.0",
     "winston": "3.8.2",
     "wrap-ansi": "7.0.0",
     "yaml": "2.2.1"
@@ -105,7 +105,7 @@
     "access": "public",
     "tag": "next"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72",
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
   "typedoc": {
     "entryPoint": "./lib/main.js"
   }

packages/appium/test/unit/parser.spec.js

@@ -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 () {

packages/base-driver/CHANGELOG.md

@@ -3,6 +3,38 @@
 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)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.7.2 ([5580539](https://github.com/appium/appium/commit/55805390b5a0c6aa718bb357b30f66651f3db281))
+
+
+
+
+
 ## [9.3.4](https://github.com/appium/appium/compare/@appium/base-driver@9.3.3...@appium/base-driver@9.3.4) (2023-03-28)
 
 

packages/base-driver/lib/basedriver/commands/index.ts

@@ -1,7 +1,6 @@
 import './event';
 import './find';
 import './log';
-import './session';
 import './settings';
 import './timeout';
 import './execute';

packages/base-driver/lib/basedriver/commands/session.ts

@@ -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);

packages/base-driver/lib/basedriver/driver.ts

@@ -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) {

packages/base-driver/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "9.3.4",
+  "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.8",
-    "@appium/types": "^0.10.2",
+    "@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.1",
+    "type-fest": "3.8.0",
     "validate.js": "0.13.1"
   },
   "engines": {
@@ -76,7 +76,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72",
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
   "typedoc": {
     "entryPoint": "./lib/index.js"
   },

packages/base-plugin/CHANGELOG.md

@@ -3,6 +3,30 @@
 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
+
+
+
+
+
 ## [2.2.4](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.3...@appium/base-plugin@2.2.4) (2023-03-28)
 
 

packages/base-plugin/README.md

@@ -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.

packages/base-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-plugin",
-  "version": "2.2.4",
+  "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.4",
-    "@appium/support": "^3.1.8"
+    "@appium/base-driver": "^9.3.7",
+    "@appium/support": "^3.1.11"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -50,7 +50,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72",
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
   "tags": [
     "appium"
   ],

packages/doctor/CHANGELOG.md

@@ -3,6 +3,33 @@
 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)
+
+
+### Bug Fixes
+
+* **doctor:** update dependency appium-adb to v9.11.0 ([d8b6334](https://github.com/appium/appium/commit/d8b633406a68e88cdd945906dde3f23a2a566a71))
+
+
+
+
+
 ## [2.0.10](https://github.com/appium/appium/compare/@appium/doctor@2.0.9...@appium/doctor@2.0.10) (2023-03-28)
 
 **Note:** Version bump only for package @appium/doctor

packages/doctor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/doctor",
-  "version": "2.0.10",
+  "version": "2.0.13",
   "description": "Test environment for fitness to run Appium",
   "keywords": [
     "automation",
@@ -44,11 +44,11 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^3.1.8",
+    "@appium/support": "^3.1.11",
     "@colors/colors": "1.5.0",
     "@types/bluebird": "3.5.38",
     "@types/teen_process": "2.0.0",
-    "appium-adb": "9.10.24",
+    "appium-adb": "9.11.0",
     "bluebird": "3.7.2",
     "inquirer": "8.2.5",
     "lodash": "4.17.21",
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/docutils/CHANGELOG.md

@@ -3,6 +3,70 @@
 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
+
+
+
+
+
+## [0.3.3](https://github.com/appium/appium/compare/@appium/docutils@0.3.2...@appium/docutils@0.3.3) (2023-04-04)
+
+**Note:** Version bump only for package @appium/docutils
+
+
+
+
+
+## [0.3.2](https://github.com/appium/appium/compare/@appium/docutils@0.3.1...@appium/docutils@0.3.2) (2023-04-03)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.7.2 ([5580539](https://github.com/appium/appium/commit/55805390b5a0c6aa718bb357b30f66651f3db281))
+
+
+
+
+
 ## [0.3.1](https://github.com/appium/appium/compare/@appium/docutils@0.3.0...@appium/docutils@0.3.1) (2023-03-28)
 
 

packages/docutils/lib/builder/deploy.ts

@@ -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());
   }
 }
 

packages/docutils/lib/builder/nav.ts

@@ -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`

packages/docutils/lib/builder/reference.ts

@@ -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_

packages/docutils/lib/builder/site.ts

@@ -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());
   }
 }
 

packages/docutils/lib/cli/check.ts

@@ -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

packages/docutils/lib/cli/command/build.ts

@@ -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) {

packages/docutils/lib/cli/command/init.ts

@@ -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:',

packages/docutils/lib/cli/command/validate.ts

@@ -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:',

packages/docutils/lib/cli/config.ts

@@ -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

packages/docutils/lib/cli/index.ts

@@ -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);
       }

packages/docutils/lib/fs.ts

@@ -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`

packages/docutils/lib/index.ts

@@ -8,3 +8,4 @@ export * from './builder';
 export * from './validate';
 export * from './scaffold';
 export * from './constants';
+export * from './logger';

packages/docutils/lib/init.ts

@@ -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'];
 /**

packages/docutils/lib/logger.ts

@@ -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();
+    }
+  }
+});

packages/docutils/lib/scaffold.ts

@@ -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

packages/docutils/lib/validate.ts

@@ -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

packages/docutils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/docutils",
-  "version": "0.3.1",
+  "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.8",
-    "@appium/tsconfig": "^0.2.4",
-    "@appium/typedoc-plugin-appium": "^0.5.2",
+    "@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.1",
+    "type-fest": "3.8.0",
     "typedoc": "0.23.28",
     "typedoc-plugin-markdown": "3.14.0",
     "typedoc-plugin-resolve-crossmodule-references": "0.3.3",
@@ -83,5 +83,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/docutils/requirements.txt

@@ -1,4 +1,4 @@
 mkdocs==1.4.2
-mkdocs-material==9.1.4
+mkdocs-material==9.1.6
 mkdocs-material-extensions==1.1.1
 mike==1.1.2

packages/driver-test-support/CHANGELOG.md

@@ -3,6 +3,38 @@
 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)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.7.2 ([5580539](https://github.com/appium/appium/commit/55805390b5a0c6aa718bb357b30f66651f3db281))
+
+
+
+
+
 ## [0.4.2](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.1...@appium/driver-test-support@0.4.2) (2023-03-28)
 
 

packages/driver-test-support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/driver-test-support",
-  "version": "0.4.2",
+  "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.2",
-    "@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.1"
+    "type-fest": "3.8.0"
   },
   "peerDependencies": {
     "appium": "^2.0.0-beta.43",
@@ -65,5 +65,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
+  "typedoc": {
+    "entryPoint": "./lib/index.js"
+  },
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/eslint-config-appium-ts/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.3.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.3.0...@appium/eslint-config-appium-ts@0.3.1) (2023-04-03)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
 # [0.3.0](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.2.0...@appium/eslint-config-appium-ts@0.3.0) (2023-03-28)
 
 

packages/eslint-config-appium-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/eslint-config-appium-ts",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Shared ESLint config for Appium projects (TypeScript version)",
   "keywords": [
     "eslint",
@@ -44,5 +44,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/eslint-config-appium/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.3](https://github.com/appium/appium/compare/@appium/eslint-config-appium@8.0.2...@appium/eslint-config-appium@8.0.3) (2023-04-03)
+
+**Note:** Version bump only for package @appium/eslint-config-appium
+
+
+
+
+
 ## [8.0.2](https://github.com/appium/appium/compare/@appium/eslint-config-appium@8.0.1...@appium/eslint-config-appium@8.0.2) (2023-03-28)
 
 

packages/eslint-config-appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/eslint-config-appium",
-  "version": "8.0.2",
+  "version": "8.0.3",
   "description": "Shared ESLint config for Appium projects",
   "keywords": [
     "eslint",
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72"
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/execute-driver-plugin/CHANGELOG.md

@@ -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.
 
+## [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
+
+
+
+
+
 ## [3.0.9](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.8...@appium/execute-driver-plugin@3.0.9) (2023-03-28)
 
 

packages/execute-driver-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/execute-driver-plugin",
-  "version": "3.0.9",
+  "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": {
@@ -59,7 +59,7 @@
     "pluginName": "execute-driver",
     "mainClass": "ExecuteDriverPlugin"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72",
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
   "typedoc": {
     "entryPoint": "./lib/plugin.js"
   }

packages/fake-driver/CHANGELOG.md

@@ -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.
 
+## [5.2.3](https://github.com/appium/appium/compare/@appium/fake-driver@5.2.2...@appium/fake-driver@5.2.3) (2023-04-03)
+
+
+### Bug Fixes
+
+* **universal-xml-plugin:** update dependency @xmldom/xmldom to v0.8.7 ([b9d339e](https://github.com/appium/appium/commit/b9d339eaf3527a0642f4fd904f447c80e2c2165b))
+
+
+
+
+
 ## [5.2.2](https://github.com/appium/appium/compare/@appium/fake-driver@5.2.1...@appium/fake-driver@5.2.2) (2023-03-28)
 
 

packages/fake-driver/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/fake-driver",
-  "version": "5.2.2",
+  "version": "5.2.3",
   "description": "Mock driver used internally by Appium for testing. Ignore",
   "keywords": [
     "automation",
@@ -47,7 +47,7 @@
   },
   "dependencies": {
     "@types/bluebird": "3.5.38",
-    "@xmldom/xmldom": "0.8.6",
+    "@xmldom/xmldom": "0.8.7",
     "asyncbox": "2.9.4",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",
@@ -83,5 +83,5 @@
     "entryPoint": "./lib/index.js"
   },
   "types": "./build/lib/index.d.ts",
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/fake-plugin/CHANGELOG.md

@@ -3,6 +3,30 @@
 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
+
+
+
+
+
 ## [3.1.8](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.7...@appium/fake-plugin@3.1.8) (2023-03-28)
 
 **Note:** Version bump only for package @appium/fake-plugin

packages/fake-plugin/lib/plugin.js

@@ -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);

packages/fake-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/fake-plugin",
-  "version": "3.1.8",
+  "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.4",
-    "@appium/support": "^3.1.8",
+    "@appium/base-plugin": "^2.2.7",
+    "@appium/support": "^3.1.11",
     "@types/bluebird": "3.5.38",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",
@@ -64,7 +64,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72",
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
   "tags": [
     "appium"
   ],

packages/images-plugin/CHANGELOG.md

@@ -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.10](https://github.com/appium/appium/compare/@appium/images-plugin@2.0.9...@appium/images-plugin@2.0.10) (2023-04-05)
+
+**Note:** Version bump only for package @appium/images-plugin
+
+
+
+
+
+## [2.0.9](https://github.com/appium/appium/compare/@appium/images-plugin@2.0.8...@appium/images-plugin@2.0.9) (2023-04-03)
+
+**Note:** Version bump only for package @appium/images-plugin
+
+
+
+
+
 ## [2.0.8](https://github.com/appium/appium/compare/@appium/images-plugin@2.0.7...@appium/images-plugin@2.0.8) (2023-03-08)
 
 

packages/images-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/images-plugin",
-  "version": "2.0.8",
+  "version": "2.0.10",
   "description": "Plugin for working with images and image elements in Appium",
   "keywords": [
     "automation",
@@ -39,7 +39,7 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/opencv": "^2.0.8",
+    "@appium/opencv": "^2.0.10",
     "lodash": "4.17.21",
     "lru-cache": "7.18.3",
     "source-map-support": "0.5.21"

packages/opencv/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.10](https://github.com/appium/appium/compare/@appium/opencv@2.0.9...@appium/opencv@2.0.10) (2023-04-05)
+
+
+### Bug Fixes
+
+* **opencv:** fix a type error causing typedoc problems ([bb11d1c](https://github.com/appium/appium/commit/bb11d1cfe9681ccd457f0677118725a6e9ddd72f))
+
+
+
+
+
+## [2.0.9](https://github.com/appium/appium/compare/@appium/opencv@2.0.8...@appium/opencv@2.0.9) (2023-04-03)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
 ## [2.0.8](https://github.com/appium/appium/compare/@appium/opencv@2.0.7...@appium/opencv@2.0.8) (2023-03-08)
 
 

packages/opencv/lib/index.js

@@ -360,12 +360,12 @@ async function getImagesMatches(img1Data, img2Data, options = {}) {
  * as an image (useful for debugging purposes)
  * @property {string} method [TM_CCOEFF_NORMED] The name of the template matching method.
  * Acceptable values are:
- * - TM_CCOEFF
- * - TM_CCOEFF_NORMED (default)
- * - TM_CCORR
- * - TM_CCORR_NORMED
- * - TM_SQDIFF
- * - TM_SQDIFF_NORMED
+ * - `TM_CCOEFF`
+ * - `TM_CCOEFF_NORMED` (default)
+ * - `TM_CCORR`
+ * - `TM_CCORR_NORMED`
+ * - `TM_SQDIFF`
+ * - `TM_SQDIFF_NORMED`
  * Read https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_imgproc/py_template_matching/py_template_matching.html
  * for more details.
  */
@@ -475,7 +475,7 @@ async function getImagesSimilarity(img1Data, img2Data, options = {}) {
  */
 
 /**
- * @typedef {'TM_CCOEFF'|'TM_CCOEFF_NORMED|'TM_CCORR'|'TM_CCORR_NORMED'|'TM_SQDIFF'|'TMSQDIFF_NORMED'} OccurrenceResultMethod
+ * @typedef {'TM_CCOEFF'|'TM_CCOEFF_NORMED'|'TM_CCORR'|'TM_CCORR_NORMED'|'TM_SQDIFF'|'TMSQDIFF_NORMED'} OccurrenceResultMethod
  */
 
 /**
@@ -492,12 +492,12 @@ async function getImagesSimilarity(img1Data, img2Data, options = {}) {
  * - only when multiple option is passed
  * @property {OccurrenceResultMethod} [method='TM_CCOEFF_NORMED'] The name of the template matching method.
  * Acceptable values are:
- * - TM_CCOEFF
- * - TM_CCOEFF_NORMED (default)
- * - TM_CCORR
- * - TM_CCORR_NORMED
- * - TM_SQDIFF
- * - TM_SQDIFF_NORMED
+ * - `TM_CCOEFF`
+ * - `TM_CCOEFF_NORMED` (default)
+ * - `TM_CCORR`
+ * - `TM_CCORR_NORMED`
+ * - `TM_SQDIFF`
+ * - `TM_SQDIFF_NORMED`
  * Read https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_imgproc/py_template_matching/py_template_matching.html
  * for more details.
  */

packages/opencv/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/opencv",
-  "version": "2.0.8",
+  "version": "2.0.10",
   "description": "OpenCV-related helper library",
   "keywords": [
     "automation",
@@ -55,5 +55,8 @@
   "publishConfig": {
     "access": "public"
   },
+  "typedoc": {
+    "entryPoint": "./lib/index.js"
+  },
   "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
 }

packages/plugin-test-support/CHANGELOG.md

@@ -3,6 +3,30 @@
 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
+
+
+
+
+
 ## [0.3.10](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.9...@appium/plugin-test-support@0.3.10) (2023-03-28)
 
 **Note:** Version bump only for package @appium/plugin-test-support

packages/plugin-test-support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/plugin-test-support",
-  "version": "0.3.10",
+  "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.2",
+    "@appium/types": "^0.11.0",
     "get-port": "5.1.1",
     "log-symbols": "4.1.0",
     "source-map-support": "0.5.21",
@@ -58,5 +58,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
+  "typedoc": {
+    "entryPoint": "./lib/harness.js"
+  },
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/strongbox/CHANGELOG.md

@@ -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))

packages/strongbox/README.md

@@ -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

packages/strongbox/lib/base-item.ts

@@ -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;
+      }
+    }
+  }
+}

packages/strongbox/lib/index.ts

@@ -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};

packages/strongbox/lib/util.ts

@@ -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);
+}

packages/strongbox/package.json

@@ -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"
+  }
+}

packages/strongbox/test/types/strongbox.test-d.ts

@@ -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>({});

packages/strongbox/test/unit/strongbox.spec.ts

@@ -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();
+  });
+});

packages/strongbox/tsconfig.json

@@ -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"]
+}

packages/support/CHANGELOG.md

@@ -3,6 +3,40 @@
 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)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.7.2 ([5580539](https://github.com/appium/appium/commit/55805390b5a0c6aa718bb357b30f66651f3db281))
+
+
+
+
+
 ## [3.1.8](https://github.com/appium/appium/compare/@appium/support@3.1.7...@appium/support@3.1.8) (2023-03-28)
 
 

packages/support/lib/net.js

@@ -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(),

packages/support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/support",
-  "version": "3.1.8",
+  "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.2",
+    "@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.1",
+    "type-fest": "3.8.0",
     "uuid": "9.0.0",
     "which": "3.0.0",
     "yauzl": "2.10.0"
@@ -107,7 +107,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72",
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
   "typedoc": {
     "entryPoint": "./lib/index.js"
   }

packages/support/test/e2e/net.e2e.spec.js

@@ -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;
     });
   });

packages/test-support/CHANGELOG.md

@@ -3,6 +3,30 @@
 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
+
+
+
+
+
 ## [3.0.10](https://github.com/appium/appium/compare/@appium/test-support@3.0.9...@appium/test-support@3.0.10) (2023-03-28)
 
 

packages/test-support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/test-support",
-  "version": "3.0.10",
+  "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.8",
+    "@appium/support": "^3.1.11",
     "@colors/colors": "1.5.0",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",
@@ -60,5 +60,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "84b211330dc84849af9cc1f3a5c5ad32e15b2e72"
+  "typedoc": {
+    "entryPoint": "./lib/index.js"
+  },
+  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/tsconfig/CHANGELOG.md

@@ -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)
 
 

packages/tsconfig/package.json

@@ -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": [

packages/tsconfig/tsconfig.json

@@ -16,6 +16,7 @@
     "sourceMap": true,
     "removeComments": false,
     "strict": false,
-    "types": ["node"]
+    "types": ["node"],
+    "lib": ["es2020", "ES2021.WeakRef"]
   }
 }

packages/typedoc-plugin-appium/CHANGELOG.md

@@ -3,6 +3,68 @@
 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)
+
+
+### Features
+
+* **typedoc-plugin-appium:** enable comment derivation via reflection types ([b808dc8](https://github.com/appium/appium/commit/b808dc866d6587269d8adbe8d354471b3a1ba6de))
+
+
+
+
+
+## [0.5.4](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.5.3...@appium/typedoc-plugin-appium@0.5.4) (2023-04-04)
+
+
+### Bug Fixes
+
+* **typedoc-plugin-appium:** allow ts v5 as peer dep ([822206b](https://github.com/appium/appium/commit/822206be204599390c2f97b9b8d6c618ff53cb89))
+
+
+
+
+
+## [0.5.3](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.5.2...@appium/typedoc-plugin-appium@0.5.3) (2023-04-03)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.7.2 ([5580539](https://github.com/appium/appium/commit/55805390b5a0c6aa718bb357b30f66651f3db281))
+
+
+
+
+
 ## [0.5.2](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.5.1...@appium/typedoc-plugin-appium@0.5.2) (2023-03-28)
 
 

packages/typedoc-plugin-appium/lib/converter/builtin-external-driver.ts

@@ -41,14 +41,14 @@ export class BuiltinExternalDriverConverter extends BaseConverter<KnownMethods>
     methods = findCommandMethodsInReflection(externalDriverRefl);
 
     if (!methods.size) {
-      this.log.error('No methods found in %s', NAME_EXTERNAL_DRIVER);
+      this.log.error('(%s) No methods found! This is a bug.', NAME_EXTERNAL_DRIVER);
       return methods;
     }
 
     this.log.verbose(
-      'Done; found %s in %s',
-      pluralize('builtin command method', methods.size, true),
-      NAME_EXTERNAL_DRIVER
+      '(%s) Done; found %s',
+      NAME_EXTERNAL_DRIVER,
+      pluralize('builtin command method', methods.size, true)
     );
 
     return methods;

packages/typedoc-plugin-appium/lib/converter/comment/finder.ts

@@ -8,7 +8,7 @@ import {CommentSource} from '../types';
 const nullFinder: CommentFinder = {
   /**
    *
-   * @returns A comment probably from the method map itself
+   * @returns A comment which was directly provided
    */
   getter: ({comment}) => comment,
   commentSource: CommentSource.OtherComment,