appium-android-driver 7.8.2 → 8.0.0

package/build/lib/commands/geolocation.js

@@ -0,0 +1,182 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetMockLocation = exports.setMockLocationApp = exports.toggleLocationServices = exports.isLocationServicesEnabled = exports.getGeoLocation = exports.mobileRefreshGpsCache = exports.setGeoLocation = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const support_1 = require("@appium/support");
+const node_path_1 = __importDefault(require("node:path"));
+const bluebird_1 = __importDefault(require("bluebird"));
+const io_appium_settings_1 = require("io.appium.settings");
+const app_management_1 = require("./app-management");
+// The value close to zero, but not zero, is needed
+// to trick JSON generation and send a float value instead of an integer,
+// This allows strictly-typed clients, like Java, to properly
+// parse it. Otherwise float 0.0 is always represented as integer 0 in JS.
+// The value must not be greater than DBL_EPSILON (https://opensource.apple.com/source/Libc/Libc-498/include/float.h)
+const GEO_EPSILON = Number.MIN_VALUE;
+const MOCK_APP_IDS_STORE = '/data/local/tmp/mock_apps.json';
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('@appium/types').Location} location
+ * @returns {Promise<import('@appium/types').Location>}
+ */
+async function setGeoLocation(location) {
+    await this.settingsApp.setGeoLocation(location, this.isEmulator());
+    try {
+        return await this.getGeoLocation();
+    }
+    catch (e) {
+        this.log.warn(`Could not get the current geolocation info: ${ /** @type {Error} */(e).message}`);
+        this.log.warn(`Returning the default zero'ed values`);
+        return {
+            latitude: GEO_EPSILON,
+            longitude: GEO_EPSILON,
+            altitude: GEO_EPSILON,
+        };
+    }
+}
+exports.setGeoLocation = setGeoLocation;
+/**
+ * Sends an async request to refresh the GPS cache.
+ *
+ * This feature only works if the device under test has Google Play Services
+ * installed. In case the vanilla LocationManager is used the device API level
+ * must be at version 30 (Android R) or higher.
+ *
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').GpsCacheRefreshOpts} [opts={}]
+ * @returns {Promise<void>}
+ */
+async function mobileRefreshGpsCache(opts = {}) {
+    const { timeoutMs } = opts;
+    await this.settingsApp.refreshGeoLocationCache(timeoutMs);
+}
+exports.mobileRefreshGpsCache = mobileRefreshGpsCache;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<import('@appium/types').Location>}
+ */
+async function getGeoLocation() {
+    const { latitude, longitude, altitude } = await this.settingsApp.getGeoLocation();
+    return {
+        latitude: parseFloat(String(latitude)) || GEO_EPSILON,
+        longitude: parseFloat(String(longitude)) || GEO_EPSILON,
+        altitude: parseFloat(String(altitude)) || GEO_EPSILON,
+    };
+}
+exports.getGeoLocation = getGeoLocation;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<boolean>}
+ */
+async function isLocationServicesEnabled() {
+    return (await this.adb.getLocationProviders()).includes('gps');
+}
+exports.isLocationServicesEnabled = isLocationServicesEnabled;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+async function toggleLocationServices() {
+    this.log.info('Toggling location services');
+    const isGpsEnabled = await this.isLocationServicesEnabled();
+    this.log.debug(`Current GPS state: ${isGpsEnabled}. ` +
+        `The service is going to be ${isGpsEnabled ? 'disabled' : 'enabled'}`);
+    await this.adb.toggleGPSLocationProvider(!isGpsEnabled);
+}
+exports.toggleLocationServices = toggleLocationServices;
+// #region Internal helpers
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} appId
+ * @returns {Promise<void>}
+ */
+async function setMockLocationApp(appId) {
+    try {
+        if ((await this.adb.getApiLevel()) < 23) {
+            await this.adb.shell(['settings', 'put', 'secure', 'mock_location', '1']);
+        }
+        else {
+            await this.adb.shell(['appops', 'set', appId, 'android:mock_location', 'allow']);
+        }
+    }
+    catch (err) {
+        this.log.warn(`Unable to set mock location for app '${appId}': ${err.message}`);
+        return;
+    }
+    try {
+        /** @type {string[]} */
+        let pkgIds = [];
+        if (await this.adb.fileExists(MOCK_APP_IDS_STORE)) {
+            try {
+                pkgIds = JSON.parse(await this.adb.shell(['cat', MOCK_APP_IDS_STORE]));
+            }
+            catch (ign) { }
+        }
+        if (pkgIds.includes(appId)) {
+            return;
+        }
+        pkgIds.push(appId);
+        const tmpRoot = await support_1.tempDir.openDir();
+        const srcPath = node_path_1.default.posix.join(tmpRoot, node_path_1.default.posix.basename(MOCK_APP_IDS_STORE));
+        try {
+            await support_1.fs.writeFile(srcPath, JSON.stringify(pkgIds), 'utf8');
+            await this.adb.push(srcPath, MOCK_APP_IDS_STORE);
+        }
+        finally {
+            await support_1.fs.rimraf(tmpRoot);
+        }
+    }
+    catch (e) {
+        this.log.warn(`Unable to persist mock location app id '${appId}': ${e.message}`);
+    }
+}
+exports.setMockLocationApp = setMockLocationApp;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+async function resetMockLocation() {
+    try {
+        if ((await this.adb.getApiLevel()) < 23) {
+            await this.adb.shell(['settings', 'put', 'secure', 'mock_location', '0']);
+            return;
+        }
+        const thirdPartyPkgIdsPromise = app_management_1.getThirdPartyPackages.bind(this)();
+        let pkgIds = [];
+        if (await this.adb.fileExists(MOCK_APP_IDS_STORE)) {
+            try {
+                pkgIds = JSON.parse(await this.adb.shell(['cat', MOCK_APP_IDS_STORE]));
+            }
+            catch (ign) { }
+        }
+        const thirdPartyPkgIds = await thirdPartyPkgIdsPromise;
+        // Only include currently installed packages
+        const resultPkgs = lodash_1.default.intersection(pkgIds, thirdPartyPkgIds);
+        if (lodash_1.default.size(resultPkgs) <= 1) {
+            await this.adb.shell([
+                'appops',
+                'set',
+                resultPkgs[0] ?? io_appium_settings_1.SETTINGS_HELPER_ID,
+                'android:mock_location',
+                'deny',
+            ]);
+            return;
+        }
+        this.log.debug(`Resetting mock_location permission for the following apps: ${resultPkgs}`);
+        await bluebird_1.default.all(resultPkgs.map((pkgId) => (async () => {
+            try {
+                await this.adb.shell(['appops', 'set', pkgId, 'android:mock_location', 'deny']);
+            }
+            catch (ign) { }
+        })()));
+    }
+    catch (err) {
+        this.log.warn(`Unable to reset mock location: ${err.message}`);
+    }
+}
+exports.resetMockLocation = resetMockLocation;
+// #endregion Internal helpers
+//# sourceMappingURL=geolocation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation.js","sourceRoot":"","sources":["../../../lib/commands/geolocation.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,6CAA4C;AAC5C,0DAA6B;AAC7B,wDAAyB;AACzB,2DAAsD;AACtD,qDAAuD;AAEvD,mDAAmD;AACnD,yEAAyE;AACzE,6DAA6D;AAC7D,0EAA0E;AAC1E,qHAAqH;AACrH,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC;AACrC,MAAM,kBAAkB,GAAG,gCAAgC,CAAC;AAE5D;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAAC,QAAQ;IAC3C,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACnE,IAAI;QACF,OAAO,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;KACpC;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,+CAA+C,CAAA,oBAAqB,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAClF,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACtD,OAAO;YACL,QAAQ,EAAE,WAAW;YACrB,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,WAAW;SACtB,CAAC;KACH;AACH,CAAC;AAfD,wCAeC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,qBAAqB,CAAC,IAAI,GAAG,EAAE;IACnD,MAAM,EAAC,SAAS,EAAC,GAAG,IAAI,CAAC;IACzB,MAAM,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5D,CAAC;AAHD,sDAGC;AAED;;;GAGG;AACI,KAAK,UAAU,cAAc;IAClC,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;IAChF,OAAO;QACL,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,WAAW;QACrD,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,WAAW;QACvD,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,WAAW;KACtD,CAAC;AACJ,CAAC;AAPD,wCAOC;AAED;;;GAGG;AACI,KAAK,UAAU,yBAAyB;IAC7C,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAFD,8DAEC;AAED;;;GAGG;AACI,KAAK,UAAU,sBAAsB;IAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC5C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,yBAAyB,EAAE,CAAC;IAC5D,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,sBAAsB,YAAY,IAAI;QACpC,8BAA8B,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,CACxE,CAAC;IACF,MAAM,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,YAAY,CAAC,CAAC;AAC1D,CAAC;AARD,wDAQC;AAED,2BAA2B;AAE3B;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CAAC,KAAK;IAC5C,IAAI;QACF,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;YACvC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC;SAC3E;aAAM;YACL,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC,CAAC;SAClF;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,KAAK,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,OAAO;KACR;IACD,IAAI;QACF,uBAAuB;QACvB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;YACjD,IAAI;gBACF,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;aACxE;YAAC,OAAO,GAAG,EAAE,GAAE;SACjB;QACD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC1B,OAAO;SACR;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,MAAM,OAAO,GAAG,MAAM,iBAAO,CAAC,OAAO,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,mBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,mBAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC;QAClF,IAAI;YACF,MAAM,YAAE,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5D,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;SAClD;gBAAS;YACR,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SAC1B;KACF;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2CAA2C,KAAK,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KAClF;AACH,CAAC;AAlCD,gDAkCC;AAED;;;GAGG;AACI,KAAK,UAAU,iBAAiB;IACrC,IAAI;QACF,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;YACvC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC;YAC1E,OAAO;SACR;QAED,MAAM,uBAAuB,GAAG,sCAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACnE,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;YACjD,IAAI;gBACF,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;aACxE;YAAC,OAAO,GAAG,EAAE,GAAE;SACjB;QACD,MAAM,gBAAgB,GAAG,MAAM,uBAAuB,CAAC;QACvD,4CAA4C;QAC5C,MAAM,UAAU,GAAG,gBAAC,CAAC,YAAY,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAC5D,IAAI,gBAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;gBACnB,QAAQ;gBACR,KAAK;gBACL,UAAU,CAAC,CAAC,CAAC,IAAI,uCAAkB;gBACnC,uBAAuB;gBACvB,MAAM;aACP,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8DAA8D,UAAU,EAAE,CAAC,CAAC;QAC3F,MAAM,kBAAC,CAAC,GAAG,CACT,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACvB,CAAC,KAAK,IAAI,EAAE;YACV,IAAI;gBACF,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,uBAAuB,EAAE,MAAM,CAAC,CAAC,CAAC;aACjF;YAAC,OAAO,GAAG,EAAE,GAAE;QAClB,CAAC,CAAC,EAAE,CACL,CACF,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kCAAkC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;KAChE;AACH,CAAC;AAzCD,8CAyCC;AAED,8BAA8B"}

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

