appium-android-driver 5.14.6 → 6.0.0

package/build/lib/commands/find.js

@@ -1,38 +1,27 @@
 "use strict";
+/**
+ * @privateRemarks This file needed to be converted to TS because the overload of `findElOrEls` is seemingly impossible to express in JS since the value of `this` cannot be bound via a type assertion.
+ * @module
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.helpers = void 0;
 const lodash_1 = __importDefault(require("lodash"));
+const mixins_1 = require("./mixins");
 const driver_1 = require("appium/driver");
-let helpers = {}, extensions = {};
-exports.helpers = helpers;
-/**
- * Reason for isolating doFindElementOrEls from findElOrEls is for reusing findElOrEls
- * across android-drivers (like appium-uiautomator2-driver) to avoid code duplication.
- * Other android-drivers (like appium-uiautomator2-driver) need to override doFindElementOrEls
- * to facilitate findElOrEls.
- */
-helpers.doFindElementOrEls = async function doFindElementOrEls(params) {
-    return await this.bootstrap.sendAction('find', params);
-};
-// stategy: locator strategy
-// selector: the actual selector for finding an element
-// mult: multiple elements or just one?
-// context: finding an element from the root context? or starting from another element
-helpers.findElOrEls = async function findElOrEls(strategy, selector, mult, context = '') {
+async function findElOrEls(strategy, selector, mult, context = '') {
     if (!selector) {
         throw new Error('Must provide a selector when finding elements');
     }
-    let params = {
+    const params = {
         strategy,
         selector,
         context,
-        multiple: mult
+        multiple: mult,
     };
     let element;
-    let doFind = async () => {
+    const doFind = async () => {
         try {
             element = await this.doFindElementOrEls(params);
         }
@@ -57,7 +46,8 @@ helpers.findElOrEls = async function findElOrEls(strategy, selector, mult, conte
     try {
         await this.implicitWaitForCondition(doFind);
     }
-    catch (err) {
+    catch (e) {
+        const err = e;
         if (err.message && err.message.match(/Condition unmet/)) {
             // only get here if we are looking for multiple elements
             // condition was not met setting res to empty array
@@ -74,7 +64,13 @@ helpers.findElOrEls = async function findElOrEls(strategy, selector, mult, conte
         throw new driver_1.errors.NoSuchElementError();
     }
     return element;
+}
+const FindMixin = {
+    async doFindElementOrEls(params) {
+        return await this.bootstrap.sendAction('find', params);
+    },
+    findElOrEls,
 };
-Object.assign(extensions, helpers);
-exports.default = extensions;
+(0, mixins_1.mixin)(FindMixin);
+exports.default = FindMixin;
 //# sourceMappingURL=find.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../lib/commands/find.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAoD;AAGpD,IAAI,OAAO,GAAG,EAAE,EAAE,UAAU,GAAG,EAAE,CAAC;AA4EzB,0BAAO;AA1EhB;;;;;GAKG;AACH,OAAO,CAAC,kBAAkB,GAAG,KAAK,UAAU,kBAAkB,CAAE,MAAM;IACpE,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,4BAA4B;AAC5B,uDAAuD;AACvD,uCAAuC;AACvC,sFAAsF;AACtF,OAAO,CAAC,WAAW,GAAG,KAAK,UAAU,WAAW,CAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,GAAG,EAAE;IACtF,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;KAClE;IAED,IAAI,MAAM,GAAG;QACX,QAAQ;QACR,QAAQ;QACR,OAAO;QACP,QAAQ,EAAE,IAAI;KACf,CAAC;IAEF,IAAI,OAAO,CAAC;IACZ,IAAI,MAAM,GAAG,KAAK,IAAI,EAAE;QACtB,IAAI;YACF,OAAO,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;SACjD;QAAC,OAAO,GAAG,EAAE;YAEZ,qEAAqE;YACrE,+CAA+C;YAC/C,IAAI,IAAA,oBAAW,EAAC,GAAG,EAAE,eAAM,CAAC,iBAAiB,CAAC,EAAE;gBAC9C,GAAG,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,mCAAmC;aAChE;YAED,mEAAmE;YACnE,6DAA6D;YAC7D,gBAAgB;YAChB,IAAI,IAAA,oBAAW,EAAC,GAAG,EAAE,eAAM,CAAC,kBAAkB,CAAC,EAAE;gBAC/C,+CAA+C;gBAC/C,OAAO,KAAK,CAAC;aACd;YACD,MAAM,GAAG,CAAC;SACX;QAED,8DAA8D;QAC9D,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,IAAI;QACF,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;KAC7C;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE;YACvD,wDAAwD;YACxD,mDAAmD;YACnD,OAAO,GAAG,EAAE,CAAC;SACd;aAAM;YACL,MAAM,GAAG,CAAC;SACX;KACF;IAED,IAAI,IAAI,EAAE;QACR,OAAO,OAAO,CAAC;KAChB;IACD,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACtB,MAAM,IAAI,eAAM,CAAC,kBAAkB,EAAE,CAAC;KACvC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAEnC,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../lib/commands/find.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,oDAAuB;AACvB,qCAA+C;AAC/C,0CAAkD;AAoBlD,KAAK,UAAU,WAAW,CAExB,QAAgB,EAChB,QAAgB,EAChB,IAAa,EACb,OAAO,GAAG,EAAE;IAEZ,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;KAClE;IAED,MAAM,MAAM,GAAoB;QAC9B,QAAQ;QACR,QAAQ;QACR,OAAO;QACP,QAAQ,EAAE,IAAI;KACf,CAAC;IAEF,IAAI,OAAwC,CAAC;IAC7C,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;QACxB,IAAI;YACF,OAAO,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;SACjD;QAAC,OAAO,GAAG,EAAE;YACZ,qEAAqE;YACrE,+CAA+C;YAC/C,IAAI,IAAA,oBAAW,EAAC,GAAG,EAAE,eAAM,CAAC,iBAAiB,CAAC,EAAE;gBAC9C,GAAG,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,mCAAmC;aAChE;YAED,mEAAmE;YACnE,6DAA6D;YAC7D,gBAAgB;YAChB,IAAI,IAAA,oBAAW,EAAC,GAAG,EAAE,eAAM,CAAC,kBAAkB,CAAC,EAAE;gBAC/C,+CAA+C;gBAC/C,OAAO,KAAK,CAAC;aACd;YACD,MAAM,GAAG,CAAC;SACX;QAED,8DAA8D;QAC9D,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,IAAI;QACF,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;KAC7C;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,GAAG,GAAG,CAAU,CAAC;QACvB,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE;YACvD,wDAAwD;YACxD,mDAAmD;YACnD,OAAO,GAAG,EAAE,CAAC;SACd;aAAM;YACL,MAAM,GAAG,CAAC;SACX;KACF;IAED,IAAI,IAAI,EAAE;QACR,OAAO,OAAoB,CAAC;KAC7B;IACD,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACtB,MAAM,IAAI,eAAM,CAAC,kBAAkB,EAAE,CAAC;KACvC;IACD,OAAO,OAAkB,CAAC;AAC5B,CAAC;AAED,MAAM,SAAS,GAAwC;IACrD,KAAK,CAAC,kBAAkB,CAAC,MAAM;QAC7B,OAAO,MAAO,IAAI,CAAC,SAA8B,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/E,CAAC;IAED,WAAW;CACZ,CAAC;AAEF,IAAA,cAAK,EAAC,SAAS,CAAC,CAAC;AAEjB,kBAAe,SAAS,CAAC"}

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

@@ -1,133 +1,10 @@
-export default extensions;
-export type DeviceTimeOptions = {
-    /**
-     * [YYYY-MM-DDTHH:mm:ssZ] - See getDeviceTime#format
-     */
-    format: string;
-};
-export type SmsListOptions = {
-    /**
-     * [100] - The maximum count of recent SMS messages
-     * to retrieve
-     */
-    max: number;
-};
-export type UnlockOptions = {
-    /**
-     * The unlock key. The value of this key depends
-     * on the actual unlock type and could be a pin/password/pattern value or
-     * a biometric finger id.
-     * If not provided then the corresponding value from session capabilities is used.
-     */
-    key: string | null;
-    /**
-     * The unlock type. The following unlock types
-     * are supported: `pin`, `pinWithKeyEvent`, `password`, `pattern` and `fingerprint`.
-     * If not provided then the corresponding value from session capabilities is used.
-     */
-    type: string | null;
-    /**
-     * Either 'locksettings' (default) or 'uiautomator'.
-     * Setting it to 'uiautomator' will enforce the driver to avoid using special
-     * ADB shortcuts in order to speed up the unlock procedure.
-     */
-    strategy: string | null;
-    /**
-     * [2000] The maximum time in milliseconds
-     * to wait until the screen gets unlocked
-     */
-    timeoutMs: number | null;
-};
-export namespace commands {
-    function keys(keys: any): Promise<void>;
-    function doSendKeys(params: any): Promise<any>;
-    /**
-     * Retrieves the current device's timestamp.
-     *
-     * @param {string} format - The set of format specifiers. Read
-     *                          https://momentjs.com/docs/ to get the full list of supported
-     *                          datetime format specifiers. The default format is
-     *                          `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601
-     * @return {string} Formatted datetime string or the raw command output if formatting fails
-     */
-    function getDeviceTime(format?: string): string;
-    /**
-     * @typedef {Object} DeviceTimeOptions
-     * @property {string} format [YYYY-MM-DDTHH:mm:ssZ] - See getDeviceTime#format
-     */
-    /**
-     * Retrieves the current device time
-     *
-     * @param {DeviceTimeOptions} opts
-     * @return {string} Formatted datetime string or the raw command output if formatting fails
-     */
-    function mobileGetDeviceTime(opts?: DeviceTimeOptions): string;
-    function getPageSource(): Promise<any>;
-    function back(): Promise<any>;
-    function openSettingsActivity(setting: any): Promise<void>;
-    function getWindowSize(): Promise<any>;
-    function getWindowRect(): Promise<{
-        width: any;
-        height: any;
-        x: number;
-        y: number;
-    }>;
-    function getCurrentActivity(): Promise<any>;
-    function getCurrentPackage(): Promise<any>;
-    function background(seconds: any): Promise<any>;
-    function getStrings(language: any): Promise<{}>;
-    function launchApp(): Promise<void>;
-    function startActivity(appPackage: any, appActivity: any, appWaitPackage: any, appWaitActivity: any, intentAction: any, intentCategory: any, intentFlags: any, optionalIntentArguments: any, dontStopAppOnReset: any): Promise<void>;
-    function reset(): Promise<any>;
-    function startAUT(): Promise<void>;
-    function setUrl(uri: any): Promise<void>;
-    function closeApp(): Promise<void>;
-    function getDisplayDensity(): Promise<number | undefined>;
-    function mobilePerformEditorAction(opts?: {}): Promise<void>;
-    /**
-     * Retrieves the list of recent system notifications.
-     *
-     * @returns {Object} See the documentation on `adb.getNotifications` for
-     * more details
-     */
-    function mobileGetNotifications(): any;
-    /**
-     * @typedef {Object} SmsListOptions
-     * @property {number} max [100] - The maximum count of recent SMS messages
-     * to retrieve
-     */
-    /**
-     * Retrieves the list of recent SMS messages with their properties.
-     *
-     * @param {SmsListOptions} opts
-     * @returns {Object} See the documentation on `adb.getSmsList` for
-     * more details
-     */
-    function mobileListSms(opts?: SmsListOptions): any;
-    /**
-     * @typedef {Object} UnlockOptions
-     * @property {string?} key The unlock key. The value of this key depends
-     * on the actual unlock type and could be a pin/password/pattern value or
-     * a biometric finger id.
-     * If not provided then the corresponding value from session capabilities is used.
-     * @property {string?} type The unlock type. The following unlock types
-     * are supported: `pin`, `pinWithKeyEvent`, `password`, `pattern` and `fingerprint`.
-     * If not provided then the corresponding value from session capabilities is used.
-     * @property {string?} strategy Either 'locksettings' (default) or 'uiautomator'.
-     * Setting it to 'uiautomator' will enforce the driver to avoid using special
-     * ADB shortcuts in order to speed up the unlock procedure.
-     * @property {number?} timeoutMs [2000] The maximum time in milliseconds
-     * to wait until the screen gets unlocked
-     */
-    /**
-     * Unlocks the device if it is locked. Noop if the device's screen is not locked.
-     *
-     * @param {UnlockOptions} opts
-     * @throws {Error} if unlock operation fails or the provided
-     * arguments are not valid
-     */
-    function mobileUnlock(opts?: UnlockOptions): Promise<void>;
-}
-export let helpers: {};
-declare let extensions: {};
+export default GeneralMixin;
+export type AndroidBootstrap = import('../bootstrap').AndroidBootstrap;
+export type ADB = import('appium-adb').ADB;
+export type StringRecord = import('@appium/types').StringRecord;
+/**
+ * @type {import('./mixins').GeneralMixin & ThisType<import('../driver').AndroidDriver>}
+ * @satisfies {import('@appium/types').ExternalDriver}
+ */
+declare const GeneralMixin: import('./mixins').GeneralMixin & ThisType<import('../driver').AndroidDriver>;
 //# sourceMappingURL=general.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../../../lib/commands/general.js"],"names":[],"mappings":";;;;;YAoDc,MAAM;;;;;;;SA8PN,MAAM;;;;;;;;;SAiBN,MAAM;;;;;;UAIN,MAAM;;;;;;cAGN,MAAM;;;;;eAGN,MAAM;;;IAlUpB,wCAWC;IAED,+CAEC;IAED;;;;;;;;OAQG;IACH,gDAWC;IAED;;;OAGG;IAEH;;;;;OAKG;IACH,+DAEC;IAED,uCAEC;IAED,8BAEC;IAED,2DAIC;IAED,uCAEC;IAGD;;;;;OAQC;IAED,4CAEC;IAED,2CAEC;IAED,gDA0DC;IAED,gDA4BC;IAED,oCAGC;IAED,qOAyBC;IAED,+BAKC;IAED,mCAeC;IAID,yCAEC;IAGD,mCAIC;IAED,0DAsBC;IAED,6DAOC;IAED;;;;;OAKG;IACH,uCAEC;IAED;;;;OAIG;IAEH;;;;;;OAMG;IACH,mDAEC;IAED;;;;;;;;;;;;;;OAcG;IAEH;;;;;;OAMG;IACH,2DAYC;;AA3VkB,uBAAY;AAAE,2BAAe"}
+{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../../../lib/commands/general.js"],"names":[],"mappings":";+BAyVa,OAAO,cAAc,EAAE,gBAAgB;kBACvC,OAAO,YAAY,EAAE,GAAG;2BACxB,OAAO,eAAe,EAAE,YAAY;AAhVjD;;;GAGG;AACH,4BAHU,OAAO,UAAU,EAAE,YAAY,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CAsUrF"}