appium-android-driver 7.8.2 → 8.0.0

package/build/lib/commands/lock/helpers.js

@@ -0,0 +1,375 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patternUnlock = exports.verifyUnlock = exports.getPatternActions = exports.getPatternKeyPosition = exports.passwordUnlock = exports.pinUnlockWithKeyEvent = exports.pinUnlock = exports.fingerprintUnlock = exports.stringKeyToArr = exports.encodePassword = exports.fastUnlock = exports.validateUnlockCapabilities = exports.toCredentialType = exports.INPUT_KEYS_WAIT_TIME = exports.UNLOCK_WAIT_TIME = exports.KEYCODE_NUMPAD_ENTER = exports.FINGERPRINT_UNLOCK = exports.PATTERN_UNLOCK = exports.PASSWORD_UNLOCK = exports.PIN_UNLOCK_KEY_EVENT = exports.PIN_UNLOCK = void 0;
+const support_1 = require("@appium/support");
+const asyncbox_1 = require("asyncbox");
+const lodash_1 = __importDefault(require("lodash"));
+exports.PIN_UNLOCK = 'pin';
+exports.PIN_UNLOCK_KEY_EVENT = 'pinWithKeyEvent';
+exports.PASSWORD_UNLOCK = 'password';
+exports.PATTERN_UNLOCK = 'pattern';
+exports.FINGERPRINT_UNLOCK = 'fingerprint';
+const UNLOCK_TYPES = /** @type {const}  */ ([
+    exports.PIN_UNLOCK,
+    exports.PIN_UNLOCK_KEY_EVENT,
+    exports.PASSWORD_UNLOCK,
+    exports.PATTERN_UNLOCK,
+    exports.FINGERPRINT_UNLOCK,
+]);
+exports.KEYCODE_NUMPAD_ENTER = 66;
+exports.UNLOCK_WAIT_TIME = 100;
+exports.INPUT_KEYS_WAIT_TIME = 100;
+const NUMBER_ZERO_KEYCODE = 7;
+/**
+ *
+ * @param {any} value
+ * @returns {value is string}
+ */
+function isNonEmptyString(value) {
+    return typeof value === 'string' && value !== '';
+}
+/**
+ * Wait for the display to be unlocked.
+ * Some devices automatically accept typed 'pin' and 'password' code
+ * without pressing the Enter key. But some devices need it.
+ * This method waits a few seconds first for such automatic acceptance case.
+ * If the device is still locked, then this method will try to send
+ * the enter key code.
+ *
+ * @param {import('appium-adb').ADB} adb The instance of ADB
+ */
+async function waitForUnlock(adb) {
+    await (0, asyncbox_1.sleep)(exports.UNLOCK_WAIT_TIME);
+    if (!(await adb.isScreenLocked())) {
+        return;
+    }
+    await adb.keyevent(exports.KEYCODE_NUMPAD_ENTER);
+    await (0, asyncbox_1.sleep)(exports.UNLOCK_WAIT_TIME);
+}
+/**
+ *
+ * @param {import('../types').UnlockType} unlockType
+ * @returns {string}
+ */
+function toCredentialType(unlockType) {
+    const result = {
+        [exports.PIN_UNLOCK]: 'pin',
+        [exports.PIN_UNLOCK_KEY_EVENT]: 'pin',
+        [exports.PASSWORD_UNLOCK]: 'password',
+        [exports.PATTERN_UNLOCK]: 'pattern',
+    }[unlockType];
+    if (result) {
+        return result;
+    }
+    throw new Error(`Unlock type '${unlockType}' is not known`);
+}
+exports.toCredentialType = toCredentialType;
+/**
+ * @template {AndroidDriverCaps} T
+ * @param {T} caps
+ * @returns {T}
+ */
+function validateUnlockCapabilities(caps) {
+    const { unlockKey, unlockType } = caps ?? {};
+    if (!isNonEmptyString(unlockType)) {
+        throw new Error('A non-empty unlock key value must be provided');
+    }
+    if ([exports.PIN_UNLOCK, exports.PIN_UNLOCK_KEY_EVENT, exports.FINGERPRINT_UNLOCK].includes(unlockType)) {
+        if (!/^[0-9]+$/.test(lodash_1.default.trim(unlockKey))) {
+            throw new Error(`Unlock key value '${unlockKey}' must only consist of digits`);
+        }
+    }
+    else if (unlockType === exports.PATTERN_UNLOCK) {
+        if (!/^[1-9]{2,9}$/.test(lodash_1.default.trim(unlockKey))) {
+            throw new Error(`Unlock key value '${unlockKey}' must only include from two to nine digits in range 1..9`);
+        }
+        if (/([1-9]).*?\1/.test(lodash_1.default.trim(unlockKey))) {
+            throw new Error(`Unlock key value '${unlockKey}' must define a valid pattern where repeats are not allowed`);
+        }
+    }
+    else if (unlockType === exports.PASSWORD_UNLOCK) {
+        // Dont trim password key, you can use blank spaces in your android password
+        // ¯\_(ツ)_/¯
+        if (!/.{4,}/g.test(String(unlockKey))) {
+            throw new Error(`The minimum allowed length of unlock key value '${unlockKey}' is 4 characters`);
+        }
+    }
+    else {
+        throw new Error(`Invalid unlock type '${unlockType}'. ` +
+            `Only the following unlock types are supported: ${UNLOCK_TYPES}`);
+    }
+    return caps;
+}
+exports.validateUnlockCapabilities = validateUnlockCapabilities;
+/**
+ * @this {AndroidDriver}
+ * @param {import('../types').FastUnlockOptions} opts
+ */
+async function fastUnlock(opts) {
+    const { credential, credentialType } = opts;
+    this.log.info(`Unlocking the device via ADB using ${credentialType} credential '${credential}'`);
+    const wasLockEnabled = await this.adb.isLockEnabled();
+    if (wasLockEnabled) {
+        await this.adb.clearLockCredential(credential);
+        // not sure why, but the device's screen still remains locked
+        // if a preliminary wake up cycle has not been performed
+        await this.adb.cycleWakeUp();
+    }
+    else {
+        this.log.info('No active lock has been detected. Proceeding to the keyguard dismissal');
+    }
+    try {
+        await this.adb.dismissKeyguard();
+    }
+    finally {
+        if (wasLockEnabled) {
+            await this.adb.setLockCredential(credentialType, credential);
+        }
+    }
+}
+exports.fastUnlock = fastUnlock;
+/**
+ *
+ * @param {string} key
+ * @returns {string}
+ */
+function encodePassword(key) {
+    return `${key}`.replace(/\s/gi, '%s');
+}
+exports.encodePassword = encodePassword;
+/**
+ *
+ * @param {string} key
+ * @returns {string[]}
+ */
+function stringKeyToArr(key) {
+    return `${key}`.trim().replace(/\s+/g, '').split(/\s*/);
+}
+exports.stringKeyToArr = stringKeyToArr;
+/**
+ * @this {AndroidDriver}
+ * @param {AndroidDriverCaps} capabilities
+ * @returns {Promise<void>}
+ */
+async function fingerprintUnlock(capabilities) {
+    if ((await this.adb.getApiLevel()) < 23) {
+        throw new Error('Fingerprint unlock only works for Android 6+ emulators');
+    }
+    await this.adb.fingerprint(String(capabilities.unlockKey));
+    await (0, asyncbox_1.sleep)(exports.UNLOCK_WAIT_TIME);
+}
+exports.fingerprintUnlock = fingerprintUnlock;
+/**
+ * @this {AndroidDriver}
+ * @param {AndroidDriverCaps} capabilities
+ * @returns {Promise<void>}
+ */
+async function pinUnlock(capabilities) {
+    this.log.info(`Trying to unlock device using pin ${capabilities.unlockKey}`);
+    await this.adb.dismissKeyguard();
+    const keys = stringKeyToArr(String(capabilities.unlockKey));
+    if ((await this.adb.getApiLevel()) >= 21) {
+        const els = await this.findElOrEls('id', 'com.android.systemui:id/digit_text', true);
+        if (lodash_1.default.isEmpty(els)) {
+            // fallback to pin with key event
+            return await pinUnlockWithKeyEvent.bind(this)(capabilities);
+        }
+        const pins = {};
+        for (const el of els) {
+            const text = await this.getAttribute('text', support_1.util.unwrapElement(el));
+            pins[text] = el;
+        }
+        for (const pin of keys) {
+            const el = pins[pin];
+            await this.click(support_1.util.unwrapElement(el));
+        }
+    }
+    else {
+        for (const pin of keys) {
+            const el = await this.findElOrEls('id', `com.android.keyguard:id/key${pin}`, false);
+            if (el === null) {
+                // fallback to pin with key event
+                return await pinUnlockWithKeyEvent.bind(this)(capabilities);
+            }
+            await this.click(support_1.util.unwrapElement(el));
+        }
+    }
+    await waitForUnlock(this.adb);
+}
+exports.pinUnlock = pinUnlock;
+/**
+ * @this {AndroidDriver}
+ * @param {AndroidDriverCaps} capabilities
+ * @returns {Promise<void>}
+ */
+async function pinUnlockWithKeyEvent(capabilities) {
+    this.log.info(`Trying to unlock device using pin with keycode ${capabilities.unlockKey}`);
+    await this.adb.dismissKeyguard();
+    const keys = stringKeyToArr(String(capabilities.unlockKey));
+    // Some device does not have system key ids like 'com.android.keyguard:id/key'
+    // Then, sending keyevents are more reliable to unlock the screen.
+    for (const pin of keys) {
+        // 'pin' is number (0-9) in string.
+        // Number '0' is keycode '7'. number '9' is keycode '16'.
+        await this.adb.shell(['input', 'keyevent', String(parseInt(pin, 10) + NUMBER_ZERO_KEYCODE)]);
+    }
+    await waitForUnlock(this.adb);
+}
+exports.pinUnlockWithKeyEvent = pinUnlockWithKeyEvent;
+/**
+ * @this {AndroidDriver}
+ * @param {AndroidDriverCaps} capabilities
+ * @returns {Promise<void>}
+ */
+async function passwordUnlock(capabilities) {
+    const { unlockKey } = capabilities;
+    this.log.info(`Trying to unlock device using password ${unlockKey}`);
+    await this.adb.dismissKeyguard();
+    // Replace blank spaces with %s
+    const key = encodePassword(String(unlockKey));
+    // Why adb ? It was less flaky
+    await this.adb.shell(['input', 'text', key]);
+    // Why sleeps ? Avoid some flakyness waiting for the input to receive the keys
+    await (0, asyncbox_1.sleep)(exports.INPUT_KEYS_WAIT_TIME);
+    await this.adb.shell(['input', 'keyevent', String(exports.KEYCODE_NUMPAD_ENTER)]);
+    // Waits a bit for the device to be unlocked
+    await waitForUnlock(this.adb);
+}
+exports.passwordUnlock = passwordUnlock;
+/**
+ *
+ * @param {number} key
+ * @param {import('@appium/types').Position} initPos
+ * @param {number} piece
+ * @returns {import('@appium/types').Position}
+ */
+function getPatternKeyPosition(key, initPos, piece) {
+    /*
+    How the math works:
+    We have 9 buttons divided in 3 columns and 3 rows inside the lockPatternView,
+    every button has a position on the screen corresponding to the lockPatternView since
+    it is the parent view right at the middle of each column or row.
+    */
+    const cols = 3;
+    const pins = 9;
+    const xPos = (key, x, piece) => Math.round(x + (key % cols || cols) * piece - piece / 2);
+    const yPos = (key, y, piece) => Math.round(y + (Math.ceil((key % pins || pins) / cols) * piece - piece / 2));
+    return {
+        x: xPos(key, initPos.x, piece),
+        y: yPos(key, initPos.y, piece),
+    };
+}
+exports.getPatternKeyPosition = getPatternKeyPosition;
+/**
+ * @param {string[]|number[]} keys
+ * @param {import('@appium/types').Position} initPos
+ * @param {number} piece
+ * @returns {import('../types').TouchAction[]}
+ */
+function getPatternActions(keys, initPos, piece) {
+    /** @type {import('../types').TouchAction[]} */
+    const actions = [];
+    /** @type {number[]} */
+    const intKeys = keys.map((key) => (lodash_1.default.isString(key) ? lodash_1.default.parseInt(key) : key));
+    /** @type {import('@appium/types').Position|undefined} */
+    let lastPos;
+    for (const key of intKeys) {
+        const keyPos = getPatternKeyPosition(key, initPos, piece);
+        if (!lastPos) {
+            actions.push({ action: 'press', options: { element: undefined, x: keyPos.x, y: keyPos.y } });
+            lastPos = keyPos;
+            continue;
+        }
+        const moveTo = { x: 0, y: 0 };
+        const diffX = keyPos.x - lastPos.x;
+        if (diffX > 0) {
+            moveTo.x = piece;
+            if (Math.abs(diffX) > piece) {
+                moveTo.x += piece;
+            }
+        }
+        else if (diffX < 0) {
+            moveTo.x = -1 * piece;
+            if (Math.abs(diffX) > piece) {
+                moveTo.x -= piece;
+            }
+        }
+        const diffY = keyPos.y - lastPos.y;
+        if (diffY > 0) {
+            moveTo.y = piece;
+            if (Math.abs(diffY) > piece) {
+                moveTo.y += piece;
+            }
+        }
+        else if (diffY < 0) {
+            moveTo.y = -1 * piece;
+            if (Math.abs(diffY) > piece) {
+                moveTo.y -= piece;
+            }
+        }
+        actions.push({
+            action: 'moveTo',
+            // @ts-ignore lastPos should be defined
+            options: { element: undefined, x: moveTo.x + lastPos.x, y: moveTo.y + lastPos.y },
+        });
+        lastPos = keyPos;
+    }
+    actions.push({ action: 'release' });
+    return actions;
+}
+exports.getPatternActions = getPatternActions;
+/**
+ * @this {AndroidDriver}
+ * @param {number?} [timeoutMs=null]
+ */
+async function verifyUnlock(timeoutMs = null) {
+    try {
+        await (0, asyncbox_1.waitForCondition)(async () => !(await this.adb.isScreenLocked()), {
+            waitMs: timeoutMs ?? 2000,
+            intervalMs: 500,
+        });
+    }
+    catch (ign) {
+        throw new Error('The device has failed to be unlocked');
+    }
+    this.log.info('The device has been successfully unlocked');
+}
+exports.verifyUnlock = verifyUnlock;
+/**
+ * @this {AndroidDriver}
+ * @param {AndroidDriverCaps} capabilities
+ */
+async function patternUnlock(capabilities) {
+    const { unlockKey } = capabilities;
+    this.log.info(`Trying to unlock device using pattern ${unlockKey}`);
+    await this.adb.dismissKeyguard();
+    const keys = stringKeyToArr(String(unlockKey));
+    /* We set the device pattern buttons as number of a regular phone
+      *  | • • • |     | 1 2 3 |
+      *  | • • • | --> | 4 5 6 |
+      *  | • • • |     | 7 8 9 |
+  
+    The pattern view buttons are not seeing by the uiautomator since they are
+    included inside a FrameLayout, so we are going to try clicking on the buttons
+    using the parent view bounds and math.
+    */
+    const apiLevel = await this.adb.getApiLevel();
+    const el = await this.findElOrEls('id', `com.android.${apiLevel >= 21 ? 'systemui' : 'keyguard'}:id/lockPatternView`, false);
+    const initPos = await this.getLocation(support_1.util.unwrapElement(el));
+    const size = await this.getSize(support_1.util.unwrapElement(el));
+    // Get actions to perform
+    const actions = getPatternActions(keys, initPos, size.width / 3);
+    // Perform gesture
+    await this.performTouch(actions);
+    // Waits a bit for the device to be unlocked
+    await (0, asyncbox_1.sleep)(exports.UNLOCK_WAIT_TIME);
+}
+exports.patternUnlock = patternUnlock;
+/**
+ * @typedef {import('@appium/types').Capabilities<import('../../constraints').AndroidDriverConstraints>} AndroidDriverCaps
+ * @typedef {import('../../driver').AndroidDriver} AndroidDriver
+ */
+//# sourceMappingURL=helpers.js.map

