appium-android-driver 9.15.0 → 10.0.0

package/lib/driver.ts

@@ -76,9 +76,7 @@ import {
   mobileClearApp,
   mobileInstallApp,
   installApp,
-  mobileActivateApp,
   mobileIsAppInstalled,
-  mobileQueryAppState,
   mobileRemoveApp,
   mobileTerminateApp,
   terminateApp,
@@ -109,16 +107,11 @@ import {
 } from './commands/element';
 import {
   execute,
-  executeMobile,
-  mobileCommandsMapping,
 } from './commands/execute';
 import {
   pullFile,
-  mobilePullFile,
   pullFolder,
-  mobilePullFolder,
   pushFile,
-  mobilePushFile,
   mobileDeleteFile,
 } from './commands/file-actions';
 import {findElOrEls, doFindElementOrEls} from './commands/find';
@@ -158,7 +151,7 @@ import {
   longPressKeyCode,
   mobilePerformEditorAction,
 } from './commands/keyboard';
-import {lock, unlock, mobileLock, mobileUnlock, isLocked} from './commands/lock/exports';
+import {lock, unlock, mobileUnlock, isLocked} from './commands/lock/exports';
 import {
   supportedLogTypes,
   mobileStartLogsBroadcast,
@@ -213,6 +206,7 @@ import {mobileShell} from './commands/shell';
 import {mobileStartScreenStreaming, mobileStopScreenStreaming} from './commands/streamscreen';
 import {getSystemBars, mobilePerformStatusBarCommand} from './commands/system-bars';
 import {getDeviceTime, mobileGetDeviceTime} from './commands/time';
+import { executeMethodMap } from './execute-method-map';
 
 export type AndroidDriverCaps = DriverCaps<AndroidDriverConstraints>;
 export type W3CAndroidDriverCaps = W3CDriverCaps<AndroidDriverConstraints>;
@@ -226,6 +220,8 @@ class AndroidDriver
   implements ExternalDriver<AndroidDriverConstraints, string, StringRecord>
 {
   static newMethodMap = newMethodMap;
+  static executeMethodMap = executeMethodMap;
+
   jwpProxyAvoid: RouteMatcher[];
 
   adb: ADB;
@@ -409,9 +405,7 @@ class AndroidDriver
   mobileClearApp = mobileClearApp;
   mobileInstallApp = mobileInstallApp;
   installApp = installApp;
-  mobileActivateApp = mobileActivateApp;
   mobileIsAppInstalled = mobileIsAppInstalled;
-  mobileQueryAppState = mobileQueryAppState;
   mobileRemoveApp = mobileRemoveApp;
   mobileTerminateApp = mobileTerminateApp;
   terminateApp = terminateApp;
@@ -444,15 +438,10 @@ class AndroidDriver
   getSize = getSize;
 
   execute = execute;
-  executeMobile = executeMobile;
-  mobileCommandsMapping = mobileCommandsMapping;
 
   pullFile = pullFile;
-  mobilePullFile = mobilePullFile;
   pullFolder = pullFolder;
-  mobilePullFolder = mobilePullFolder;
   pushFile = pushFile;
-  mobilePushFile = mobilePushFile;
   mobileDeleteFile = mobileDeleteFile;
 
   findElOrEls = findElOrEls;
@@ -501,7 +490,6 @@ class AndroidDriver
 
   lock = lock;
   unlock = unlock;
-  mobileLock = mobileLock;
   mobileUnlock = mobileUnlock;
   isLocked = isLocked;
 

package/lib/execute-method-map.ts

@@ -0,0 +1,464 @@
+import {ExecuteMethodMap} from '@appium/types';
+
+const INTENT_PARAMS = [
+  'user',
+  'intent',
+  'action',
+  'package',
+  'uri',
+  'mimeType',
+  'identifier',
+  'component',
+  'categories',
+  'extras',
+  'flags',
+] as const;
+
+export const executeMethodMap = {
+  'mobile: shell': {
+    command: 'mobileShell',
+    params: {
+      required: ['command'],
+      optional: ['args', 'timeout', 'includeStderr'],
+    },
+  },
+
+  'mobile: execEmuConsoleCommand': {
+    command: 'mobileExecEmuConsoleCommand',
+    params: {
+      required: ['command'],
+      optional: ['execTimeout', 'connTimeout', 'initTimeout'],
+    },
+  },
+
+  'mobile: startLogsBroadcast': {
+    command: 'mobileStartLogsBroadcast',
+  },
+  'mobile: stopLogsBroadcast': {
+    command: 'mobileStopLogsBroadcast',
+  },
+
+  'mobile: changePermissions': {
+    command: 'mobileChangePermissions',
+    params: {
+      required: ['permissions'],
+      optional: ['appPackage', 'action', 'target'],
+    },
+  },
+  'mobile: getPermissions': {
+    command: 'mobileGetPermissions',
+    params: {
+      optional: ['type', 'appPackage'],
+    },
+  },
+
+  'mobile: performEditorAction': {
+    command: 'mobilePerformEditorAction',
+    params: {
+      required: ['action'],
+    },
+  },
+
+  'mobile: getDeviceTime': {
+    command: 'mobileGetDeviceTime',
+    params: {
+      optional: ['format'],
+    },
+  },
+
+  'mobile: startScreenStreaming': {
+    command: 'mobileStartScreenStreaming',
+    params: {
+      optional: [
+        'width',
+        'height',
+        'bitRate',
+        'host',
+        'port',
+        'pathname',
+        'tcpPort',
+        'quality',
+        'considerRotation',
+        'logPipelineDetails',
+      ],
+    },
+  },
+  'mobile: stopScreenStreaming': {
+    command: 'mobileStopScreenStreaming',
+  },
+
+  'mobile: getNotifications': {
+    command: 'mobileGetNotifications',
+  },
+
+  'mobile: listSms': {
+    command: 'mobileListSms',
+  },
+
+  'mobile: pushFile': {
+    command: 'pushFile',
+    params: {
+      required: ['remotePath', 'payload'],
+    },
+  },
+  'mobile: pullFolder': {
+    command: 'pullFolder',
+    params: {
+      required: ['remotePath'],
+    },
+  },
+  'mobile: pullFile': {
+    command: 'pullFile',
+    params: {
+      required: ['remotePath'],
+    },
+  },
+  'mobile: deleteFile': {
+    command: 'mobileDeleteFile',
+    params: {
+      required: ['remotePath'],
+    },
+  },
+
+  'mobile: isAppInstalled': {
+    command: 'mobileIsAppInstalled',
+    params: {
+      required: ['appId'],
+      optional: ['user'],
+    },
+  },
+  'mobile: queryAppState': {
+    command: 'queryAppState',
+    params: {
+      required: ['appId'],
+    },
+  },
+  'mobile: activateApp': {
+    command: 'activateApp',
+    params: {
+      required: ['appId'],
+    },
+  },
+  'mobile: removeApp': {
+    command: 'mobileRemoveApp',
+    params: {
+      required: ['appId'],
+      optional: ['timeout', 'keepData', 'skipInstallCheck'],
+    },
+  },
+  'mobile: terminateApp': {
+    command: 'mobileTerminateApp',
+    params: {
+      required: ['appId'],
+      optional: ['timeout'],
+    },
+  },
+  'mobile: installApp': {
+    command: 'mobileInstallApp',
+    params: {
+      required: ['appPath'],
+      optional: [
+        'checkVersion',
+        'timeout',
+        'allowTestPackages',
+        'useSdcard',
+        'grantPermissions',
+        'replace',
+        'noIncremental',
+      ],
+    },
+  },
+  'mobile: clearApp': {
+    command: 'mobileClearApp',
+    params: {
+      required: ['appId'],
+    },
+  },
+
+  'mobile: startService': {
+    command: 'mobileStartService',
+    params: {
+      optional: [
+        'foreground',
+        ...INTENT_PARAMS,
+      ],
+    },
+  },
+  'mobile: stopService': {
+    command: 'mobileStopService',
+    params: {
+      optional: [
+        ...INTENT_PARAMS,
+      ],
+    },
+  },
+  'mobile: startActivity': {
+    command: 'mobileStartActivity',
+    params: {
+      optional: [
+        'wait',
+        'stop',
+        'windowingMode',
+        'activityType',
+        'display',
+        ...INTENT_PARAMS,
+      ],
+    },
+  },
+  'mobile: broadcast': {
+    command: 'mobileBroadcast',
+    params: {
+      optional: [
+        'receiverPermission',
+        'allowBackgroundActivityStarts',
+        ...INTENT_PARAMS,
+      ],
+    },
+  },
+
+  'mobile: getContexts': {
+    command: 'mobileGetContexts',
+    params: {
+      optional: [
+        'waitForWebviewMs',
+      ],
+    },
+  },
+
+  'mobile: lock': {
+    command: 'lock',
+    params: {
+      optional: [
+        'seconds',
+      ],
+    },
+  },
+  'mobile: unlock': {
+    command: 'mobileUnlock',
+    params: {
+      optional: [
+        'key',
+        'type',
+        'strategy',
+        'timeoutMs',
+      ],
+    },
+  },
+  'mobile: isLocked': {
+    command: 'isLocked',
+  },
+
+  'mobile: refreshGpsCache': {
+    command: 'mobileRefreshGpsCache',
+    params: {
+      optional: [
+        'timeoutMs',
+      ],
+    },
+  },
+
+  'mobile: startMediaProjectionRecording': {
+    command: 'mobileStartMediaProjectionRecording',
+    params: {
+      optional: [
+        'resolution',
+        'priority',
+        'maxDurationSec',
+        'filename',
+      ],
+    },
+  },
+  'mobile: isMediaProjectionRecordingRunning': {
+    command: 'mobileIsMediaProjectionRecordingRunning',
+  },
+  'mobile: stopMediaProjectionRecording': {
+    command: 'mobileStopMediaProjectionRecording',
+    params: {
+      optional: [
+        'remotePath',
+        'user',
+        'pass',
+        'method',
+        'headers',
+        'fileFieldName',
+        'formFields',
+        'uploadTimeout',
+      ],
+    },
+  },
+
+  'mobile: getConnectivity': {
+    command: 'mobileGetConnectivity',
+    params: {
+      optional: ['services'],
+    }
+  },
+  'mobile: setConnectivity': {
+    command: 'mobileSetConnectivity',
+    params: {
+      optional: ['wifi', 'data', 'airplaneMode'],
+    }
+  },
+
+  'mobile: hideKeyboard': {
+    command: 'hideKeyboard',
+  },
+  'mobile: isKeyboardShown': {
+    command: 'isKeyboardShown',
+  },
+
+  'mobile: deviceidle': {
+    command: 'mobileDeviceidle',
+    params: {
+      required: ['action'],
+      optional: ['packages'],
+    }
+  },
+
+  'mobile: bluetooth': {
+    command: 'mobileBluetooth',
+    params: {
+      required: ['action'],
+    }
+  },
+  'mobile: nfc': {
+    command: 'mobileNfc',
+    params: {
+      required: ['action'],
+    }
+  },
+
+  'mobile: setUiMode': {
+    command: 'mobileSetUiMode',
+    params: {
+      required: ['mode', 'value'],
+    }
+  },
+  'mobile: getUiMode': {
+    command: 'mobileGetUiMode',
+    params: {
+      required: ['mode'],
+    }
+  },
+
+  'mobile: injectEmulatorCameraImage': {
+    command: 'mobileInjectEmulatorCameraImage',
+    params: {
+      required: ['payload'],
+    }
+  },
+
+  'mobile: sendTrimMemory': {
+    command: 'mobileSendTrimMemory',
+    params: {
+      required: ['pkg', 'level'],
+    }
+  },
+
+  'mobile: getPerformanceData': {
+    command: 'mobileGetPerformanceData',
+    params: {
+      required: ['packageName', 'dataType'],
+    }
+  },
+  'mobile: getPerformanceDataTypes': {
+    command: 'getPerformanceDataTypes',
+  },
+
+  'mobile: toggleGps': {
+    command: 'toggleLocationServices',
+  },
+  'mobile: isGpsEnabled': {
+    command: 'isLocationServicesEnabled',
+  },
+
+  'mobile: getDisplayDensity': {
+    command: 'getDisplayDensity',
+  },
+  'mobile: getSystemBars': {
+    command: 'getSystemBars',
+  },
+  'mobile: statusBar': {
+    command: 'mobilePerformStatusBarCommand',
+    params: {
+      required: ['command'],
+      optional: ['component'],
+    }
+  },
+
+  'mobile: fingerprint': {
+    command: 'mobileFingerprint',
+    params: {
+      required: ['fingerprintId'],
+    }
+  },
+  'mobile: sendSms': {
+    command: 'mobileSendSms',
+    params: {
+      required: ['phoneNumber', 'message'],
+    }
+  },
+  'mobile: gsmCall': {
+    command: 'mobileGsmCall',
+    params: {
+      required: ['phoneNumber', 'action'],
+    }
+  },
+  'mobile: gsmSignal': {
+    command: 'mobileGsmSignal',
+    params: {
+      required: ['strength'],
+    }
+  },
+  'mobile: gsmVoice': {
+    command: 'mobileGsmVoice',
+    params: {
+      required: ['state'],
+    }
+  },
+  'mobile: powerAc': {
+    command: 'mobilePowerAc',
+    params: {
+      required: ['state'],
+    }
+  },
+  'mobile: powerCapacity': {
+    command: 'mobilePowerCapacity',
+    params: {
+      required: ['percent'],
+    }
+  },
+  'mobile: networkSpeed': {
+    command: 'mobileNetworkSpeed',
+    params: {
+      required: ['speed'],
+    }
+  },
+  'mobile: sensorSet': {
+    command: 'sensorSet',
+    params: {
+      required: ['sensorType', 'value'],
+    }
+  },
+
+  'mobile: getCurrentActivity': {
+    command: 'getCurrentActivity',
+  },
+  'mobile: getCurrentPackage': {
+    command: 'getCurrentPackage',
+  },
+
+  'mobile: setGeolocation': {
+    command: 'mobileSetGeolocation',
+    params: {
+      required: ['latitude', 'longitude'],
+      optional: ['altitude'],
+    }
+  },
+  'mobile: getGeolocation': {
+    command: 'mobileGetGeolocation',
+  },
+  'mobile: resetGeolocation': {
+    command: 'mobileResetGeolocation',
+  },
+} as const satisfies ExecuteMethodMap<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "9.15.0",
+  "version": "10.0.0",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -51,7 +51,7 @@
     "@appium/support": "^6.0.0",
     "@colors/colors": "^1.6.0",
     "appium-adb": "^12.12.0",
-    "appium-chromedriver": "^6.0.1",
+    "appium-chromedriver": "^7.0.0",
     "asyncbox": "^3.0.0",
     "axios": "^1.x",
     "bluebird": "^3.4.7",