appium-android-driver 5.14.7 → 6.0.0

package/lib/method-map.js

@@ -1,169 +1,164 @@
 export const newMethodMap = /** @type {const} */ ({
   '/session/:sessionId/timeouts/implicit_wait': {
-    POST: { command: 'implicitWait', payloadParams: { required: ['ms'] } }
+    POST: {command: 'implicitWait', payloadParams: {required: ['ms']}},
   },
-  '/session/:sessionId/ime/available_engines': { GET: { command: 'availableIMEEngines' } },
-  '/session/:sessionId/ime/active_engine': { GET: { command: 'getActiveIMEEngine' } },
-  '/session/:sessionId/ime/activated': { GET: { command: 'isIMEActivated' } },
-  '/session/:sessionId/ime/deactivate': { POST: { command: 'deactivateIMEEngine' } },
+  '/session/:sessionId/ime/available_engines': {GET: {command: 'availableIMEEngines'}},
+  '/session/:sessionId/ime/active_engine': {GET: {command: 'getActiveIMEEngine'}},
+  '/session/:sessionId/ime/activated': {GET: {command: 'isIMEActivated'}},
+  '/session/:sessionId/ime/deactivate': {POST: {command: 'deactivateIMEEngine'}},
   '/session/:sessionId/ime/activate': {
     POST: {
       command: 'activateIMEEngine',
-      payloadParams: { required: ['engine'] }
-    }
+      payloadParams: {required: ['engine']},
+    },
   },
-  '/session/:sessionId/window/:windowhandle/size': { GET: { command: 'getWindowSize' } },
+  '/session/:sessionId/window/:windowhandle/size': {GET: {command: 'getWindowSize'}},
   '/session/:sessionId/keys': {
-    POST: { command: 'keys', payloadParams: { required: ['value'] } }
+    POST: {command: 'keys', payloadParams: {required: ['value']}},
   },
-  '/session/:sessionId/element/:elementId/location': { GET: { command: 'getLocation' } },
-  '/session/:sessionId/element/:elementId/location_in_view': { GET: { command: 'getLocationInView' } },
-  '/session/:sessionId/element/:elementId/size': { GET: { command: 'getSize' } },
+  '/session/:sessionId/element/:elementId/location': {GET: {command: 'getLocation'}},
+  '/session/:sessionId/element/:elementId/location_in_view': {GET: {command: 'getLocationInView'}},
+  '/session/:sessionId/element/:elementId/size': {GET: {command: 'getSize'}},
   '/session/:sessionId/touch/click': {
-    POST: { command: 'click', payloadParams: { required: ['element'] } }
+    POST: {command: 'click', payloadParams: {required: ['element']}},
   },
   '/session/:sessionId/touch/down': {
-    POST: { command: 'touchDown', payloadParams: { required: ['x', 'y'] } }
+    POST: {command: 'touchDown', payloadParams: {required: ['x', 'y']}},
   },
   '/session/:sessionId/touch/up': {
-    POST: { command: 'touchUp', payloadParams: { required: ['x', 'y'] } }
+    POST: {command: 'touchUp', payloadParams: {required: ['x', 'y']}},
   },
   '/session/:sessionId/touch/move': {
-    POST: { command: 'touchMove', payloadParams: { required: ['x', 'y'] } }
+    POST: {command: 'touchMove', payloadParams: {required: ['x', 'y']}},
   },
   '/session/:sessionId/touch/longclick': {
     POST: {
       command: 'touchLongClick',
-      payloadParams: { required: ['elements'] }
-    }
+      payloadParams: {required: ['elements']},
+    },
   },
   '/session/:sessionId/touch/flick': {
     POST: {
       command: 'flick',
       payloadParams: {
-        optional: [
-          'element',
-          'xspeed',
-          'yspeed',
-          'xoffset',
-          'yoffset',
-          'speed'
-        ]
-      }
-    }
+        optional: ['element', 'xspeed', 'yspeed', 'xoffset', 'yoffset', 'speed'],
+      },
+    },
   },
   '/session/:sessionId/touch/perform': {
     POST: {
       command: 'performTouch',
-      payloadParams: { wrap: 'actions', required: ['actions'] }
-    }
+      payloadParams: {wrap: 'actions', required: ['actions']},
+    },
   },
   '/session/:sessionId/touch/multi/perform': {
     POST: {
       command: 'performMultiAction',
-      payloadParams: { required: ['actions'], optional: ['elementId'] }
-    }
+      payloadParams: {required: ['actions'], optional: ['elementId']},
+    },
   },
   '/session/:sessionId/appium/device/lock': {
-    POST: { command: 'lock', payloadParams: { optional: ['seconds'] } }
+    POST: {command: 'lock', payloadParams: {optional: ['seconds']}},
   },