@@ -1,8 +1,28 @@
-export default IMEMixin;
-export type ADB = import('appium-adb').ADB;
 /**
- * @type {import('./mixins').IMEMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<boolean>}
+ */
+export function isIMEActivated(this: import("../driver").AndroidDriver): Promise<boolean>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<string[]>}
+ */
+export function availableIMEEngines(this: import("../driver").AndroidDriver): Promise<string[]>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<string>}
  */
-declare const IMEMixin: import('./mixins').IMEMixin & ThisType<import('../driver').AndroidDriver>;
+export function getActiveIMEEngine(this: import("../driver").AndroidDriver): Promise<string>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} imeId
+ * @returns {Promise<void>}
+ */
+export function activateIMEEngine(this: import("../driver").AndroidDriver, imeId: string): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+export function deactivateIMEEngine(this: import("../driver").AndroidDriver): Promise<void>;
+export type ADB = import('appium-adb').ADB;
 //# sourceMappingURL=ime.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ime.d.ts","sourceRoot":"","sources":["../../../lib/commands/ime.js"],"names":[],"mappings":";kBAuDa,OAAO,YAAY,EAAE,GAAG;AAlDrC;;;GAGG;AACH,wBAHU,OAAO,UAAU,EAAE,QAAQ,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CA0CjF"}
