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

package/lib/commands/mixins.ts

@@ -18,14 +18,13 @@ import type {
   UninstallOptions,
 } from 'appium-adb';
 import type Chromedriver from 'appium-chromedriver';
-import type {Sharp} from 'sharp';
 import {AndroidDriverOpts, AndroidDriver} from '../driver';
 import type * as types from './types';
 
 export interface ActionsMixin {
   keyevent(keycode: string | number, metastate?: number): Promise<void>;
-  pressKeyCode(keycode: string | number, metastate?: number): Promise<void>;
-  longPressKeyCode(keycode: string | number, metastate?: number): Promise<void>;
+  pressKeyCode(keycode: string | number, metastate?: number, flags?: any): Promise<void>;
+  longPressKeyCode(keycode: string | number, metastate?: number, flags?: any): Promise<void>;
   getOrientation(): Promise<Orientation>;
   setOrientation(orientation: Orientation): Promise<void>;
   fakeFlick(xSpeed: number, ySpeed: number): Promise<void>;
@@ -84,7 +83,12 @@ export interface ActionsMixin {
     destElId?: string | number
   ): Promise<void>;
   doDrag(opts: types.DragOpts): Promise<void>;
-  lock(seconds: number | string): Promise<void>;
+  lock(seconds?: number): Promise<void>;
+  /**
+   * Lock the device (and optionally unlock it after a certain amount of time).
+   * @throws {Error} if lock or unlock operation fails
+   */
+  mobileLock(opts: types.LockOpts): Promise<void>;
   unlock(): Promise<void>;
   isLocked(): Promise<boolean>;
   openNotifications(): Promise<void>;
@@ -408,8 +412,8 @@ export interface EmulatorConsoleMixin {
 }
 
 export interface ExecuteMixin {
-  execute(script: string, args?: any): Promise<void>;
-  executeMobile(mobileCommand: string, opts?: StringRecord): Promise<void>;
+  execute(script: string, args?: unknown[]): Promise<unknown>;
+  executeMobile(mobileCommand: string, opts?: StringRecord): Promise<unknown>;
 }
 
 export interface FileActionsMixin {
@@ -532,7 +536,7 @@ export interface GeneralMixin {
 
   background(seconds: number): Promise<string | true>;
 
-  getStrings(language: string): Promise<StringRecord>;
+  getStrings(language?: string | null): Promise<StringRecord>;
 
   launchApp(): Promise<void>;
 

package/lib/commands/types.ts

@@ -350,7 +350,7 @@ export interface ListSmsOpts {
    * Maximum count of recent SMS messages
    * @defaultValue 100
    */
-  max: number;
+  max?: number;
 }
 
 export type UnlockType = 'pin' | 'pinWithKeyEvent' | 'password' | 'pattern';
@@ -1087,3 +1087,11 @@ export type SwipeAction = [
 ];
 
 export type TouchDragAction = [NonReleaseTouchAction, NonReleaseTouchAction, ReleaseTouchAction];
+
+export interface LockOpts {
+  /**
+   * The number to keep the locked.
+   * 0 or empty value will keep the device locked.
+   */
+  seconds?: number;
+}

package/lib/{constraints.js → constraints.ts}

@@ -1,18 +1,13 @@
-export const ANDROID_DRIVER_CONSTRAINTS = /** @type {const} */ ({
+import {type Constraints} from '@appium/types';
+
+export const ANDROID_DRIVER_CONSTRAINTS = {
   platformName: {
     isString: true,
     inclusionCaseInsensitive: ['Android'],
     presence: true,
   },
-  /**
-   * XXX: this overrides BaseDriver's constraint, since this driver seems to require the deviceName cap
-   */
   deviceName: {
     isString: true,
-    presence: true,
-  },
-  app: {
-    isString: true,
   },
   appActivity: {
     isString: true,
@@ -301,6 +296,8 @@ export const ANDROID_DRIVER_CONSTRAINTS = /** @type {const} */ ({
   appWaitForLaunch: {
     isBoolean: true,
   },
-});
+} as const satisfies Constraints;
 
 export default ANDROID_DRIVER_CONSTRAINTS;
+
+export type AndroidDriverConstraints = typeof ANDROID_DRIVER_CONSTRAINTS;