appium-ios-simulator 8.0.13 → 8.1.0

package/lib/extensions/settings.ts

@@ -1,10 +1,9 @@
-import _ from 'lodash';
 import {NSUserDefaults, generateDefaultsCommandArgs} from '../defaults-utils';
-import B from 'bluebird';
 import path from 'node:path';
 import {exec} from 'teen_process';
 import AsyncLock from 'async-lock';
 import {fs} from '@appium/support';
+import {isPlainObject} from '../utils';
 import type {
   CoreSimulator,
   HasSettings,
@@ -90,12 +89,12 @@ export async function updateSettings(
   domain: string,
   updates: StringRecord,
 ): Promise<boolean> {
-  if (_.isEmpty(updates)) {
+  if (Object.keys(updates).length === 0) {
     return false;
   }
 
   const argChunks = generateDefaultsCommandArgs(updates);
-  await B.all(
+  await Promise.all(
     argChunks.map((args) => this.simctl.spawnProcess(['defaults', 'write', domain, ...args])),
   );
   return true;
@@ -111,7 +110,7 @@ export async function updateSettings(
  * @since Xcode SDK 11.4
  */
 export async function setAppearance(this: CoreSimulatorWithSettings, value: string): Promise<void> {
-  await this.simctl.setAppearance(_.toLower(value));
+  await this.simctl.setAppearance(value.toLowerCase());
 }
 
 /**
@@ -203,14 +202,14 @@ export async function configureLocalization(
   this: CoreSimulatorWithSettings,
   opts: LocalizationOptions = {},
 ): Promise<boolean> {
-  if (_.isEmpty(opts)) {
+  if (Object.keys(opts).length === 0) {
     return false;
   }
 
   const {language, locale, keyboard} = opts;
   const globalPrefs: Record<string, any> = {};
   let keyboardId: string | null = null;
-  if (_.isPlainObject(keyboard) && keyboard) {
+  if (isPlainObject(keyboard)) {
     const {name, layout, hardware} = keyboard;
     if (!name) {
       throw new Error(`The 'keyboard' field must have a valid name set`);
@@ -224,14 +223,14 @@ export async function configureLocalization(
     }
     globalPrefs.AppleKeyboards = [keyboardId];
   }
-  if (_.isPlainObject(language) && language) {
+  if (isPlainObject(language)) {
     const {name} = language;
     if (!name) {
       throw new Error(`The 'language' field must have a valid name set`);
     }
     globalPrefs.AppleLanguages = [name];
   }
-  if (_.isPlainObject(locale) && locale) {
+  if (isPlainObject(locale)) {
     const {name, calendar} = locale;
     if (!name) {
       throw new Error(`The 'locale' field must have a valid name set`);
@@ -242,7 +241,7 @@ export async function configureLocalization(
     }
     globalPrefs.AppleLocale = localeId;
   }
-  if (_.isEmpty(globalPrefs)) {
+  if (Object.keys(globalPrefs).length === 0) {
     return false;
   }
 
@@ -265,7 +264,7 @@ export async function configureLocalization(
   }
 
   const argChunks = generateDefaultsCommandArgs(globalPrefs, true);
-  await B.all(
+  await Promise.all(
     argChunks.map((args) =>
       this.simctl.spawnProcess(['defaults', 'write', GLOBAL_PREFS_PLIST, ...args]),
     ),
@@ -280,7 +279,7 @@ export async function configureLocalization(
       },
       true,
     );
-    await B.all(
+    await Promise.all(
       argChunks.map((args) =>
         this.simctl.spawnProcess(['defaults', 'write', 'com.apple.Preferences', ...args]),
       ),
@@ -288,7 +287,7 @@ export async function configureLocalization(
   }
 
   if (globalPrefs.AppleLanguages) {
-    if (_.isEqual(previousAppleLanguages, globalPrefs.AppleLanguages)) {
+    if (JSON.stringify(previousAppleLanguages) === JSON.stringify(globalPrefs.AppleLanguages)) {
       this.log.info(
         `The 'AppleLanguages' preference is already set to '${globalPrefs.AppleLanguages}'. ` +
           `Skipping services reset`,
@@ -303,7 +302,7 @@ export async function configureLocalization(
           `${SERVICES_FOR_TRANSLATION}. This might have unexpected side effects, ` +
           `see https://github.com/appium/appium/issues/19440 for more details`,
       );
-      await B.all(
+      await Promise.all(
         SERVICES_FOR_TRANSLATION.map((arg) => this.simctl.spawnProcess(['launchctl', 'stop', arg])),
       );
     }
@@ -343,12 +342,12 @@ export async function updatePreferences(
   devicePrefs: DevicePreferences = {},
   commonPrefs: CommonPreferences = {},
 ): Promise<boolean> {
-  if (!_.isEmpty(devicePrefs)) {
+  if (Object.keys(devicePrefs).length > 0) {
     this.log.debug(
       `Setting preferences of ${this.udid} Simulator to ${JSON.stringify(devicePrefs)}`,
     );
   }
-  if (!_.isEmpty(commonPrefs)) {
+  if (Object.keys(commonPrefs).length > 0) {
     this.log.debug(`Setting common Simulator preferences to ${JSON.stringify(commonPrefs)}`);
   }
   const homeFolderPath = process.env.HOME;
@@ -368,16 +367,16 @@ export async function updatePreferences(
   );
   return await PREFERENCES_PLIST_GUARD.acquire(this.constructor.name, async () => {
     const defaults = new NSUserDefaults(plistPath);
-    const prefsToUpdate = _.clone(commonPrefs);
+    const prefsToUpdate = {...commonPrefs};
     try {
-      if (!_.isEmpty(devicePrefs)) {
+      if (Object.keys(devicePrefs).length > 0) {
         let existingDevicePrefs: any;
         const udidKey = this.udid.toUpperCase();
         if (await fs.exists(plistPath)) {
           const currentPlistContent = await defaults.asJson();
           if (
-            _.isPlainObject(currentPlistContent.DevicePreferences) &&
-            _.isPlainObject(currentPlistContent.DevicePreferences[udidKey])
+            isPlainObject(currentPlistContent.DevicePreferences) &&
+            isPlainObject(currentPlistContent.DevicePreferences[udidKey])
           ) {
             existingDevicePrefs = currentPlistContent.DevicePreferences[udidKey];
           }
@@ -427,22 +426,26 @@ export function compileSimulatorPreferences(
     AttachBootedOnStart: true,
   };
   const devicePreferences: DevicePreferences = opts.devicePreferences
-    ? _.cloneDeep(opts.devicePreferences)
+    ? structuredClone(opts.devicePreferences)
     : {};
   if (scaleFactor) {
     devicePreferences.SimulatorWindowLastScale = parseFloat(scaleFactor);
   }
-  if (_.isBoolean(connectHardwareKeyboard) || _.isNil(connectHardwareKeyboard)) {
+  if (
+    typeof connectHardwareKeyboard === 'boolean' ||
+    connectHardwareKeyboard === null ||
+    connectHardwareKeyboard === undefined
+  ) {
     devicePreferences.ConnectHardwareKeyboard = connectHardwareKeyboard ?? false;
     commonPreferences.ConnectHardwareKeyboard = connectHardwareKeyboard ?? false;
   }
-  if (_.isBoolean(tracePointer)) {
+  if (typeof tracePointer === 'boolean') {
     commonPreferences.ShowSingleTouches = tracePointer;
     commonPreferences.ShowPinches = tracePointer;
     commonPreferences.ShowPinchPivotPoint = tracePointer;
     commonPreferences.HighlightEdgeGestures = tracePointer;
   }
-  switch (_.lowerCase(pasteboardAutomaticSync || '')) {
+  switch ((pasteboardAutomaticSync || '').toLowerCase()) {
     case 'on':
       commonPreferences.PasteboardAutomaticSync = true;
       break;
@@ -475,52 +478,58 @@ export function verifyDevicePreferences(
   this: CoreSimulatorWithSettings,
   prefs: DevicePreferences = {},
 ): void {
-  if (_.isEmpty(prefs)) {
+  if (Object.keys(prefs).length === 0) {
     return;
   }
 
-  if (!_.isUndefined(prefs.SimulatorWindowLastScale)) {
-    if (!_.isNumber(prefs.SimulatorWindowLastScale) || prefs.SimulatorWindowLastScale <= 0) {
-      throw this.log.errorWithException(
-        `SimulatorWindowLastScale is expected to be a positive float value. ` +
-          `'${prefs.SimulatorWindowLastScale}' is assigned instead.`,
-      );
-    }
+  // https://regex101.com/r/2ZXOij/2
+  const simulatorWindowCenterPattern = /{-?\d+(\.\d+)?,-?\d+(\.\d+)?}/;
+  const acceptableSimulatorWindowOrientations = [
+    'Portrait',
+    'LandscapeLeft',
+    'PortraitUpsideDown',
+    'LandscapeRight',
+  ];
+
+  if (
+    prefs.SimulatorWindowLastScale !== undefined &&
+    (typeof prefs.SimulatorWindowLastScale !== 'number' || prefs.SimulatorWindowLastScale <= 0)
+  ) {
+    throw this.log.errorWithException(
+      `SimulatorWindowLastScale is expected to be a positive float value. ` +
+        `'${prefs.SimulatorWindowLastScale}' is assigned instead.`,
+    );
   }
 
-  if (!_.isUndefined(prefs.SimulatorWindowCenter)) {
-    // https://regex101.com/r/2ZXOij/2
-    const verificationPattern = /{-?\d+(\.\d+)?,-?\d+(\.\d+)?}/;
-    if (
-      !_.isString(prefs.SimulatorWindowCenter) ||
-      !verificationPattern.test(prefs.SimulatorWindowCenter)
-    ) {
-      throw this.log.errorWithException(
-        `SimulatorWindowCenter is expected to match "{floatXPosition,floatYPosition}" format (without spaces). ` +
-          `'${prefs.SimulatorWindowCenter}' is assigned instead.`,
-      );
-    }
+  if (
+    prefs.SimulatorWindowCenter !== undefined &&
+    (typeof prefs.SimulatorWindowCenter !== 'string' ||
+      !simulatorWindowCenterPattern.test(prefs.SimulatorWindowCenter))
+  ) {
+    throw this.log.errorWithException(
+      `SimulatorWindowCenter is expected to match "{floatXPosition,floatYPosition}" format (without spaces). ` +
+        `'${prefs.SimulatorWindowCenter}' is assigned instead.`,
+    );
   }
 
-  if (!_.isUndefined(prefs.SimulatorWindowOrientation)) {
-    const acceptableValues = ['Portrait', 'LandscapeLeft', 'PortraitUpsideDown', 'LandscapeRight'];
-    if (
-      !prefs.SimulatorWindowOrientation ||
-      !acceptableValues.includes(prefs.SimulatorWindowOrientation)
-    ) {
-      throw this.log.errorWithException(
-        `SimulatorWindowOrientation is expected to be one of ${acceptableValues}. ` +
-          `'${prefs.SimulatorWindowOrientation}' is assigned instead.`,
-      );
-    }
+  if (
+    prefs.SimulatorWindowOrientation !== undefined &&
+    (!prefs.SimulatorWindowOrientation ||
+      !acceptableSimulatorWindowOrientations.includes(prefs.SimulatorWindowOrientation))
+  ) {
+    throw this.log.errorWithException(
+      `SimulatorWindowOrientation is expected to be one of ${acceptableSimulatorWindowOrientations}. ` +
+        `'${prefs.SimulatorWindowOrientation}' is assigned instead.`,
+    );
   }
 
-  if (!_.isUndefined(prefs.SimulatorWindowRotationAngle)) {
-    if (!_.isNumber(prefs.SimulatorWindowRotationAngle)) {
-      throw this.log.errorWithException(
-        `SimulatorWindowRotationAngle is expected to be a valid number. ` +
-          `'${prefs.SimulatorWindowRotationAngle}' is assigned instead.`,
-      );
-    }
+  if (
+    prefs.SimulatorWindowRotationAngle !== undefined &&
+    typeof prefs.SimulatorWindowRotationAngle !== 'number'
+  ) {
+    throw this.log.errorWithException(
+      `SimulatorWindowRotationAngle is expected to be a valid number. ` +
+        `'${prefs.SimulatorWindowRotationAngle}' is assigned instead.`,
+    );
   }
 }

package/lib/simulator-xcode-14.ts

@@ -5,9 +5,7 @@ import {exec} from 'teen_process';
 import {log as defaultLog} from './logger';
 import EventEmitter from 'node:events';
 import AsyncLock from 'async-lock';
-import _ from 'lodash';
 import path from 'node:path';
-import B from 'bluebird';
 import {getPath as getXcodePath} from 'appium-xcode';
 import {Simctl} from 'node-simctl';
 import * as appExtensions from './extensions/applications';
@@ -57,6 +55,57 @@ export class SimulatorXcode14
   _keychainsBackupPath: string | null | undefined;
   _platformVersion: string | null | undefined;
   _webInspectorSocket: string | null | undefined;
+
+  // Extension methods
+  installApp = appExtensions.installApp;
+  getUserInstalledBundleIdsByBundleName = appExtensions.getUserInstalledBundleIdsByBundleName;
+  isAppInstalled = appExtensions.isAppInstalled;
+  removeApp = appExtensions.removeApp;
+  launchApp = appExtensions.launchApp;
+  terminateApp = appExtensions.terminateApp;
+  isAppRunning = appExtensions.isAppRunning;
+  scrubApp = appExtensions.scrubApp;
+
+  openUrl = safariExtensions.openUrl;
+  scrubSafari = safariExtensions.scrubSafari;
+  updateSafariSettings = safariExtensions.updateSafariSettings;
+  getWebInspectorSocket = safariExtensions.getWebInspectorSocket as unknown as () => Promise<
+    string | null
+  >;
+
+  isBiometricEnrolled = biometricExtensions.isBiometricEnrolled;
+  enrollBiometric = biometricExtensions.enrollBiometric;
+  sendBiometricMatch = biometricExtensions.sendBiometricMatch;
+
+  backupKeychains = keychainExtensions.backupKeychains as unknown as () => Promise<boolean>;
+  restoreKeychains = keychainExtensions.restoreKeychains as unknown as (
+    excludePatterns: string[],
+  ) => Promise<boolean>;
+  clearKeychains = keychainExtensions.clearKeychains;
+
+  setGeolocation = geolocationExtensions.setGeolocation;
+
+  shake = miscExtensions.shake;
+  addCertificate = miscExtensions.addCertificate;
+  pushNotification = miscExtensions.pushNotification;
+
+  setPermission = permissionsExtensions.setPermission;
+  setPermissions = permissionsExtensions.setPermissions;
+  getPermission = permissionsExtensions.getPermission;
+
+  updateSettings = settingsExtensions.updateSettings;
+  setAppearance = settingsExtensions.setAppearance;
+  getAppearance = settingsExtensions.getAppearance;
+  setIncreaseContrast = settingsExtensions.setIncreaseContrast;
+  getIncreaseContrast = settingsExtensions.getIncreaseContrast;
+  setContentSize = settingsExtensions.setContentSize;
+  getContentSize = settingsExtensions.getContentSize;
+  configureLocalization = settingsExtensions.configureLocalization;
+  setAutoFillPasswords = settingsExtensions.setAutoFillPasswords;
+  setReduceMotion = settingsExtensions.setReduceMotion;
+  setReduceTransparency = settingsExtensions.setReduceTransparency;
+  disableKeyboardIntroduction = settingsExtensions.disableKeyboardIntroduction;
+
   private readonly _udid: string;
   private readonly _simctl: Simctl;
   private readonly _xcodeVersion: XcodeVersion;
@@ -193,7 +242,7 @@ export class SimulatorXcode14
    */
   async stat(): Promise<DeviceStat | StringRecord<never>> {
     const devices = await this.simctl.getDevices();
-    for (const [sdk, deviceArr] of _.toPairs(devices)) {
+    for (const [sdk, deviceArr] of Object.entries(devices)) {
       for (const device of deviceArr as any[]) {
         if (device.udid === this.udid) {
           device.sdk = sdk;
@@ -246,7 +295,7 @@ export class SimulatorXcode14
       await this.simctl.getEnv('dummy');
       return false;
     } catch (e: any) {
-      return _.includes(e.stderr, 'Current state: Shutdown');
+      return String(e.stderr).includes('Current state: Shutdown');
     }
   }
 
@@ -276,7 +325,7 @@ export class SimulatorXcode14
    * @returns True if UI client is running or false otherwise.
    */
   async isUIClientRunning(): Promise<boolean> {
-    return !_.isNull(await this.getUIClientPid());
+    return (await this.getUIClientPid()) !== null;
   }
 
   /**
@@ -307,14 +356,14 @@ export class SimulatorXcode14
       shouldPreboot: true,
     });
     try {
-      await new B<void>((resolve, reject) => {
+      await new Promise<void>((resolve, reject) => {
         // Historically this call was always asynchronous,
         // e.g. it was not waiting until Simulator is fully booted.
         // So we preserve that behavior, and if no errors are received for a while
         // then we assume the Simulator booting is still in progress.
         setTimeout(resolve, 3000);
         bootEventsEmitter.once('failure', (err: Error) => {
-          if (_.includes(err?.message, 'state: Booted')) {
+          if (String(err?.message).includes('state: Booted')) {
             resolve();
           } else {
             reject(err);
@@ -402,16 +451,16 @@ export class SimulatorXcode14
    * @param opts - Simulator startup options.
    */
   async startUIClient(opts: StartUiClientOptions = {}): Promise<void> {
-    opts = _.cloneDeep(opts);
-    _.defaultsDeep(opts, {
+    const startUiOpts = {
       startupTimeout: this.startupTimeout,
-    });
+      ...opts,
+    };
 
     const simulatorApp = path.resolve(await getXcodePath(), 'Applications', SIMULATOR_APP_NAME);
     const args = ['-Fn', simulatorApp];
     this.log.info(`Starting Simulator UI: ${util.quote(['open', ...args])}`);
     try {
-      await exec('open', args, {timeout: opts.startupTimeout});
+      await exec('open', args, {timeout: startUiOpts.startupTimeout});
     } catch (err: any) {
       throw new Error(
         `Got an unexpected error while opening Simulator UI: ` + err.stderr ||
@@ -428,21 +477,21 @@ export class SimulatorXcode14
    * @param opts - One or more of available Simulator options.
    */
   async run(opts: RunOptions = {}): Promise<void> {
-    opts = _.cloneDeep(opts);
-    _.defaultsDeep(opts, {
+    const runOpts: RunOptions = {
       isHeadless: false,
       startupTimeout: this.startupTimeout,
-    });
+      ...structuredClone(opts),
+    };
 
     const [devicePreferences, commonPreferences] =
-      settingsExtensions.compileSimulatorPreferences.bind(this)(opts);
+      settingsExtensions.compileSimulatorPreferences.bind(this)(runOpts);
     await settingsExtensions.updatePreferences.bind(this)(devicePreferences, commonPreferences);
 
     const timer = new timing.Timer().start();
     const shouldWaitForBoot = await STARTUP_LOCK.acquire(this.uiClientBundleId, async () => {
       const isServerRunning = await this.isRunning();
       const uiClientPid = await this.getUIClientPid();
-      if (opts.isHeadless) {
+      if (runOpts.isHeadless) {
         if (isServerRunning && !uiClientPid) {
           this.log.info(`Simulator with UDID '${this.udid}' is already booted in headless mode.`);
           return false;
@@ -485,19 +534,19 @@ export class SimulatorXcode14
           );
           await this.shutdown({timeout: SIMULATOR_SHUTDOWN_TIMEOUT});
         }
-        await this.launchWindow(Boolean(uiClientPid), opts);
+        await this.launchWindow(Boolean(uiClientPid), runOpts);
       }
       return true;
     });
 
-    if (shouldWaitForBoot && opts.startupTimeout) {
-      await this.waitForBoot(opts.startupTimeout);
+    if (shouldWaitForBoot && runOpts.startupTimeout) {
+      await this.waitForBoot(runOpts.startupTimeout);
       this.log.info(
         `Simulator with UDID ${this.udid} booted in ${timer.getDuration().asSeconds.toFixed(3)}s`,
       );
     }
 
-    (async () => {
+    void (async () => {
       try {
         await this.disableKeyboardIntroduction();
       } catch (e: any) {
@@ -573,7 +622,7 @@ export class SimulatorXcode14
 
     const result: ProcessInfo[] = [];
     for (const line of stdout.split('\n')) {
-      const trimmedLine = _.trim(line);
+      const trimmedLine = line.trim();
       if (!trimmedLine) {
         continue;
       }
@@ -616,54 +665,4 @@ export class SimulatorXcode14
       'LaunchDaemons',
     );
   }
-
-  // Extension methods
-  installApp = appExtensions.installApp;
-  getUserInstalledBundleIdsByBundleName = appExtensions.getUserInstalledBundleIdsByBundleName;
-  isAppInstalled = appExtensions.isAppInstalled;
-  removeApp = appExtensions.removeApp;
-  launchApp = appExtensions.launchApp;
-  terminateApp = appExtensions.terminateApp;
-  isAppRunning = appExtensions.isAppRunning;
-  scrubApp = appExtensions.scrubApp;
-
-  openUrl = safariExtensions.openUrl;
-  scrubSafari = safariExtensions.scrubSafari;
-  updateSafariSettings = safariExtensions.updateSafariSettings;
-  getWebInspectorSocket = safariExtensions.getWebInspectorSocket as unknown as () => Promise<
-    string | null
-  >;
-
-  isBiometricEnrolled = biometricExtensions.isBiometricEnrolled;
-  enrollBiometric = biometricExtensions.enrollBiometric;
-  sendBiometricMatch = biometricExtensions.sendBiometricMatch;
-
-  backupKeychains = keychainExtensions.backupKeychains as unknown as () => Promise<boolean>;
-  restoreKeychains = keychainExtensions.restoreKeychains as unknown as (
-    excludePatterns: string[],
-  ) => Promise<boolean>;
-  clearKeychains = keychainExtensions.clearKeychains;
-
-  setGeolocation = geolocationExtensions.setGeolocation;
-
-  shake = miscExtensions.shake;
-  addCertificate = miscExtensions.addCertificate;
-  pushNotification = miscExtensions.pushNotification;
-
-  setPermission = permissionsExtensions.setPermission;
-  setPermissions = permissionsExtensions.setPermissions;
-  getPermission = permissionsExtensions.getPermission;
-
-  updateSettings = settingsExtensions.updateSettings;
-  setAppearance = settingsExtensions.setAppearance;
-  getAppearance = settingsExtensions.getAppearance;
-  setIncreaseContrast = settingsExtensions.setIncreaseContrast;
-  getIncreaseContrast = settingsExtensions.getIncreaseContrast;
-  setContentSize = settingsExtensions.setContentSize;
-  getContentSize = settingsExtensions.getContentSize;
-  configureLocalization = settingsExtensions.configureLocalization;
-  setAutoFillPasswords = settingsExtensions.setAutoFillPasswords;
-  setReduceMotion = settingsExtensions.setReduceMotion;
-  setReduceTransparency = settingsExtensions.setReduceTransparency;
-  disableKeyboardIntroduction = settingsExtensions.disableKeyboardIntroduction;
 }

package/lib/simulator-xcode-15.ts

@@ -1,8 +1,6 @@
 import {fs} from '@appium/support';
 import {exec} from 'teen_process';
 import path from 'node:path';
-import _ from 'lodash';
-import B from 'bluebird';
 import {SimulatorXcode14} from './simulator-xcode-14';
 
 export class SimulatorXcode15 extends SimulatorXcode14 {
@@ -102,7 +100,7 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
     if (!simRoot) {
       throw new Error('The IPHONE_SIMULATOR_ROOT environment variable value cannot be retrieved');
     }
-    return _.trim(simRoot);
+    return simRoot.trim();
   }
 
   /**
@@ -124,7 +122,7 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
           'print CFBundleIdentifier',
           infoPlistPath,
         ]);
-        return _.trim(stdout);
+        return stdout.trim();
       } catch {
         return null;
       }
@@ -132,7 +130,7 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
     const allApps = (await fs.readdir(appsRoot))
       .filter((x) => x.endsWith('.app'))
       .map((x) => path.join(appsRoot, x));
-    const bundleIds = await B.all(allApps.map(fetchBundleId));
+    const bundleIds = await Promise.all(allApps.map(fetchBundleId));
     this._systemAppBundleIds = new Set(bundleIds.filter((x): x is string => x !== null));
     return this._systemAppBundleIds;
   }

package/lib/types.ts

@@ -212,15 +212,6 @@ export interface InteractsWithSafariBrowser {
   getWebInspectorSocket(): Promise<string | null>;
 }
 
-interface KeyboardOptions {
-  /** The name of the keyboard locale, for example `en_US` or `de_CH` */
-  name: string;
-  /** The keyboard layout, for example `QUERTY` or `Ukrainian` */
-  layout: string;
-  /** hardware Could either be `Automatic` or `null` */
-  hardware?: string | null;
-}
-
 export interface LanguageOptions {
   /** The name of the language, for example `de` or `zh-Hant-CN` */
   name: string;
@@ -298,3 +289,12 @@ export type Simulator = CoreSimulator &
   InteractsWithKeychain &
   SupportsAppPermissions &
   HasMiscFeatures;
+
+interface KeyboardOptions {
+  /** The name of the keyboard locale, for example `en_US` or `de_CH` */
+  name: string;
+  /** The keyboard layout, for example `QUERTY` or `Ukrainian` */
+  layout: string;
+  /** hardware Could either be `Automatic` or `null` */
+  hardware?: string | null;
+}