chore: Migrate the rest of command modules to typescript (#971)

Author: mykola-mokhnach

lib/commands/actions.js

@@ -0,0 +1,95 @@
+import type {StringRecord} from '@appium/types';
+import type {AndroidUiautomator2Driver} from '../driver';
+import type {ActionResult} from './types';
+
+/**
+ * Schedules a recurring action to be performed at specified intervals.
+ * @param name - Unique name for the scheduled action.
+ * @param steps - Array of action steps to be executed.
+ * @param maxPass - Maximum number of successful executions before stopping.
+ * @param maxFail - Maximum number of failed executions before stopping.
+ * @param times - Total number of times to execute the action.
+ * @param intervalMs - Interval in milliseconds between action executions.
+ * @param maxHistoryItems - Maximum number of history items to keep.
+ * @returns The result of scheduling the action.
+ */
+export async function mobileScheduleAction(
+  this: AndroidUiautomator2Driver,
+  name: string,
+  steps: StringRecord[],
+  maxPass?: number,
+  maxFail?: number,
+  times?: number,
+  intervalMs?: number,
+  maxHistoryItems?: number,
+): Promise<any> {
+  return await this.uiautomator2.jwproxy.command('/appium/schedule_action', 'POST', {
+    name,
+    steps,
+    maxFail,
+    maxPass,
+    times,
+    intervalMs,
+    maxHistoryItems,
+  });
+}
+
+/**
+ * Gets the execution history for a scheduled action.
+ * @param name - Name of the scheduled action.
+ * @returns The action execution history containing repeats and step results.
+ */
+export async function mobileGetActionHistory(
+  this: AndroidUiautomator2Driver,
+  name: string,
+): Promise<ActionResult> {
+  return (await this.uiautomator2.jwproxy.command('/appium/action_history', 'POST', {name})) as ActionResult;
+}
+
+/**
+ * Unschedules a previously scheduled action.
+ * @param name - Name of the scheduled action to unschedule.
+ * @returns The result of unscheduling the action.
+ */
+export async function mobileUnscheduleAction(
+  this: AndroidUiautomator2Driver,
+  name: string,
+): Promise<any> {
+  return await this.uiautomator2.jwproxy.command('/appium/unschedule_action', 'POST', {name});
+}
+
+/**
+ * Performs a sequence of actions.
+ * @param actions - Array of action objects to perform. Pointer actions are automatically converted to touch type.
+ */
+export async function performActions(
+  this: AndroidUiautomator2Driver,
+  actions: StringRecord[],
+): Promise<void> {
+  // 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,
+  });
+}
+
+/**
+ * Releases all currently pressed keys and buttons.
+ */
+export async function releaseActions(this: AndroidUiautomator2Driver): Promise<void> {
+  this.log.info('On this platform, releaseActions is a no-op');
+}
+

lib/commands/actions.ts

@@ -0,0 +1,46 @@
+import type {AndroidUiautomator2Driver} from '../driver';
+
+/**
+ * Gets the text of the currently displayed alert.
+ * @returns The alert text as a string.
+ */
+export async function getAlertText(this: AndroidUiautomator2Driver): Promise<string> {
+  return String(await this.uiautomator2.jwproxy.command('/alert/text', 'GET', {}));
+}
+
+/**
+ * Accepts the currently displayed alert.
+ * @param buttonLabel - Optional label of the button to click. If not provided, the button will be detected automatically.
+ */
+export async function mobileAcceptAlert(
+  this: AndroidUiautomator2Driver,
+  buttonLabel?: string,
+): Promise<void> {
+  await this.uiautomator2.jwproxy.command('/alert/accept', 'POST', {buttonLabel});
+}
+
+/**
+ * Accepts the currently displayed alert (W3C endpoint).
+ */
+export async function postAcceptAlert(this: AndroidUiautomator2Driver): Promise<void> {
+  await this.mobileAcceptAlert();
+}
+
+/**
+ * Dismisses the currently displayed alert.
+ * @param buttonLabel - Optional label of the button to click. If not provided, the button will be detected automatically.
+ */
+export async function mobileDismissAlert(
+  this: AndroidUiautomator2Driver,
+  buttonLabel?: string,
+): Promise<void> {
+  await this.uiautomator2.jwproxy.command('/alert/dismiss', 'POST', {buttonLabel});
+}
+
+/**
+ * Dismisses the currently displayed alert (W3C endpoint).
+ */
+export async function postDismissAlert(this: AndroidUiautomator2Driver): Promise<void> {
+  await this.mobileDismissAlert();
+}
+

lib/commands/alert.js

@@ -0,0 +1,25 @@
+import _ from 'lodash';
+import B from 'bluebird';
+import {errors} from 'appium/driver';
+import {APK_EXTENSION} from '../extensions';
+import type {AndroidUiautomator2Driver} from '../driver';
+import type {InstallOptions} from './types';
+
+/**
+ * Installs multiple APKs with `install-multiple` option.
+ * @param apks - Array of APK file paths or URLs to install.
+ * @param options - Optional installation options (allowTestPackages, useSdcard, grantPermissions, etc.).
+ * @throws {errors.InvalidArgumentError} If the apks array is empty or invalid.
+ */
+export async function mobileInstallMultipleApks(
+  this: AndroidUiautomator2Driver,
+  apks: string[],
+  options?: InstallOptions,
+): Promise<void> {
+  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);
+}
+