-  '/session/:sessionId/appium/device/unlock': { POST: { command: 'unlock' } },
-  '/session/:sessionId/appium/device/is_locked': { POST: { command: 'isLocked' } },
+  '/session/:sessionId/appium/device/unlock': {POST: {command: 'unlock'}},
+  '/session/:sessionId/appium/device/is_locked': {POST: {command: 'isLocked'}},
   '/session/:sessionId/appium/start_recording_screen': {
     POST: {
       command: 'startRecordingScreen',
-      payloadParams: { optional: ['options'] }
-    }
+      payloadParams: {optional: ['options']},
+    },
   },
   '/session/:sessionId/appium/stop_recording_screen': {
     POST: {
       command: 'stopRecordingScreen',
-      payloadParams: { optional: ['options'] }
-    }
+      payloadParams: {optional: ['options']},
+    },
   },
-  '/session/:sessionId/appium/performanceData/types': { POST: { command: 'getPerformanceDataTypes' } },
+  '/session/:sessionId/appium/performanceData/types': {POST: {command: 'getPerformanceDataTypes'}},
   '/session/:sessionId/appium/getPerformanceData': {
     POST: {
       command: 'getPerformanceData',
       payloadParams: {
         required: ['packageName', 'dataType'],
-        optional: ['dataReadTimeout']
-      }
-    }
+        optional: ['dataReadTimeout'],
+      },
+    },
   },
   '/session/:sessionId/appium/device/press_keycode': {
     POST: {
       command: 'pressKeyCode',
-      payloadParams: { required: ['keycode'], optional: ['metastate', 'flags'] }
-    }
+      payloadParams: {required: ['keycode'], optional: ['metastate', 'flags']},
+    },
   },
   '/session/:sessionId/appium/device/long_press_keycode': {
     POST: {
       command: 'longPressKeyCode',
-      payloadParams: { required: ['keycode'], optional: ['metastate', 'flags'] }
-    }
+      payloadParams: {required: ['keycode'], optional: ['metastate', 'flags']},
+    },
   },
   '/session/:sessionId/appium/device/finger_print': {
     POST: {
       command: 'fingerprint',
-      payloadParams: { required: ['fingerprintId'] }
-    }
+      payloadParams: {required: ['fingerprintId']},
+    },
   },
   '/session/:sessionId/appium/device/send_sms': {
     POST: {
       command: 'sendSMS',
-      payloadParams: { required: ['phoneNumber', 'message'] }
-    }
+      payloadParams: {required: ['phoneNumber', 'message']},
+    },
   },
   '/session/:sessionId/appium/device/gsm_call': {
     POST: {
       command: 'gsmCall',
-      payloadParams: { required: ['phoneNumber', 'action'] }
-    }
+      payloadParams: {required: ['phoneNumber', 'action']},
+    },
   },
   '/session/:sessionId/appium/device/gsm_signal': {
     POST: {
       command: 'gsmSignal',
-      payloadParams: { required: ['signalStrength'] }
-    }
+      payloadParams: {required: ['signalStrength']},
+    },
   },
   '/session/:sessionId/appium/device/gsm_voice': {
-    POST: { command: 'gsmVoice', payloadParams: { required: ['state'] } }
+    POST: {command: 'gsmVoice', payloadParams: {required: ['state']}},
   },
   '/session/:sessionId/appium/device/power_capacity': {
     POST: {
       command: 'powerCapacity',
-      payloadParams: { required: ['percent'] }
-    }
+      payloadParams: {required: ['percent']},
+    },
   },
   '/session/:sessionId/appium/device/power_ac': {
-    POST: { command: 'powerAC', payloadParams: { required: ['state'] } }
+    POST: {command: 'powerAC', payloadParams: {required: ['state']}},
   },
   '/session/:sessionId/appium/device/network_speed': {
     POST: {
       command: 'networkSpeed',
-      payloadParams: { required: ['netspeed'] }
-    }
+      payloadParams: {required: ['netspeed']},
+    },
   },
   '/session/:sessionId/appium/device/keyevent': {
     POST: {
       command: 'keyevent',
-      payloadParams: { required: ['keycode'], optional: ['metastate'] }
-    }
+      payloadParams: {required: ['keycode'], optional: ['metastate']},
+    },
   },