+{"version":3,"file":"ime.d.ts","sourceRoot":"","sources":["../../../lib/commands/ime.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH,yEAFa,QAAQ,OAAO,CAAC,CAM5B;AAED;;;GAGG;AACH,8EAFa,QAAQ,MAAM,EAAE,CAAC,CAO7B;AAED;;;GAGG;AACH,6EAFa,QAAQ,MAAM,CAAC,CAK3B;AAED;;;;GAIG;AACH,kFAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;AAED;;;GAGG;AACH,8EAFa,QAAQ,IAAI,CAAC,CASzB;kBAGY,OAAO,YAAY,EAAE,GAAG"}

package/build/lib/commands/ime.js

@@ -1,50 +1,67 @@
 "use strict";
-// @ts-check
 Object.defineProperty(exports, "__esModule", { value: true });
-const mixins_1 = require("./mixins");
+exports.deactivateIMEEngine = exports.activateIMEEngine = exports.getActiveIMEEngine = exports.availableIMEEngines = exports.isIMEActivated = void 0;
 const driver_1 = require("appium/driver");
 /**
- * @type {import('./mixins').IMEMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<boolean>}
  */
-const IMEMixin = {
-    async isIMEActivated() {
-        // eslint-disable-line require-await
-        // IME is always activated on Android devices
-        return true;
-    },
-    async availableIMEEngines() {
-        this.log.debug('Retrieving available IMEs');
-        let engines = await this.adb.availableIMEs();
-        this.log.debug(`Engines: ${JSON.stringify(engines)}`);
-        return engines;
-    },
-    async getActiveIMEEngine() {
-        this.log.debug('Retrieving current default IME');
-        return String(await this.adb.defaultIME());
-    },
-    async activateIMEEngine(imeId) {
-        this.log.debug(`Attempting to activate IME ${imeId}`);
-        let availableEngines = await this.adb.availableIMEs();
-        if (availableEngines.indexOf(imeId) === -1) {
-            this.log.debug('IME not found, failing');
-            throw new driver_1.errors.IMENotAvailableError();
-        }
-        this.log.debug('Found installed IME, attempting to activate');
-        await this.adb.enableIME(imeId);
-        await this.adb.setIME(imeId);
-    },
-    async deactivateIMEEngine() {
-        let currentEngine = await this.getActiveIMEEngine();
-        // XXX: this allowed 'null' to be passed into `adb.shell`
-        if (currentEngine) {
-            this.log.debug(`Attempting to deactivate ${currentEngine}`);
-            await this.adb.disableIME(currentEngine);
-        }
-    },
-};
-exports.default = IMEMixin;
-(0, mixins_1.mixin)(IMEMixin);
+async function isIMEActivated() {
+    // eslint-disable-line require-await
+    // IME is always activated on Android devices
+    return true;
+}
+exports.isIMEActivated = isIMEActivated;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<string[]>}
+ */
+async function availableIMEEngines() {
+    this.log.debug('Retrieving available IMEs');
+    let engines = await this.adb.availableIMEs();
+    this.log.debug(`Engines: ${JSON.stringify(engines)}`);
+    return engines;
+}
+exports.availableIMEEngines = availableIMEEngines;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<string>}
+ */
+async function getActiveIMEEngine() {
+    this.log.debug('Retrieving current default IME');
+    return String(await this.adb.defaultIME());
+}
+exports.getActiveIMEEngine = getActiveIMEEngine;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} imeId
+ * @returns {Promise<void>}
+ */
+async function activateIMEEngine(imeId) {
+    this.log.debug(`Attempting to activate IME ${imeId}`);
+    let availableEngines = await this.adb.availableIMEs();
+    if (availableEngines.indexOf(imeId) === -1) {
+        this.log.debug('IME not found, failing');
+        throw new driver_1.errors.IMENotAvailableError();
+    }
+    this.log.debug('Found installed IME, attempting to activate');
+    await this.adb.enableIME(imeId);
+    await this.adb.setIME(imeId);
+}
+exports.activateIMEEngine = activateIMEEngine;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+async function deactivateIMEEngine() {
+    let currentEngine = await this.getActiveIMEEngine();
+    // XXX: this allowed 'null' to be passed into `adb.shell`
+    if (currentEngine) {
+        this.log.debug(`Attempting to deactivate ${currentEngine}`);
+        await this.adb.disableIME(currentEngine);
+    }
+}
+exports.deactivateIMEEngine = deactivateIMEEngine;
 /**
  * @typedef {import('appium-adb').ADB} ADB
  */

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

