appium-android-driver 7.8.2 → 8.0.0

package/build/lib/commands/device/emulator-console.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileExecEmuConsoleCommand = void 0;
+const driver_1 = require("appium/driver");
+const EMU_CONSOLE_FEATURE = 'emulator_console';
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {import('../types').ExecOptions} opts
+ * @returns {Promise<string>}
+ */
+async function mobileExecEmuConsoleCommand(opts) {
+    this.ensureFeatureEnabled(EMU_CONSOLE_FEATURE);
+    const { command, execTimeout, connTimeout, initTimeout } = opts;
+    if (!command) {
+        throw new driver_1.errors.InvalidArgumentError(`The 'command' argument is mandatory`);
+    }
+    return await /** @type {import('appium-adb').ADB} */ (this.adb).execEmuConsoleCommand(command, {
+        execTimeout,
+        connTimeout,
+        initTimeout,
+    });
+}
+exports.mobileExecEmuConsoleCommand = mobileExecEmuConsoleCommand;
+//# sourceMappingURL=emulator-console.js.map

package/build/lib/commands/device/emulator-console.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emulator-console.js","sourceRoot":"","sources":["../../../../lib/commands/device/emulator-console.js"],"names":[],"mappings":";;;AAAA,0CAAqC;AAErC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAE/C;;;;GAIG;AACI,KAAK,UAAU,2BAA2B,CAAC,IAAI;IACpD,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAE/C,MAAM,EAAC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC;IAE9D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,qCAAqC,CAAC,CAAC;KAC9E;IAED,OAAO,MAAM,uCAAuC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,OAAO,EAAE;QAC7F,WAAW;QACX,WAAW;QACX,WAAW;KACZ,CAAC,CAAC;AACL,CAAC;AAdD,kEAcC"}

package/build/lib/commands/device/utils.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {string} errMsg
+ */
+export function requireEmulator(this: import("../../driver").AndroidDriver, errMsg: string): void;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {void}
+ */
+export function validatePackageActivityNames(this: import("../../driver").AndroidDriver): void;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {string} networkSpeed
+ * @returns {string}
+ */
+export function ensureNetworkSpeed(this: import("../../driver").AndroidDriver, networkSpeed: string): string;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {string[]}
+ */
+export function prepareAvdArgs(this: import("../../driver").AndroidDriver): string[];
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+export function prepareEmulator(this: import("../../driver").AndroidDriver): Promise<void>;
+/**
+ * @param {import('../../driver').AndroidDriverOpts?} [opts=null]
+ * @returns {Promise<ADB>}
+ */
+export function createBaseADB(opts?: import("../../driver").AndroidDriverOpts | null | undefined): Promise<ADB>;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {boolean} throwIfError
+ * @returns {Promise<void>}
+ */
+export function pushSettingsApp(this: import("../../driver").AndroidDriver, throwIfError: boolean): Promise<void>;
+/**
+ * @deprecated
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {Promise<string?>}
+ */
+export function initUnicodeKeyboard(this: import("../../driver").AndroidDriver): Promise<string | null>;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+export function hideKeyboardCompletely(this: import("../../driver").AndroidDriver): Promise<void>;
+import ADB from 'appium-adb';
+//# sourceMappingURL=utils.d.ts.map

package/build/lib/commands/device/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../lib/commands/device/utils.js"],"names":[],"mappings":"AAeA;;;GAGG;AACH,oFAFW,MAAM,QAMhB;AAED;;;GAGG;AACH,0FAFa,IAAI,CAuBhB;AAED;;;;GAIG;AACH,6FAHW,MAAM,GACJ,MAAM,CAWlB;AAED;;;GAGG;AACH,4EAFa,MAAM,EAAE,CAmBpB;AAED;;;GAGG;AACH,6EAFa,QAAQ,IAAI,CAAC,CAyCzB;AAED;;;GAGG;AACH,mGAFa,QAAQ,GAAG,CAAC,CAqCxB;AAED;;;;GAIG;AACH,0FAHW,OAAO,GACL,QAAQ,IAAI,CAAC,CA4EzB;AAED;;;;GAIG;AACH,iFAFa,QAAQ,MAAM,QAAE,CAa5B;AAED;;;GAGG;AACH,oFAFa,QAAQ,IAAI,CAAC,CAMzB;gBA1Re,YAAY"}