-  '/session/:sessionId/appium/device/current_activity': { GET: { command: 'getCurrentActivity' } },
-  '/session/:sessionId/appium/device/current_package': { GET: { command: 'getCurrentPackage' } },
+  '/session/:sessionId/appium/device/current_activity': {GET: {command: 'getCurrentActivity'}},
+  '/session/:sessionId/appium/device/current_package': {GET: {command: 'getCurrentPackage'}},
   '/session/:sessionId/appium/device/app_state': {
     POST: {
       command: 'queryAppState',
-      payloadParams: { required: [['appId'], ['bundleId']] }
-    }
-  },
-  '/session/:sessionId/appium/device/toggle_airplane_mode': { POST: { command: 'toggleFlightMode' } },
-  '/session/:sessionId/appium/device/toggle_data': { POST: { command: 'toggleData' } },
-  '/session/:sessionId/appium/device/toggle_wifi': { POST: { command: 'toggleWiFi' } },
-  '/session/:sessionId/appium/device/toggle_location_services': { POST: { command: 'toggleLocationServices' } },
-  '/session/:sessionId/appium/device/open_notifications': { POST: { command: 'openNotifications' } },
+      payloadParams: {required: [['appId'], ['bundleId']]},
+    },
+  },
+  '/session/:sessionId/appium/device/toggle_airplane_mode': {POST: {command: 'toggleFlightMode'}},
+  '/session/:sessionId/appium/device/toggle_data': {POST: {command: 'toggleData'}},
+  '/session/:sessionId/appium/device/toggle_wifi': {POST: {command: 'toggleWiFi'}},
+  '/session/:sessionId/appium/device/toggle_location_services': {
+    POST: {command: 'toggleLocationServices'},
+  },
+  '/session/:sessionId/appium/device/open_notifications': {POST: {command: 'openNotifications'}},
   '/session/:sessionId/appium/device/start_activity': {
     POST: {
       command: 'startActivity',
@@ -176,44 +171,38 @@ export const newMethodMap = /** @type {const} */ ({
           'intentCategory',
           'intentFlags',
           'optionalIntentArguments',
-          'dontStopAppOnReset'
-        ]
-      }
-    }
-  },
-  '/session/:sessionId/appium/device/system_bars': { GET: { command: 'getSystemBars' } },
-  '/session/:sessionId/appium/device/display_density': { GET: { command: 'getDisplayDensity' } },
-  '/session/:sessionId/appium/app/launch': { POST: { command: 'launchApp' } },
-  '/session/:sessionId/appium/app/close': { POST: { command: 'closeApp' } },
-  '/session/:sessionId/appium/app/reset': { POST: { command: 'reset' } },
+          'dontStopAppOnReset',
+        ],
+      },
+    },
+  },
+  '/session/:sessionId/appium/device/system_bars': {GET: {command: 'getSystemBars'}},
+  '/session/:sessionId/appium/device/display_density': {GET: {command: 'getDisplayDensity'}},
+  '/session/:sessionId/appium/app/launch': {POST: {command: 'launchApp'}},
+  '/session/:sessionId/appium/app/close': {POST: {command: 'closeApp'}},
+  '/session/:sessionId/appium/app/reset': {POST: {command: 'reset'}},
   '/session/:sessionId/appium/app/background': {
     POST: {
       command: 'background',
-      payloadParams: { required: ['seconds'] }
-    }
-  },
-  '/session/:sessionId/appium/app/end_test_coverage': {
-    POST: {
-      command: 'endCoverage',
-      payloadParams: { required: ['intent', 'path'] }
-    }
+      payloadParams: {required: ['seconds']},
+    },
   },
   '/session/:sessionId/appium/app/strings': {
     POST: {
       command: 'getStrings',
-      payloadParams: { optional: ['language', 'stringFile'] }
-    }
+      payloadParams: {optional: ['language', 'stringFile']},
+    },
   },
   '/session/:sessionId/appium/element/:elementId/value': {
     POST: {
       command: 'setValueImmediate',
-      payloadParams: { required: ['text'] }
-    }
+      payloadParams: {required: ['text']},
+    },
   },
   '/session/:sessionId/appium/element/:elementId/replace_value': {
     POST: {
       command: 'replaceValue',
-      payloadParams: { required: ['text'] }
-    }
-  }
+      payloadParams: {required: ['text']},
+    },
+  },
 });

