appium-android-driver 5.13.4 → 5.14.0-alpha.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.13.5](https://github.com/appium/appium-android-driver/compare/v5.13.4...v5.13.5) (2023-06-16)
+
+
+### Miscellaneous Chores
+
+* Make sharp to an optional dependency ([#824](https://github.com/appium/appium-android-driver/issues/824)) ([598388b](https://github.com/appium/appium-android-driver/commit/598388be58ab4e5ece4f3606ce78cabddc1574bb))
+
 ## [5.13.4](https://github.com/appium/appium-android-driver/compare/v5.13.3...v5.13.4) (2023-06-15)
 
 

package/bootstrap/README.md

@@ -0,0 +1,19 @@
+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.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -11,41 +10,28 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 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;
+exports.webviewHelpers = exports.WEBVIEW_WIN = exports.WEBVIEW_BASE = exports.NATIVE_WIN = exports.CHROMIUM_WIN = exports.androidHelpers = exports.SETTINGS_HELPER_PKG_ID = exports.commonCapConstraints = 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;
+const driver_1 = require("./lib/driver");
+var constraints_1 = require("./lib/constraints");
+Object.defineProperty(exports, "commonCapConstraints", { enumerable: true, get: function () { return constraints_1.ANDROID_DRIVER_CONSTRAINTS; } });
+__exportStar(require("./lib/driver"), exports);
+var android_1 = require("./lib/helpers/android");
+Object.defineProperty(exports, "SETTINGS_HELPER_PKG_ID", { enumerable: true, get: function () { return android_1.SETTINGS_HELPER_PKG_ID; } });
+Object.defineProperty(exports, "androidHelpers", { enumerable: true, get: function () { return __importDefault(android_1).default; } });
+var webview_1 = require("./lib/helpers/webview");
+Object.defineProperty(exports, "CHROMIUM_WIN", { enumerable: true, get: function () { return webview_1.CHROMIUM_WIN; } });
+Object.defineProperty(exports, "NATIVE_WIN", { enumerable: true, get: function () { return webview_1.NATIVE_WIN; } });
+Object.defineProperty(exports, "WEBVIEW_BASE", { enumerable: true, get: function () { return webview_1.WEBVIEW_BASE; } });
+Object.defineProperty(exports, "WEBVIEW_WIN", { enumerable: true, get: function () { return webview_1.WEBVIEW_WIN; } });
+Object.defineProperty(exports, "webviewHelpers", { enumerable: true, get: function () { return __importDefault(webview_1).default; } });
+exports.default = driver_1.AndroidDriver;
 //# sourceMappingURL=index.js.map

package/build/lib/bootstrap.d.ts

@@ -20,10 +20,10 @@ export class AndroidBootstrap {
     _ignoreUnexpectedShutdown: any;
 }
 export namespace COMMAND_TYPES {
-    const ACTION: string;
-    const SHUTDOWN: string;
+    let ACTION: string;
+    let SHUTDOWN: string;
 }
-import B from "bluebird";
-import net from "net";
-import UiAutomator from "./uiautomator";
+import B from 'bluebird';
+import net from 'net';
+import UiAutomator from './uiautomator';
 //# sourceMappingURL=bootstrap.d.ts.map

package/build/lib/bootstrap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../lib/bootstrap.js"],"names":[],"mappings":";;AAuCA;IACE,kEAKC;IAJC,SAAc;IACd,mBAA4B;IAC5B,eAA0B;IA4K5B,uCAGC;IAED,oCAEC;IA/KD,mCASC;IANG,iDAEE;IAMN,iGA4EC;IArEG,aAMC;IA6CG,qCAA6D;IAoBrE,iDA4CC;IAED,mDAGC;IAED,0BAaC;IADC,4CAAuB;IAIzB,sBAUC;IAIC,+BAAuC;CAM1C"}
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../lib/bootstrap.js"],"names":[],"mappings":";;AAuCA;IACE,kEAKC;IAJC,SAAc;IACd,mBAA4B;IAC5B,eAA0B;IA4K5B,uCAGC;IAED,oCAEC;IA/KD,mCASC;IANG,iDAEE;IAMN,iGA4EC;IArEG,aAMC;IA6CG,qCAA6D;IAoBrE,iDA4CC;IAED,mDAGC;IAED,0BAaC;IADC,4CAAuB;IAIzB,sBAUC;IAIC,+BAAuC;CAM1C;;;;;cA1Na,UAAU;gBAJR,KAAK;wBADG,eAAe"}

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

@@ -1,209 +1,9 @@
-export default extensions;
-export type FingerprintOpts = any;
-export type SendSmsOptions = {
-    /**
-     * The phone number to send SMS to
-     */
-    phoneNumber: string;
-    /**
-     * The message payload
-     */
-    message: string;
-};
-export type GsmCallOptions = {
-    /**
-     * The phone number to call to
-     */
-    phoneNumber: string;
-    /**
-     * One of possible actions to take
-     */
-    action: call | accept | cancel | hold;
-};
-export type GsmSignalOptions = {
-    /**
-     * One of possible signal strength values, where 4 is the best signal.
-     */
-    strength: 0 | 1 | 2 | 3 | 4;
-};
-export type GsmVoiceOptions = {
-    state: on | off;
-};
-export type PowerAcOptions = {
-    state: on | off;
-};
-export type PowerCapacityOptions = {
-    /**
-     * - Percentage value in range [0, 100]
-     */
-    percent: number;
-};
-export type NetworkSpeedOptions = {
-    speed: gsm | scsd | gprs | edge | umts | hsdpa | lte | evdo | full;
-};
+export default ActionsMixin;
+export type AndroidBootstrap = import('../bootstrap').AndroidBootstrap;
+export type ADB = import('appium-adb').ADB;
 /**
- * Emulate sensors values on the connected emulator.
+ * @type {import('./mixins').ActionsMixin & ThisType<import('../driver').AndroidDriver>}
+ * @satisfies {import('@appium/types').ExternalDriver}
  */
-export type Sensor = {
-    /**
-     * - sensor type declared in adb.SENSORS
-     */
-    sensorType: string;
-    /**
-     * - value to set to the sensor
-     */
-    value: string;
-};
-export namespace commands {
-    function keyevent(keycode: any, metastate?: null): Promise<any>;
-    function pressKeyCode(keycode: any, metastate?: null): Promise<any>;
-    function longPressKeyCode(keycode: any, metastate?: null): Promise<any>;
-    function getOrientation(): Promise<any>;
-    function setOrientation(orientation: any): Promise<any>;
-    function fakeFlick(xSpeed: any, ySpeed: any): Promise<any>;
-    function fakeFlickElement(elementId: any, xoffset: any, yoffset: any, speed: any): Promise<any>;
-    function swipe(startX: any, startY: any, endX: any, endY: any, duration: any, touchCount: any, elId: any): Promise<any>;
-    function doSwipe(swipeOpts: any): Promise<any>;
-    function pinchClose(startX: any, startY: any, endX: any, endY: any, duration: any, percent: any, steps: any, elId: any): Promise<any>;
-    function pinchOpen(startX: any, startY: any, endX: any, endY: any, duration: any, percent: any, steps: any, elId: any): Promise<any>;
-    function flick(element: any, xSpeed: any, ySpeed: any, xOffset: any, yOffset: any, speed: any): Promise<void>;
-    function drag(startX: any, startY: any, endX: any, endY: any, duration: any, touchCount: any, elementId: any, destElId: any): Promise<any>;
-    function doDrag(dragOpts: any): Promise<any>;
-    function lock(seconds: any): Promise<void>;
-    function isLocked(): Promise<any>;
-    function unlock(): Promise<void>;
-    function openNotifications(): Promise<any>;
-    function setLocation(latitude: any, longitude: any): Promise<any>;
-    function fingerprint(fingerprintId: any): Promise<void>;
-    /**
-     * @typedef {Object} FingerprintOpts
-     * @param {string|number} fingerprintId The value is the finger_id for the finger that
-     * was "scanned". It is a unique integer that you assign for each virtual fingerprint.
-     * When the app is running you can run this same command each time the
-     * emulator prompts you for a fingerprint, you can run the adb command and pass it
-     * the finger_id to simulate the fingerprint scan.
-     */
-    /**
-     * Emulate fingerprint on Android Emulator.
-     * Only works on API 23+
-     *
-     * @param {FingerprintOpts} opts
-     */
-    function mobileFingerprint(opts?: any): Promise<void>;
-    function sendSMS(phoneNumber: any, message: any): Promise<void>;
-    /**
-     * @typedef {Object} SendSmsOptions
-     * @property {string} phoneNumber The phone number to send SMS to
-     * @property {string} message The message payload
-     */
-    /**
-     * Emulate sending an SMS to the given phone number.
-     * Only works on emulators.
-     *
-     * @param {SendSmsOptions} opts
-     */
-    function mobileSendSms(opts?: SendSmsOptions): Promise<void>;
-    function gsmCall(phoneNumber: any, action: any): Promise<void>;
-    /**
-     * @typedef {Object} GsmCallOptions
-     * @property {string} phoneNumber The phone number to call to
-     * @property {call|accept|cancel|hold} action One of possible actions to take
-     */
-    /**
-     * Emulate a GSM call to the given phone number.
-     * Only works on emulators.
-     *
-     * @param {GsmCallOptions} opts
-     */
-    function mobileGsmCall(opts?: GsmCallOptions): Promise<void>;
-    function gsmSignal(signalStrengh: any): Promise<void>;
-    /**
-     * @typedef {Object} GsmSignalOptions
-     * @property {0|1|2|3|4} strength One of possible signal strength values, where 4 is the best signal.
-     */
-    /**
-     * Emulate GSM signal strength change event.
-     * Only works on emulators.
-     *
-     * @param {GsmSignalOptions} opts
-     */
-    function mobileGsmSignal(opts?: GsmSignalOptions): Promise<void>;
-    function gsmVoice(state: any): Promise<void>;
-    /**
-     * @typedef {Object} GsmVoiceOptions
-     * @property {on|off} state
-     */
-    /**
-     * Emulate GSM voice state change event.
-     * Only works on emulators.
-     *
-     * @param {GsmVoiceOptions} opts
-     */
-    function mobileGsmVoice(opts?: GsmVoiceOptions): Promise<void>;
-    function powerAC(state: any): Promise<void>;
-    /**
-     * @typedef {Object} PowerAcOptions
-     * @property {on|off} state
-     */
-    /**
-     * Emulate AC power state change.
-     * Only works on emulators.
-     *
-     * @param {GsmVoiceOptions} opts
-     */
-    function mobilePowerAc(opts?: GsmVoiceOptions): Promise<void>;
-    function powerCapacity(batteryPercent: any): Promise<void>;
-    /**
-     * @typedef {Object} PowerCapacityOptions
-     * @property {number} percent - Percentage value in range [0, 100]
-     */
-    /**
-     * Emulate power capacity change.
-     * Only works on emulators.
-     *
-     * @param {PowerCapacityOptions} opts
-     */
-    function mobilePowerCapacity(opts?: PowerCapacityOptions): Promise<void>;
-    function networkSpeed(networkSpeed: any): Promise<void>;
-    /**
-     * @typedef {Object} NetworkSpeedOptions
-     * @property {gsm|scsd|gprs|edge|umts|hsdpa|lte|evdo|full} speed
-     */
-    /**
-     * Emulate different network connection speed modes.
-     * Only works on emulators.
-     *
-     * @param {NetworkSpeedOptions} opts
-     */
-    function mobileNetworkSpeed(opts?: NetworkSpeedOptions): Promise<void>;
-    /**
-     * Emulate sensors values on the connected emulator.
-     *
-     * @typedef {Object} Sensor
-     * @property {string} sensorType - sensor type declared in adb.SENSORS
-     * @property {string} value - value to set to the sensor
-     *
-     * @param {Object} Sensor
-     * @throws {Error} - If sensorType is not defined
-     * @throws {Error} - If value for the se sor is not defined
-     * @throws {Error} - If deviceType is not an emulator
-     */
-    function sensorSet(sensor?: {}): Promise<void>;
-    function getScreenshot(): Promise<any>;
-}
-export namespace helpers {
-    /**
-     * @param {ADB} adb
-     * @param {Object} opts
-     * @returns {Promise<sharp>}
-     */
-    function getScreenshotDataWithAdbShell(adb: ADB, opts: any): Promise<typeof sharp>;
-    /**
-     * @param {ADB} adb
-     * @returns {Promise<sharp>}
-     */
-    function getScreenshotDataWithAdbExecOut(adb: ADB): Promise<typeof sharp>;
-}
-declare const extensions: {};
-import sharp from "sharp";
+declare const ActionsMixin: import('./mixins').ActionsMixin & ThisType<import('../driver').AndroidDriver>;
 //# sourceMappingURL=actions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../lib/commands/actions.js"],"names":[],"mappings":";;;;;;iBA0Lc,MAAM;;;;aACN,MAAM;;;;;;iBAuBN,MAAM;;;;YACN,6BAAuB;;;;;;cAuBvB,CAAC,GAAC,CAAC,GAAC,CAAC,GAAC,CAAC,GAAC,CAAC;;;WAuBT,QAAM;;;WAuBN,QAAM;;;;;;aAuBN,MAAM;;;WAuBN,2DAA2C;;;;;;;;;gBAkB3C,MAAM;;;;WACN,MAAM;;;IA1UpB,gEAIC;IAED,oEAEC;IAED,wEAEC;IAED,wCAMC;IAED,wDAOC;IAED,2DAEC;IAED,gGAGC;IAED,wHAeC;IAED,+CAMC;IAED,sIAQC;IAED,qIAGC;IAED,8GAMC;IAED,2IAOC;IAED,6CAMC;IAED,2CAYC;IAED,kCAEC;IAED,iCAEC;IAED,2CAEC;IAED,kEAEC;IAED,wDAKC;IAED;;;;;;;OAOG;IAEH;;;;;OAKG;IACH,sDAGC;IAED,gEAKC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,6DAGC;IAED,+DAKC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,6DAGC;IAED,sDAKC;IAED;;;OAGG;IAEH;;;;;OAKG;IACH,iEAGC;IAED,6CAKC;IAED;;;OAGG;IAEH;;;;;OAKG;IACH,+DAGC;IAED,4CAKC;IAED;;;OAGG;IAEH;;;;;OAKG;IACH,8DAGC;IAED,2DAKC;IAED;;;OAGG;IAEH;;;;;OAKG;IACH,yEAGC;IAED,wDAKC;IAED;;;OAGG;IAEH;;;;;OAKG;IACH,uEAGC;IAED;;;;;;;;;;;OAWG;IACH,+CAYC;IAkDD,uCAiCC;;;IAjFD;;;;OAIG;IACH,mFAmBC;IAED;;;OAGG;IACH,0EAgBC;;AA/YD,6BAAsB"}
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../lib/commands/actions.js"],"names":[],"mappings":";+BAgYa,OAAO,cAAc,EAAE,gBAAgB;kBACvC,OAAO,YAAY,EAAE,GAAG;AApXrC;;;GAGG;AACH,4BAHU,OAAO,UAAU,EAAE,YAAY,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CA2WrF"}