appium-android-driver 7.8.3 → 8.0.0

package/lib/commands/execute.js

@@ -1,115 +1,114 @@
-// @ts-check
-
 import _ from 'lodash';
 import {errors, PROTOCOLS} from 'appium/driver';
-import {mixin} from './mixins';
 
 /**
- * @type {import('./mixins').ExecuteMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} script
+ * @param {any[]} [args]
+ * @returns {Promise<any>}
  */
-const ExecuteMixin = {
-  async execute(script, args) {
-    if (script.match(/^mobile:/)) {
-      this.log.info(`Executing native command '${script}'`);
-      script = script.replace(/^mobile:/, '').trim();
-      return await this.executeMobile(
-        script,
-        _.isArray(args) ? /** @type {import('@appium/types').StringRecord} */ (args[0]) : args
-      );
-    }
-    if (!this.isWebContext()) {
-      throw new errors.NotImplementedError();
-    }
-    const endpoint =
-      /** @type {import('appium-chromedriver').Chromedriver} */ (this.chromedriver).jwproxy
-        .downstreamProtocol === PROTOCOLS.MJSONWP
-        ? '/execute'
-        : '/execute/sync';
-    return await /** @type {import('appium-chromedriver').Chromedriver} */ (
-      this.chromedriver
-    ).jwproxy.command(endpoint, 'POST', {
+export async function execute(script, args) {
+  if (script.match(/^mobile:/)) {
+    this.log.info(`Executing native command '${script}'`);
+    script = script.replace(/^mobile:/, '').trim();
+    return await this.executeMobile(
       script,
-      args,
-    });
-  },
-
-  async executeMobile(mobileCommand, opts = {}) {
-    const mobileCommandsMapping = {
-      shell: 'mobileShell',
-
-      execEmuConsoleCommand: 'mobileExecEmuConsoleCommand',
+      _.isArray(args) ? /** @type {import('@appium/types').StringRecord} */ (args[0]) : args,
+    );
+  }
+  if (!this.isWebContext()) {
+    throw new errors.NotImplementedError();
+  }
+  const endpoint =
+    /** @type {import('appium-chromedriver').Chromedriver} */ (this.chromedriver).jwproxy
+      .downstreamProtocol === PROTOCOLS.MJSONWP
+      ? '/execute'
+      : '/execute/sync';
+  return await /** @type {import('appium-chromedriver').Chromedriver} */ (
+    this.chromedriver
+  ).jwproxy.command(endpoint, 'POST', {
+    script,
+    args,
+  });
+}
 
-      startLogsBroadcast: 'mobileStartLogsBroadcast',
-      stopLogsBroadcast: 'mobileStopLogsBroadcast',
+/**
+ * @this {import('../driver').AndroidDriver}
+ * @param {string} mobileCommand
+ * @param {import('@appium/types').StringRecord} [opts={}]
+ * @returns {Promise<any>}
+ */
+export async function executeMobile(mobileCommand, opts = {}) {
+  const mobileCommandsMapping = {
+    shell: 'mobileShell',
 
-      changePermissions: 'mobileChangePermissions',
-      getPermissions: 'mobileGetPermissions',
+    execEmuConsoleCommand: 'mobileExecEmuConsoleCommand',
 
-      performEditorAction: 'mobilePerformEditorAction',
+    startLogsBroadcast: 'mobileStartLogsBroadcast',
+    stopLogsBroadcast: 'mobileStopLogsBroadcast',
 
-      sensorSet: 'sensorSet',
+    changePermissions: 'mobileChangePermissions',
+    getPermissions: 'mobileGetPermissions',
 
-      getDeviceTime: 'mobileGetDeviceTime',
+    performEditorAction: 'mobilePerformEditorAction',
 
-      startScreenStreaming: 'mobileStartScreenStreaming',
-      stopScreenStreaming: 'mobileStopScreenStreaming',
+    sensorSet: 'sensorSet',
 
-      getNotifications: 'mobileGetNotifications',
+    getDeviceTime: 'mobileGetDeviceTime',
 
-      listSms: 'mobileListSms',
+    startScreenStreaming: 'mobileStartScreenStreaming',
+    stopScreenStreaming: 'mobileStopScreenStreaming',
 
-      pushFile: 'mobilePushFile',
-      pullFile: 'mobilePullFile',
-      pullFolder: 'mobilePullFolder',
-      deleteFile: 'mobileDeleteFile',
+    getNotifications: 'mobileGetNotifications',
 
-      isAppInstalled: 'mobileIsAppInstalled',
-      queryAppState: 'mobileQueryAppState',
-      activateApp: 'mobileActivateApp',
-      removeApp: 'mobileRemoveApp',
-      terminateApp: 'mobileTerminateApp',
-      installApp: 'mobileInstallApp',
-      clearApp: 'mobileClearApp',
+    listSms: 'mobileListSms',
 
-      startService: 'mobileStartService',
-      stopService: 'mobileStopService',
-      startActivity: 'mobileStartActivity',
-      broadcast: 'mobileBroadcast',
+    pushFile: 'mobilePushFile',
+    pullFile: 'mobilePullFile',
+    pullFolder: 'mobilePullFolder',
+    deleteFile: 'mobileDeleteFile',
 
-      getContexts: 'mobileGetContexts',
+    isAppInstalled: 'mobileIsAppInstalled',
+    queryAppState: 'mobileQueryAppState',
+    activateApp: 'mobileActivateApp',
+    removeApp: 'mobileRemoveApp',
+    terminateApp: 'mobileTerminateApp',
+    installApp: 'mobileInstallApp',
+    clearApp: 'mobileClearApp',
 
-      lock: 'mobileLock',
-      unlock: 'mobileUnlock',
+    startService: 'mobileStartService',
+    stopService: 'mobileStopService',
+    startActivity: 'mobileStartActivity',
+    broadcast: 'mobileBroadcast',
 
-      refreshGpsCache: 'mobileRefreshGpsCache',
+    getContexts: 'mobileGetContexts',
 
-      startMediaProjectionRecording: 'mobileStartMediaProjectionRecording',
-      isMediaProjectionRecordingRunning: 'mobileIsMediaProjectionRecordingRunning',
-      stopMediaProjectionRecording: 'mobileStopMediaProjectionRecording',
+    lock: 'mobileLock',
+    unlock: 'mobileUnlock',
 
-      getConnectivity: 'mobileGetConnectivity',
-      setConnectivity: 'mobileSetConnectivity',
+    refreshGpsCache: 'mobileRefreshGpsCache',
 
-      hideKeyboard: 'hideKeyboard',
-      isKeyboardShown: 'isKeyboardShown',
+    startMediaProjectionRecording: 'mobileStartMediaProjectionRecording',
+    isMediaProjectionRecordingRunning: 'mobileIsMediaProjectionRecordingRunning',
+    stopMediaProjectionRecording: 'mobileStopMediaProjectionRecording',
 
-      deviceidle: 'mobileDeviceidle',
+    getConnectivity: 'mobileGetConnectivity',
+    setConnectivity: 'mobileSetConnectivity',
 
-      setUiMode: 'mobileSetUiMode',
-      getUiMode: 'mobileGetUiMode',
-    };
+    hideKeyboard: 'hideKeyboard',
+    isKeyboardShown: 'isKeyboardShown',
 
-    if (!_.has(mobileCommandsMapping, mobileCommand)) {
-      throw new errors.UnknownCommandError(
-        `Unknown mobile command "${mobileCommand}". ` +
-          `Only ${_.keys(mobileCommandsMapping)} commands are supported.`
-      );
-    }
-    return await this[mobileCommandsMapping[mobileCommand]](opts);
-  },
-};
+    deviceidle: 'mobileDeviceidle',
 
-mixin(ExecuteMixin);
+    setUiMode: 'mobileSetUiMode',
+    getUiMode: 'mobileGetUiMode',
+  };
 
-export default ExecuteMixin;
+  if (!_.has(mobileCommandsMapping, mobileCommand)) {
+    throw new errors.UnknownCommandError(
+      `Unknown mobile command "${mobileCommand}". ` +
+        `Only ${_.keys(mobileCommandsMapping)} commands are supported.`,
+    );
+  }
+  return await this[mobileCommandsMapping[mobileCommand]](opts);
+}