feat!: Migrate the package to ESM (#2914)

BREAKING CHANGE: Consumers using require('appium-xcuitest-driver') must switch to import/dynamic import() — the package no longer ships a CommonJS entry point.
BREAKING CHANGE: start is no longer callable as driver.start(...).
BREAKING CHANGE: stop is no longer callable as driver.stop(...).
BREAKING CHANGE: runReset is no longer callable as driver.runReset(...).
BREAKING CHANGE: configureApp is no longer callable as driver.configureApp(...).
BREAKING CHANGE: determineDevice is no longer callable as driver.determineDevice(...).
BREAKING CHANGE: setInitialOrientation is no longer callable as driver.setInitialOrientation(...).
BREAKING CHANGE: resetIos is no longer callable as driver.resetIos(...).
BREAKING CHANGE: mergeCliArgsToOpts is no longer callable as driver.mergeCliArgsToOpts(...).
BREAKING CHANGE: handleMjpegOptions is no longer callable as driver.handleMjpegOptions(...).
BREAKING CHANGE: allocateMjpegServerPort is no longer callable as driver.allocateMjpegServerPort(...).
BREAKING CHANGE: getDefaultUrl is no longer callable as driver.getDefaultUrl(...).
BREAKING CHANGE: onSettingsUpdate is no longer callable as driver.onSettingsUpdate(...).
BREAKING CHANGE: isXcodebuildNeeded is no longer callable as driver.isXcodebuildNeeded(...).
BREAKING CHANGE: createSim has been removed; it was already deprecated.
BREAKING CHANGE: startWdaSession is no longer callable as driver.startWdaSession(...).
BREAKING CHANGE: installAUT is no longer callable as driver.installAUT(...).
BREAKING CHANGE: installOtherApps is no longer callable as driver.installOtherApps(...).

Author: mykola-mokhnach

.github/workflows/functional-test.yml

@@ -92,10 +92,8 @@ jobs:
           popd
         name: Install Appium Server
       - run: |
-          brew install xq
           npm install
           npm install --no-save mjpeg-consumer
-          npm install mocha-multi-reporters --save-dev
         name: Install dev dependencies
       - run: |
           export cwd=$(pwd)

lib/app-infos-cache.ts

@@ -1,10 +1,10 @@
 import path from 'node:path';
 
 import type {AppiumLogger, StringRecord} from '@appium/types';
-import {plist, fs, tempDir, zip} from 'appium/support';
+import {plist, fs, tempDir, zip} from 'appium/support.js';
 import {LRUCache} from 'lru-cache';
 
-import {escapeRegExp, isPlainObject} from './utils';
+import {escapeRegExp, isPlainObject} from './utils/index.js';
 
 const MANIFEST_CACHE = new LRUCache<string, StringRecord>({
   max: 40,

lib/commands/active-app-info.ts

@@ -1,5 +1,5 @@
-import type {XCUITestDriver} from '../driver';
-import type {ActiveAppInfo} from './types';
+import type {XCUITestDriver} from '../driver.js';
+import type {ActiveAppInfo} from './types.js';
 
 /**
  * Returns information about the active application.

lib/commands/alert.ts

@@ -1,4 +1,4 @@
-import type {XCUITestDriver} from '../driver';
+import type {XCUITestDriver} from '../driver.js';
 
 export type AlertAction = 'accept' | 'dismiss' | 'getButtons';