io.appium.settings/lib/commands/clipboard.ts

App for dealing with Android settings

import { LOG_PREFIX } from '../logger';
import {
  CLIPBOARD_RECEIVER,
  CLIPBOARD_RETRIEVAL_ACTION,
  APPIUM_IME
} from '../constants';
import type { SettingsApp } from '../client';

/**
 * Retrieves the text content of the device's clipboard.
 * The method works for Android below and above 29.
 * It temporarily enforces the IME setting in order to workaround
 * security limitations if needed.
 * This method only works if Appium Settings v. 2.15+ is installed
 * on the device under test
 *
 * @returns The actual content of the main clipboard as base64-encoded string or an empty string if the clipboard is empty
 * @throws {Error} If there was a problem while getting the clipboard content
 */
export async function getClipboard(this: SettingsApp): Promise<string> {
  this.log.debug(LOG_PREFIX, 'Getting the clipboard content');
  await this.requireRunning({shouldRestoreCurrentApp: true});
  const retrieveClipboard = async (): Promise<string> => await this.checkBroadcast([
    '-n', CLIPBOARD_RECEIVER,
    '-a', CLIPBOARD_RETRIEVAL_ACTION,
  ], 'retrieve clipboard', false);
  let output: string;
  try {
    output = (await this.adb.getApiLevel() >= 29)
      ? (await this.adb.runInImeContext(APPIUM_IME, retrieveClipboard))
      : (await retrieveClipboard());
  } catch (err: any) {
    throw new Error(`Cannot retrieve the current clipboard content from the device. ` +
      `Make sure the Appium Settings application is up to date. ` +
      `Original error: ${err.message}`);
  }

  const match = /data="([^"]*)"/.exec(output);
  if (!match) {
    throw new Error(`Cannot parse the actual clipboard content from the command output: ${output}`);
  }
  return match[1].trim();
}