package/build/lib/commands/device/utils.js

@@ -0,0 +1,238 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hideKeyboardCompletely = exports.initUnicodeKeyboard = exports.pushSettingsApp = exports.createBaseADB = exports.prepareEmulator = exports.prepareAvdArgs = exports.ensureNetworkSpeed = exports.validatePackageActivityNames = exports.requireEmulator = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const support_1 = require("@appium/support");
+const appium_adb_1 = __importDefault(require("appium-adb"));
+const asyncbox_1 = require("asyncbox");
+const io_appium_settings_1 = require("io.appium.settings");
+const bluebird_1 = __importDefault(require("bluebird"));
+const HELPER_APP_INSTALL_RETRIES = 3;
+const HELPER_APP_INSTALL_RETRY_DELAY_MS = 5000;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {string} errMsg
+ */
+function requireEmulator(errMsg) {
+    if (!this.isEmulator()) {
+        this.log.errorAndThrow(errMsg);
+    }
+}
+exports.requireEmulator = requireEmulator;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {void}
+ */
+function validatePackageActivityNames() {
+    for (const key of ['appPackage', 'appActivity', 'appWaitPackage', 'appWaitActivity']) {
+        const name = this.opts[key];
+        if (!name) {
+            continue;
+        }
+        const match = /([^\w.*,])+/.exec(String(name));
+        if (!match) {
+            continue;
+        }
+        this.log.warn(`Capability '${key}' is expected to only include latin letters, digits, underscore, dot, comma and asterisk characters.`);
+        this.log.warn(`Current value '${name}' has non-matching character at index ${match.index}: '${String(name).substring(0, match.index + 1)}'`);
+    }
+}
+exports.validatePackageActivityNames = validatePackageActivityNames;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {string} networkSpeed
+ * @returns {string}
+ */
+function ensureNetworkSpeed(networkSpeed) {
+    if (networkSpeed.toUpperCase() in this.adb.NETWORK_SPEED) {
+        return networkSpeed;
+    }
+    this.log.warn(`Wrong network speed param '${networkSpeed}', using default: ${this.adb.NETWORK_SPEED.FULL}. ` +
+        `Supported values: ${lodash_1.default.values(this.adb.NETWORK_SPEED)}`);
+    return this.adb.NETWORK_SPEED.FULL;
+}
+exports.ensureNetworkSpeed = ensureNetworkSpeed;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {string[]}
+ */
+function prepareAvdArgs() {
+    const { networkSpeed, isHeadless, avdArgs } = this.opts;
+    const result = [];
+    if (avdArgs) {
+        if (lodash_1.default.isArray(avdArgs)) {
+            result.push(...avdArgs);
+        }
+        else {
+            result.push(...support_1.util.shellParse(`${avdArgs}`));
+        }
+    }
+    if (networkSpeed) {
+        result.push('-netspeed', ensureNetworkSpeed.bind(this)(networkSpeed));
+    }
+    if (isHeadless) {
+        result.push('-no-window');
+    }
+    return result;
+}
+exports.prepareAvdArgs = prepareAvdArgs;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+async function prepareEmulator() {
+    const { avd, avdEnv: env, language, locale: country, avdLaunchTimeout: launchTimeout, avdReadyTimeout: readyTimeout, } = this.opts;
+    if (!avd) {
+        throw new Error('Cannot launch AVD without AVD name');
+    }
+    const avdName = avd.replace('@', '');
+    let isEmulatorRunning = true;
+    try {
+        await this.adb.getRunningAVDWithRetry(avdName, 5000);
+    }
+    catch (e) {
+        this.log.debug(`Emulator '${avdName}' is not running: ${e.message}`);
+        isEmulatorRunning = false;
+    }
+    const args = prepareAvdArgs.bind(this)();
+    if (isEmulatorRunning) {
+        if (args.includes('-wipe-data')) {
+            this.log.debug(`Killing '${avdName}' because it needs to be wiped at start.`);
+            await this.adb.killEmulator(avdName);
+        }
+        else {
+            this.log.debug('Not launching AVD because it is already running.');
+            return;
+        }
+    }
+    await this.adb.launchAVD(avd, {
+        args,
+        env,
+        language,
+        country,
+        launchTimeout,
+        readyTimeout,
+    });
+}
+exports.prepareEmulator = prepareEmulator;
+/**
+ * @param {import('../../driver').AndroidDriverOpts?} [opts=null]
+ * @returns {Promise<ADB>}
+ */
+async function createBaseADB(opts = null) {
+    // filter out any unwanted options sent in
+    // this list should be updated as ADB takes more arguments
+    const { adbPort, suppressKillServer, remoteAdbHost, clearDeviceLogsOnStart, adbExecTimeout, useKeystore, keystorePath, keystorePassword, keyAlias, keyPassword, remoteAppsCacheLimit, buildToolsVersion, allowOfflineDevices, allowDelayAdb, } = opts ?? {};
+    return await appium_adb_1.default.createADB({
+        adbPort,
+        suppressKillServer,
+        remoteAdbHost,
+        clearDeviceLogsOnStart,
+        adbExecTimeout,
+        useKeystore,
+        keystorePath,
+        keystorePassword,
+        keyAlias,
+        keyPassword,
+        remoteAppsCacheLimit,
+        buildToolsVersion,
+        allowOfflineDevices,
+        allowDelayAdb,
+    });
+}
+exports.createBaseADB = createBaseADB;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {boolean} throwIfError
+ * @returns {Promise<void>}
+ */
+async function pushSettingsApp(throwIfError) {
+    this.log.debug('Pushing settings apk to the device...');
+    try {
+        // Sometimes adb push or adb instal take more time than expected to install an app
+        // e.g. https://github.com/appium/io.appium.settings/issues/40#issuecomment-476593174
+        await (0, asyncbox_1.retryInterval)(HELPER_APP_INSTALL_RETRIES, HELPER_APP_INSTALL_RETRY_DELAY_MS, async () => await this.adb.installOrUpgrade(io_appium_settings_1.path, io_appium_settings_1.SETTINGS_HELPER_ID, {
+            grantPermissions: true,
+        }));
+    }
+    catch (err) {
+        if (throwIfError) {
+            throw err;
+        }
+        this.log.warn(`Ignored error while installing '${io_appium_settings_1.path}': ` +
+            `'${err.message}'. Features that rely on this helper ` +
+            'require the apk such as toggle WiFi and getting location ' +
+            'will raise an error if you try to use them.');
+    }
+    // Reinstall would stop the settings helper process anyway, so
+    // there is no need to continue if the application is still running
+    if (await this.settingsApp.isRunningInForeground()) {
+        this.log.debug(`${io_appium_settings_1.SETTINGS_HELPER_ID} is already running. ` + `There is no need to reset its permissions.`);
+        return;
+    }
+    const fixSettingsAppPermissionsForLegacyApis = async () => {
+        if ((await this.adb.getApiLevel()) > 23) {
+            return;
+        }
+        // Android 6- devices should have granted permissions
+        // https://github.com/appium/appium/pull/11640#issuecomment-438260477
+        const perms = ['SET_ANIMATION_SCALE', 'CHANGE_CONFIGURATION', 'ACCESS_FINE_LOCATION'];
+        this.log.info(`Granting permissions ${perms} to '${io_appium_settings_1.SETTINGS_HELPER_ID}'`);
+        await this.adb.grantPermissions(io_appium_settings_1.SETTINGS_HELPER_ID, perms.map((x) => `android.permission.${x}`));
+    };
+    try {
+        await bluebird_1.default.all([
+            this.settingsApp.adjustNotificationsPermissions(),
+            this.settingsApp.adjustMediaProjectionServicePermissions(),
+            fixSettingsAppPermissionsForLegacyApis(),
+        ]);
+    }
+    catch (e) {
+        this.log.debug(e.stack);
+    }
+    // launch io.appium.settings app due to settings failing to be set
+    // if the app is not launched prior to start the session on android 7+
+    // see https://github.com/appium/appium/issues/8957
+    try {
+        await this.settingsApp.requireRunning({
+            timeout: this.isEmulator() ? 30000 : 5000,
+        });
+    }
+    catch (err) {
+        this.log.debug(err.stack);
+        if (throwIfError) {
+            throw err;
+        }
+    }
+}
+exports.pushSettingsApp = pushSettingsApp;
+/**
+ * @deprecated
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {Promise<string?>}
+ */
+async function initUnicodeKeyboard() {
+    this.log.debug('Enabling Unicode keyboard support');
+    // get the default IME so we can return back to it later if we want
+    const defaultIME = await this.adb.defaultIME();
+    this.log.debug(`Unsetting previous IME ${defaultIME}`);
+    this.log.debug(`Setting IME to '${io_appium_settings_1.UNICODE_IME}'`);
+    await this.adb.enableIME(io_appium_settings_1.UNICODE_IME);
+    await this.adb.setIME(io_appium_settings_1.UNICODE_IME);
+    return defaultIME;
+}
+exports.initUnicodeKeyboard = initUnicodeKeyboard;
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+async function hideKeyboardCompletely() {
+    this.log.debug(`Hiding the on-screen keyboard by setting IME to '${io_appium_settings_1.EMPTY_IME}'`);
+    await this.adb.enableIME(io_appium_settings_1.EMPTY_IME);
+    await this.adb.setIME(io_appium_settings_1.EMPTY_IME);
+}
+exports.hideKeyboardCompletely = hideKeyboardCompletely;
+//# sourceMappingURL=utils.js.map