@@ -1 +1 @@
-{"version":3,"file":"ime.js","sourceRoot":"","sources":["../../../lib/commands/ime.js"],"names":[],"mappings":";AAAA,YAAY;;AAEZ,qCAA+B;AAC/B,0CAAqC;AAErC;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,KAAK,CAAC,cAAc;QAClB,oCAAoC;QACpC,6CAA6C;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC5C,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QAC7C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACjD,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,KAAK;QAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;QACtD,IAAI,gBAAgB,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QACtD,IAAI,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;YAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACzC,MAAM,IAAI,eAAM,CAAC,oBAAoB,EAAE,CAAC;SACzC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAChC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,IAAI,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACpD,yDAAyD;QACzD,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,aAAa,EAAE,CAAC,CAAC;YAC5D,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;SAC1C;IACH,CAAC;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC;AAExB,IAAA,cAAK,EAAC,QAAQ,CAAC,CAAC;AAEhB;;GAEG"}
+{"version":3,"file":"ime.js","sourceRoot":"","sources":["../../../lib/commands/ime.js"],"names":[],"mappings":";;;AAAA,0CAAqC;AAErC;;;GAGG;AACI,KAAK,UAAU,cAAc;IAClC,oCAAoC;IACpC,6CAA6C;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC;AAJD,wCAIC;AAED;;;GAGG;AACI,KAAK,UAAU,mBAAmB;IACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC5C,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;IAC7C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACtD,OAAO,OAAO,CAAC;AACjB,CAAC;AALD,kDAKC;AAED;;;GAGG;AACI,KAAK,UAAU,kBAAkB;IACtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;AAC7C,CAAC;AAHD,gDAGC;AAED;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAAC,KAAK;IAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;IACtD,IAAI,gBAAgB,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;IACtD,IAAI,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACzC,MAAM,IAAI,eAAM,CAAC,oBAAoB,EAAE,CAAC;KACzC;IACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;IAC9D,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAVD,8CAUC;AAED;;;GAGG;AACI,KAAK,UAAU,mBAAmB;IACvC,IAAI,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACpD,yDAAyD;IACzD,IAAI,aAAa,EAAE;QACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,aAAa,EAAE,CAAC,CAAC;QAC5D,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;KAC1C;AACH,CAAC;AAPD,kDAOC;AAED;;GAEG"}

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