package/build/lib/commands/lock/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../lib/commands/lock/helpers.js"],"names":[],"mappings":";;;;;;AAAA,6CAAqC;AACrC,uCAAiD;AACjD,oDAAuB;AAEV,QAAA,UAAU,GAAG,KAAK,CAAC;AACnB,QAAA,oBAAoB,GAAG,iBAAiB,CAAC;AACzC,QAAA,eAAe,GAAG,UAAU,CAAC;AAC7B,QAAA,cAAc,GAAG,SAAS,CAAC;AAC3B,QAAA,kBAAkB,GAAG,aAAa,CAAC;AAChD,MAAM,YAAY,GAAG,qBAAqB,CAAC,CAAC;IAC1C,kBAAU;IACV,4BAAoB;IACpB,uBAAe;IACf,sBAAc;IACd,0BAAkB;CACnB,CAAC,CAAC;AACU,QAAA,oBAAoB,GAAG,EAAE,CAAC;AAC1B,QAAA,gBAAgB,GAAG,GAAG,CAAC;AACvB,QAAA,oBAAoB,GAAG,GAAG,CAAC;AACxC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAE9B;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,KAAK;IAC7B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,aAAa,CAAC,GAAG;IAC9B,MAAM,IAAA,gBAAK,EAAC,wBAAgB,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,cAAc,EAAE,CAAC,EAAE;QACjC,OAAO;KACR;IAED,MAAM,GAAG,CAAC,QAAQ,CAAC,4BAAoB,CAAC,CAAC;IACzC,MAAM,IAAA,gBAAK,EAAC,wBAAgB,CAAC,CAAC;AAChC,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,UAAU;IACzC,MAAM,MAAM,GAAG;QACb,CAAC,kBAAU,CAAC,EAAE,KAAK;QACnB,CAAC,4BAAoB,CAAC,EAAE,KAAK;QAC7B,CAAC,uBAAe,CAAC,EAAE,UAAU;QAC7B,CAAC,sBAAc,CAAC,EAAE,SAAS;KAC5B,CAAC,UAAU,CAAC,CAAC;IACd,IAAI,MAAM,EAAE;QACV,OAAO,MAAM,CAAC;KACf;IACD,MAAM,IAAI,KAAK,CAAC,gBAAgB,UAAU,gBAAgB,CAAC,CAAC;AAC9D,CAAC;AAXD,4CAWC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CAAC,IAAI;IAC7C,MAAM,EAAC,SAAS,EAAE,UAAU,EAAC,GAAG,IAAI,IAAI,EAAE,CAAC;IAC3C,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;KAClE;IAED,IAAI,CAAC,kBAAU,EAAE,4BAAoB,EAAE,0BAAkB,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QAC/E,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,+BAA+B,CAAC,CAAC;SAChF;KACF;SAAM,IAAI,UAAU,KAAK,sBAAc,EAAE;QACxC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;YAC3C,MAAM,IAAI,KAAK,CACb,qBAAqB,SAAS,2DAA2D,CAC1F,CAAC;SACH;QACD,IAAI,cAAc,CAAC,IAAI,CAAC,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CACb,qBAAqB,SAAS,6DAA6D,CAC5F,CAAC;SACH;KACF;SAAM,IAAI,UAAU,KAAK,uBAAe,EAAE;QACzC,4EAA4E;QAC5E,YAAY;QACZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;YACrC,MAAM,IAAI,KAAK,CACb,mDAAmD,SAAS,mBAAmB,CAChF,CAAC;SACH;KACF;SAAM;QACL,MAAM,IAAI,KAAK,CACb,wBAAwB,UAAU,KAAK;YACrC,kDAAkD,YAAY,EAAE,CACnE,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AApCD,gEAoCC;AAED;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,IAAI;IACnC,MAAM,EAAC,UAAU,EAAE,cAAc,EAAC,GAAG,IAAI,CAAC;IAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sCAAsC,cAAc,gBAAgB,UAAU,GAAG,CAAC,CAAC;IACjG,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;IACtD,IAAI,cAAc,EAAE;QAClB,MAAM,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC/C,6DAA6D;QAC7D,wDAAwD;QACxD,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;KAC9B;SAAM;QACL,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC;KACzF;IACD,IAAI;QACF,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;KAClC;YAAS;QACR,IAAI,cAAc,EAAE;YAClB,MAAM,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;SAC9D;KACF;AACH,CAAC;AAnBD,gCAmBC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAG;IAChC,OAAO,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC;AAFD,wCAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAG;IAChC,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAFD,wCAEC;AAED;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAAC,YAAY;IAClD,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;KAC3E;IACD,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3D,MAAM,IAAA,gBAAK,EAAC,wBAAgB,CAAC,CAAC;AAChC,CAAC;AAND,8CAMC;AAED;;;;GAIG;AACI,KAAK,UAAU,SAAS,CAAC,YAAY;IAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,qCAAqC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IAC7E,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;QACxC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,oCAAoC,EAAE,IAAI,CAAC,CAAC;QACrF,IAAI,gBAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAClB,iCAAiC;YACjC,OAAO,MAAM,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;SAC7D;QACD,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,cAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SACjB;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACrB,MAAM,IAAI,CAAC,KAAK,CAAC,cAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;SAC1C;KACF;SAAM;QACL,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,8BAA8B,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;YACpF,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,iCAAiC;gBACjC,OAAO,MAAM,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;aAC7D;YACD,MAAM,IAAI,CAAC,KAAK,CAAC,cAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;SAC1C;KACF;IACD,MAAM,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AA9BD,8BA8BC;AAED;;;;GAIG;AACI,KAAK,UAAU,qBAAqB,CAAC,YAAY;IACtD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kDAAkD,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IAC1F,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAE5D,8EAA8E;IAC9E,kEAAkE;IAClE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,mCAAmC;QACnC,yDAAyD;QACzD,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;KAC9F;IACD,MAAM,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAbD,sDAaC;AAED;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAAC,YAAY;IAC/C,MAAM,EAAC,SAAS,EAAC,GAAG,YAAY,CAAC;IACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0CAA0C,SAAS,EAAE,CAAC,CAAC;IACrE,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;IACjC,+BAA+B;IAC/B,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,8BAA8B;IAC9B,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7C,8EAA8E;IAC9E,MAAM,IAAA,gBAAK,EAAC,4BAAoB,CAAC,CAAC;IAClC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,4BAAoB,CAAC,CAAC,CAAC,CAAC;IAC1E,4CAA4C;IAC5C,MAAM,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAbD,wCAaC;AAED;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK;IACvD;;;;;MAKE;IACF,MAAM,IAAI,GAAG,CAAC,CAAC;IACf,MAAM,IAAI,GAAG,CAAC,CAAC;IACf,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;IACzF,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,CAC7B,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/E,OAAO;QACL,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC;QAC9B,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC;KAC/B,CAAC;AACJ,CAAC;AAhBD,sDAgBC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK;IACpD,+CAA+C;IAC/C,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,uBAAuB;IACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,yDAAyD;IACzD,IAAI,OAAO,CAAC;IACZ,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;QACzB,MAAM,MAAM,GAAG,qBAAqB,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,EAAC,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAC,EAAC,CAAC,CAAC;YACzF,OAAO,GAAG,MAAM,CAAC;YACjB,SAAS;SACV;QACD,MAAM,MAAM,GAAG,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QACnC,IAAI,KAAK,GAAG,CAAC,EAAE;YACb,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC;YACjB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;gBAC3B,MAAM,CAAC,CAAC,IAAI,KAAK,CAAC;aACnB;SACF;aAAM,IAAI,KAAK,GAAG,CAAC,EAAE;YACpB,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;YACtB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;gBAC3B,MAAM,CAAC,CAAC,IAAI,KAAK,CAAC;aACnB;SACF;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;QACnC,IAAI,KAAK,GAAG,CAAC,EAAE;YACb,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC;YACjB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;gBAC3B,MAAM,CAAC,CAAC,IAAI,KAAK,CAAC;aACnB;SACF;aAAM,IAAI,KAAK,GAAG,CAAC,EAAE;YACpB,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;YACtB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;gBAC3B,MAAM,CAAC,CAAC,IAAI,KAAK,CAAC;aACnB;SACF;QACD,OAAO,CAAC,IAAI,CAAC;YACX,MAAM,EAAE,QAAQ;YAChB,uCAAuC;YACvC,OAAO,EAAE,EAAC,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAC;SAChF,CAAC,CAAC;QACH,OAAO,GAAG,MAAM,CAAC;KAClB;IACD,OAAO,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;IAClC,OAAO,OAAO,CAAC;AACjB,CAAC;AAhDD,8CAgDC;AAED;;;GAGG;AACI,KAAK,UAAU,YAAY,CAAC,SAAS,GAAG,IAAI;IACjD,IAAI;QACF,MAAM,IAAA,2BAAgB,EAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,EAAE;YACrE,MAAM,EAAE,SAAS,IAAI,IAAI;YACzB,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;KACzD;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;AAC7D,CAAC;AAVD,oCAUC;AAED;;;GAGG;AACI,KAAK,UAAU,aAAa,CAAC,YAAY;IAC9C,MAAM,EAAC,SAAS,EAAC,GAAG,YAAY,CAAC;IACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yCAAyC,SAAS,EAAE,CAAC,CAAC;IACpE,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/C;;;;;;;;MAQE;IACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;IAC9C,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAC/B,IAAI,EACJ,eAAe,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,qBAAqB,EAC5E,KAAK,CACN,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,cAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;IACxD,yBAAyB;IACzB,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACjE,kBAAkB;IAClB,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACjC,4CAA4C;IAC5C,MAAM,IAAA,gBAAK,EAAC,wBAAgB,CAAC,CAAC;AAChC,CAAC;AA5BD,sCA4BC;AAED;;;GAGG"}

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

