@limrun/appium-xcuitest-driver 10.4.3-lim.1

package/build/lib/simulator-management.js

@@ -0,0 +1,278 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSim = createSim;
+exports.getExistingSim = getExistingSim;
+exports.shutdownSimulator = shutdownSimulator;
+exports.runSimulatorReset = runSimulatorReset;
+exports.installToSimulator = installToSimulator;
+exports.shutdownOtherSimulators = shutdownOtherSimulators;
+exports.setSafariPrefs = setSafariPrefs;
+exports.setLocalizationPrefs = setLocalizationPrefs;
+const appium_ios_simulator_1 = require("@limrun/appium-ios-simulator");
+const node_simctl_1 = require("@limrun/node-simctl");
+const appium_webdriveragent_1 = require("appium-webdriveragent");
+const lodash_1 = __importDefault(require("lodash"));
+const support_1 = require("appium/support");
+const utils_1 = require("./utils");
+const app_utils_1 = require("./app-utils");
+const APPIUM_SIM_PREFIX = 'appiumTest';
+/**
+ * Create a new simulator with `appiumTest-` prefix and return the object.
+ *
+ * @this {import('./driver').XCUITestDriver}
+ * @returns {Promise<object>} Simulator object associated with the udid passed in.
+ */
+async function createSim() {
+    const { simulatorDevicesSetPath: devicesSetPath, deviceName, platformVersion } = this.opts;
+    const platform = (0, utils_1.normalizePlatformName)(this.opts.platformName);
+    const simctl = new node_simctl_1.Simctl({ devicesSetPath });
+    if (!deviceName) {
+        let deviceNames = 'none';
+        try {
+            deviceNames = (await simctl
+                .getDevices(platformVersion, platform))
+                .map(({ deviceName }) => deviceName);
+        }
+        catch { }
+        throw new Error(`'deviceName' must be provided in order to create a new Simulator for ${platform} platform. ` +
+            `Currently available device names: ${deviceNames}`);
+    }
+    if (!platformVersion) {
+        throw new Error(`'platformVersion' is required.`);
+    }
+    const simName = `${APPIUM_SIM_PREFIX}-${support_1.util.uuidV4().toUpperCase()}-${deviceName}`;
+    this.log.debug(`Creating a temporary Simulator device '${simName}'`);
+    const udid = await simctl.createDevice(simName, deviceName, platformVersion, { platform });
+    return await (0, appium_ios_simulator_1.getSimulator)(udid, {
+        platform,
+        checkExistence: false,
+        devicesSetPath,
+        // @ts-ignore This is ok
+        logger: this.log,
+    });
+}
+/**
+ * @typedef {Object} SimulatorLookupOptions
+ * @property {string} [deviceName] - The name of the device to lookup
+ * @property {string} platformVersion - The platform version string
+ * @property {string} [simulatorDevicesSetPath] - The full path to the simulator devices set
+ * @property {string} [udid] - Simulator udid
+ * @property {string} [platformName] The name of the current platform
+ */
+/**
+ * Get an existing simulator matching the provided capabilities.
+ *
+ * @this {import('./driver').XCUITestDriver}
+ * @returns {Promise<import('./driver').Simulator|null>} The matched Simulator instance or `null` if no matching  device is found.
+ */
+async function getExistingSim() {
+    const { platformVersion, deviceName, udid, simulatorDevicesSetPath: devicesSetPath, platformName, } = this.opts;
+    const platform = (0, utils_1.normalizePlatformName)(platformName);
+    const selectSim = async (/** @type {{ udid: string; platform: string; }} */ dev) => await (0, appium_ios_simulator_1.getSimulator)(dev.udid, {
+        platform,
+        checkExistence: false,
+        devicesSetPath,
+        // @ts-ignore This is ok
+        logger: this.log,
+    });
+    const simctl = new node_simctl_1.Simctl({ devicesSetPath });
+    let devicesMap;
+    if (udid && lodash_1.default.toLower(udid) !== utils_1.UDID_AUTO) {
+        this.log.debug(`Looking for an existing Simulator with UDID '${udid}'`);
+        devicesMap = await simctl.getDevices(null, platform);
+        for (const device of lodash_1.default.flatMap(lodash_1.default.values(devicesMap))) {
+            if (device.udid === udid) {
+                return await selectSim(device);
+            }
+        }
+        return null;
+    }
+    if (!platformVersion) {
+        this.log.debug(`Provide 'platformVersion' capability if you prefer an existing Simulator to be selected`);
+        return null;
+    }
+    const devices = devicesMap?.[platformVersion] ?? (await simctl.getDevices(platformVersion, platform));
+    this.log.debug(`Looking for an existing Simulator with platformName: ${platform}, ` +
+        `platformVersion: ${platformVersion}, deviceName: ${deviceName}`);
+    for (const device of devices) {
+        if ((deviceName && device.name === deviceName) || !deviceName) {
+            if (!deviceName) {
+                this.log.debug(`The 'deviceName' capability value is empty. ` +
+                    `Selecting the first matching device '${device.name}' having the ` +
+                    `'platformVersion' set to ${platformVersion}`);
+            }
+            return await selectSim(device);
+        }
+    }
+    return null;
+}
+/**
+ * @this {import('./driver').XCUITestDriver}
+ */
+async function shutdownSimulator() {
+    const device = /** @type {import('./driver').Simulator} */ (this.device);
+    // stop XCTest processes if running to avoid unexpected side effects
+    await (0, appium_webdriveragent_1.resetTestProcesses)(device.udid, true);
+    await device.shutdown();
+}
+/**
+ * @this {import('./driver').XCUITestDriver}
+ * @property {boolean} [enforceSimulatorShutdown=false]
+ * @returns {Promise<void>}
+ */
+async function runSimulatorReset(enforceSimulatorShutdown = false) {
+    const { noReset, fullReset, keychainsExcludePatterns, keepKeyChains, bundleId, app, browserName, } = this.opts;
+    if (noReset && !fullReset) {
+        // noReset === true && fullReset === false
+        this.log.debug('Reset: noReset is on. Leaving simulator as is');
+        return;
+    }
+    const device = /** @type {import('./driver').Simulator} */ (this.device);
+    if (!this.device) {
+        this.log.debug('Reset: no device available. Skipping');
+        return;
+    }
+    if (fullReset) {
+        this.log.debug('Reset: fullReset is on. Cleaning simulator');
+        await shutdownSimulator.bind(this)();
+        const isKeychainsBackupSuccessful = (keychainsExcludePatterns || keepKeyChains) && (await device.backupKeychains());
+        await device.clean();
+        if (isKeychainsBackupSuccessful) {
+            await device.restoreKeychains(keychainsExcludePatterns || []);
+            this.log.info(`Successfully restored keychains after full reset`);
+        }
+        else if (keychainsExcludePatterns || keepKeyChains) {
+            this.log.warn('Cannot restore keychains after full reset, because ' +
+                'the backup operation did not succeed');
+        }
+    }
+    else if (bundleId) {
+        // fastReset or noReset
+        // Terminate the app under test if it is still running on Simulator
+        try {
+            await device.terminateApp(bundleId);
+        }
+        catch {
+            this.log.warn(`Reset: failed to terminate Simulator application with id "${bundleId}"`);
+        }
+        if (app) {
+            this.log.info('Not scrubbing third party app in anticipation of uninstall');
+        }
+        else {
+            const isSafari = lodash_1.default.toLower(browserName) === 'safari';
+            try {
+                if (isSafari) {
+                    await device.scrubSafari(true);
+                }
+                else {
+                    await device.scrubApp(bundleId);
+                }
+            }
+            catch (err) {
+                this.log.debug(err.stack);
+                this.log.warn(err.message);
+                this.log.warn(`Reset: could not scrub ${isSafari ? 'Safari browser' : 'application with id "' + this.opts.bundleId + '"'}. ` + `Leaving as is.`);
+            }
+        }
+        if (enforceSimulatorShutdown && (await device.isRunning())) {
+            await shutdownSimulator.bind(this)(device);
+        }
+    }
+}
+/**
+ * @typedef {Object} InstallOptions
+ *
+ * @property {boolean} [skipUninstall] Whether to skip app uninstall before installing it
+ * @property {boolean} [newSimulator=false] Whether the simulator is brand new
+ */
+/**
+ * @this {import('./driver').XCUITestDriver}
+ * @param {string} app The app to the path
+ * @param {string} [bundleId] The bundle id to ensure it is already installed and uninstall it
+ * @param {InstallOptions} [opts={}]
+ */
+async function installToSimulator(app, bundleId, opts = {}) {
+    if (!app) {
+        this.log.debug('No app path is given. Nothing to install.');
+        return;
+    }
+    const { skipUninstall, newSimulator = false } = opts;
+    const device = /** @type {import('./driver').Simulator} */ (this.device);
+    if (!skipUninstall && !newSimulator && bundleId && (await device.isAppInstalled(bundleId))) {
+        this.log.debug(`Reset requested. Removing app with id '${bundleId}' from the device`);
+        await device.removeApp(bundleId);
+    }
+    this.log.debug(`Installing '${app}' on Simulator with UUID '${device.udid}'...`);
+    const timer = new support_1.timing.Timer().start();
+    await device.installApp(app);
+    this.log.info(`The app has been successfully installed in ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
+}
+/**
+ * @this {import('./driver').XCUITestDriver}
+ */
+async function shutdownOtherSimulators() {
+    const device = /** @type {import('./driver').Simulator} */ (this.device);
+    const simctl = new node_simctl_1.Simctl({
+        devicesSetPath: device.devicesSetPath,
+    });
+    const allDevices = lodash_1.default.flatMap(lodash_1.default.values(await simctl.getDevices()));
+    const otherBootedDevices = allDevices
+        .filter(({ udid, state }) => udid !== device.udid && state === 'Booted');
+    if (lodash_1.default.isEmpty(otherBootedDevices)) {
+        this.log.info('No other running simulators have been detected');
+        return;
+    }
+    this.log.info(`Detected ${support_1.util.pluralize('other running Simulator', otherBootedDevices.length, true)}. Shutting them down...`);
+    for (const { udid } of otherBootedDevices) {
+        // It is necessary to stop the corresponding xcodebuild process before killing
+        // the simulator, otherwise it will be automatically restarted
+        await (0, appium_webdriveragent_1.resetTestProcesses)(udid, true);
+        simctl.udid = udid;
+        await simctl.shutdownDevice();
+    }
+}
+/**
+ * Configures Safari options based on the given session capabilities
+ *
+ * @this {import('./driver').XCUITestDriver}
+ * @return {Promise<boolean>} true if any preferences have been updated
+ */
+async function setSafariPrefs() {
+    const prefs = (0, app_utils_1.buildSafariPreferences)(this.opts);
+    if (lodash_1.default.isEmpty(prefs)) {
+        return false;
+    }
+    this.log.debug(`About to update Safari preferences: ${JSON.stringify(prefs)}`);
+    await /** @type {import('./driver').Simulator} */ (this.device).updateSafariSettings(prefs);
+    return true;
+}
+/**
+ * Changes Simulator localization preferences
+ *
+ * @this {import('./driver').XCUITestDriver}
+ * @returns {Promise<boolean>} True if preferences were changed
+ */
+async function setLocalizationPrefs() {
+    const { language, locale, calendarFormat, skipSyncUiDialogTranslation } = this.opts;
+    /** @type {import('@limrun/appium-ios-simulator').LocalizationOptions} */
+    const l10nConfig = {};
+    if (language) {
+        l10nConfig.language = { name: language, skipSyncUiDialogTranslation };
+    }
+    if (locale) {
+        l10nConfig.locale = { name: locale };
+        if (calendarFormat) {
+            l10nConfig.locale.calendar = calendarFormat;
+        }
+    }
+    if (lodash_1.default.isEmpty(l10nConfig)) {
+        return false;
+    }
+    this.log.debug(`About to update localization preferences: ${JSON.stringify(l10nConfig)}`);
+    await /** @type {import('./driver').Simulator} */ (this.device).configureLocalization(l10nConfig);
+    return true;
+}
+//# sourceMappingURL=simulator-management.js.map

package/build/lib/simulator-management.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulator-management.js","sourceRoot":"","sources":["../../lib/simulator-management.js"],"names":[],"mappings":";;;;;AAgBA,8BA+BC;AAiBD,wCA0DC;AAKD,8CAKC;AAOD,8CAuEC;AAeD,gDAsBC;AAKD,0DA0BC;AAQD,wCASC;AAQD,oDAoBC;AAnUD,uEAA0D;AAC1D,qDAA2C;AAC3C,iEAAyD;AACzD,oDAAuB;AACvB,4CAA4C;AAC5C,mCAAyD;AACzD,2CAAmD;AAEnD,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAEvC;;;;;GAKG;AACI,KAAK,UAAU,SAAS;IAC7B,MAAM,EAAC,uBAAuB,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAC,GAAG,IAAI,CAAC,IAAI,CAAC;IACzF,MAAM,QAAQ,GAAG,IAAA,6BAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,IAAI,oBAAM,CAAC,EAAC,cAAc,EAAC,CAAC,CAAC;IAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,IAAI,WAAW,GAAG,MAAM,CAAC;QACzB,IAAI,CAAC;YACH,WAAW,GAAG,CAAC,MAAM,MAAM;iBACxB,UAAU,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;iBACtC,GAAG,CAAC,CAAC,EAAC,UAAU,EAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QACV,MAAM,IAAI,KAAK,CACb,wEAAwE,QAAQ,aAAa;YAC3F,qCAAqC,WAAW,EAAE,CACrD,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,iBAAiB,IAAI,cAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,IAAI,UAAU,EAAE,CAAC;IACpF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,OAAO,GAAG,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IACzF,OAAO,MAAM,IAAA,mCAAY,EAAC,IAAI,EAAE;QAC9B,QAAQ;QACR,cAAc,EAAE,KAAK;QACrB,cAAc;QACd,wBAAwB;QACxB,MAAM,EAAE,IAAI,CAAC,GAAG;KACjB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AAEH;;;;;GAKG;AACI,KAAK,UAAU,cAAc;IAClC,MAAM,EACJ,eAAe,EACf,UAAU,EACV,IAAI,EACJ,uBAAuB,EAAE,cAAc,EACvC,YAAY,GACb,GAAG,IAAI,CAAC,IAAI,CAAC;IAEd,MAAM,QAAQ,GAAG,IAAA,6BAAqB,EAAC,YAAY,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,KAAK,EAAE,kDAAkD,CAAC,GAAG,EAAE,EAAE,CACjF,MAAM,IAAA,mCAAY,EAAC,GAAG,CAAC,IAAI,EAAE;QAC3B,QAAQ;QACR,cAAc,EAAE,KAAK;QACrB,cAAc;QACd,wBAAwB;QACxB,MAAM,EAAE,IAAI,CAAC,GAAG;KACjB,CAAC,CAAC;IAEL,MAAM,MAAM,GAAG,IAAI,oBAAM,CAAC,EAAC,cAAc,EAAC,CAAC,CAAC;IAC5C,IAAI,UAAU,CAAC;IACf,IAAI,IAAI,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,iBAAS,EAAE,CAAC;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gDAAgD,IAAI,GAAG,CAAC,CAAC;QACxE,UAAU,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACrD,KAAK,MAAM,MAAM,IAAI,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACrD,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,yFAAyF,CAC1F,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GACX,UAAU,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxF,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,wDAAwD,QAAQ,IAAI;QAClE,oBAAoB,eAAe,iBAAiB,UAAU,EAAE,CACnE,CAAC;IACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAC9D,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,8CAA8C;oBAC5C,wCAAwC,MAAM,CAAC,IAAI,eAAe;oBAClE,4BAA4B,eAAe,EAAE,CAChD,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,iBAAiB;IACrC,MAAM,MAAM,GAAG,2CAA2C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzE,oEAAoE;IACpE,MAAM,IAAA,0CAAkB,EAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAAC,wBAAwB,GAAG,KAAK;IACtE,MAAM,EACJ,OAAO,EACP,SAAS,EACT,wBAAwB,EACxB,aAAa,EACb,QAAQ,EACR,GAAG,EACH,WAAW,GACZ,GAAG,IAAI,CAAC,IAAI,CAAC;IACd,IAAI,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;QAC1B,0CAA0C;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAChE,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,2CAA2C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEzE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACvD,OAAO;IACT,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC7D,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,2BAA2B,GAAG,CAAC,wBAAwB,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;QACpH,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,2BAA2B,EAAE,CAAC;YAChC,MAAM,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;QACpE,CAAC;aAAM,IAAI,wBAAwB,IAAI,aAAa,EAAE,CAAC;YACrD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,qDAAqD;gBACnD,sCAAsC,CACzC,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,EAAE,CAAC;QACpB,uBAAuB;QAEvB,mEAAmE;QACnE,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6DAA6D,QAAQ,GAAG,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;QAC9E,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC;YACrD,IAAI,CAAC;gBACH,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,MAAM,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,0BACE,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,uBAAuB,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,GAC/E,IAAI,GAAG,gBAAgB,CACxB,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,wBAAwB,IAAI,CAAC,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;YAC3D,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AAEH;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CACtC,GAAG,EACH,QAAQ,EACR,IAAI,GAAG,EAAE;IAET,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC5D,OAAO;IACT,CAAC;IAED,MAAM,EAAC,aAAa,EAAE,YAAY,GAAG,KAAK,EAAC,GAAG,IAAI,CAAC;IACnD,MAAM,MAAM,GAAG,2CAA2C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEzE,IAAI,CAAC,aAAa,IAAI,CAAC,YAAY,IAAI,QAAQ,IAAI,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC3F,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,QAAQ,mBAAmB,CAAC,CAAC;QACtF,MAAM,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,GAAG,6BAA6B,MAAM,CAAC,IAAI,MAAM,CAAC,CAAC;IACjF,MAAM,KAAK,GAAG,IAAI,gBAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC;IACzC,MAAM,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8CAA8C,KAAK,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACjH,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,uBAAuB;IAC3C,MAAM,MAAM,GAAG,2CAA2C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,IAAI,oBAAM,CAAC;QACxB,cAAc,EAAE,MAAM,CAAC,cAAc;KACtC,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,MAAM,CAAC,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAClE,MAAM,kBAAkB,GAAG,UAAU;SAClC,MAAM,CAAC,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,KAAK,KAAK,QAAQ,CAAC,CAAC;IACzE,IAAI,gBAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;QAChE,OAAO;IACT,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,YAAY,cAAI,CAAC,SAAS,CACxB,yBAAyB,EACzB,kBAAkB,CAAC,MAAM,EACzB,IAAI,CACL,yBAAyB,CAC3B,CAAC;IACF,KAAK,MAAM,EAAC,IAAI,EAAC,IAAI,kBAAkB,EAAE,CAAC;QACxC,8EAA8E;QAC9E,8DAA8D;QAC9D,MAAM,IAAA,0CAAkB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACnB,MAAM,MAAM,CAAC,cAAc,EAAE,CAAC;IAChC,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,cAAc;IAClC,MAAM,KAAK,GAAG,IAAA,kCAAsB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,gBAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/E,MAAM,2CAA2C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC5F,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB;IACxC,MAAM,EAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,2BAA2B,EAAC,GAAG,IAAI,CAAC,IAAI,CAAC;IAClF,yEAAyE;IACzE,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,IAAI,QAAQ,EAAE,CAAC;QACb,UAAU,CAAC,QAAQ,GAAG,EAAC,IAAI,EAAE,QAAQ,EAAE,2BAA2B,EAAE,CAAC;IACvE,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,MAAM,GAAG,EAAC,IAAI,EAAE,MAAM,EAAC,CAAC;QACnC,IAAI,cAAc,EAAE,CAAC;YACnB,UAAU,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC;QAC9C,CAAC;IACH,CAAC;IACD,IAAI,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6CAA6C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC1F,MAAM,2CAA2C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAClG,OAAO,IAAI,CAAC;AACd,CAAC"}

package/build/lib/stubs.d.ts

@@ -0,0 +1,3 @@
+declare module 'appium-ios-device';
+export {};
+//# sourceMappingURL=stubs.d.ts.map

package/build/lib/stubs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubs.d.ts","sourceRoot":"","sources":["../../lib/stubs.ts"],"names":[],"mappings":"AAEA,OAAO,QAAQ,mBAAmB,CAAC"}

package/build/lib/stubs.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=stubs.js.map

package/build/lib/stubs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stubs.js","sourceRoot":"","sources":["../../lib/stubs.ts"],"names":[],"mappings":""}

package/build/lib/types.d.ts

@@ -0,0 +1,31 @@
+export interface Page {
+    id: number | string;
+    isKey?: boolean;
+    url: string;
+}
+export interface AsyncPromise {
+    resolve: (value: any) => void;
+    reject: (reason: any) => void;
+}
+export interface LifecycleData {
+    createSim?: boolean;
+}
+export interface CalibrationData {
+    /**
+     * webview x offset in real coordinates
+     */
+    offsetX: number;
+    /**
+     * webview y offset in real coordinates
+     */
+    offsetY: number;
+    /**
+     * pixel ratio x inside of the web view
+     */
+    pixelRatioX: number;
+    /**
+     * pixel ratio y inside of the web view
+     */
+    pixelRatioY: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAC9B,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/build/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":""}

package/build/lib/utils.d.ts

@@ -0,0 +1,191 @@
+/**
+ * Stops and removes all web socket handlers that are listening
+ * in scope of the current session.
+ *
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function removeAllSessionWebSocketHandlers(this: import("./driver").XCUITestDriver): Promise<void>;
+/**
+ * Asserts that the given driver is running on a Simulator and return
+ * the simlator instance.
+ *
+ * @param {string} action - Description of action
+ * @param {import('./driver').XCUITestDriver} driver
+ * @returns {Simulator}
+ */
+export function assertSimulator(action: string, driver: import("./driver").XCUITestDriver): Simulator;
+/**
+ * Check if platform name is the TV OS one.
+ *
+ * @param {string|null|undefined} platformName
+ * @returns {boolean}
+ */
+export function isTvOs(platformName: string | null | undefined): boolean;
+/**
+ * Return normalized platform name.
+ *
+ * @param {string|null|undefined} platformName
+ * @returns {string}
+ */
+export function normalizePlatformName(platformName: string | null | undefined): string;
+/**
+ * @param {import('./driver').XCUITestDriverOpts} opts
+ * @returns {boolean}
+ */
+export function shouldSetInitialSafariUrl(opts: import("./driver").XCUITestDriverOpts): boolean;
+/**
+ * @param {import('./driver').XCUITestDriverOpts} opts
+ * @returns {boolean}
+ */
+export function isIos17OrNewer(opts: import("./driver").XCUITestDriverOpts): boolean;
+/**
+ * @param {import('./driver').XCUITestDriverOpts} opts
+ * @returns {boolean}
+ */
+export function isIos18OrNewer(opts: import("./driver").XCUITestDriverOpts): boolean;
+export const UDID_AUTO: "auto";
+export const NATIVE_WIN: "NATIVE_APP";
+export type UploadOptions = {
+    /**
+     * - The name of the user for the remote authentication. Only works if `remotePath` is provided.
+     */
+    user?: string | undefined;
+    /**
+     * - The password for the remote authentication. Only works if `remotePath` is provided.
+     */
+    pass?: string | undefined;
+    /**
+     * - The http multipart upload method name. The 'PUT' one is used by default.
+     * Only works if `remotePath` is provided.
+     */
+    method?: import("axios").Method | undefined;
+    /**
+     * - Additional headers mapping for multipart http(s) uploads
+     */
+    headers?: import("@appium/types").HTTPHeaders | undefined;
+    /**
+     * [file] - The name of the form field, where the file content BLOB should be stored for
+     *          http(s) uploads
+     */
+    fileFieldName?: string | undefined;
+    /**
+     * - Additional form fields for multipart http(s) uploads
+     */
+    formFields?: [string, any][] | Record<string, any> | undefined;
+};
+export type DriverInfo = {
+    /**
+     * Driver version string
+     */
+    version: string;
+    /**
+     * Driver build timestamp
+     */
+    built: string;
+};
+export type XcodeVersion = import("@limrun/appium-xcode").XcodeVersion;
+export type Simulator = import("@limrun/appium-ios-simulator").Simulator;
+export type XCUITestDriver = import("./driver").XCUITestDriver;
+/**
+ * @privateRemarks Is the minimum version really Xcode 7.3?
+ * @returns {Promise<XcodeVersion>}
+ */
+export function getAndCheckXcodeVersion(): Promise<XcodeVersion>;
+/**
+ * @returns {Promise<string|null>}
+ */
+export function getAndCheckIosSdkVersion(): Promise<string | null>;
+export function checkAppPresent(app: any): Promise<void>;
+/**
+ * @typedef {Object} DriverInfo
+ * @property {string} version Driver version string
+ * @property {string} built Driver build timestamp
+ */
+/**
+ * @returns {DriverInfo}
+ */
+export const getDriverInfo: (() => Promise<{
+    built: string;
+    version: any;
+}>) & _.MemoizedFunction;
+export function clearSystemFiles(wda: any): Promise<void>;
+/**
+ *
+ * @param {string} platformVersion
+ * @param {string} deviceName
+ * @returns {string}
+ */
+export function translateDeviceName(platformVersion: string, deviceName: string): string;
+export function normalizeCommandTimeouts(value: any): any;
+export const DEFAULT_TIMEOUT_KEY: "default";
+export function markSystemFilesForCleanup(wda: any): Promise<void>;
+export function printUser(): Promise<void>;
+/**
+ * Get the IDs of processes listening on the particular system port.
+ * It is also possible to apply additional filtering based on the
+ * process command line.
+ *
+ * @param {string|number} port - The port number.
+ * @param {?Function} filteringFunc - Optional lambda function, which
+ *                                    receives command line string of the particular process
+ *                                    listening on given port, and is expected to return
+ *                                    either true or false to include/exclude the corresponding PID
+ *                                    from the resulting array.
+ * @returns {Promise<string[]>} - the list of matched process ids.
+ */
+export function getPIDsListeningOnPort(port: string | number, filteringFunc?: Function | null): Promise<string[]>;
+/**
+ * @typedef {Object} UploadOptions
+ *
+ * @property {string} [user] - The name of the user for the remote authentication. Only works if `remotePath` is provided.
+ * @property {string} [pass] - The password for the remote authentication. Only works if `remotePath` is provided.
+ * @property {import('axios').Method} [method] - The http multipart upload method name. The 'PUT' one is used by default.
+ *                              Only works if `remotePath` is provided.
+ * @property {import('@appium/types').HTTPHeaders} [headers] - Additional headers mapping for multipart http(s) uploads
+ * @property {string} [fileFieldName] [file] - The name of the form field, where the file content BLOB should be stored for
+ *                                            http(s) uploads
+ * @property {Record<string, any> | [string, any][]} [formFields] - Additional form fields for multipart http(s) uploads
+ */
+/**
+ * Encodes the given local file to base64 and returns the resulting string
+ * or uploads it to a remote server using http/https or ftp protocols
+ * if `remotePath` is set
+ *
+ * @param {string} localPath - The path to an existing local file
+ * @param {string|null} [remotePath] - The path to the remote location, where
+ *                               this file should be uploaded
+ * @param {UploadOptions} uploadOptions - Set of upload options
+ * @returns {Promise<string>} Either an empty string if the upload was successful or
+ * base64-encoded file representation if `remotePath` is falsy
+ */
+export function encodeBase64OrUpload(localPath: string, remotePath?: string | null, uploadOptions?: UploadOptions): Promise<string>;
+/**
+ * Returns true if the urlString is localhost
+ * @param {string} urlString
+ * @returns {boolean} Return true if the urlString is localhost
+ */
+export function isLocalHost(urlString: string): boolean;
+/**
+ * Normalizes platformVersion to a valid iOS version string
+ *
+ * @param {string} originalVersion - Loose version number, that can be parsed by semver
+ * @return {string} iOS version number in <major>.<minor> format
+ * @throws {Error} if the version number cannot be parsed
+ */
+export function normalizePlatformVersion(originalVersion: string): string;
+/**
+ * @param {string[]} locations
+ * @returns {Promise<void>}
+ */
+export function clearLogs(locations: string[]): Promise<void>;
+/**
+ * Assert the presence of particular keys in the given object
+ *
+ * @param {string|Array<string>} argNames one or more key names
+ * @param {Object} opts the object to check
+ * @returns {Object} the same given object
+ */
+export function requireArgs(argNames: string | Array<string>, opts?: any): any;
+import _ from 'lodash';
+//# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AAmZA;;;;;;GAMG;AACH,4FAFa,OAAO,CAAC,IAAI,CAAC,CAWzB;AAgDD;;;;;;;GAOG;AACH,wCAJW,MAAM,UACN,OAAO,UAAU,EAAE,cAAc,GAC/B,SAAS,CAOrB;AAED;;;;;GAKG;AACH,qCAHW,MAAM,GAAC,IAAI,GAAC,SAAS,GACnB,OAAO,CAInB;AAED;;;;;GAKG;AACH,oDAHW,MAAM,GAAC,IAAI,GAAC,SAAS,GACnB,MAAM,CAIlB;AAED;;;GAGG;AACH,gDAHW,OAAO,UAAU,EAAE,kBAAkB,GACnC,OAAO,CAKnB;AAED;;;GAGG;AACH,qCAHW,OAAO,UAAU,EAAE,kBAAkB,GACnC,OAAO,CAInB;AAED;;;GAGG;AACH,qCAHW,OAAO,UAAU,EAAE,kBAAkB,GACnC,OAAO,CAInB;AA/fD,wBAAyB,MAAM,CAAC;AAQhC,yBAA0B,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aA8OzB,MAAM;;;;WACN,MAAM;;2BA8RP,OAAO,sBAAsB,EAAE,YAAY;wBAC3C,OAAO,8BAA8B,EAAE,SAAS;6BAChD,OAAO,UAAU,EAAE,cAAc;AA7gB9C;;;GAGG;AACH,2CAFa,OAAO,CAAC,YAAY,CAAC,CAmBjC;AAED;;GAEG;AACH,4CAFa,OAAO,CAAC,MAAM,GAAC,IAAI,CAAC,CAShC;AAwKD,yDAMC;AA2BD;;;;GAIG;AAEH;;GAEG;AACH;;;yBASG;AAjHH,0DA4DC;AAzID;;;;;GAKG;AACH,qDAJW,MAAM,cACN,MAAM,GACJ,MAAM,CAgBlB;AA4KD,0DAgCC;AAtSD,kCAA4B,SAAS,CAAC;AAmItC,mEAcC;AAuJD,2CAOC;AAED;;;;;;;;;;;;GAYG;AACH,6CARW,MAAM,GAAC,MAAM,kBACb,eAAS,GAKP,OAAO,CAAC,MAAM,EAAE,CAAC,CAmB7B;AAED;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;GAWG;AACH,gDAPW,MAAM,eACN,MAAM,GAAC,IAAI,kBAEX,aAAa,GACX,OAAO,CAAC,MAAM,CAAC,CA0B3B;AAoBD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,OAAO,CAUnB;AAED;;;;;;GAMG;AACH,0DAJW,MAAM,GACL,MAAM,CASjB;AArVD;;;GAGG;AACH,qCAHW,MAAM,EAAE,GACN,OAAO,CAAC,IAAI,CAAC,CA8BzB;AAuTD;;;;;;GAMG;AACH,sCAJW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,mBAW9B;cA7ca,QAAQ"}