package/build/lib/commands/device/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../lib/commands/device/utils.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,6CAAqC;AACrC,4DAA6B;AAC7B,uCAAuC;AACvC,2DAK4B;AAC5B,wDAAyB;AAEzB,MAAM,0BAA0B,GAAG,CAAC,CAAC;AACrC,MAAM,iCAAiC,GAAG,IAAI,CAAC;AAE/C;;;GAGG;AACH,SAAgB,eAAe,CAAC,MAAM;IACpC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;QACtB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;KAChC;AACH,CAAC;AAJD,0CAIC;AAED;;;GAGG;AACH,SAAgB,4BAA4B;IAC1C,KAAK,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,EAAE;QACpF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,EAAE;YACT,SAAS;SACV;QAED,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK,EAAE;YACV,SAAS;SACV;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,eAAe,GAAG,sGAAsG,CACzH,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,kBAAkB,IAAI,yCAAyC,KAAK,CAAC,KAAK,MAAM,MAAM,CACpF,IAAI,CACL,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CACnC,CAAC;KACH;AACH,CAAC;AArBD,oEAqBC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,YAAY;IAC7C,IAAI,YAAY,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE;QACxD,OAAO,YAAY,CAAC;KACrB;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,8BAA8B,YAAY,qBAAqB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,IAAI;QAC5F,qBAAqB,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAC1D,CAAC;IACF,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC;AACrC,CAAC;AATD,gDASC;AAED;;;GAGG;AACH,SAAgB,cAAc;IAC5B,MAAM,EAAC,YAAY,EAAE,UAAU,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,IAAI,CAAC;IACtD,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,OAAO,EAAE;QACX,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtB,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;SACzB;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,GAAG,cAAI,CAAC,UAAU,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;SAC/C;KACF;IACD,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;KACvE;IACD,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC3B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,wCAiBC;AAED;;;GAGG;AACI,KAAK,UAAU,eAAe;IACnC,MAAM,EACJ,GAAG,EACH,MAAM,EAAE,GAAG,EACX,QAAQ,EACR,MAAM,EAAE,OAAO,EACf,gBAAgB,EAAE,aAAa,EAC/B,eAAe,EAAE,YAAY,GAC9B,GAAG,IAAI,CAAC,IAAI,CAAC;IACd,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,iBAAiB,GAAG,IAAI,CAAC;IAC7B,IAAI;QACF,MAAM,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,OAAO,qBAAqB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACrE,iBAAiB,GAAG,KAAK,CAAC;KAC3B;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACzC,IAAI,iBAAiB,EAAE;QACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,OAAO,0CAA0C,CAAC,CAAC;YAC9E,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;SACtC;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;YACnE,OAAO;SACR;KACF;IACD,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;QAC5B,IAAI;QACJ,GAAG;QACH,QAAQ;QACR,OAAO;QACP,aAAa;QACb,YAAY;KACb,CAAC,CAAC;AACL,CAAC;AAvCD,0CAuCC;AAED;;;GAGG;AACI,KAAK,UAAU,aAAa,CAAC,IAAI,GAAG,IAAI;IAC7C,0CAA0C;IAC1C,0DAA0D;IAC1D,MAAM,EACJ,OAAO,EACP,kBAAkB,EAClB,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,gBAAgB,EAChB,QAAQ,EACR,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,GACd,GAAG,IAAI,IAAI,EAAE,CAAC;IACf,OAAO,MAAM,oBAAG,CAAC,SAAS,CAAC;QACzB,OAAO;QACP,kBAAkB;QAClB,aAAa;QACb,sBAAsB;QACtB,cAAc;QACd,WAAW;QACX,YAAY;QACZ,gBAAgB;QAChB,QAAQ;QACR,WAAW;QACX,oBAAoB;QACpB,iBAAiB;QACjB,mBAAmB;QACnB,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAnCD,sCAmCC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe,CAAC,YAAY;IAChD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAExD,IAAI;QACF,kFAAkF;QAClF,qFAAqF;QACrF,MAAM,IAAA,wBAAa,EACjB,0BAA0B,EAC1B,iCAAiC,EACjC,KAAK,IAAI,EAAE,CACT,MAAM,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,yBAAiB,EAAE,uCAAkB,EAAE;YACrE,gBAAgB,EAAE,IAAI;SACvB,CAAC,CACL,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,YAAY,EAAE;YAChB,MAAM,GAAG,CAAC;SACX;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,mCAAmC,yBAAiB,KAAK;YACvD,IAAI,GAAG,CAAC,OAAO,uCAAuC;YACtD,2DAA2D;YAC3D,6CAA6C,CAChD,CAAC;KACH;IAED,8DAA8D;IAC9D,mEAAmE;IACnE,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,EAAE;QAClD,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,GAAG,uCAAkB,uBAAuB,GAAG,4CAA4C,CAC5F,CAAC;QACF,OAAO;KACR;IAED,MAAM,sCAAsC,GAAG,KAAK,IAAI,EAAE;QACxD,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;YACvC,OAAO;SACR;QAED,qDAAqD;QACrD,qEAAqE;QACrE,MAAM,KAAK,GAAG,CAAC,qBAAqB,EAAE,sBAAsB,EAAE,sBAAsB,CAAC,CAAC;QACtF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,KAAK,QAAQ,uCAAkB,GAAG,CAAC,CAAC;QAC1E,MAAM,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAC7B,uCAAkB,EAClB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAC5C,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI;QACF,MAAM,kBAAC,CAAC,GAAG,CAAC;YACV,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE;YACjD,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE;YAC1D,sCAAsC,EAAE;SACzC,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;KACzB;IAED,kEAAkE;IAClE,sEAAsE;IACtE,mDAAmD;IACnD,IAAI;QACF,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;SAC1C,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,YAAY,EAAE;YAChB,MAAM,GAAG,CAAC;SACX;KACF;AACH,CAAC;AA1ED,0CA0EC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB;IACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEpD,mEAAmE;IACnE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;IAE/C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,UAAU,EAAE,CAAC,CAAC;IACvD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,gCAAW,GAAG,CAAC,CAAC;IAClD,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,gCAAW,CAAC,CAAC;IACtC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,gCAAW,CAAC,CAAC;IACnC,OAAO,UAAU,CAAC;AACpB,CAAC;AAXD,kDAWC;AAED;;;GAGG;AACI,KAAK,UAAU,sBAAsB;IAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oDAAoD,8BAAS,GAAG,CAAC,CAAC;IACjF,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,8BAAS,CAAC,CAAC;IACpC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,8BAAS,CAAC,CAAC;AACnC,CAAC;AAJD,wDAIC"}