@@ -1,8 +1,59 @@
-export default ActivityMixin;
-export type ADB = import('appium-adb').ADB;
 /**
- * @type {import('./mixins').ActivityMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * @deprecated
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} appPackage
+ * @param {string} appActivity
+ * @param {string} [appWaitPackage]
+ * @param {string} [appWaitActivity]
+ * @param {string} [intentAction]
+ * @param {string} [intentCategory]
+ * @param {string} [intentFlags]
+ * @param {string} [optionalIntentArguments]
+ * @param {boolean} [dontStopAppOnReset]
+ * @returns {Promise<void>}
+ */
+export function startActivity(this: import("../driver").AndroidDriver, appPackage: string, appActivity: string, appWaitPackage?: string | undefined, appWaitActivity?: string | undefined, intentAction?: string | undefined, intentCategory?: string | undefined, intentFlags?: string | undefined, optionalIntentArguments?: string | undefined, dontStopAppOnReset?: boolean | undefined): Promise<void>;
+export class startActivity {
+    /**
+     * @deprecated
+     * @this {import('../driver').AndroidDriver}
+     * @param {string} appPackage
+     * @param {string} appActivity
+     * @param {string} [appWaitPackage]
+     * @param {string} [appWaitActivity]
+     * @param {string} [intentAction]
+     * @param {string} [intentCategory]
+     * @param {string} [intentFlags]
+     * @param {string} [optionalIntentArguments]
+     * @param {boolean} [dontStopAppOnReset]
+     * @returns {Promise<void>}
+     */
+    constructor(this: import("../driver").AndroidDriver, appPackage: string, appActivity: string, appWaitPackage?: string | undefined, appWaitActivity?: string | undefined, intentAction?: string | undefined, intentCategory?: string | undefined, intentFlags?: string | undefined, optionalIntentArguments?: string | undefined, dontStopAppOnReset?: boolean | undefined);
+    _cachedActivityArgs: import("@appium/types").StringRecord;
+}
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').StartActivityOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+export function mobileStartActivity(this: import("../driver").AndroidDriver, opts?: import("./types").StartActivityOpts | undefined): Promise<string>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').BroadcastOpts} [opts={}]
+ * @returns {Promise<string>}
  */