@@ -1,8 +1,62 @@
-export default LogMixin;
-export type ADB = import('appium-adb').ADB;
 /**
- * @type {import('./mixins').LogMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * Starts Android logcat broadcast websocket on the same host and port
+ * where Appium server is running at `/ws/session/:sessionId:/appium/logcat` endpoint. The method
+ * will return immediately if the web socket is already listening.
+ *
+ * Each connected websocket listener will receive logcat log lines
+ * as soon as they are visible to Appium.
+ *
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+export function mobileStartLogsBroadcast(this: import("../driver").AndroidDriver): Promise<void>;
+export class mobileStartLogsBroadcast {
+    _logcatWebsocketListener: ((logRecord: import("appium-adb").LogcatRecord) => void) | undefined;
+}
+/**
+ * Stops the previously started logcat broadcasting wesocket server.
+ * This method will return immediately if no server is running.
+ *
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<void>}
+ */
+export function mobileStopLogsBroadcast(this: import("../driver").AndroidDriver): Promise<void>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @returns {Promise<string[]>}
+ */
+export function getLogTypes(this: import("../driver").AndroidDriver): Promise<string[]>;
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} logType
+ * @returns {Promise<any>}
  */
-declare const LogMixin: import('./mixins').LogMixin & ThisType<import('../driver').AndroidDriver>;
+export function getLog(this: import("../driver").AndroidDriver, logType: string): Promise<any>;
+export namespace supportedLogTypes {
+    namespace logcat {
+        let description: string;
+        function getter(self: import("../driver").AndroidDriver): string[];
+    }
+    namespace bugreport {
+        let description_1: string;
+        export { description_1 as description };
+        export function getter_1(self: import("../driver").AndroidDriver): Promise<{
+            timestamp: number;
+            level: string;
+            message: string;
+        }[]>;
+        export { getter_1 as getter };
+    }
+    namespace server {
+        let description_2: string;
+        export { description_2 as description };
+        export function getter_2(self: import("../driver").AndroidDriver): {
+            timestamp: number;
+            level: string;
+            message: string;
+        }[];
+        export { getter_2 as getter };
+    }
+}
+export type ADB = import('appium-adb').ADB;
 //# sourceMappingURL=log.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":";kBAqMa,OAAO,YAAY,EAAE,GAAG;AArKrC;;;GAGG;AACH,wBAHU,OAAO,UAAU,EAAE,QAAQ,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CA6JjF"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":"AAqDA;;;;;;;;;;GAUG;AACH,mFAFa,QAAQ,IAAI,CAAC,CAwDzB;;IA3BK,+FAIC;;AAyBP;;;;;;GAMG;AACH,kFAFa,QAAQ,IAAI,CAAC,CAczB;AAED;;;GAGG;AACH,sEAFa,QAAQ,MAAM,EAAE,CAAC,CAc7B;AAED;;;;GAIG;AACH,yEAHW,MAAM,GACJ,QAAQ,GAAG,CAAC,CAUxB;;;;QA7JW,mEAAuD;;;;;QASvD;;;;aAIP;;;;;;QASO;;;;YAYP;;;;kBAwJQ,OAAO,YAAY,EAAE,GAAG"}