package/lib/stubs.ts

@@ -3,6 +3,5 @@
  * @module
  */
 
-declare module 'appium-adb';
 declare module 'shared-preferences-builder';
 declare module 'io.appium.settings';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "5.14.7",
+  "version": "6.0.0",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -19,18 +19,18 @@
   },
   "license": "Apache-2.0",
   "author": "Appium Contributors",
-  "main": "./build/index.js",
+  "main": "./build/lib/index.js",
   "bin": {},
   "directories": {
     "lib": "lib"
   },
   "files": [
-    "index.js",
     "lib",
-    "build/index.js",
-    "build/lib",
+    "build",
     "bootstrap/bin/AppiumBootstrap.jar",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "!build/test",
+    "!build/tsconfig.tsbuildinfo"
   ],
   "scripts": {
     "build": "tsc -b",
@@ -41,8 +41,8 @@
     "lint:commit": "commitlint",
     "lint:fix": "npm run lint -- --fix",
     "lint:staged": "lint-staged",
-    "prepare": "husky install && npm run rebuild",
-    "rebuild": "npm run clean && npm run build",
+    "prepare": "husky install; npm run rebuild",
+    "rebuild": "npm run clean; npm run build",
     "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\""
   },
   "lint-staged": {
@@ -57,8 +57,8 @@
     "singleQuote": true
   },
   "dependencies": {
-    "appium-adb": "^9.11.2",
-    "appium-chromedriver": "^5.2.0",
+    "appium-adb": "^9.12.0",
+    "appium-chromedriver": "^5.5.1",
     "asyncbox": "^2.8.0",
     "axios": "^1.x",
     "bluebird": "^3.4.7",
@@ -73,12 +73,14 @@
     "shared-preferences-builder": "^0.x",
     "source-map-support": "^0.x",
     "teen_process": "^2.0.0",
+    "type-fest": "^3.11.1",
     "ws": "^8.0.0"
   },
   "devDependencies": {
-    "@appium/eslint-config-appium": "^6.0.0",
-    "@appium/support": "^4.0.1",
-    "@appium/test-support": "^3.0.0",
+    "@appium/eslint-config-appium": "^8.0.4",
+    "@appium/eslint-config-appium-ts": "^0.3.1",
+    "@appium/support": "^4.1.2",
+    "@appium/test-support": "^3.0.20",
     "@appium/tsconfig": "^0.3.0",
     "@appium/types": "^0.13.4",
     "@commitlint/cli": "^17.6.3",
@@ -97,16 +99,20 @@
     "@types/source-map-support": "^0.5.6",
     "@types/teen_process": "^2.0.0",
     "@types/ws": "^8.5.4",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
     "@xmldom/xmldom": "^0.x",
     "android-apidemos": "^4.1.0",
+    "appium": "^2.0.0-rc.5",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
-    "conventional-changelog-conventionalcommits": "^7.0.1",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-mocha": "^9.0.0",
-    "eslint-plugin-promise": "^6.0.0",
+    "conventional-changelog-conventionalcommits": "^6.0.0",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "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",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.0",
     "mocha": "^10.0.0",
@@ -124,5 +130,6 @@
   "engines": {
     "node": ">=14",
     "npm": ">=8"
-  }
+  },
+  "types": "./build/lib/index.d.ts"
 }

package/index.js

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-import {install} from 'source-map-support';
-install();
-
-import * as driver from './lib/driver';
-import * as androidHelperIndex from './lib/android-helpers';
-import * as commandIndex from './lib/commands/index';
-import * as webview from './lib/webview-helpers';
-import * as caps from './lib/desired-caps';
-
-const { AndroidDriver } = driver;
-const { helpers: webviewHelpers, NATIVE_WIN, WEBVIEW_WIN, WEBVIEW_BASE,
-        CHROMIUM_WIN } = webview;
-const { commonCapConstraints } = caps;
-const { commands: androidCommands } = commandIndex;
-const { helpers: androidHelpers, SETTINGS_HELPER_PKG_ID } = androidHelperIndex;
-
-
-export default AndroidDriver;
-export {
-  androidHelpers, androidCommands, AndroidDriver,
-  commonCapConstraints, webviewHelpers, NATIVE_WIN, WEBVIEW_WIN,
-  WEBVIEW_BASE, CHROMIUM_WIN, SETTINGS_HELPER_PKG_ID,
-};