appium-uiautomator2-driver 6.7.5 → 6.7.7

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "6.7.5",
+  "version": "6.7.7",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },

package/lib/commands/actions.js

@@ -1,107 +0,0 @@
-/**
- * @see https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/scheduled-actions.md#mobile-scheduleaction
- * @this {AndroidUiautomator2Driver}
- * @param {string} name
- * @param {import('@appium/types').StringRecord[]} steps
- * @param {number} [maxPass]
- * @param {number} [maxFail]
- * @param {number} [times]
- * @param {number} [intervalMs]
- * @param {number} [maxHistoryItems]
- * @returns {Promise<any>}
- */
-export async function mobileScheduleAction(
-  name,
-  steps,
-  maxPass,
-  maxFail,
-  times,
-  intervalMs,
-  maxHistoryItems,
-) {
-  return await this.uiautomator2.jwproxy.command(
-    '/appium/schedule_action',
-    'POST',
-    {
-      name,
-      steps,
-      maxFail,
-      maxPass,
-      times,
-      intervalMs,
-      maxHistoryItems,
-    }
-  );
-}
-
-/**
- * @see https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/scheduled-actions.md#mobile-getactionhistory
- * @this {AndroidUiautomator2Driver}
- * @param {string} name
- * @returns {Promise<import('./types').ActionResult>}
- */
-export async function mobileGetActionHistory(name) {
-  return /** @type {import('./types').ActionResult} */ (
-    await this.uiautomator2.jwproxy.command(
-      '/appium/action_history',
-      'POST',
-      {name}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @see https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/scheduled-actions.md#mobile-unscheduleaction
- * @param {string} name
- * @returns {Promise<any>}
- */
-export async function mobileUnscheduleAction(name) {
-  return await this.uiautomator2.jwproxy.command(
-    '/appium/unschedule_action',
-    'POST',
-    {name}
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {import('@appium/types').StringRecord[]} actions
- * @returns {Promise<void>}
- */
-export async function performActions(actions) {
-  // This is mandatory, since Selenium API uses MOUSE as the default pointer type
-  const preprocessedActions = actions.map((action) =>
-    Object.assign(
-      {},
-      action,
-      action.type === 'pointer'
-        ? {
-            parameters: {
-              pointerType: 'touch',
-            },
-          }
-        : {}
-    )
-  );
-  this.log.debug(`Preprocessed actions: ${JSON.stringify(preprocessedActions, null, '  ')}`);
-  await this.uiautomator2.jwproxy.command(
-    '/actions',
-    'POST',
-    {
-      actions: preprocessedActions,
-    }
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<void>}
- */
-export async function releaseActions() {
-  this.log.info('On this platform, releaseActions is a no-op');
-}
-
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */

package/lib/commands/alert.js

@@ -1,63 +0,0 @@
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>}
- */
-export async function getAlertText() {
-  return String(
-    await this.uiautomator2.jwproxy.command(
-      '/alert/text',
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} [buttonLabel] The name of the button to click in order to accept the alert.
- * If the name is not provided
- * then the script will try to detect the button automatically.
- * @returns {Promise<void>}
- */
-export async function mobileAcceptAlert(buttonLabel) {
-  await this.uiautomator2.jwproxy.command(
-    '/alert/accept',
-    'POST',
-    {buttonLabel}
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<void>}
- */
-export async function postAcceptAlert() {
-  await this.mobileAcceptAlert();
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} [buttonLabel] The name of the button to click in order to dismiss the alert.
- * If the name is not provided
- * then the script will try to detect the button automatically.
- * @returns {Promise<void>}
- */
-export async function mobileDismissAlert(buttonLabel) {
-  await this.uiautomator2.jwproxy.command(
-    '/alert/dismiss',
-    'POST',
-    {buttonLabel}
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<void>}
- */
-export async function postDismissAlert() {
-  await this.mobileDismissAlert();
-}
-
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */

package/lib/commands/app-management.js

@@ -1,32 +0,0 @@
-import _ from 'lodash';
-import B from 'bluebird';
-import {errors} from 'appium/driver';
-import {APK_EXTENSION} from '../extensions';
-
-/**
- * Install multiple APKs with `install-multiple` option.
- * @this {AndroidUiautomator2Driver}
- * @param {string[]} apks The list of APKs to install. Each APK should be a path to a apk
- * or downloadable URL as HTTP/HTTPS.
- * @param {import('./types').InstallOptions} [options] Installation options.
- * @throws {Error} if an error occured while installing the given APKs.
- * @returns {Promise<void>}
- */
-export async function mobileInstallMultipleApks(apks, options) {
-  if (!_.isArray(apks) || _.isEmpty(apks)) {
-    throw new errors.InvalidArgumentError('No apks are given to install');
-  }
-  const configuredApks = await B.all(
-    apks.map((app) => this.helpers.configureApp(app, [APK_EXTENSION]))
-  );
-  await this.adb.installMultipleApks(configuredApks, options);
-}
-
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */
-
-/**
- * @template [T=any]
- * @typedef {import('@appium/types').StringRecord<T>} StringRecord
- */

package/lib/commands/battery.js

@@ -1,23 +0,0 @@
-
-/**
- * Reads the battery information from the device under test.
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<import('./types').BatteryInfo>} The actual battery info
- */
-export async function mobileGetBatteryInfo() {
-  const result = /** @type {import('./types').MapKey<BatteryInfo, 'state', 'status'>} */ (
-    await /** @type {import('../uiautomator2').UiAutomator2Server} */ (
-      this.uiautomator2
-    ).jwproxy.command('/appium/device/battery_info', 'GET', {})
-  );
-  const batteryInfo = /** @type {any} */ (result);
-  // Give it the same name as in iOS
-  batteryInfo.state = result.status;
-  delete batteryInfo.status;
-  return /** @type {BatteryInfo} */ (batteryInfo);
-}
-
-/**
- * @typedef {import('./types').BatteryInfo} BatteryInfo
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */

package/lib/commands/clipboard.js

@@ -1,37 +0,0 @@
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>} Base64-encoded content of the clipboard
- * or an empty string if the clipboard is empty.
- */
-export async function getClipboard() {
-  return String(
-    (await this.adb.getApiLevel()) < 29
-      ? await this.uiautomator2.jwproxy.command(
-          '/appium/device/get_clipboard',
-          'POST',
-          {}
-        )
-      : await this.settingsApp.getClipboard()
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} content Base64-encoded clipboard payload
- * @param {'plaintext'} [contentType='plaintext'] Only a single
- * content type is supported, which is 'plaintext'
- * @param {string} [label] Optinal label to identify the current
- * clipboard payload
- * @returns {Promise<void>}
- */
-export async function setClipboard(content, contentType, label) {
-  await this.uiautomator2.jwproxy.command(
-    '/appium/device/set_clipboard',
-    'POST',
-    {content, contentType, label}
-  );
-}
-
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */

package/lib/commands/element.js

@@ -1,261 +0,0 @@
-import B from 'bluebird';
-import _ from 'lodash';
-import {PROTOCOLS} from 'appium/driver';
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<import('@appium/types').Element>}
- */
-export async function active() {
-  return /** @type {import('@appium/types').Element} */ (
-    await this.uiautomator2.jwproxy.command(
-      '/element/active',
-      'GET'
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} attribute
- * @param {string} elementId
- * @returns {Promise<string?>}
- */
-export async function getAttribute(attribute, elementId) {
-  return String(
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/attribute/${attribute}`,
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
- */
-export async function elementDisplayed(elementId) {
-  return toBool(await this.getAttribute('displayed', elementId));
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
- */
-export async function elementEnabled(elementId) {
-  return toBool(await this.getAttribute('enabled', elementId));
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
- */
-export async function elementSelected(elementId) {
-  return toBool(await this.getAttribute('selected', elementId));
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<string>}
- */
-export async function getName(elementId) {
-  return /** @type {string} */ (
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/name`,
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Position>}
- */
-export async function getLocation(elementId) {
-  return /** @type {import('@appium/types').Position} */ (
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/location`,
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Size>}
- */
-export async function getSize(elementId) {
-  return /** @type {import('@appium/types').Size} */ (
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/size`,
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {import('appium-android-driver').DoSetElementValueOpts} params
- * @returns {Promise<void>}
- */
-export async function doSetElementValue(params) {
-  await this.uiautomator2.jwproxy.command(
-    `/element/${params.elementId}/value`,
-    'POST',
-    params
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
- */
-export async function setValueImmediate(keys, elementId) {
-  await this.uiautomator2.jwproxy.command(
-    `/element/${elementId}/value`,
-    'POST',
-    {
-      elementId,
-      text: _.isArray(keys) ? keys.join('') : keys,
-      replace: false,
-    }
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<string>}
- */
-export async function getText(elementId) {
-  return String(
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/text`,
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} element
- * @returns {Promise<void>}
- */
-export async function click(element) {
-  await this.uiautomator2.jwproxy.command(
-    `/element/${element}/click`,
-    'POST',
-    {element}
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} element
- * @returns {Promise<string>}
- */
-export async function getElementScreenshot(element) {
-  return String(
-    await this.uiautomator2.jwproxy.command(
-      `/element/${element}/screenshot`,
-      'GET',
-      {}
-    )
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<void>}
- */
-export async function clear(elementId) {
-  await this.uiautomator2.jwproxy.command(
-    `/element/${elementId}/clear`,
-    'POST',
-    {
-      elementId,
-    }
-  );
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Rect>}
- */
-export async function getElementRect(elementId) {
-  const chromedriver = /** @type {import('appium-chromedriver').default} */ (this.chromedriver);
-  if (this.isWebContext()) {
-    this.log.debug(
-      `Detected downstream chromedriver protocol: ${chromedriver.jwproxy.downstreamProtocol}`
-    );
-    if (chromedriver.jwproxy.downstreamProtocol === PROTOCOLS.MJSONWP) {
-      const [{x, y}, {width, height}] =
-        /** @type {[import('@appium/types').Position, import('@appium/types').Size]} */ (
-          await B.all([
-            chromedriver.jwproxy.command(`/element/${elementId}/location`, 'GET'),
-            chromedriver.jwproxy.command(`/element/${elementId}/size`, 'GET'),
-          ])
-        );
-      return {x, y, width, height};
-    }
-    return /** @type {import('@appium/types').Rect} */ (
-      await chromedriver.jwproxy.command(`/element/${elementId}/rect`, 'GET')
-    );
-  }
-  return /** @type {import('@appium/types').Rect} */ (
-    await this.uiautomator2.jwproxy.command(
-      `/element/${elementId}/rect`,
-      'GET'
-    )
-  );
-}
-
-/**
- * Sends text to the given element by replacing its previous content
- * @this {AndroidUiautomator2Driver}
- * @param {string} elementId The id of the element whose content will be replaced.
- * @param {string} text The actual text to set.
- * @throws {Error} If there was a faulre while setting the text
- * @returns {Promise<void>}
- */
-export async function mobileReplaceElementValue(elementId, text) {
-  await this.uiautomator2.jwproxy.command(
-    `/element/${elementId}/value`,
-    'POST',
-    {
-      text,
-      replace: true,
-    }
-  );
-}
-
-// #region Internal Helpers
-
-/**
- * @param {any} s
- * @returns {boolean}
- */
-function toBool(s) {
-  return _.isString(s) ? s.toLowerCase() === 'true' : !!s;
-}
-
-// #endregion
-
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */

package/lib/commands/find.js

@@ -1,47 +0,0 @@
-import {CssConverter} from '../css-converter';
-
-// we override the xpath search for this first-visible-child selector, which
-// looks like /*[@firstVisible="true"]
-const MAGIC_FIRST_VIS_CHILD_SEL = /\/\*\[@firstVisible ?= ?('|")true\1\]/;
-
-const MAGIC_SCROLLABLE_SEL = /\/\/\*\[@scrollable ?= ?('|")true\1\]/;
-const MAGIC_SCROLLABLE_BY = 'new UiSelector().scrollable(true)';
-
-/**
- * @privateRemarks Overriding helpers.doFindElementOrEls functionality of appium-android-driver,
- * this.element initialized in find.js of appium-android-drive.
- *
- * @this {AndroidUiautomator2Driver}
- * @param {import('appium-android-driver').FindElementOpts} params
- * @returns {Promise<Element | Element[]>}
- */
-export async function doFindElementOrEls(params) {
-  const uiautomator2 = /** @type {import('../uiautomator2').UiAutomator2Server} */ (
-    this.uiautomator2
-  );
-  if (params.strategy === 'xpath' && MAGIC_FIRST_VIS_CHILD_SEL.test(params.selector)) {
-    let elementId = params.context;
-    return /** @type {Element} */ (
-      await uiautomator2.jwproxy.command(`/appium/element/${elementId}/first_visible`, 'GET', {})
-    );
-  }
-  if (params.strategy === 'xpath' && MAGIC_SCROLLABLE_SEL.test(params.selector)) {
-    params.strategy = '-android uiautomator';
-    params.selector = MAGIC_SCROLLABLE_BY;
-  }
-  if (params.strategy === 'css selector') {
-    params.strategy = '-android uiautomator';
-    params.selector = new CssConverter(
-      params.selector,
-      this.opts.appPackage
-    ).toUiAutomatorSelector();
-  }
-  return /** @type {Element|Element[]} */ (
-    await uiautomator2.jwproxy.command(`/element${params.multiple ? 's' : ''}`, 'POST', params)
-  );
-}
-
-/**
- * @typedef {import('@appium/types').Element} Element
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */