appium-xcuitest-driver 10.14.5 → 10.14.7

package/lib/commands/active-app-info.ts

@@ -0,0 +1,15 @@
+import type {XCUITestDriver} from '../driver';
+import type {ActiveAppInfo} from './types';
+
+/**
+ * Returns information about the active application.
+ *
+ * @returns Active app information
+ * @throws {Error} if an error raised by command
+ */
+export async function mobileGetActiveAppInfo(
+  this: XCUITestDriver,
+): Promise<ActiveAppInfo> {
+  return await this.proxyCommand<unknown, ActiveAppInfo>('/wda/activeAppInfo', 'GET');
+}
+

package/lib/commands/{app-strings.js → app-strings.ts}

@@ -1,19 +1,23 @@
 import {parseLocalizableStrings} from '../app-utils';
+import type {XCUITestDriver} from '../driver';
+import type {StringRecord} from '@appium/types';
 
 /**
  * Return the language-specific strings for an app
  *
- * @param {string} language - The language abbreviation to fetch app strings mapping for.
+ * @param language - The language abbreviation to fetch app strings mapping for.
  * If no language is provided then strings for the 'en language would be returned
- * @param {string|null} [stringFile=null] - Relative path to the corresponding .strings
+ * @param stringFile - Relative path to the corresponding .strings
  * file starting from the corresponding .lproj folder, e.g., `base/main.strings`. If omitted,
  * then Appium will make its best guess where the file is.
  *
- * @returns {Promise<import('@appium/types').StringRecord<string>>} A record of localized keys to localized text
- *
- * @this {XCUITestDriver}
+ * @returns A record of localized keys to localized text
  */