-declare const ActivityMixin: import('./mixins').ActivityMixin & ThisType<import('../driver').AndroidDriver>;
+export function mobileBroadcast(this: import("../driver").AndroidDriver, opts?: import("./types").BroadcastOpts | undefined): Promise<string>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').StartServiceOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+export function mobileStartService(this: import("../driver").AndroidDriver, opts?: import("./types").StartServiceOpts | undefined): Promise<string>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').StopServiceOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+export function mobileStopService(this: import("../driver").AndroidDriver, opts?: import("./types").IntentOpts | undefined): Promise<string>;
+export type ADB = import('appium-adb').ADB;
 //# sourceMappingURL=intent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"intent.d.ts","sourceRoot":"","sources":["../../../lib/commands/intent.js"],"names":[],"mappings":";kBA4La,OAAO,YAAY,EAAE,GAAG;AAvFrC;;;GAGG;AACH,6BAHU,OAAO,UAAU,EAAE,aAAa,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CA+EtF"}
+{"version":3,"file":"intent.d.ts","sourceRoot":"","sources":["../../../lib/commands/intent.js"],"names":[],"mappings":"AAyBA;;;;;;;;;;;;;GAaG;AACH,mFAXW,MAAM,eACN,MAAM,gRAQJ,QAAQ,IAAI,CAAC,CAoCzB;;IAhDD;;;;;;;;;;;;;OAaG;IACH,iEAXW,MAAM,eACN,MAAM,+QA4ChB;IAHC,0DAAyD;;AAK3D;;;;GAIG;AACH,sIAFa,QAAQ,MAAM,CAAC,CA4B3B;AAED;;;;GAIG;AACH,8HAFa,QAAQ,MAAM,CAAC,CAgB3B;AAED;;;;GAIG;AACH,oIAFa,QAAQ,MAAM,CAAC,CAe3B;AAED;;;;GAIG;AACH,6HAFa,QAAQ,MAAM,CAAC,CAa3B;kBAiFY,OAAO,YAAY,EAAE,GAAG"}

package/build/lib/commands/intent.js

@@ -1,12 +1,12 @@
 "use strict";
