appium-uiautomator2-driver 2.31.3 → 2.32.0

package/lib/commands/general.js

@@ -7,6 +7,8 @@ import {APK_EXTENSION} from '../extensions';
 import {mixin} from './mixins';
 import {AndroidUiautomator2Driver} from '../driver';
 
+const MOBILE_SCRIPT_NAME_PREFIX = 'mobile:';
+
 /**
  * Massages the arguments going into an execute method.
  * @remarks A similar method is implemented in `appium-xcuitest-driver`, but it
@@ -38,10 +40,12 @@ function preprocessExecuteMethodArgs(args) {
  * Type guard to check if a script is an execute method.
  * @param {any} script
  * @internal
- * @returns {script is keyof import('../execute-method-map').Uiautomator2ExecuteMethodMap}
+ * @returns {string?}
  */
-function isExecuteMethod(script) {
-  return script in AndroidUiautomator2Driver.executeMethodMap;
+function toExecuteMethodName(script) {
+  return _.startsWith(script, MOBILE_SCRIPT_NAME_PREFIX)
+    ? script.replace(new RegExp(`${MOBILE_SCRIPT_NAME_PREFIX}\\s*`), `${MOBILE_SCRIPT_NAME_PREFIX} `)
+    : null;
 }
 
 /**
@@ -127,13 +131,16 @@ const GeneralMixin = {
    * into `BaseDriver.executeMethod`.
    */
   async execute(script, args) {
-    if (isExecuteMethod(script)) {
-      const executeMethodArgs = preprocessExecuteMethodArgs(args);
-      this.log.info(`Executing native command '${script}'`);
-      return await this.executeMobile(script, executeMethodArgs);
-    }
-    if (!this.isWebContext()) {
-      throw new errors.NotImplementedError();
+    const mobileScriptName = toExecuteMethodName(script);
+    const isWebContext = this.isWebContext();
+    if (mobileScriptName && isWebContext || !isWebContext) {
+      if (mobileScriptName) {
+        const executeMethodArgs = preprocessExecuteMethodArgs(args);
+        this.log.info(`Executing method '${mobileScriptName}'`);
+        return await this.executeMobile(mobileScriptName, executeMethodArgs);
+      }
+      // Just pass the script name through and let it fail with a proper error message
+      return await this.executeMobile(`${script}`, {});
     }
     const endpoint =
       /** @type {import('appium-chromedriver').Chromedriver} */ (this.chromedriver).jwproxy
@@ -153,9 +160,10 @@ const GeneralMixin = {
    * @override
    */
   async executeMobile(script, opts = {}) {
-    if (!isExecuteMethod(script)) {
-      const commandNames = _.map(_.keys(AndroidUiautomator2Driver.executeMethodMap), (value) =>
-        value.slice(8)
+    if (!(script in AndroidUiautomator2Driver.executeMethodMap)) {
+      const commandNames = _.map(
+        _.keys(AndroidUiautomator2Driver.executeMethodMap),
+        (value) => value.slice(8)
       );
       throw new errors.UnknownCommandError(
         `Unknown mobile command "${script}". ` +

package/lib/execute-method-map.ts

@@ -112,6 +112,14 @@ export const executeMethodMap = {
     command: 'mobileStopLogsBroadcast',
   },
 
+  'mobile: deviceidle': {
+    command: 'mobileDeviceidle',
+    params: {
+      required: ['action'],
+      optional: ['packages'],
+    },
+  },
+
   'mobile: acceptAlert': {
     command: 'mobileAcceptAlert',
     params: {

package/npm-shrinkwrap.json

@@ -1,16 +1,16 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "2.31.3",
+  "version": "2.32.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "2.31.3",
+      "version": "2.32.0",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^9.14.12",
-        "appium-android-driver": "^7.0.1",
+        "appium-android-driver": "^7.1.0",
         "appium-chromedriver": "^5.6.5",
         "appium-uiautomator2-server": "^5.12.2",
         "asyncbox": "^2.3.1",
@@ -21,7 +21,7 @@
         "portscanner": "^2.2.0",
         "source-map-support": "^0.x",
         "teen_process": "^2.0.0",
-        "type-fest": "^3.12.0"
+        "type-fest": "^4.4.0"
       },
       "devDependencies": {
         "@appium/docutils": "^0.4.4",
@@ -64,16 +64,16 @@
         "eslint-plugin-promise": "^6.1.1",
         "fancy-log": "^2.0.0",
         "husky": "^8.0.3",
-        "lint-staged": "^14.0.0",
+        "lint-staged": "^15.0.1",
         "mocha": "^10.0.0",
-        "prettier": "^2.8.8",
+        "prettier": "^3.0.3",
         "rimraf": "^5.0.0",
-        "semantic-release": "^21.1.0",
+        "semantic-release": "^22.0.5",
         "sharp": "^0.x",
         "sinon": "^16.1.0",
         "sinon-chai": "^3.7.0",
         "ts-node": "^10.9.1",
-        "typescript": "~5.0",
+        "typescript": "~5.2",
         "unzipper": "^0.x",
         "webdriverio": "^8.0.5",
         "xpath": "^0.x"
@@ -138,6 +138,16 @@
         "proxy-from-env": "^1.1.0"
       }
     },
+    "node_modules/@appium/base-driver/node_modules/type-fest": {
+      "version": "3.13.1",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=14.16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@appium/base-plugin": {
       "version": "2.2.20",
       "extraneous": true,
@@ -192,6 +202,61 @@
         "npm": ">=8"
       }
     },
+    "node_modules/@appium/docutils/node_modules/@appium/typedoc-plugin-appium": {
+      "version": "0.6.6",
+      "dev": true,
+      "license": "Apache-2.0",
+      "dependencies": {
+        "handlebars": "4.7.8",
+        "lodash": "4.17.21",
+        "pluralize": "8.0.0",
+        "type-fest": "3.13.1"
+      },
+      "engines": {
+        "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
+        "npm": ">=8"
+      },
+      "peerDependencies": {
+        "appium": "^2.0.0-beta.48",
+        "typedoc": "~0.23.14",
+        "typedoc-plugin-markdown": "3.14.0",
+        "typedoc-plugin-resolve-crossmodule-references": "~0.3.3",
+        "typescript": "^4.7.0 || ^5.0.0"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/brace-expansion": {
+      "version": "2.0.1",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "balanced-match": "^1.0.0"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/marked": {
+      "version": "4.3.0",
+      "dev": true,
+      "license": "MIT",
+      "bin": {
+        "marked": "bin/marked.js"
+      },
+      "engines": {
+        "node": ">= 12"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/minimatch": {
+      "version": "7.4.6",
+      "dev": true,
+      "license": "ISC",
+      "dependencies": {
+        "brace-expansion": "^2.0.1"
+      },
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/isaacs"
+      }
+    },
     "node_modules/@appium/docutils/node_modules/teen_process": {
       "version": "2.0.4",
       "dev": true,
@@ -207,6 +272,74 @@
         "npm": ">=8"
       }
     },
+    "node_modules/@appium/docutils/node_modules/type-fest": {
+      "version": "3.13.1",
+      "dev": true,
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=14.16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/typedoc": {
+      "version": "0.23.28",
+      "dev": true,
+      "license": "Apache-2.0",
+      "dependencies": {
+        "lunr": "^2.3.9",
+        "marked": "^4.2.12",
+        "minimatch": "^7.1.3",
+        "shiki": "^0.14.1"
+      },
+      "bin": {
+        "typedoc": "bin/typedoc"
+      },
+      "engines": {
+        "node": ">= 14.14"
+      },
+      "peerDependencies": {
+        "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/typedoc-plugin-markdown": {
+      "version": "3.14.0",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "handlebars": "^4.7.7"
+      },
+      "peerDependencies": {
+        "typedoc": ">=0.23.0"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/typedoc-plugin-resolve-crossmodule-references": {
+      "version": "0.3.3",
+      "dev": true,
+      "license": "Apache-2.0",
+      "workspaces": [
+        "test/packages/*"
+      ],
+      "engines": {
+        "node": ">=14"
+      },
+      "peerDependencies": {
+        "typedoc": ">=0.22 <=0.23"
+      }
+    },
+    "node_modules/@appium/docutils/node_modules/typescript": {
+      "version": "5.0.4",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=12.20"
+      }
+    },
     "node_modules/@appium/schema": {
       "version": "0.3.1",
       "license": "Apache-2.0",
@@ -342,37 +475,25 @@
         "npm": ">=8"
       }
     },
-    "node_modules/@appium/tsconfig": {
-      "version": "0.3.1",
-      "license": "Apache-2.0",
-      "dependencies": {
-        "@tsconfig/node14": "1.0.3"
-      },
+    "node_modules/@appium/support/node_modules/type-fest": {
+      "version": "3.13.1",
+      "license": "(MIT OR CC0-1.0)",
       "engines": {
-        "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-        "npm": ">=8"
+        "node": ">=14.16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
       }
     },
-    "node_modules/@appium/typedoc-plugin-appium": {
-      "version": "0.6.6",
-      "dev": true,
+    "node_modules/@appium/tsconfig": {
+      "version": "0.3.1",
       "license": "Apache-2.0",
       "dependencies": {
-        "handlebars": "4.7.8",
-        "lodash": "4.17.21",
-        "pluralize": "8.0.0",
-        "type-fest": "3.13.1"
+        "@tsconfig/node14": "1.0.3"
       },
       "engines": {
         "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
         "npm": ">=8"
-      },
-      "peerDependencies": {
-        "appium": "^2.0.0-beta.48",
-        "typedoc": "~0.23.14",
-        "typedoc-plugin-markdown": "3.14.0",
-        "typedoc-plugin-resolve-crossmodule-references": "~0.3.3",
-        "typescript": "^4.7.0 || ^5.0.0"
       }
     },
     "node_modules/@appium/types": {
@@ -398,6 +519,16 @@
         "@types/node": "*"
       }
     },
+    "node_modules/@appium/types/node_modules/type-fest": {
+      "version": "3.13.1",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=14.16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@babel/code-frame": {
       "version": "7.22.13",
       "license": "MIT",
@@ -1044,7 +1175,7 @@
       }
     },
     "node_modules/appium-android-driver": {
-      "version": "7.0.2",
+      "version": "7.1.0",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^9.12.0",
@@ -1057,8 +1188,7 @@
         "lru-cache": "^10.0.1",
         "moment": "^2.24.0",
         "moment-timezone": "^0.5.26",
-        "portfinder": "^1.0.6",
-        "portscanner": "2.2.0",
+        "portscanner": "^2.2.0",
         "semver": "^7.0.0",
         "source-map-support": "^0.x",
         "teen_process": "^2.0.0",
@@ -1080,16 +1210,6 @@
         "node": "14 || >=16.14"
       }
     },
-    "node_modules/appium-android-driver/node_modules/type-fest": {
-      "version": "4.4.0",
-      "license": "(MIT OR CC0-1.0)",
-      "engines": {
-        "node": ">=16"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/sindresorhus"
-      }
-    },
     "node_modules/appium-chromedriver": {
       "version": "5.6.13",
       "hasInstallScript": true,
@@ -3039,7 +3159,7 @@
       "license": "MIT"
     },
     "node_modules/node-abi": {
-      "version": "3.50.0",
+      "version": "3.51.0",
       "license": "MIT",
       "optional": true,
       "dependencies": {
@@ -3333,32 +3453,6 @@
         "node": ">=4"
       }
     },
-    "node_modules/portfinder": {
-      "version": "1.0.32",
-      "license": "MIT",
-      "dependencies": {
-        "async": "^2.6.4",
-        "debug": "^3.2.7",
-        "mkdirp": "^0.5.6"
-      },
-      "engines": {
-        "node": ">= 0.12.0"
-      }
-    },
-    "node_modules/portfinder/node_modules/async": {
-      "version": "2.6.4",
-      "license": "MIT",
-      "dependencies": {
-        "lodash": "^4.17.14"
-      }
-    },
-    "node_modules/portfinder/node_modules/debug": {
-      "version": "3.2.7",
-      "license": "MIT",
-      "dependencies": {
-        "ms": "^2.1.1"
-      }
-    },
     "node_modules/portscanner": {
       "version": "2.2.0",
       "license": "MIT",
@@ -4185,10 +4279,10 @@
       }
     },
     "node_modules/type-fest": {
-      "version": "3.13.1",
+      "version": "4.4.0",
       "license": "(MIT OR CC0-1.0)",
       "engines": {
-        "node": ">=14.16"
+        "node": ">=16"
       },
       "funding": {
         "url": "https://github.com/sponsors/sindresorhus"
@@ -4205,86 +4299,8 @@
         "node": ">= 0.6"
       }
     },
-    "node_modules/typedoc": {
-      "version": "0.23.28",
-      "dev": true,
-      "license": "Apache-2.0",
-      "dependencies": {
-        "lunr": "^2.3.9",
-        "marked": "^4.2.12",
-        "minimatch": "^7.1.3",
-        "shiki": "^0.14.1"
-      },
-      "bin": {
-        "typedoc": "bin/typedoc"
-      },
-      "engines": {
-        "node": ">= 14.14"
-      },
-      "peerDependencies": {
-        "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x"
-      }
-    },
-    "node_modules/typedoc-plugin-markdown": {
-      "version": "3.14.0",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "handlebars": "^4.7.7"
-      },
-      "peerDependencies": {
-        "typedoc": ">=0.23.0"
-      }
-    },
-    "node_modules/typedoc-plugin-resolve-crossmodule-references": {
-      "version": "0.3.3",
-      "dev": true,
-      "license": "Apache-2.0",
-      "workspaces": [
-        "test/packages/*"
-      ],
-      "engines": {
-        "node": ">=14"
-      },
-      "peerDependencies": {
-        "typedoc": ">=0.22 <=0.23"
-      }
-    },
-    "node_modules/typedoc/node_modules/brace-expansion": {
-      "version": "2.0.1",
-      "dev": true,
-      "license": "MIT",
-      "dependencies": {
-        "balanced-match": "^1.0.0"
-      }
-    },
-    "node_modules/typedoc/node_modules/marked": {
-      "version": "4.3.0",
-      "dev": true,
-      "license": "MIT",
-      "bin": {
-        "marked": "bin/marked.js"
-      },
-      "engines": {
-        "node": ">= 12"
-      }
-    },
-    "node_modules/typedoc/node_modules/minimatch": {
-      "version": "7.4.6",
-      "dev": true,
-      "license": "ISC",
-      "dependencies": {
-        "brace-expansion": "^2.0.1"
-      },
-      "engines": {
-        "node": ">=10"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/isaacs"
-      }
-    },
     "node_modules/typescript": {
-      "version": "5.0.4",
+      "version": "5.2.2",
       "dev": true,
       "license": "Apache-2.0",
       "bin": {
@@ -4292,7 +4308,7 @@
         "tsserver": "bin/tsserver"
       },
       "engines": {
-        "node": ">=12.20"
+        "node": ">=14.17"
       }
     },
     "node_modules/uglify-js": {

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "2.31.3",
+  "version": "2.32.0",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },
@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "appium-adb": "^9.14.12",
-    "appium-android-driver": "^7.0.1",
+    "appium-android-driver": "^7.1.0",
     "appium-chromedriver": "^5.6.5",
     "appium-uiautomator2-server": "^5.12.2",
     "asyncbox": "^2.3.1",
@@ -74,7 +74,7 @@
     "portscanner": "^2.2.0",
     "source-map-support": "^0.x",
     "teen_process": "^2.0.0",
-    "type-fest": "^3.12.0"
+    "type-fest": "^4.4.0"
   },
   "devDependencies": {
     "@appium/docutils": "^0.4.4",
@@ -117,16 +117,16 @@
     "eslint-plugin-promise": "^6.1.1",
     "fancy-log": "^2.0.0",
     "husky": "^8.0.3",
-    "lint-staged": "^14.0.0",
+    "lint-staged": "^15.0.1",
     "mocha": "^10.0.0",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.3",
     "rimraf": "^5.0.0",
-    "semantic-release": "^21.1.0",
+    "semantic-release": "^22.0.5",
     "sharp": "^0.x",
     "sinon": "^16.1.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.1",
-    "typescript": "~5.0",
+    "typescript": "~5.2",
     "unzipper": "^0.x",
     "webdriverio": "^8.0.5",
     "xpath": "^0.x"