appium-android-driver 12.6.0 → 12.6.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [12.6.2](https://github.com/appium/appium-android-driver/compare/v12.6.1...v12.6.2) (2025-12-23)
+
+### Miscellaneous Chores
+
+* **deps:** bump teen_process from 3.0.6 to 4.0.7 ([#1046](https://github.com/appium/appium-android-driver/issues/1046)) ([1e88bc4](https://github.com/appium/appium-android-driver/commit/1e88bc4c83015609200fe8c6bd8b791ede1720fa))
+
+## [12.6.1](https://github.com/appium/appium-android-driver/compare/v12.6.0...v12.6.1) (2025-12-21)
+
+### Miscellaneous Chores
+
+* Migrate lock helpers to typescript ([#1045](https://github.com/appium/appium-android-driver/issues/1045)) ([6779082](https://github.com/appium/appium-android-driver/commit/6779082ba788ee803277c5033dc1c1cb37d68cf4))
+
 ## [12.6.0](https://github.com/appium/appium-android-driver/compare/v12.5.0...v12.6.0) (2025-12-21)
 
 ### Features

package/build/lib/commands/lock/exports.d.ts

@@ -1,41 +1,37 @@
+import type { AndroidDriver, AndroidDriverCaps } from '../../driver';
+import type { UnlockType } from '../types';
 /**
- * @this {AndroidDriver}
- * @param {number} [seconds]
- * @returns {Promise<void>}
+ * Locks the device and optionally unlocks it after a specified number of seconds.
+ *
+ * @param seconds - Optional number of seconds to wait before unlocking. If not provided or invalid, the device remains locked.
  */
-export function lock(this: import("../../driver").AndroidDriver, seconds?: number): Promise<void>;
+export declare function lock(this: AndroidDriver, seconds?: number): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @returns {Promise<boolean>}
+ * Checks if the device screen is currently locked.
+ *
+ * @returns True if the screen is locked, false otherwise
  */
-export function isLocked(this: import("../../driver").AndroidDriver): Promise<boolean>;
+export declare function isLocked(this: AndroidDriver): Promise<boolean>;
 /**
- * @this {AndroidDriver}
- * @returns {Promise<void>}
+ * Unlocks the device using the unlock options from session capabilities.
  */
-export function unlock(this: import("../../driver").AndroidDriver): Promise<void>;
+export declare function unlock(this: AndroidDriver): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @param {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.
- * @param {import('../types').UnlockType} [type] The unlock type.
- * If not provided then the corresponding value from session capabilities is used.
- * @param {string} [strategy] Setting it to 'uiautomator' will enforce the driver to avoid using special
- * ADB shortcuts in order to speed up the unlock procedure.
- * 'uiautomator' by default.
- * @param {number} [timeoutMs] The maximum time in milliseconds to wait until the screen gets unlocked
- * 2000ms byde fault.
- * @returns {Promise<void>}
+ * Unlocks the device with the specified options.
+ *
+ * @param 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.
+ * @param type - The unlock type. If not provided then the corresponding value from session capabilities is used.
+ * @param strategy - Setting it to 'uiautomator' will enforce the driver to avoid using special
+ *                  ADB shortcuts in order to speed up the unlock procedure. 'uiautomator' by default.
+ * @param timeoutMs - The maximum time in milliseconds to wait until the screen gets unlocked. 2000ms by default.
  */
-export function mobileUnlock(this: import("../../driver").AndroidDriver, key?: string, type?: import("../types").UnlockType, strategy?: string, timeoutMs?: number): Promise<void>;
+export declare function mobileUnlock(this: AndroidDriver, key?: string, type?: UnlockType, strategy?: string, timeoutMs?: number): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps?} [caps=null]
- * @returns {Promise<void>}
+ * Unlocks the device with the specified capabilities.
+ *
+ * @param caps - Optional capabilities to use for unlocking. If not provided, uses session capabilities.
  */
-export function unlockWithOptions(this: import("../../driver").AndroidDriver, caps?: AndroidDriverCaps | null): Promise<void>;
-export type AndroidDriverCaps = import("@appium/types").Capabilities<import("../../constraints").AndroidDriverConstraints>;
-export type AndroidDriver = import("../../driver").AndroidDriver;
+export declare function unlockWithOptions(this: AndroidDriver, caps?: AndroidDriverCaps | null): Promise<void>;
 //# sourceMappingURL=exports.d.ts.map

package/build/lib/commands/lock/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../../lib/commands/lock/exports.js"],"names":[],"mappings":"AAmBA;;;;GAIG;AACH,2EAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAczB;AAED;;;GAGG;AACH,sEAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;GAGG;AACH,oEAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;;;;;;;;;;;GAcG;AACH,+EAbW,MAAM,SAIN,OAAO,UAAU,EAAE,UAAU,aAE7B,MAAM,cAGN,MAAM,GAEJ,OAAO,CAAC,IAAI,CAAC,CAazB;AAID;;;;GAIG;AACH,qFAHW,iBAAiB,OAAC,GAChB,OAAO,CAAC,IAAI,CAAC,CA0CzB;gCAKY,OAAO,eAAe,EAAE,YAAY,CAAC,OAAO,mBAAmB,EAAE,wBAAwB,CAAC;4BAC1F,OAAO,cAAc,EAAE,aAAa"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../../lib/commands/lock/exports.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAC,aAAa,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC;AACnE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAEzC;;;;GAIG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAY/E;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAEpE;AAED;;GAEG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/D;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,aAAa,EACnB,GAAG,CAAC,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,UAAU,EACjB,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAWf;AAID;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,aAAa,EACnB,IAAI,GAAE,iBAAiB,GAAG,IAAW,GACpC,OAAO,CAAC,IAAI,CAAC,CA+Cf"}

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

@@ -12,13 +12,13 @@ const bluebird_1 = __importDefault(require("bluebird"));
 const helpers_1 = require("./helpers");
 const lodash_1 = __importDefault(require("lodash"));
 /**
- * @this {AndroidDriver}
- * @param {number} [seconds]
- * @returns {Promise<void>}
+ * Locks the device and optionally unlocks it after a specified number of seconds.
+ *
+ * @param seconds - Optional number of seconds to wait before unlocking. If not provided or invalid, the device remains locked.
  */
 async function lock(seconds) {
     await this.adb.lock();
-    if (Number.isNaN(seconds)) {
+    if (Number.isNaN(seconds ?? NaN)) {
         return;
     }
     const floatSeconds = parseFloat(String(seconds));
@@ -29,33 +29,29 @@ async function lock(seconds) {
     await this.unlock();
 }
 /**
- * @this {AndroidDriver}
- * @returns {Promise<boolean>}
+ * Checks if the device screen is currently locked.
+ *
+ * @returns True if the screen is locked, false otherwise
  */
 async function isLocked() {
     return await this.adb.isScreenLocked();
 }
 /**
- * @this {AndroidDriver}
- * @returns {Promise<void>}
+ * Unlocks the device using the unlock options from session capabilities.
  */
 async function unlock() {
     await unlockWithOptions.bind(this)();
 }
 /**
- * @this {AndroidDriver}
- * @param {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.
- * @param {import('../types').UnlockType} [type] The unlock type.
- * If not provided then the corresponding value from session capabilities is used.
- * @param {string} [strategy] Setting it to 'uiautomator' will enforce the driver to avoid using special
- * ADB shortcuts in order to speed up the unlock procedure.
- * 'uiautomator' by default.
- * @param {number} [timeoutMs] The maximum time in milliseconds to wait until the screen gets unlocked
- * 2000ms byde fault.
- * @returns {Promise<void>}
+ * Unlocks the device with the specified options.
+ *
+ * @param 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.
+ * @param type - The unlock type. If not provided then the corresponding value from session capabilities is used.
+ * @param strategy - Setting it to 'uiautomator' will enforce the driver to avoid using special
+ *                  ADB shortcuts in order to speed up the unlock procedure. 'uiautomator' by default.
+ * @param timeoutMs - The maximum time in milliseconds to wait until the screen gets unlocked. 2000ms by default.
  */
 async function mobileUnlock(key, type, strategy, timeoutMs) {
     if (!key && !type) {
@@ -72,9 +68,9 @@ async function mobileUnlock(key, type, strategy, timeoutMs) {
 }
 // #region Internal Helpers
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps?} [caps=null]
- * @returns {Promise<void>}
+ * Unlocks the device with the specified capabilities.
+ *
+ * @param caps - Optional capabilities to use for unlocking. If not provided, uses session capabilities.
  */
 async function unlockWithOptions(caps = null) {
     if (!(await this.adb.isScreenLocked())) {
@@ -89,31 +85,35 @@ async function unlockWithOptions(caps = null) {
         await this.adb.dismissKeyguard();
         return;
     }
-    const { unlockType, unlockKey, unlockStrategy, unlockSuccessTimeout } = (0, helpers_1.validateUnlockCapabilities)(capabilities);
+    const validated = (0, helpers_1.validateUnlockCapabilities)(capabilities);
+    const { unlockType, unlockKey, unlockStrategy, unlockSuccessTimeout } = validated;
+    if (!unlockType) {
+        throw new Error('unlockType is required after validation');
+    }
     if (unlockKey &&
         unlockType !== helpers_1.FINGERPRINT_UNLOCK &&
         (lodash_1.default.isNil(unlockStrategy) || lodash_1.default.toLower(unlockStrategy) === 'locksettings') &&
         (await this.adb.isLockManagementSupported())) {
         await helpers_1.fastUnlock.bind(this)({
             credential: unlockKey,
-            credentialType: (0, helpers_1.toCredentialType)(/** @type {import('../types').UnlockType} */ (unlockType)),
+            credentialType: (0, helpers_1.toCredentialType)(unlockType),
         });
     }
     else {
-        const unlockMethod = {
+        const unlockMethodMap = {
             [helpers_1.PIN_UNLOCK]: helpers_1.pinUnlock,
             [helpers_1.PIN_UNLOCK_KEY_EVENT]: helpers_1.pinUnlockWithKeyEvent,
             [helpers_1.PASSWORD_UNLOCK]: helpers_1.passwordUnlock,
             [helpers_1.PATTERN_UNLOCK]: helpers_1.patternUnlock,
             [helpers_1.FINGERPRINT_UNLOCK]: helpers_1.fingerprintUnlock,
-        }[unlockType];
+        };
+        const unlockMethod = unlockMethodMap[unlockType];
+        if (!unlockMethod) {
+            throw new Error(`Unknown unlock type: ${unlockType}`);
+        }
         await unlockMethod.bind(this)(capabilities);
     }
     await helpers_1.verifyUnlock.bind(this)(unlockSuccessTimeout);
 }
 // #endregion
-/**
- * @typedef {import('@appium/types').Capabilities<import('../../constraints').AndroidDriverConstraints>} AndroidDriverCaps
- * @typedef {import('../../driver').AndroidDriver} AndroidDriver
- */
 //# sourceMappingURL=exports.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../../../lib/commands/lock/exports.js"],"names":[],"mappings":";;;;;AAwBA,oBAYC;AAMD,4BAEC;AAMD,wBAEC;AAiBD,oCAWC;AASD,8CAwCC;AAjID,wDAAyB;AACzB,uCAemB;AACnB,oDAAuB;AAEvB;;;;GAIG;AACI,KAAK,UAAU,IAAI,CAAC,OAAO;IAChC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACtB,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IACD,MAAM,kBAAC,CAAC,KAAK,CAAC,IAAI,GAAG,YAAY,CAAC,CAAC;IACnC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;AACtB,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;AACzC,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,MAAM;IAC1B,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS;IAC/D,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,SAAS,EAAE,GAAG;YACd,UAAU,EAAE,IAAI;YAChB,cAAc,EAAE,QAAQ;YACxB,oBAAoB,EAAE,SAAS;SAChC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,2BAA2B;AAE3B;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAI,GAAG,IAAI;IACjD,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;QACxD,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;IACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACrD,IAAI,CAAC,YAAY,CAAC,UAAU,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QACxD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,+DAA+D;YAC7D,0DAA0D,CAC7D,CAAC;QACF,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,MAAM,EAAC,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,oBAAoB,EAAC,GACjE,IAAA,oCAA0B,EAAC,YAAY,CAAC,CAAC;IAC3C,IACE,SAAS;QACT,UAAU,KAAK,4BAAkB;QACjC,CAAC,gBAAC,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,cAAc,CAAC;QACzE,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC,EAC5C,CAAC;QACD,MAAM,oBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,UAAU,EAAE,SAAS;YACrB,cAAc,EAAE,IAAA,0BAAgB,EAAC,4CAA4C,CAAC,CAAC,UAAU,CAAC,CAAC;SAC5F,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,YAAY,GAAG;YACnB,CAAC,oBAAU,CAAC,EAAE,mBAAS;YACvB,CAAC,8BAAoB,CAAC,EAAE,+BAAqB;YAC7C,CAAC,yBAAe,CAAC,EAAE,wBAAc;YACjC,CAAC,wBAAc,CAAC,EAAE,uBAAa;YAC/B,CAAC,4BAAkB,CAAC,EAAE,2BAAiB;SACxC,CAAC,UAAU,CAAC,CAAC;QACd,MAAM,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IACD,MAAM,sBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC;AACtD,CAAC;AAED,aAAa;AAEb;;;GAGG"}
+{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../../../lib/commands/lock/exports.ts"],"names":[],"mappings":";;;;;AA0BA,oBAYC;AAOD,4BAEC;AAKD,wBAEC;AAaD,oCAiBC;AASD,8CAkDC;AA/ID,wDAAyB;AACzB,uCAemB;AACnB,oDAAuB;AAIvB;;;;GAIG;AACI,KAAK,UAAU,IAAI,CAAsB,OAAgB;IAC9D,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACtB,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IACD,MAAM,kBAAC,CAAC,KAAK,CAAC,IAAI,GAAG,YAAY,CAAC,CAAC;IACnC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;AACzC,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,MAAM;IAC1B,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,YAAY,CAEhC,GAAY,EACZ,IAAiB,EACjB,QAAiB,EACjB,SAAkB;IAElB,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,SAAS,EAAE,GAAG;YACd,UAAU,EAAE,IAAI;YAChB,cAAc,EAAE,QAAQ;YACxB,oBAAoB,EAAE,SAAS;SACX,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,2BAA2B;AAE3B;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAErC,OAAiC,IAAI;IAErC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;QACxD,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;IACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACrD,IAAI,CAAC,YAAY,CAAC,UAAU,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QACxD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,+DAA+D;YAC7D,0DAA0D,CAC7D,CAAC;QACF,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,MAAM,SAAS,GAAG,IAAA,oCAA0B,EAAC,YAAY,CAAC,CAAC;IAC3D,MAAM,EAAC,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,oBAAoB,EAAC,GAAG,SAAS,CAAC;IAChF,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IACD,IACE,SAAS;QACT,UAAU,KAAK,4BAAkB;QACjC,CAAC,gBAAC,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,cAAc,CAAC;QACzE,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC,EAC5C,CAAC;QACD,MAAM,oBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,UAAU,EAAE,SAAS;YACrB,cAAc,EAAE,IAAA,0BAAgB,EAAC,UAAwB,CAAC;SAC3D,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,eAAe,GAAoF;YACvG,CAAC,oBAAU,CAAC,EAAE,mBAAS;YACvB,CAAC,8BAAoB,CAAC,EAAE,+BAAqB;YAC7C,CAAC,yBAAe,CAAC,EAAE,wBAAc;YACjC,CAAC,wBAAc,CAAC,EAAE,uBAAa;YAC/B,CAAC,4BAAkB,CAAC,EAAE,2BAAiB;SACxC,CAAC;QACF,MAAM,YAAY,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;QACjD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IACD,MAAM,sBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC;AACtD,CAAC;AAED,aAAa"}

package/build/lib/commands/lock/helpers.d.ts

@@ -1,89 +1,103 @@
+import type { Position, StringRecord } from '@appium/types';
+import type { AndroidDriver, AndroidDriverCaps } from '../../driver';
+import type { UnlockType, FastUnlockOptions } from '../types';
+export declare const PIN_UNLOCK = "pin";
+export declare const PIN_UNLOCK_KEY_EVENT = "pinWithKeyEvent";
+export declare const PASSWORD_UNLOCK = "password";
+export declare const PATTERN_UNLOCK = "pattern";
+export declare const FINGERPRINT_UNLOCK = "fingerprint";
+export declare const KEYCODE_NUMPAD_ENTER = 66;
+export declare const UNLOCK_WAIT_TIME = 100;
+export declare const INPUT_KEYS_WAIT_TIME = 100;
 /**
+ * Converts an unlock type to a credential type string.
  *
- * @param {import('../types').UnlockType} unlockType
- * @returns {string}
+ * @param unlockType - The unlock type
+ * @returns The credential type string
+ * @throws {Error} If the unlock type is not known
  */
-export function toCredentialType(unlockType: import("../types").UnlockType): string;
+export declare function toCredentialType(unlockType: UnlockType): string;
 /**
- * @template {AndroidDriverCaps} T
- * @param {T} caps
- * @returns {T}
+ * Validates unlock capabilities and returns them if valid.
+ *
+ * @param caps - The capabilities to validate
+ * @returns The validated capabilities
+ * @throws {Error} If the capabilities are invalid
  */
-export function validateUnlockCapabilities<T extends AndroidDriverCaps>(caps: T): T;
+export declare function validateUnlockCapabilities<T extends AndroidDriverCaps>(caps: T): T;
 /**
- * @this {AndroidDriver}
- * @param {import('../types').FastUnlockOptions} opts
+ * Performs a fast unlock using ADB commands.
+ *
+ * @param opts - Fast unlock options with credential and credential type
  */
-export function fastUnlock(this: import("../../driver").AndroidDriver, opts: import("../types").FastUnlockOptions): Promise<void>;
+export declare function fastUnlock(this: AndroidDriver, opts: FastUnlockOptions): Promise<void>;
 /**
+ * Encodes a password by replacing spaces with %s.
  *
- * @param {string} key
- * @returns {string}
+ * @param key - The password key
+ * @returns The encoded password
  */
-export function encodePassword(key: string): string;
+export declare function encodePassword(key: string): string;
 /**
+ * Converts a string key to an array of characters.
  *
- * @param {string} key
- * @returns {string[]}
+ * @param key - The key string
+ * @returns An array of characters
  */
-export function stringKeyToArr(key: string): string[];
+export declare function stringKeyToArr(key: string): string[];
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps} capabilities
- * @returns {Promise<void>}
+ * Unlocks the device using fingerprint.
+ *
+ * @param capabilities - Driver capabilities containing unlockKey
  */
-export function fingerprintUnlock(this: import("../../driver").AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
+export declare function fingerprintUnlock(this: AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps} capabilities
- * @returns {Promise<void>}
+ * Unlocks the device using PIN by clicking on-screen buttons.
+ *
+ * @param capabilities - Driver capabilities containing unlockKey
  */
-export function pinUnlock(this: import("../../driver").AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
+export declare function pinUnlock(this: AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps} capabilities
- * @returns {Promise<void>}
+ * Unlocks the device using PIN by sending key events.
+ *
+ * @param capabilities - Driver capabilities containing unlockKey
  */
-export function pinUnlockWithKeyEvent(this: import("../../driver").AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
+export declare function pinUnlockWithKeyEvent(this: AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps} capabilities
- * @returns {Promise<void>}
+ * Unlocks the device using password.
+ *
+ * @param capabilities - Driver capabilities containing unlockKey
  */
-export function passwordUnlock(this: import("../../driver").AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
+export declare function passwordUnlock(this: AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
 /**
+ * Calculates the position of a pattern key based on the initial position and piece size.
  *
- * @param {number} key
- * @param {import('@appium/types').Position} initPos
- * @param {number} piece
- * @returns {import('@appium/types').Position}
+ * @param key - The pattern key number (1-9)
+ * @param initPos - The initial position of the pattern view
+ * @param piece - The size of each pattern piece
+ * @returns The calculated position for the key
  */
-export function getPatternKeyPosition(key: number, initPos: import("@appium/types").Position, piece: number): import("@appium/types").Position;
+export declare function getPatternKeyPosition(key: number, initPos: Position, piece: number): Position;
 /**
- * @param {string[]|number[]} keys
- * @param {import('@appium/types').Position} initPos
- * @param {number} piece
- * @returns {import('@appium/types').StringRecord[]}
+ * Generates pointer actions for pattern unlock gesture.
+ *
+ * @param keys - Array of pattern keys (string or number)
+ * @param initPos - The initial position of the pattern view
+ * @param piece - The size of each pattern piece
+ * @returns An array of W3C action objects for pattern unlock
  */
-export function getPatternActions(keys: string[] | number[], initPos: import("@appium/types").Position, piece: number): import("@appium/types").StringRecord[];
+export declare function getPatternActions(keys: string[] | number[], initPos: Position, piece: number): StringRecord[];
 /**
- * @this {AndroidDriver}
- * @param {number?} [timeoutMs=null]
+ * Verifies that the device has been unlocked.
+ *
+ * @param timeoutMs - Optional timeout in milliseconds (default: 2000)
+ * @throws {Error} If the device fails to unlock within the timeout
  */
-export function verifyUnlock(this: import("../../driver").AndroidDriver, timeoutMs?: number | null): Promise<void>;
+export declare function verifyUnlock(this: AndroidDriver, timeoutMs?: number | null): Promise<void>;
 /**
- * @this {AndroidDriver}
- * @param {AndroidDriverCaps} capabilities
+ * Unlocks the device using pattern gesture.
+ *
+ * @param capabilities - Driver capabilities containing unlockKey
  */
-export function patternUnlock(this: import("../../driver").AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
-export const PIN_UNLOCK: "pin";
-export const PIN_UNLOCK_KEY_EVENT: "pinWithKeyEvent";
-export const PASSWORD_UNLOCK: "password";
-export const PATTERN_UNLOCK: "pattern";
-export const FINGERPRINT_UNLOCK: "fingerprint";
-export const KEYCODE_NUMPAD_ENTER: 66;
-export const UNLOCK_WAIT_TIME: 100;
-export const INPUT_KEYS_WAIT_TIME: 100;
-export type AndroidDriverCaps = import("@appium/types").Capabilities<import("../../constraints").AndroidDriverConstraints>;
-export type AndroidDriver = import("../../driver").AndroidDriver;
+export declare function patternUnlock(this: AndroidDriver, capabilities: AndroidDriverCaps): Promise<void>;
 //# sourceMappingURL=helpers.d.ts.map

package/build/lib/commands/lock/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../lib/commands/lock/helpers.js"],"names":[],"mappings":"AAmDA;;;;GAIG;AACH,6CAHW,OAAO,UAAU,EAAE,UAAU,GAC3B,MAAM,CAalB;AAED;;;;GAIG;AACH,2CAJiC,CAAC,SAApB,iBAAkB,QACrB,CAAC,GACC,CAAC,CAsCb;AAED;;;GAGG;AACH,6EAFW,OAAO,UAAU,EAAE,iBAAiB,iBAqB9C;AAED;;;;GAIG;AACH,oCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;GAIG;AACH,oCAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;AAED;;;;GAIG;AACH,4FAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAKzB;AAED;;;;GAIG;AACH,oFAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAqBzB;AAED;;;;GAIG;AACH,gGAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAezB;AAED;;;;GAIG;AACH,yFAHW,iBAAiB,GACf,OAAO,CAAC,IAAI,CAAC,CAezB;AAED;;;;;;GAMG;AACH,2CALW,MAAM,WACN,OAAO,eAAe,EAAE,QAAQ,SAChC,MAAM,GACJ,OAAO,eAAe,EAAE,QAAQ,CAkB5C;AAED;;;;;GAKG;AACH,wCALW,MAAM,EAAE,GAAC,MAAM,EAAE,WACjB,OAAO,eAAe,EAAE,QAAQ,SAChC,MAAM,GACJ,OAAO,eAAe,EAAE,YAAY,EAAE,CA8DlD;AAED;;;GAGG;AACH,qFAFW,MAAM,OAAC,iBAYjB;AAED;;;GAGG;AACH,wFAFW,iBAAiB,iBA8B3B;AAhXD,yBAA0B,KAAK,CAAC;AAChC,mCAAoC,iBAAiB,CAAC;AACtD,8BAA+B,UAAU,CAAC;AAC1C,6BAA8B,SAAS,CAAC;AACxC,iCAAkC,aAAa,CAAC;AAQhD,mCAAoC,EAAE,CAAC;AACvC,+BAAgC,GAAG,CAAC;AACpC,mCAAoC,GAAG,CAAC;gCAqW3B,OAAO,eAAe,EAAE,YAAY,CAAC,OAAO,mBAAmB,EAAE,wBAAwB,CAAC;4BAC1F,OAAO,cAAc,EAAE,aAAa"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../lib/commands/lock/helpers.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,QAAQ,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,EAAC,aAAa,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC;AACnE,OAAO,KAAK,EAAC,UAAU,EAAE,iBAAiB,EAAC,MAAM,UAAU,CAAC;AAE5D,eAAO,MAAM,UAAU,QAAQ,CAAC;AAChC,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AACtD,eAAO,MAAM,eAAe,aAAa,CAAC;AAC1C,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,kBAAkB,gBAAgB,CAAC;AAQhD,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,gBAAgB,MAAM,CAAC;AACpC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAIxC;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAW/D;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,iBAAiB,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAoClF;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB5F;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAEpD;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,aAAa,EACnB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,aAAa,EACnB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAqBf;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,aAAa,EACnB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAaf;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,aAAa,EACnB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAaf;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,QAAQ,CAiB7F;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,EACzB,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,MAAM,GACZ,YAAY,EAAE,CA2DhB;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAUtG;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,aAAa,EACnB,YAAY,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CA4Bf"}