appium-xcuitest-driver/lib/commands/biometric.ts

Appium driver for iOS using XCUITest for backend

import {requireSimulator} from '../utils';
import type {XCUITestDriver} from '../driver';
import type {BiometricFeature} from './types';

/**
 * Enrolls biometric authentication on a simulated device.
 *
 * @param isEnabled - Whether to enable/disable biometric enrollment.
 * @throws If enrollment fails or the device is not a Simulator.
 * @group Simulator Only
 */
export async function mobileEnrollBiometric(
  this: XCUITestDriver,
  isEnabled: boolean = true,
): Promise<void> {
  await requireSimulator(this, 'Biometric enrollment').enrollBiometric(isEnabled);
}

/**
 * Emulates biometric match or non-match event on a simulated device.
 *
 * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
 *
 * @param type - The biometric feature name.
 * @param match - If `true`, simulate biometric match. If `false`, simulate biometric non-match.
 * @throws If matching fails or the device is not a Simulator.
 * @group Simulator Only
 */
export async function mobileSendBiometricMatch(
  this: XCUITestDriver,
  type: BiometricFeature = 'touchId',
  match: boolean = true,
): Promise<void> {
  await requireSimulator(this, 'Sending biometric match').sendBiometricMatch(match, type);
}

/**
 * Checks whether the biometric feature is currently enrolled on a simulated device.
 *
 * @returns `true` if biometric is enrolled.
 * @throws If the detection fails or the device is not a Simulator.
 * @group Simulator Only
 */
export async function mobileIsBiometricEnrolled(this: XCUITestDriver): Promise<boolean> {
  return await requireSimulator(this, 'Checking biometric enrollment').isBiometricEnrolled();
}