-export async function getStrings(language, stringFile = null) {
+export async function getStrings(
+  this: XCUITestDriver,
+  language: string,
+  stringFile: string | null = null,
+): Promise<StringRecord<string>> {
   this.log.debug(`Gettings strings for language '${language}' and string file '${stringFile}'`);
   return await parseLocalizableStrings.bind(this)(
     {
@@ -25,6 +29,3 @@ export async function getStrings(language, stringFile = null) {
   );
 }
 
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/audit.ts

@@ -0,0 +1,25 @@
+import type {XCUITestDriver} from '../driver';
+import type {AccessibilityAuditItem} from './types';
+
+/**
+ * Performs accessibility audit of the current application according to the given type or multiple types.
+ *
+ * @since Xcode 15/iOS 17
+ * @param auditTypes - One or more type names to perform the audit for.
+ * The full list of available names could be found at
+ * https://developer.apple.com/documentation/xctest/xcuiaccessibilityaudittype?language=objc
+ * If no type if provided explicitly then XCUIAccessibilityAuditTypeAll is assumed.
+ *
+ * @returns List of found issues or an empty list
+ */
+export async function mobilePerformAccessibilityAudit(
+  this: XCUITestDriver,
+  auditTypes?: string[],
+): Promise<AccessibilityAuditItem[]> {
+  return await this.proxyCommand<{auditTypes?: string[]}, AccessibilityAuditItem[]>(
+    '/wda/performAccessibilityAudit',
+    'POST',
+    {auditTypes},
+  );
+}
+

package/lib/commands/device-info.ts

@@ -0,0 +1,24 @@
+import {utilities} from 'appium-ios-device';
+import type {XCUITestDriver} from '../driver';
+import type {DeviceInfo, LockdownInfo} from './types';
+
+/**
+ * Returns the miscellaneous information about the device under test.
+ *
+ * Since XCUITest driver v4.2.0, this includes device information via lockdown in a real device.
+ *
+ * @returns The response of `/wda/device/info'`
+ */
+export async function mobileGetDeviceInfo(
+  this: XCUITestDriver,
+): Promise<DeviceInfo | (DeviceInfo & {lockdownInfo: LockdownInfo})> {
+  const infoByWda = await this.proxyCommand<unknown, DeviceInfo>('/wda/device/info', 'GET');
+
+  if (this.isRealDevice()) {
+    const lockdownInfo = await utilities.getDeviceInfo(this.device.udid);
+    return {...infoByWda, ...{lockdownInfo}};
+  }
+
+  return infoByWda;
+}
+

package/lib/commands/keychains.ts

@@ -0,0 +1,16 @@
+import {assertSimulator} from '../utils';
+import type {XCUITestDriver} from '../driver';
+
+/**
+ * Clears keychains on a simulated device.
+ *
+ * @throws {Error} If current device is not a Simulator or there was an error
+ * while clearing keychains.
+ * @group Simulator Only
+ */
+export async function mobileClearKeychains(
+  this: XCUITestDriver,
+): Promise<void> {
+  await assertSimulator.call(this, 'Keychain modification').clearKeychains();
+}
+

package/lib/commands/{localization.js → localization.ts}

@@ -1,6 +1,6 @@
-import {assertSimulator as _assertSimulator} from '../utils';
-
-const assertSimulator = (driver) => _assertSimulator.call(driver, 'Localization configuration');
+import {assertSimulator} from '../utils';
+import type {XCUITestDriver} from '../driver';
+import type {KeyboardOptions, LanguageOptions, LocaleOptions} from './types';
 
 /**
  * Change localization settings on the currently booted simulator
@@ -9,21 +9,31 @@ const assertSimulator = (driver) => _assertSimulator.call(driver, 'Localization
  * Currently running applications will be unchanged. This means, for example, that the keyboard should be hidden and shown again in order to observe the changed layout, and corresponding apps must be restarted in order to observe their interface using the newly set locale/language.
  *
  * The driver performs no strict checking of the arguments (such as locale names). Be aware that an incorrect or invalid string may cause unexpected behavior.
- * @param {import('./types').KeyboardOptions} [keyboard] - Keyboard options
- * @param {import('./types').LanguageOptions} [language] - Language options
- * @param {import('./types').LocaleOptions} [locale] - Locale options
+ * @param keyboard - Keyboard options
+ * @param language - Language options
+ * @param locale - Locale options
  * @throws {Error} If there was a failure while setting the preferences
- * @returns {Promise<boolean>} `true` if any of settings has been successfully changed
+ * @returns `true` if any of settings has been successfully changed
  * @group Simulator Only
- * @this {import('../driver').XCUITestDriver}
  */
-export async function mobileConfigureLocalization(keyboard, language, locale) {
-  assertSimulator(this);
+export async function mobileConfigureLocalization(
+  this: XCUITestDriver,
+  keyboard?: KeyboardOptions,
+  language?: LanguageOptions,
+  locale?: LocaleOptions,
+): Promise<boolean> {
+  ;
 
-  const localizationOptions = {locale, keyboard};
+  const localizationOptions: {
+    locale?: LocaleOptions;
+    keyboard?: KeyboardOptions;
+    language?: LanguageOptions & {skipSyncUiDialogTranslation?: boolean};
+  } = {locale, keyboard};
   if (language) {
     // Assign skipSyncUiDialogTranslation: true option in order to avoid shutting down the WDA session
     localizationOptions.language = Object.assign(language, {skipSyncUiDialogTranslation: true});
   }
-  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).configureLocalization(localizationOptions);
+  return await assertSimulator.call(this, 'Localization configuration')
+    .configureLocalization(localizationOptions);
 }
+

package/lib/commands/types.ts

@@ -334,6 +334,29 @@ export interface ProcessArguments {
   args: string[];
 }
 
+/**
+ * Accessibility audit item returned by the audit command.
+ */
+export interface AccessibilityAuditItem {
+  /**
+   * The detailed description of the found accessibility issue.
+   */
+  detailedDescription: string;
+  /**
+   * The compact description of the found accessibility issue.
+   */
+  compactDescription: string;
+  /**
+   * The name of the audit type this issue belongs to. Could be
+   * a number if the type name is unknown.
+   */
+  auditType: string | number;
+  /**
+   * The description of the element this issue was found for.
+   */
+  element: string;
+}
+
 /**
  * Pressable button names; used by the {@linkcode XCUITest.mobilePressButton mobile: pressButton} command.
  */

package/lib/driver.ts

@@ -41,7 +41,7 @@ import * as clipboardCommands from './commands/clipboard';
 import * as conditionCommands from './commands/condition';
 import * as contentSizeCommands from './commands/content-size';
 import * as contextCommands from './commands/context';
-import * as deviceInfoCommands from './commands/deviceInfo';
+import * as deviceInfoCommands from './commands/device-info';
 import * as elementCommands from './commands/element';
 import * as executeCommands from './commands/execute';
 import * as fileMovementCommands from './commands/file-movement';

package/lib/index.ts

@@ -0,0 +1,5 @@
+import {XCUITestDriver} from './driver';
+
+export {XCUITestDriver};
+export * as doctor from './doctor/checks';
+export default XCUITestDriver;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "10.14.5",
+  "version": "10.14.7",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "10.14.5",
+      "version": "10.14.7",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^1.0.0-rc.1",
@@ -692,9 +692,9 @@
       }
     },
     "node_modules/appium-ios-remotexpc": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/appium-ios-remotexpc/-/appium-ios-remotexpc-0.24.2.tgz",
-      "integrity": "sha512-bZBVG5eo/TC9PJJIu/kpGy5YprMn9vcVMKCarNM8rTTtNNUgOE80LPJ5e1UxWj2AnIAXyoJochN996mmiaWvnA==",
+      "version": "0.25.0",
+      "resolved": "https://registry.npmjs.org/appium-ios-remotexpc/-/appium-ios-remotexpc-0.25.0.tgz",
+      "integrity": "sha512-inc/mZc3Dz7mtBj/CWC+m3NlWB2a14aZ4Ug6onM/7vI80N3YRsOyaSfYk1HCLwacstvDJhjEoA6bqi5LMtVwYA==",
       "license": "Apache-2.0",
       "optional": true,
       "dependencies": {

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "10.14.5",
+  "version": "10.14.7",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -61,24 +61,21 @@
       ]
     }
   },
