appium-android-driver 6.0.0 → 7.0.0

package/lib/utils.js

@@ -6,16 +6,15 @@ export const ADB_SHELL_FEATURE = 'adb_shell';
 /**
  * Assert the presence of particular keys in the given object
  *
- * @template {Object} T
  * @param {string|string[]} argNames one or more key names
- * @param {T} opts the object to check
- * @returns {T} the same given object
+ * @param {any} opts the object to check
+ * @returns {Record<string, any>} the same given object
  */
-export function requireArgs (argNames, opts = {}) {
+export function requireArgs (argNames, opts) {
   for (const argName of (_.isArray(argNames) ? argNames : [argNames])) {
     if (!_.has(opts, argName)) {
       throw new errors.InvalidArgumentError(`'${argName}' argument must be provided`);
     }
   }
   return opts;
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -27,7 +27,6 @@
   "files": [
     "lib",
     "build",
-    "bootstrap/bin/AppiumBootstrap.jar",
     "CHANGELOG.md",
     "!build/test",
     "!build/tsconfig.tsbuildinfo"
@@ -36,7 +35,6 @@
     "build": "tsc -b",
     "clean": "npm run build -- --clean",
     "dev": "npm run build -- --watch",
-    "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.js\"",
     "lint": "eslint .",
     "lint:commit": "commitlint",
     "lint:fix": "npm run lint -- --fix",
@@ -70,7 +68,6 @@
     "portfinder": "^1.0.6",
     "portscanner": "2.2.0",
     "semver": "^7.0.0",
-    "shared-preferences-builder": "^0.x",
     "source-map-support": "^0.x",
     "teen_process": "^2.0.0",
     "type-fest": "^3.11.1",
@@ -106,7 +103,7 @@
     "appium": "^2.0.0-rc.5",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
-    "conventional-changelog-conventionalcommits": "^6.0.0",
+    "conventional-changelog-conventionalcommits": "^7.0.1",
     "eslint": "^8.40.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-typescript": "^3.5.5",

package/bootstrap/README.md

@@ -1,19 +0,0 @@
-Bootstrap Android
-===
-
-To install the Android Maven dependencies in your local environment, run the following:
-
-* Clone https://github.com/mosabua/maven-android-sdk-deployer into your workstation
-* Set the ANDROID_HOME environment to the location of the Android SDK, eg. `export ANDROID_HOME=/Developer/adt-bundle-mac-x86_64-20130219/sdk/`
-* Run `mvn install -P 4.4` from the `maven-android-sdk-deployer` directory. The build will fail if API 19 and some extra packages are not installed.
-* Please install all sdk and api versions of android for building `maven-android-sdk-deployer`.
-
-You can then compile the bootstrap project by running
-
-    mvn package -P 4.4
-
-If mvn package fails, try deleting your ANDROID_HOME folder and downloading everything again. If it still doesn't work try:
-
-    android-sdk/tools/android update sdk --no-ui --obsolete --force
-
-and then run `mvn clean ; mvn install`

package/build/index.d.ts

@@ -1,282 +0,0 @@
-#!/usr/bin/env node
-export default AndroidDriver;
-export const AndroidDriver: typeof driver.AndroidDriver;
-export const androidHelpers: typeof androidHelperIndex.helpers;
-export const androidCommands: {};
-export const commonCapConstraints: {
-    platformName: {
-        isString: boolean;
-        inclusionCaseInsensitive: string[];
-        presence: boolean;
-    };
-    app: {
-        isString: boolean;
-    };
-    appActivity: {
-        isString: boolean;
-    };
-    appPackage: {
-        isString: boolean;
-    };
-    appWaitActivity: {
-        isString: boolean;
-    };
-    appWaitPackage: {
-        isString: boolean;
-    };
-    appWaitDuration: {
-        isNumber: boolean;
-    };
-    deviceReadyTimeout: {
-        isNumber: boolean;
-    };
-    androidCoverage: {
-        isString: boolean;
-    };
-    androidDeviceReadyTimeout: {
-        isNumber: boolean;
-    };
-    androidDeviceSocket: {
-        isString: boolean;
-    };
-    androidInstallTimeout: {
-        isNumber: boolean;
-    };
-    adbPort: {
-        isNumber: boolean;
-    };
-    remoteAdbHost: {
-        isString: boolean;
-    };
-    adbExecTimeout: {
-        isNumber: boolean;
-    };
-    avd: {
-        isString: boolean;
-    };
-    avdLaunchTimeout: {
-        isNumber: boolean;
-    };
-    avdReadyTimeout: {
-        isNumber: boolean;
-    };
-    avdArgs: {};
-    avdEnv: {
-        isObject: boolean;
-    };
-    useKeystore: {
-        isBoolean: boolean;
-    };
-    keystorePath: {
-        isString: boolean;
-    };
-    keystorePassword: {
-        isString: boolean;
-    };
-    keyAlias: {
-        isString: boolean;
-    };
-    keyPassword: {
-        isString: boolean;
-    };
-    webviewDevtoolsPort: {
-        isNumber: boolean;
-    };
-    ensureWebviewsHavePages: {
-        isBoolean: boolean;
-    };
-    enableWebviewDetailsCollection: {
-        isBoolean: boolean;
-    };
-    chromeDriverPort: {
-        isNumber: boolean;
-    };
-    chromedriverPort: {
-        isNumber: boolean;
-    };
-    chromedriverPorts: {
-        isArray: boolean;
-    };
-    chromedriverArgs: {
-        isObject: boolean;
-    };
-    chromedriverExecutable: {
-        isString: boolean;
-    };
-    chromedriverExecutableDir: {
-        isString: boolean;
-    };
-    chromedriverChromeMappingFile: {
-        isString: boolean;
-    };
-    chromedriverUseSystemExecutable: {
-        isBoolean: boolean;
-    };
-    chromedriverDisableBuildCheck: {
-        isBoolean: boolean;
-    };
-    chromeLoggingPrefs: {
-        isObject: boolean;
-    };
-    autoWebviewTimeout: {
-        isNumber: boolean;
-    };
-    autoWebviewName: {
-        isString: boolean;
-    };
-    intentAction: {
-        isString: boolean;
-    };
-    intentCategory: {
-        isString: boolean;
-    };
-    intentFlags: {
-        isString: boolean;
-    };
-    optionalIntentArguments: {
-        isString: boolean;
-    };
-    dontStopAppOnReset: {
-        isBoolean: boolean;
-    };
-    unicodeKeyboard: {
-        isBoolean: boolean;
-    };
-    resetKeyboard: {
-        isBoolean: boolean;
-    };
-    noSign: {
-        isBoolean: boolean;
-    };
-    recreateChromeDriverSessions: {
-        isBoolean: boolean;
-    };
-    autoLaunch: {
-        isBoolean: boolean;
-    };
-    nativeWebScreenshot: {
-        isBoolean: boolean;
-    };
-    androidScreenshotPath: {
-        isString: boolean;
-    };
-    androidInstallPath: {
-        isString: boolean;
-    };
-    clearSystemFiles: {
-        isBoolean: boolean;
-    };
-    extractChromeAndroidPackageFromContextName: {
-        isBoolean: boolean;
-    };
-    autoGrantPermissions: {
-        isBoolean: boolean;
-    };
-    sharedPreferences: {
-        isObject: boolean;
-    };
-    networkSpeed: {
-        isString: boolean;
-    };
-    gpsEnabled: {
-        isBoolean: boolean;
-    };
-    isHeadless: {
-        isBoolean: boolean;
-    };
-    showChromedriverLog: {
-        isBoolean: boolean;
-    };
-    skipUnlock: {
-        isBoolean: boolean;
-    };
-    clearDeviceLogsOnStart: {
-        isBoolean: boolean;
-    };
-    unlockType: {
-        isString: boolean;
-    };
-    unlockKey: {
-        isString: boolean;
-    };
-    unlockStrategy: {
-        isString: boolean;
-        inclusionCaseInsensitive: string[];
-    };
-    otherApps: {
-        isString: boolean;
-    };
-    uninstallOtherPackages: {
-        isString: boolean;
-    };
-    allowTestPackages: {
-        isBoolean: boolean;
-    };
-    pageLoadStrategy: {
-        isString: boolean;
-    };
-    localeScript: {
-        isString: boolean;
-    };
-    skipDeviceInitialization: {
-        isBoolean: boolean;
-    };
-    remoteAppsCacheLimit: {
-        isNumber: boolean;
-    };
-    buildToolsVersion: {
-        isString: boolean;
-    };
-    skipLogcatCapture: {
-        isBoolean: boolean;
-    };
-    chromeOptions: {
-        isObject: boolean;
-    };
-    enablePerformanceLogging: {
-        isBoolean: boolean;
-    };
-    userProfile: {
-        isNumber: boolean;
-    };
-    browserName: {
-        isString: boolean;
-    };
-    enforceAppInstall: {
-        isBoolean: boolean;
-    };
-    suppressKillServer: {
-        isBoolean: boolean;
-    };
-    allowOfflineDevices: {
-        isBoolean: boolean;
-    };
-    ignoreHiddenApiPolicyError: {
-        isBoolean: boolean;
-    };
-    unlockSuccessTimeout: {
-        isNumber: boolean;
-    };
-    mockLocationApp: {
-        isString: boolean;
-    };
-    logcatFormat: {
-        isString: boolean;
-    };
-    logcatFilterSpecs: {
-        isArray: boolean;
-    };
-    allowDelayAdb: {
-        isBoolean: boolean;
-    };
-};
-export const webviewHelpers: typeof webview.helpers;
-export const NATIVE_WIN: "NATIVE_APP";
-export const WEBVIEW_WIN: "WEBVIEW";
-export const WEBVIEW_BASE: "WEBVIEW_";
-export const CHROMIUM_WIN: "CHROMIUM";
-export const SETTINGS_HELPER_PKG_ID: "io.appium.settings";
-import * as driver from './lib/driver';
-import * as androidHelperIndex from './lib/android-helpers';
-import * as webview from './lib/webview-helpers';
-//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAIwB,cAAc;oCACF,uBAAuB;yBAElC,uBAAuB"}

package/build/index.js

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SETTINGS_HELPER_PKG_ID = exports.CHROMIUM_WIN = exports.WEBVIEW_BASE = exports.WEBVIEW_WIN = exports.NATIVE_WIN = exports.webviewHelpers = exports.commonCapConstraints = exports.AndroidDriver = exports.androidCommands = exports.androidHelpers = void 0;
-const source_map_support_1 = require("source-map-support");
-(0, source_map_support_1.install)();
-const driver = __importStar(require("./lib/driver"));
-const androidHelperIndex = __importStar(require("./lib/android-helpers"));
-const commandIndex = __importStar(require("./lib/commands/index"));
-const webview = __importStar(require("./lib/webview-helpers"));
-const caps = __importStar(require("./lib/desired-caps"));
-const { AndroidDriver } = driver;
-exports.AndroidDriver = AndroidDriver;
-const { helpers: webviewHelpers, NATIVE_WIN, WEBVIEW_WIN, WEBVIEW_BASE, CHROMIUM_WIN } = webview;
-exports.webviewHelpers = webviewHelpers;
-exports.NATIVE_WIN = NATIVE_WIN;
-exports.WEBVIEW_WIN = WEBVIEW_WIN;
-exports.WEBVIEW_BASE = WEBVIEW_BASE;
-exports.CHROMIUM_WIN = CHROMIUM_WIN;
-const { commonCapConstraints } = caps;
-exports.commonCapConstraints = commonCapConstraints;
-const { commands: androidCommands } = commandIndex;
-exports.androidCommands = androidCommands;
-const { helpers: androidHelpers, SETTINGS_HELPER_PKG_ID } = androidHelperIndex;
-exports.androidHelpers = androidHelpers;
-exports.SETTINGS_HELPER_PKG_ID = SETTINGS_HELPER_PKG_ID;
-exports.default = AndroidDriver;
-//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2DAA2C;AAC3C,IAAA,4BAAO,GAAE,CAAC;AAEV,qDAAuC;AACvC,0EAA4D;AAC5D,mEAAqD;AACrD,+DAAiD;AACjD,yDAA2C;AAE3C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;AAUE,sCAAa;AAThD,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAC9D,YAAY,EAAE,GAAG,OAAO,CAAC;AAST,wCAAc;AAAE,gCAAU;AAAE,kCAAW;AAC7D,oCAAY;AAAE,oCAAY;AAT5B,MAAM,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;AAQpC,oDAAoB;AAPtB,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,YAAY,CAAC;AAMjC,0CAAe;AALjC,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,GAAG,kBAAkB,CAAC;AAK7E,wCAAc;AAEc,wDAAsB;AAJpD,kBAAe,aAAa,CAAC"}

package/build/lib/android-helpers.d.ts

@@ -1,136 +0,0 @@
-export default helpers;
-export namespace helpers {
-    export function createBaseADB(opts?: {}): Promise<any>;
-    export function prepareEmulator(adb: any, opts: any): Promise<void>;
-    /**
-     * Set and ensure the locale name of the device under test.
-     *
-     * @param {Object} adb - The adb module instance.
-     * @param {string} language - Language. The language field is case insensitive, but Locale always canonicalizes to lower case.
-     *                            format: [a-zA-Z]{2,8}. e.g. en, ja : https://developer.android.com/reference/java/util/Locale.html
-     * @param {string} country - Country. The country (region) field is case insensitive, but Locale always canonicalizes to upper case.
-     *                            format: [a-zA-Z]{2} | [0-9]{3}. e.g. US, JP : https://developer.android.com/reference/java/util/Locale.html
-     * @param {?string} script - Script. The script field is case insensitive but Locale always canonicalizes to title case.
-     *                            format: [a-zA-Z]{4}. e.g. Hans in zh-Hans-CN : https://developer.android.com/reference/java/util/Locale.html
-     * @throws {Error} If it failed to set locale properly
-     */
-    export function ensureDeviceLocale(adb: any, language: string, country: string, script?: string | null): Promise<void>;
-    export function getDeviceInfoFromCaps(opts?: {}): Promise<{
-        udid: any;
-        emPort: any;
-    }>;
-    export function createADB(opts?: {}): Promise<any>;
-    export function validatePackageActivityNames(opts: any): void;
-    export function getLaunchInfo(adb: any, opts: any): Promise<{
-        appPackage: any;
-        appWaitPackage: any;
-        appActivity: any;
-        appWaitActivity: any;
-    } | undefined>;
-    export function resetApp(adb: any, opts?: {}): Promise<void>;
-    export function installApk(adb: any, opts?: {}): Promise<void>;
-    /**
-     * Installs an array of apks
-     * @param {ADB} adb Instance of Appium ADB object
-     * @param {Object} opts Opts defined in driver.js
-     */
-    export function installOtherApks(otherApps: any, adb: any, opts: any): Promise<void>;
-    /**
-     * Uninstall an array of packages
-     * @param {ADB} adb Instance of Appium ADB object
-     * @param {Array<string>} appPackages An array of package names to uninstall. If this includes `'*'`, uninstall all of 3rd party apps
-     * @param {Array<string>} filterPackages An array of packages does not uninstall when `*` is provided as `appPackages`
-     */
-    export function uninstallOtherPackages(adb: any, appPackages: string[], filterPackages?: string[]): Promise<void>;
-    /**
-     * Get third party packages filtered with `filterPackages`
-     * @param {ADB} adb Instance of Appium ADB object
-     * @param {Array<string>} filterPackages An array of packages does not uninstall when `*` is provided as `appPackages`
-     * @returns {Array<string>} An array of installed third pary packages
-     */
-    export function getThirdPartyPackages(adb: any, filterPackages?: string[]): string[];
-    export function initUnicodeKeyboard(adb: any): Promise<any>;
-    export function setMockLocationApp(adb: any, app: any): Promise<void>;
-    export function resetMockLocation(adb: any): Promise<void>;
-    export function installHelperApp(adb: any, apkPath: any, packageId: any): Promise<void>;
-    /**
-     * Pushes and installs io.appium.settings app.
-     * Throws an error if the setting app is required
-     *
-     * @param {Adb} adb - The adb module instance.
-     * @param {Object} opts - Driver options dictionary.
-     * @param {boolean} throwError [false] - Whether throw an error if Settings app fails to start
-     * @throws {Error} If throwError is true and something happens in installation step
-     */
-    export function pushSettingsApp(adb: Adb, throwError?: boolean, opts?: any): Promise<void>;
-    /**
-     * Extracts string.xml and converts it to string.json and pushes
-     * it to /data/local/tmp/string.json on for use of bootstrap
-     * If app is not present to extract string.xml it deletes remote strings.json
-     * If app does not have strings.xml we push an empty json object to remote
-     *
-     * @param {?string} language - Language abbreviation, for example 'fr'. The default language
-     * is used if this argument is not defined.
-     * @param {Object} adb - The adb module instance.
-     * @param {Object} opts - Driver options dictionary.
-     * @returns {Object} The dictionary, where string resource identifiers are keys
-     * along with their corresponding values for the given language or an empty object
-     * if no matching resources were extracted.
-     */
-    export function pushStrings(language: string | null, adb: any, opts: any): any;
-    export function unlock(driver: any, adb: any, capabilities: any): Promise<void>;
-    export function verifyUnlock(adb: any, timeoutMs?: null): Promise<void>;
-    export function initDevice(adb: any, opts: any): Promise<any>;
-    export function removeNullProperties(obj: any): void;
-    export function truncateDecimals(number: any, digits: any): number;
-    export function isChromeBrowser(browser: any): boolean;
-    export function getChromePkg(browser: any): any;
-    export function removeAllSessionWebSocketHandlers(server: any, sessionId: any): Promise<void>;
-    /**
-     * Takes a desired capability and tries to JSON.parse it as an array,
-     * and either returns the parsed array or a singleton array.
-     *
-     * @param {any} cap A desired capability
-     */
-    export function parseArray(cap: any): any[];
-    /**
-     * Validate desired capabilities. Returns true if capability is valid
-     *
-     * @param {*} cap A desired capability
-     * @return {boolean} Returns true if the capability is valid
-     * @throws {Error} If the caps has invalid capability
-     */
-    export function validateDesiredCaps(caps: any): boolean;
-    /**
-     * Adjust the capabilities for a browser session
-     *
-     * @param {Object} caps - Current capabilities object
-     * !!! The object is mutated by this method call !!!
-     * @returns {Object} The same possibly mutated `opts` instance.
-     * No mutation is happening is the current session if
-     * appPackage/appActivity caps have already been provided.
-     */
-    export function adjustBrowserSessionCaps(caps?: any): any;
-    /**
-     * Checks whether the current device under test is an emulator
-     *
-     * @param {ADB} adb - appium-adb instance
-     * @param {Object} opts - driver options mapping
-     * @returns {boolean} `true` if the device is an Android emulator
-     */
-    export function isEmulator(adb: any, opts: any): boolean;
-    export { Bootstrap as bootstrap };
-    export { unlocker };
-}
-export const SETTINGS_HELPER_PKG_ID: "io.appium.settings";
-export const APP_STATE: Readonly<{
-    NOT_INSTALLED: 0;
-    NOT_RUNNING: 1;
-    RUNNING_IN_BACKGROUND: 3;
-    RUNNING_IN_FOREGROUND: 4;
-}>;
-export function prepareAvdArgs(adb: any, opts: any): any[];
-export function ensureNetworkSpeed(adb: any, networkSpeed: any): any;
-import Bootstrap from './bootstrap';
-import { helpers as unlocker } from './unlock-helpers';
-//# sourceMappingURL=android-helpers.d.ts.map

package/build/lib/android-helpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"android-helpers.d.ts","sourceRoot":"","sources":["../../lib/android-helpers.js"],"names":[],"mappings":";;IAiHA,uDAmCC;IAED,oEAuCC;IAED;;;;;;;;;;;OAWG;IACH,uHAaC;IAED;;;OA4FC;IAGD,mDASC;IAED,8DAeC;IAED;;;;;mBA8BC;IAED,6DAsDC;IAED,+DAsCC;IAED;;;;OAIG;IACH,qFAgBC;IAED;;;;;OAKG;IACH,kHAQC;IAED;;;;;OAKG;IACH,qFAUC;IAED,4DAYC;IAED,sEAiCC;IAED,2DA+BC;IAED,wFAQC;IAED;;;;;;;;OAQG;IACH,2FA0DC;IAED;;;;;;;;;;;;;OAaG;IACH,+EAiCC;IAED,gFAsCC;IAED,wEAUC;IAED,8DA6DC;IAED,qDAMC;IAED,mEAMC;IAED,uDAEC;IAED,gDAEC;IAED,8FASC;IAED;;;;;OAKG;IACH,4CAaC;IAED;;;;;;OAMG;IACH,wDAoBC;IAED;;;;;;;;OAQG;IACH,0DAmBC;IAED;;;;;;OAMG;IACH,yDAGC;;;;AA55BD,0DAAoD;AAKpD;;;;;GAKG;AAYH,2DAqBC;AA9BD,qEAOC;sBAlEqB,aAAa;oCAO5B,kBAAkB"}