-// @ts-check
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const mixins_1 = require("./mixins");
+exports.mobileStopService = exports.mobileStartService = exports.mobileBroadcast = exports.mobileStartActivity = exports.startActivity = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const driver_1 = require("appium/driver");
+const support_1 = require("@appium/support");
 const NO_VALUE_ARG_TYPE = 'sn';
 const SUPPORTED_EXTRA_TYPES = [
     's',
@@ -27,6 +27,138 @@ const SUPPORTED_EXTRA_TYPES = [
     'sal',
 ];
 const API_LEVEL_ANDROID_8 = 26;
+/**
+ * @deprecated
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} appPackage
+ * @param {string} appActivity
+ * @param {string} [appWaitPackage]
+ * @param {string} [appWaitActivity]
+ * @param {string} [intentAction]
+ * @param {string} [intentCategory]
+ * @param {string} [intentFlags]
+ * @param {string} [optionalIntentArguments]
+ * @param {boolean} [dontStopAppOnReset]
+ * @returns {Promise<void>}
+ */
+async function startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset) {
+    this.log.debug(`Starting package '${appPackage}' and activity '${appActivity}'`);
+    // dontStopAppOnReset is both an argument here, and a desired capability
+    // if the argument is set, use it, otherwise use the cap
+    if (!support_1.util.hasValue(dontStopAppOnReset)) {
+        dontStopAppOnReset = !!this.opts.dontStopAppOnReset;
+    }
+    /** @type {import('appium-adb').StartAppOptions} */
+    let args = {
+        pkg: appPackage,
+        activity: appActivity,
+        waitPkg: appWaitPackage || appPackage,
+        waitActivity: appWaitActivity || appActivity,
+        action: intentAction,
+        category: intentCategory,
+        flags: intentFlags,
+        optionalIntentArguments,
+        stopApp: !dontStopAppOnReset,
+    };
+    this._cachedActivityArgs = this._cachedActivityArgs || {};
+    this._cachedActivityArgs[`${args.waitPkg}/${args.waitActivity}`] = args;
+    await this.adb.startApp(args);
+}
+exports.startActivity = startActivity;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').StartActivityOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+async function mobileStartActivity(opts = {}) {
+    const { user, wait, stop, windowingMode, activityType, display } = opts;
+    const cmd = [
+        'am',
+        (await this.adb.getApiLevel()) < API_LEVEL_ANDROID_8 ? 'start' : 'start-activity',
+    ];
+    if (!lodash_1.default.isNil(user)) {
+        cmd.push('--user', String(user));
+    }
+    if (wait) {
+        cmd.push('-W');
+    }
+    if (stop) {
+        cmd.push('-S');
+    }
+    if (!lodash_1.default.isNil(windowingMode)) {
+        cmd.push('--windowingMode', String(windowingMode));
+    }
+    if (!lodash_1.default.isNil(activityType)) {
+        cmd.push('--activityType', String(activityType));
+    }
+    if (!lodash_1.default.isNil(display)) {
+        cmd.push('--display', String(display));
+    }
+    cmd.push(...parseIntentSpec(opts));
+    return await this.adb.shell(cmd);
+}
+exports.mobileStartActivity = mobileStartActivity;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').BroadcastOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+async function mobileBroadcast(opts = {}) {
+    const { user, receiverPermission, allowBackgroundActivityStarts } = opts;
+    const cmd = ['am', 'broadcast'];
+    if (!lodash_1.default.isNil(user)) {
+        cmd.push('--user', String(user));
+    }
+    if (receiverPermission) {
+        cmd.push('--receiver-permission', receiverPermission);
+    }
+    if (allowBackgroundActivityStarts) {
+        cmd.push('--allow-background-activity-starts');
+    }
+    cmd.push(...parseIntentSpec(opts));
+    return await this.adb.shell(cmd);
+}
+exports.mobileBroadcast = mobileBroadcast;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').StartServiceOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+async function mobileStartService(opts = {}) {
+    const { user, foreground } = opts;
+    const cmd = ['am'];
+    if ((await this.adb.getApiLevel()) < API_LEVEL_ANDROID_8) {
+        cmd.push('startservice');
+    }
+    else {
+        cmd.push(foreground ? 'start-foreground-service' : 'start-service');
+    }
+    if (!lodash_1.default.isNil(user)) {
+        cmd.push('--user', String(user));
+    }
+    cmd.push(...parseIntentSpec(opts));
+    return await this.adb.shell(cmd);
+}
+exports.mobileStartService = mobileStartService;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {import('./types').StopServiceOpts} [opts={}]
+ * @returns {Promise<string>}
+ */
+async function mobileStopService(opts = {}) {
+    const { user } = opts;
+    const cmd = [
+        'am',
+        (await this.adb.getApiLevel()) < API_LEVEL_ANDROID_8 ? 'stopservice' : 'stop-service',
+    ];
+    if (!lodash_1.default.isNil(user)) {
+        cmd.push('--user', String(user));
+    }
+    cmd.push(...parseIntentSpec(opts));
+    return await this.adb.shell(cmd);
+}
+exports.mobileStopService = mobileStopService;
+// #region Internal helpers
 /**
  *
  * @param {import('./types').IntentOpts} opts
@@ -97,87 +229,7 @@ function parseIntentSpec(opts = {}) {
     }
     return resultArgs;
 }
-/**
- * @type {import('./mixins').ActivityMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
- */
-const ActivityMixin = {
-    async mobileStartActivity(opts = {}) {
-        const { user, wait, stop, windowingMode, activityType, display } = opts;
-        const cmd = [
-            'am',
-            (await this.adb.getApiLevel()) < API_LEVEL_ANDROID_8
-                ? 'start'
-                : 'start-activity',
-        ];
-        if (!lodash_1.default.isNil(user)) {
-            cmd.push('--user', String(user));
-        }
-        if (wait) {
-            cmd.push('-W');
-        }
-        if (stop) {
-            cmd.push('-S');
-        }
-        if (!lodash_1.default.isNil(windowingMode)) {
-            cmd.push('--windowingMode', String(windowingMode));
-        }
-        if (!lodash_1.default.isNil(activityType)) {
-            cmd.push('--activityType', String(activityType));
-        }
-        if (!lodash_1.default.isNil(display)) {
-            cmd.push('--display', String(display));
-        }
-        cmd.push(...parseIntentSpec(opts));
-        return await this.adb.shell(cmd);
-    },
-    async mobileBroadcast(opts = {}) {
-        const { user, receiverPermission, allowBackgroundActivityStarts } = opts;
-        const cmd = ['am', 'broadcast'];
-        if (!lodash_1.default.isNil(user)) {
-            cmd.push('--user', String(user));
-        }
-        if (receiverPermission) {
-            cmd.push('--receiver-permission', receiverPermission);
-        }
-        if (allowBackgroundActivityStarts) {
-            cmd.push('--allow-background-activity-starts');
-        }
-        cmd.push(...parseIntentSpec(opts));
-        return await this.adb.shell(cmd);
-    },
-    async mobileStartService(opts = {}) {
-        const { user, foreground } = opts;
-        const cmd = ['am'];
-        if ((await this.adb.getApiLevel()) < API_LEVEL_ANDROID_8) {
-            cmd.push('startservice');
-        }
-        else {
-            cmd.push(foreground ? 'start-foreground-service' : 'start-service');
-        }
-        if (!lodash_1.default.isNil(user)) {
-            cmd.push('--user', String(user));
-        }
-        cmd.push(...parseIntentSpec(opts));
-        return await this.adb.shell(cmd);
-    },
-    async mobileStopService(opts = {}) {
-        const { user } = opts;
-        const cmd = [
-            'am',
-            (await this.adb.getApiLevel()) < API_LEVEL_ANDROID_8
-                ? 'stopservice'
-                : 'stop-service',
-        ];
-        if (!lodash_1.default.isNil(user)) {
-            cmd.push('--user', String(user));
-        }
-        cmd.push(...parseIntentSpec(opts));
-        return await this.adb.shell(cmd);
-    },
-};
-(0, mixins_1.mixin)(ActivityMixin);
-exports.default = ActivityMixin;
+// #endregion
 /**
  * @typedef {import('appium-adb').ADB} ADB
  */