-  "main": "./build/index.js",
+  "main": "./build/lib/index.js",
   "bin": {},
   "directories": {
     "lib": "lib"
   },
   "files": [
-    "index.js",
     "lib",
     "scripts",
-    "build/index.js",
-    "build/index.d.ts",
-    "build/lib",
+    "build",
     "!.DS_Store",
     "CHANGELOG.md",
     "LICENSE",
     "npm-shrinkwrap.json"
   ],
-  "types": "./build/index.d.ts",
+  "types": "./build/lib/index.d.ts",
   "dependencies": {
     "@appium/strongbox": "^1.0.0-rc.1",
     "@colors/colors": "^1.6.0",

package/build/index.d.ts

@@ -1,5 +0,0 @@
-export { XCUITestDriver };
-export * as doctor from "./lib/doctor/checks";
-export default XCUITestDriver;
-import { XCUITestDriver } from './lib/driver';
-//# sourceMappingURL=index.d.ts.map

package/build/lib/commands/deviceInfo.d.ts

@@ -1,12 +0,0 @@
-/**
- * Returns the miscellaneous information about the device under test.
- *
- * Since XCUITest driver v4.2.0, this includes device information via lockdown in a real device.
- *
- * @returns {Promise<DeviceInfo | (DeviceInfo & LockdownInfo)>} The response of `/wda/device/info'`
- * @this {import('../driver').XCUITestDriver}
- */
-export function mobileGetDeviceInfo(this: import("../driver").XCUITestDriver): Promise<DeviceInfo | (DeviceInfo & LockdownInfo)>;
-export type DeviceInfo = import("./types").DeviceInfo;
-export type LockdownInfo = import("./types").LockdownInfo;
-//# sourceMappingURL=deviceInfo.d.ts.map

package/build/lib/commands/deviceInfo.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deviceInfo.d.ts","sourceRoot":"","sources":["../../../lib/commands/deviceInfo.js"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,+EAHa,OAAO,CAAC,UAAU,GAAG,CAAC,UAAU,GAAG,YAAY,CAAC,CAAC,CAc7D;yBAGY,OAAO,SAAS,EAAE,UAAU;2BAC5B,OAAO,SAAS,EAAE,YAAY"}