package/build/lib/commands/deviceidle.d.ts

@@ -1,8 +1,11 @@
-export default DeviceidleMixin;
-export type ADB = import('appium-adb').ADB;
 /**
- * @type {import('./mixins').DeviceidleMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * This is a wrapper to 'adb shell dumpsys deviceidle' interface.
+ * Read https://www.protechtraining.com/blog/post/diving-into-android-m-doze-875
+ * for more details.
+ *
+ * @param {import('./types').DeviceidleOpts} opts
+ * @returns {Promise<void>}
  */
-declare const DeviceidleMixin: import('./mixins').DeviceidleMixin & ThisType<import('../driver').AndroidDriver>;
+export function mobileDeviceidle(opts: import('./types').DeviceidleOpts): Promise<void>;
+export type ADB = import('appium-adb').ADB;
 //# sourceMappingURL=deviceidle.d.ts.map

package/build/lib/commands/deviceidle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deviceidle.d.ts","sourceRoot":"","sources":["../../../lib/commands/deviceidle.js"],"names":[],"mappings":";kBAuDa,OAAO,YAAY,EAAE,GAAG;AAjDrC;;;GAGG;AACH,+BAHU,OAAO,UAAU,EAAE,eAAe,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CAyCxF"}
+{"version":3,"file":"deviceidle.d.ts","sourceRoot":"","sources":["../../../lib/commands/deviceidle.js"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,uCAHW,OAAO,SAAS,EAAE,cAAc,GAC9B,QAAQ,IAAI,CAAC,CA4BzB;kBAGY,OAAO,YAAY,EAAE,GAAG"}

package/build/lib/commands/deviceidle.js

@@ -3,48 +3,42 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileDeviceidle = void 0;
 const driver_1 = require("appium/driver");
 const lodash_1 = __importDefault(require("lodash"));
-const mixins_1 = require("./mixins");
 const SUPPORTED_ACTIONS = ['whitelistAdd', 'whitelistRemove'];
 /**
- * @type {import('./mixins').DeviceidleMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * This is a wrapper to 'adb shell dumpsys deviceidle' interface.
+ * Read https://www.protechtraining.com/blog/post/diving-into-android-m-doze-875
+ * for more details.
+ *
+ * @param {import('./types').DeviceidleOpts} opts
+ * @returns {Promise<void>}
  */
-const DeviceidleMixin = {
-    /**
-     * This is a wrapper to 'adb shell dumpsys deviceidle' interface.
-     * Read https://www.protechtraining.com/blog/post/diving-into-android-m-doze-875
-     * for more details.
-     *
-     * @param {import('./types').DeviceidleOpts} opts
-     */
-    async mobileDeviceidle(opts) {
-        const { action, packages, } = opts;
-        if (!(lodash_1.default.isString(packages) || lodash_1.default.isArray(packages))) {
-            throw new driver_1.errors.InvalidArgumentError(`packages argument must be a string or an array`);
-        }
-        /** @type {string[]} */
-        const packagesArr = lodash_1.default.isArray(packages) ? packages : [packages];
-        /** @type {string[]} */
-        const commonArgs = ['dumpsys', 'deviceidle', 'whitelist'];
-        /** @type {(x: string) => string[]} */
-        let argsGenerator;
-        switch (action) {
-            case SUPPORTED_ACTIONS[0]:
-                argsGenerator = (pkg) => [...commonArgs, `+${pkg}`];
-                break;
-            case SUPPORTED_ACTIONS[1]:
-                argsGenerator = (pkg) => [...commonArgs, `-${pkg}`];
-                break;
-            default:
-                throw new driver_1.errors.InvalidArgumentError(`action must be one of ${JSON.stringify(SUPPORTED_ACTIONS)}. Got '${action}' instead`);
-        }
-        await (this.adb).shellChunks(argsGenerator, packagesArr);
-    },
-};
-(0, mixins_1.mixin)(DeviceidleMixin);
-exports.default = DeviceidleMixin;
+async function mobileDeviceidle(opts) {
+    const { action, packages } = opts;
+    if (!(lodash_1.default.isString(packages) || lodash_1.default.isArray(packages))) {
+        throw new driver_1.errors.InvalidArgumentError(`packages argument must be a string or an array`);
+    }
+    /** @type {string[]} */
+    const packagesArr = lodash_1.default.isArray(packages) ? packages : [packages];
+    /** @type {string[]} */
+    const commonArgs = ['dumpsys', 'deviceidle', 'whitelist'];
+    /** @type {(x: string) => string[]} */
+    let argsGenerator;
+    switch (action) {
+        case SUPPORTED_ACTIONS[0]:
+            argsGenerator = (pkg) => [...commonArgs, `+${pkg}`];
+            break;
+        case SUPPORTED_ACTIONS[1]:
+            argsGenerator = (pkg) => [...commonArgs, `-${pkg}`];
+            break;
+        default:
+            throw new driver_1.errors.InvalidArgumentError(`action must be one of ${JSON.stringify(SUPPORTED_ACTIONS)}. Got '${action}' instead`);
+    }
+    await this.adb.shellChunks(argsGenerator, packagesArr);
+}
+exports.mobileDeviceidle = mobileDeviceidle;
 /**
  * @typedef {import('appium-adb').ADB} ADB
  */

package/build/lib/commands/deviceidle.js.map

@@ -1 +1 @@
-{"version":3,"file":"deviceidle.js","sourceRoot":"","sources":["../../../lib/commands/deviceidle.js"],"names":[],"mappings":";;;;;AAAA,0CAAqC;AACrC,oDAAuB;AACvB,qCAA+B;AAE/B,MAAM,iBAAiB,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;AAE9D;;;GAGG;AACH,MAAM,eAAe,GAAG;IACtB;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAI;QACzB,MAAM,EACJ,MAAM,EACN,QAAQ,GACT,GAAG,IAAI,CAAC;QAET,IAAI,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE;YAClD,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,gDAAgD,CAAC,CAAC;SACzF;QAED,uBAAuB;QACvB,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAChE,uBAAuB;QACvB,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QAC1D,sCAAsC;QACtC,IAAI,aAAa,CAAC;QAClB,QAAQ,MAAM,EAAE;YACd,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACvB,aAAa,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBACpD,MAAM;YACR,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACvB,aAAa,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBACpD,MAAM;YACR;gBACE,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,yBAAyB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,UAAU,MAAM,WAAW,CACtF,CAAC;SACL;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;CACF,CAAC;AAEF,IAAA,cAAK,EAAC,eAAe,CAAC,CAAC;AAEvB,kBAAe,eAAe,CAAC;AAE/B;;GAEG"}
+{"version":3,"file":"deviceidle.js","sourceRoot":"","sources":["../../../lib/commands/deviceidle.js"],"names":[],"mappings":";;;;;;AAAA,0CAAqC;AACrC,oDAAuB;AAEvB,MAAM,iBAAiB,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;AAE9D;;;;;;;GAOG;AACI,KAAK,UAAU,gBAAgB,CAAC,IAAI;IACzC,MAAM,EAAC,MAAM,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;IAEhC,IAAI,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE;QAClD,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,gDAAgD,CAAC,CAAC;KACzF;IAED,uBAAuB;IACvB,MAAM,WAAW,GAAG,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAChE,uBAAuB;IACvB,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC1D,sCAAsC;IACtC,IAAI,aAAa,CAAC;IAClB,QAAQ,MAAM,EAAE;QACd,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,aAAa,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;YACpD,MAAM;QACR,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,aAAa,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;YACpD,MAAM;QACR;YACE,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,yBAAyB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,UAAU,MAAM,WAAW,CACtF,CAAC;KACL;IACD,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;AACzD,CAAC;AA1BD,4CA0BC;AAED;;GAEG"}

package/build/lib/commands/element.d.ts

@@ -1,8 +1,102 @@
-export default ElementMixin;
-export type ADB = import('appium-adb').ADB;
 /**
- * @type {import('./mixins').ElementMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} attribute
+ * @param {string} elementId
+ * @returns {Promise<string?>}
  */
-declare const ElementMixin: import('./mixins').ElementMixin & ThisType<import('../driver').AndroidDriver>;
+export function getAttribute(this: import("../driver").AndroidDriver, attribute: string, elementId: string): Promise<string | null>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<void>}
+ */
+export function click(this: import("../driver").AndroidDriver, elementId: string): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<string>}
+ */
+export function getText(this: import("../driver").AndroidDriver, elementId: string): Promise<string>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<import('@appium/types').Position>}
+ */
+export function getLocation(this: import("../driver").AndroidDriver, elementId: string): Promise<import('@appium/types').Position>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<import('@appium/types').Size>}
+ */
+export function getSize(this: import("../driver").AndroidDriver, elementId: string): Promise<import('@appium/types').Size>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<string>}
+ */
+export function getName(this: import("../driver").AndroidDriver, elementId: string): Promise<string>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<boolean>}
+ */
+export function elementDisplayed(this: import("../driver").AndroidDriver, elementId: string): Promise<boolean>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<boolean>}
+ */
+export function elementEnabled(this: import("../driver").AndroidDriver, elementId: string): Promise<boolean>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<boolean>}
+ */
+export function elementSelected(this: import("../driver").AndroidDriver, elementId: string): Promise<boolean>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string|string[]} keys
+ * @param {string} elementId
+ * @param {boolean} [replace=false]
+ * @returns {Promise<void>}
+ */
+export function setElementValue(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string, replace?: boolean | undefined): Promise<void>;
+/**
+ * Reason for isolating doSetElementValue from setElementValue is for reusing setElementValue
+ * across android-drivers (like appium-uiautomator2-driver) and to avoid code duplication.
+ * Other android-drivers (like appium-uiautomator2-driver) need to override doSetElementValue
+ * to facilitate setElementValue.
+ *
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').DoSetElementValueOpts} params
+ * @returns {Promise<void>}
+ */
+export function doSetElementValue(this: import("../driver").AndroidDriver, params: import('./types').DoSetElementValueOpts): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string|string[]} keys
+ * @param {string} elementId
+ * @returns {Promise<void>}
+ */
+export function setValue(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string|string[]} keys
+ * @param {string} elementId
+ * @returns {Promise<void>}
+ */
+export function replaceValue(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string|string[]} keys
+ * @param {string} elementId
+ * @returns {Promise<void>}
+ */
+export function setValueImmediate(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} elementId
+ * @returns {Promise<import('@appium/types').Position>}
+ */
+export function getLocationInView(this: import("../driver").AndroidDriver, elementId: string): Promise<import('@appium/types').Position>;
 //# sourceMappingURL=element.d.ts.map