package/build/lib/commands/deviceInfo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deviceInfo.js","sourceRoot":"","sources":["../../../lib/commands/deviceInfo.js"],"names":[],"mappings":";;AAUA,kDAWC;AArBD,yDAA4C;AAE5C;;;;;;;GAOG;AACI,KAAK,UAAU,mBAAmB;IACvC,MAAM,SAAS,GAAG,2CAA2C,CAAC,CAC5D,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,CACnD,CAAC;IAEF,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,YAAY,GAAG,MAAM,6BAAS,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrE,OAAO,EAAC,GAAG,SAAS,EAAE,GAAG,EAAC,YAAY,EAAC,EAAC,CAAC;IAC3C,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG"}

package/index.js

@@ -1,7 +0,0 @@
-import {XCUITestDriver} from './lib/driver';
-
-export {XCUITestDriver};
-
-export * as doctor from './lib/doctor/checks';
-
-export default XCUITestDriver;

package/lib/commands/active-app-info.js

@@ -1,12 +0,0 @@
-/**
- * Returns information about the active application.
- *
- * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
- * @throws {Error} if an error raised by command
- * @this {import('../driver').XCUITestDriver}
- */
-export async function mobileGetActiveAppInfo() {
-  return /** @type {import('./types').ActiveAppInfo} */ (
-    await this.proxyCommand('/wda/activeAppInfo', 'GET')
-  );
-}

package/lib/commands/audit.js

@@ -1,31 +0,0 @@
-/**
- * @typedef {Object} AccessibilityAuditItem
- * @property {string} detailedDescription The detailed description of the found accessibility issue.
- * @property {string} compactDescription The compact description of the found accessibility issue.
- * @property {string|number} auditType The name of the audit type this issue belongs to. Could be
- * a number if the type name is unknown.
- * @property {string} element The description of the element this issue was found for.
- */
-
-/**
- * Performs accessibility audit of the current application according to the given type or multiple types.
- *
- * @since Xcode 15/iOS 17
- * @param {string[]?} auditTypes - One or more type names to perform the audit for.
- * The full list of available names could be found at
- * https://developer.apple.com/documentation/xctest/xcuiaccessibilityaudittype?language=objc
- * If no type if provided explicitly then XCUIAccessibilityAuditTypeAll is assumed.
- *
- * @returns {Promise<AccessibilityAuditItem[]>} List of found issues or an empty list
- *
- * @this {XCUITestDriver}
- */
-export async function mobilePerformAccessibilityAudit(auditTypes) {
-  return /** @type {AccessibilityAuditItem[]} */ (
-    await this.proxyCommand('/wda/performAccessibilityAudit', 'POST', {auditTypes})
-  );
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/deviceInfo.js

@@ -1,27 +0,0 @@
-import {utilities} from 'appium-ios-device';
-
-/**
- * Returns the miscellaneous information about the device under test.
- *
- * Since XCUITest driver v4.2.0, this includes device information via lockdown in a real device.
- *
- * @returns {Promise<DeviceInfo | (DeviceInfo & LockdownInfo)>} The response of `/wda/device/info'`
- * @this {import('../driver').XCUITestDriver}
- */
-export async function mobileGetDeviceInfo() {
-  const infoByWda = /** @type {import('./types').DeviceInfo} */ (
-    await this.proxyCommand('/wda/device/info', 'GET')
-  );
-
-  if (this.isRealDevice()) {
-    const lockdownInfo = await utilities.getDeviceInfo(this.device.udid);
-    return {...infoByWda, ...{lockdownInfo}};
-  }
-
-  return infoByWda;
-}
-
-/**
- * @typedef {import('./types').DeviceInfo} DeviceInfo
- * @typedef {import('./types').LockdownInfo} LockdownInfo
- */

package/lib/commands/keychains.js

@@ -1,17 +0,0 @@
-import {assertSimulator as _assertSimulator} from '../utils';
-
-const assertSimulator = (driver) => _assertSimulator.call(driver, 'Keychain modification');
-
-/**
- * Clears keychains on a simulated device.
- *
- * @throws {Error} If current device is not a Simulator or there was an error
- * while clearing keychains.
- * @this {import('../driver').XCUITestDriver}
- * @group Simulator Only
- */
-export async function mobileClearKeychains() {
-  assertSimulator(this);
-
-  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).clearKeychains();
-}