package/build/lib/commands/element.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../lib/commands/element.js"],"names":[],"mappings":";kBAqJa,OAAO,YAAY,EAAE,GAAG;AA/IrC;;;GAGG;AACH,4BAHU,OAAO,UAAU,EAAE,YAAY,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CAuIrF"}
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../lib/commands/element.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,iFAJW,MAAM,aACN,MAAM,GACJ,QAAQ,MAAM,QAAE,CAI5B;AAED;;;;GAIG;AACH,0EAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAIzB;AAED;;;;GAIG;AACH,4EAHW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAI3B;AAED;;;;GAIG;AACH,gFAHW,MAAM,GACJ,QAAQ,OAAO,eAAe,EAAE,QAAQ,CAAC,CAIrD;AAED;;;;GAIG;AACH,4EAHW,MAAM,GACJ,QAAQ,OAAO,eAAe,EAAE,IAAI,CAAC,CAIjD;AAED;;;;GAIG;AACH,4EAHW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAI3B;AAED;;;;GAIG;AACH,qFAHW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAI5B;AAED;;;;GAIG;AACH,mFAHW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAI5B;AAED;;;;GAIG;AACH,oFAHW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAI5B;AAED;;;;;;GAMG;AACH,+EALW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,kCAEJ,QAAQ,IAAI,CAAC,CASzB;AAED;;;;;;;;;GASG;AACH,mFAHW,OAAO,SAAS,EAAE,qBAAqB,GACrC,QAAQ,IAAI,CAAC,CAIzB;AAED;;;;;GAKG;AACH,wEAJW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,GACJ,QAAQ,IAAI,CAAC,CAIzB;AAED;;;;;GAKG;AACH,4EAJW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,GACJ,QAAQ,IAAI,CAAC,CAIzB;AAED;;;;;GAKG;AACH,iFAJW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,GACJ,QAAQ,IAAI,CAAC,CAQzB;AAED;;;;GAIG;AACH,sFAHW,MAAM,GACJ,QAAQ,OAAO,eAAe,EAAE,QAAQ,CAAC,CAIrD"}