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

package/build/lib/commands/recordscreen.js

@@ -0,0 +1,326 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScreenRecorder = void 0;
+exports.startRecordingScreen = startRecordingScreen;
+exports.stopRecordingScreen = stopRecordingScreen;
+const lodash_1 = __importDefault(require("lodash"));
+const support_1 = require("appium/support");
+const teen_process_1 = require("teen_process");
+const utils_1 = require("../utils");
+const appium_webdriveragent_1 = require("appium-webdriveragent");
+const asyncbox_1 = require("asyncbox");
+const url_1 = __importDefault(require("url"));
+/**
+ * Set max timeout for 'reconnect_delay_max' ffmpeg argument usage.
+ * It could have [0-4294] range limitation, thus this value should be less than that right now
+ * to return a better error message.
+ */
+const MAX_RECORDING_TIME_SEC = 4200;
+const DEFAULT_RECORDING_TIME_SEC = 60 * 3;
+const DEFAULT_FPS = 10;
+const DEFAULT_QUALITY = 'medium';
+const DEFAULT_MJPEG_SERVER_PORT = 9100;
+const DEFAULT_VCODEC = 'mjpeg';
+const MP4_EXT = '.mp4';
+const FFMPEG_BINARY = 'ffmpeg';
+const ffmpegLogger = support_1.logger.getLogger(FFMPEG_BINARY);
+const QUALITY_MAPPING = {
+    low: 10,
+    medium: 25,
+    high: 75,
+    photo: 100,
+};
+const HARDWARE_ACCELERATION_PARAMETERS = {
+    /* https://trac.ffmpeg.org/wiki/HWAccelIntro#VideoToolbox */
+    videoToolbox: {
+        hwaccel: 'videotoolbox',
+        hwaccelOutputFormat: 'videotoolbox_vld',
+        scaleFilterHWAccel: 'scale_vt',
+        videoTypeHWAccel: 'h264_videotoolbox',
+    },
+    /* https://trac.ffmpeg.org/wiki/HWAccelIntro#CUDANVENCNVDEC */
+    cuda: {
+        hwaccel: 'cuda',
+        hwaccelOutputFormat: 'cuda',
+        scaleFilterHWAccel: 'scale_cuda',
+        videoTypeHWAccel: 'h264_nvenc',
+    },
+    /* https://trac.ffmpeg.org/wiki/Hardware/AMF */
+    amf_dx11: {
+        hwaccel: 'd3d11va',
+        hwaccelOutputFormat: 'd3d11',
+        scaleFilterHWAccel: 'scale',
+        videoTypeHWAccel: 'av1_amf',
+    },
+    /* https://trac.ffmpeg.org/wiki/Hardware/QuickSync */
+    qsv: {
+        hwaccel: 'qsv',
+        hwaccelOutputFormat: '',
+        scaleFilterHWAccel: 'scale_qsv',
+        videoTypeHWAccel: 'h264_qsv'
+    },
+    /* https://trac.ffmpeg.org/wiki/Hardware/VAAPI */
+    vaapi: {
+        hwaccel: 'vaapi',
+        hwaccelOutputFormat: 'vaapi',
+        scaleFilterHWAccel: 'scale_vaapi',
+        videoTypeHWAccel: 'h264_vaapi'
+    }
+};
+const CAPTURE_START_MARKER = /^\s*frame=/;
+class ScreenRecorder {
+    constructor(udid, log, videoPath, opts = {}) {
+        this.videoPath = videoPath;
+        this.log = log;
+        this.opts = opts;
+        this.udid = udid;
+        this.mainProcess = null;
+        this.timeoutHandler = null;
+    }
+    async start(timeoutMs) {
+        try {
+            await support_1.fs.which(FFMPEG_BINARY);
+        }
+        catch {
+            throw new Error(`'${FFMPEG_BINARY}' binary is not found in PATH. Install it using 'brew install ffmpeg'. ` +
+                `Check https://www.ffmpeg.org/download.html for more details.`);
+        }
+        const { hardwareAcceleration, remotePort, remoteUrl, videoFps, videoType, videoScale, videoFilters, pixelFormat, } = this.opts;
+        const args = [
+            '-f',
+            'mjpeg',
+            // https://github.com/appium/appium/issues/16294
+            '-reconnect',
+            '1',
+            '-reconnect_at_eof',
+            '1',
+            '-reconnect_streamed',
+            '1',
+            '-reconnect_delay_max',
+            `${timeoutMs / 1000 + 1}`,
+        ];
+        const { hwaccel, hwaccelOutputFormat, scaleFilterHWAccel, videoTypeHWAccel } = HARDWARE_ACCELERATION_PARAMETERS[hardwareAcceleration] ?? {};
+        if (hwaccel) {
+            args.push('-hwaccel', hwaccel);
+        }
+        if (hwaccelOutputFormat) {
+            args.push('-hwaccel_output_format', hwaccelOutputFormat);
+        }
+        //Parameter `-r` is optional. See details: https://github.com/appium/appium/issues/12067
+        if (videoFps && videoType === 'libx264' || videoTypeHWAccel) {
+            args.push('-r', videoFps);
+        }
+        const { protocol, hostname } = url_1.default.parse(remoteUrl);
+        args.push('-i', `${protocol}//${hostname}:${remotePort}`);
+        if (videoFilters || videoScale) {
+            args.push('-vf', videoFilters || `${scaleFilterHWAccel || 'scale'}=${videoScale}`);
+        }
+        // Quicktime compatibility via pixelFormat: 'yuv420p'
+        if (pixelFormat) {
+            args.push('-pix_fmt', pixelFormat);
+        }
+        args.push('-vcodec', videoTypeHWAccel || videoType);
+        args.push('-y');
+        args.push(this.videoPath);
+        this.mainProcess = new teen_process_1.SubProcess(FFMPEG_BINARY, args);
+        let isCaptureStarted = false;
+        this.mainProcess.on('line-stderr', (line) => {
+            if (CAPTURE_START_MARKER.test(line)) {
+                if (!isCaptureStarted) {
+                    isCaptureStarted = true;
+                }
+            }
+            else {
+                ffmpegLogger.info(line);
+            }
+        });
+        await this.mainProcess.start(0);
+        const startupTimeout = 5000;
+        try {
+            await (0, asyncbox_1.waitForCondition)(() => isCaptureStarted, {
+                waitMs: startupTimeout,
+                intervalMs: 300,
+            });
+        }
+        catch {
+            this.log.warn(`Screen capture process did not start within ${startupTimeout}ms. Continuing anyway`);
+        }
+        if (!this.mainProcess.isRunning) {
+            throw new Error(`The screen capture process '${FFMPEG_BINARY}' died unexpectedly. ` +
+                `Check server logs for more details`);
+        }
+        this.log.info(`Starting screen capture on the device '${this.udid}' with command: '${FFMPEG_BINARY} ${args.join(' ')}'. ` + `Will timeout in ${timeoutMs}ms`);
+        this.timeoutHandler = setTimeout(async () => {
+            if (!(await this.interrupt())) {
+                this.log.warn(`Cannot finish the active screen recording on the device '${this.udid}' after ${timeoutMs}ms timeout`);
+            }
+        }, timeoutMs);
+    }
+    async interrupt(force = false) {
+        let result = true;
+        if (this.timeoutHandler) {
+            clearTimeout(this.timeoutHandler);
+            this.timeoutHandler = null;
+        }
+        if (this.mainProcess?.isRunning) {
+            const interruptPromise = this.mainProcess.stop(force ? 'SIGTERM' : 'SIGINT');
+            this.mainProcess = null;
+            try {
+                await interruptPromise;
+            }
+            catch (e) {
+                this.log.warn(`Cannot ${force ? 'terminate' : 'interrupt'} ${FFMPEG_BINARY}. ` +
+                    `Original error: ${e.message}`);
+                result = false;
+            }
+        }
+        return result;
+    }
+    async finish() {
+        await this.interrupt();
+        return this.videoPath;
+    }
+    async cleanup() {
+        if (await support_1.fs.exists(this.videoPath)) {
+            await support_1.fs.rimraf(this.videoPath);
+        }
+    }
+}
+exports.ScreenRecorder = ScreenRecorder;
+/**
+ * Direct Appium to start recording the device screen
+ *
+ * Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
+ * (ffmpeg utility is required: 'brew install ffmpeg').
+ * It records screen activity to a MPEG-4 file. Audio is not recorded with the video file.
+ * If screen recording has been already started then the command will stop it forcefully and start a new one.
+ * The previously recorded video file will be deleted.
+ *
+ * @param {import('./types').StartRecordingScreenOptions} [options] - The available options.
+ * @returns {Promise<string>} Base64-encoded content of the recorded media file if
+ *                   any screen recording is currently running or an empty string.
+ * @throws {Error} If screen recording has failed to start.
+ * @this {XCUITestDriver}
+ */
+async function startRecordingScreen(options = {}) {
+    const { videoType = DEFAULT_VCODEC, timeLimit = DEFAULT_RECORDING_TIME_SEC, videoQuality = DEFAULT_QUALITY, videoFps = DEFAULT_FPS, videoFilters, videoScale, forceRestart, pixelFormat, hardwareAcceleration } = options;
+    let result = '';
+    if (!forceRestart) {
+        this.log.info(`Checking if there is/was a previous screen recording. ` +
+            `Set 'forceRestart' option to 'true' if you'd like to skip this step.`);
+        result = (await this.stopRecordingScreen(options)) ?? result;
+    }
+    const videoPath = await support_1.tempDir.path({
+        prefix: `appium_${Math.random().toString(16).substring(2, 8)}`,
+        suffix: MP4_EXT
+    });
+    const wdaBaseUrl = this.opts.wdaBaseUrl || appium_webdriveragent_1.WDA_BASE_URL;
+    const screenRecorder = new ScreenRecorder(this.device.udid, this.log, videoPath, {
+        remotePort: this.opts.mjpegServerPort || DEFAULT_MJPEG_SERVER_PORT,
+        remoteUrl: wdaBaseUrl,
+        videoType,
+        videoFilters,
+        videoScale,
+        videoFps,
+        pixelFormat,
+        hardwareAcceleration
+    });
+    if (!(await screenRecorder.interrupt(true))) {
+        throw this.log.errorWithException('Unable to stop screen recording process');
+    }
+    if (this._recentScreenRecorder) {
+        await this._recentScreenRecorder.cleanup();
+        this._recentScreenRecorder = null;
+    }
+    const timeoutSeconds = parseFloat(String(timeLimit));
+    if (isNaN(timeoutSeconds) || timeoutSeconds > MAX_RECORDING_TIME_SEC || timeoutSeconds <= 0) {
+        throw this.log.errorWithException(`The timeLimit value must be in range [1, ${MAX_RECORDING_TIME_SEC}] seconds. ` +
+            `The value of '${timeLimit}' has been passed instead.`);
+    }
+    let { mjpegServerScreenshotQuality, mjpegServerFramerate } = 
+    /** @type {import('appium-webdriveragent').WDASettings} */ (await this.proxyCommand('/appium/settings', 'GET'));
+    if (videoQuality) {
+        const quality = lodash_1.default.isInteger(videoQuality)
+            ? videoQuality
+            : QUALITY_MAPPING[lodash_1.default.toLower(String(videoQuality))];
+        if (!quality) {
+            throw new Error(`videoQuality value should be one of ${JSON.stringify(lodash_1.default.keys(QUALITY_MAPPING))} or a number in range 1..100. ` + `'${videoQuality}' is given instead`);
+        }
+        mjpegServerScreenshotQuality = mjpegServerScreenshotQuality !== quality ? quality : undefined;
+    }
+    else {
+        mjpegServerScreenshotQuality = undefined;
+    }
+    if (videoFps) {
+        const fps = parseInt(String(videoFps), 10);
+        if (isNaN(fps)) {
+            throw new Error(`videoFps value should be a valid number in range 1..60. ` +
+                `'${videoFps}' is given instead`);
+        }
+        mjpegServerFramerate = mjpegServerFramerate !== fps ? fps : undefined;
+    }
+    else {
+        mjpegServerFramerate = undefined;
+    }
+    if (support_1.util.hasValue(mjpegServerScreenshotQuality) || support_1.util.hasValue(mjpegServerFramerate)) {
+        await this.proxyCommand('/appium/settings', 'POST', {
+            settings: {
+                mjpegServerScreenshotQuality,
+                mjpegServerFramerate
+            }
+        });
+    }
+    try {
+        await screenRecorder.start(timeoutSeconds * 1000);
+    }
+    catch (e) {
+        await screenRecorder.interrupt(true);
+        await screenRecorder.cleanup();
+        throw e;
+    }
+    this._recentScreenRecorder = screenRecorder;
+    return result;
+}
+/**
+ * Direct Appium to stop screen recording and return the video
+ *
+ * If no screen recording process is running then the endpoint will try to get
+ * the recently recorded file. If no previously recorded file is found and no
+ * active screen recording processes are running then the method returns an
+ * empty string.
+ *
+ * @param {import('./types').StopRecordingScreenOptions} options - The available
+ * options.
+ * @returns {Promise<string?>} Base64-encoded content of the recorded media
+ * file if `remotePath` parameter is empty or null or an empty string.
+ * @throws {Error} If there was an error while getting the name of a media
+ *                 file or the file content cannot be uploaded to the remote
+ *                 location.
+ * @this {XCUITestDriver}
+ */
+async function stopRecordingScreen(options = {}) {
+    if (!this._recentScreenRecorder) {
+        this.log.info('Screen recording is not running. There is nothing to stop.');
+        return '';
+    }
+    try {
+        const videoPath = await this._recentScreenRecorder.finish();
+        if (!(await support_1.fs.exists(videoPath))) {
+            throw this.log.errorWithException(`The screen recorder utility has failed ` +
+                `to store the actual screen recording at '${videoPath}'`);
+        }
+        return await (0, utils_1.encodeBase64OrUpload)(videoPath, options.remotePath, options);
+    }
+    finally {
+        await this._recentScreenRecorder.interrupt(true);
+        await this._recentScreenRecorder.cleanup();
+        this._recentScreenRecorder = null;
+    }
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=recordscreen.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recordscreen.js","sourceRoot":"","sources":["../../../lib/commands/recordscreen.js"],"names":[],"mappings":";;;;;;AAmPA,oDAwGC;AAmBD,kDAoBC;AAlYD,oDAAuB;AACvB,4CAAyD;AACzD,+CAAwC;AACxC,oCAA8C;AAC9C,iEAAmD;AACnD,uCAA0C;AAC1C,8CAAsB;AAEtB;;;;GAIG;AACH,MAAM,sBAAsB,GAAG,IAAI,CAAC;AACpC,MAAM,0BAA0B,GAAG,EAAE,GAAG,CAAC,CAAC;AAC1C,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,eAAe,GAAG,QAAQ,CAAC;AACjC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AACvC,MAAM,cAAc,GAAG,OAAO,CAAC;AAC/B,MAAM,OAAO,GAAG,MAAM,CAAC;AACvB,MAAM,aAAa,GAAG,QAAQ,CAAC;AAC/B,MAAM,YAAY,GAAG,gBAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AACrD,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;IACV,IAAI,EAAE,EAAE;IACR,KAAK,EAAE,GAAG;CACX,CAAC;AAEF,MAAM,gCAAgC,GAAG;IACvC,4DAA4D;IAC5D,YAAY,EAAE;QACZ,OAAO,EAAE,cAAc;QACvB,mBAAmB,EAAE,kBAAkB;QACvC,kBAAkB,EAAE,UAAU;QAC9B,gBAAgB,EAAE,mBAAmB;KACtC;IACD,8DAA8D;IAC9D,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM;QACf,mBAAmB,EAAE,MAAM;QAC3B,kBAAkB,EAAE,YAAY;QAChC,gBAAgB,EAAE,YAAY;KAC/B;IACD,+CAA+C;IAC/C,QAAQ,EAAE;QACR,OAAO,EAAE,SAAS;QAClB,mBAAmB,EAAE,OAAO;QAC5B,kBAAkB,EAAE,OAAO;QAC3B,gBAAgB,EAAE,SAAS;KAC5B;IACD,qDAAqD;IACrD,GAAG,EAAE;QACH,OAAO,EAAE,KAAK;QACd,mBAAmB,EAAE,EAAE;QACvB,kBAAkB,EAAE,WAAW;QAC/B,gBAAgB,EAAE,UAAU;KAC7B;IACD,iDAAiD;IACjD,KAAK,EAAE;QACL,OAAO,EAAE,OAAO;QAChB,mBAAmB,EAAE,OAAO;QAC5B,kBAAkB,EAAE,aAAa;QACjC,gBAAgB,EAAE,YAAY;KAC/B;CACF,CAAC;AAEF,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAE1C,MAAa,cAAc;IACzB,YAAY,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE;QACzC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,SAAS;QACnB,IAAI,CAAC;YACH,MAAM,YAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CACb,IAAI,aAAa,yEAAyE;gBACxF,8DAA8D,CACjE,CAAC;QACJ,CAAC;QAED,MAAM,EACJ,oBAAoB,EACpB,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,EACT,UAAU,EACV,YAAY,EACZ,WAAW,GACZ,GAAG,IAAI,CAAC,IAAI,CAAC;QAEd,MAAM,IAAI,GAAG;YACX,IAAI;YACJ,OAAO;YACP,gDAAgD;YAChD,YAAY;YACZ,GAAG;YACH,mBAAmB;YACnB,GAAG;YACH,qBAAqB;YACrB,GAAG;YACH,sBAAsB;YACtB,GAAG,SAAS,GAAG,IAAI,GAAG,CAAC,EAAE;SAC1B,CAAC;QACF,MAAM,EACJ,OAAO,EACP,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EACjB,GAAG,gCAAgC,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;QAEjE,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,mBAAmB,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;QAC3D,CAAC;QAED,wFAAwF;QACxF,IAAI,QAAQ,IAAI,SAAS,KAAK,SAAS,IAAI,gBAAgB,EAAE,CAAC;YAC5D,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,EAAC,QAAQ,EAAE,QAAQ,EAAC,GAAG,aAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,QAAQ,KAAK,QAAQ,IAAI,UAAU,EAAE,CAAC,CAAC;QAE1D,IAAI,YAAY,IAAI,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,IAAI,GAAG,kBAAkB,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACrF,CAAC;QAED,qDAAqD;QACrD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,IAAI,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE1B,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACvD,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1C,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACtB,gBAAgB,GAAG,IAAI,CAAC;gBAC1B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,cAAc,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,IAAA,2BAAgB,EAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE;gBAC7C,MAAM,EAAE,cAAc;gBACtB,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,+CAA+C,cAAc,uBAAuB,CACrF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,+BAA+B,aAAa,uBAAuB;gBACjE,oCAAoC,CACvC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,0CACE,IAAI,CAAC,IACP,oBAAoB,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,mBAAmB,SAAS,IAAI,CAC5F,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;YAC1C,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,4DAA4D,IAAI,CAAC,IAAI,WAAW,SAAS,YAAY,CACtG,CAAC;YACJ,CAAC;QACH,CAAC,EAAE,SAAS,CAAC,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAK,GAAG,KAAK;QAC3B,IAAI,MAAM,GAAG,IAAI,CAAC;QAElB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAClC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC7E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,gBAAgB,CAAC;YACzB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,UAAU,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,IAAI,aAAa,IAAI;oBAC9D,mBAAmB,CAAC,CAAC,OAAO,EAAE,CACjC,CAAC;gBACF,MAAM,GAAG,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACpC,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF;AA7JD,wCA6JC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,oBAAoB,CAAC,OAAO,GAAG,EAAE;IACrD,MAAM,EACJ,SAAS,GAAG,cAAc,EAC1B,SAAS,GAAG,0BAA0B,EACtC,YAAY,GAAG,eAAe,EAC9B,QAAQ,GAAG,WAAW,EACtB,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,oBAAoB,EACrB,GAAG,OAAO,CAAC;IAEZ,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,wDAAwD;YACxD,sEAAsE,CACvE,CAAC;QACF,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,IAAI,MAAM,CAAC;IAC/D,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,iBAAO,CAAC,IAAI,CAAC;QACnC,MAAM,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QAC9D,MAAM,EAAE,OAAO;KAChB,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,oCAAY,CAAC;IACxD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE;QAC/E,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,yBAAyB;QAClE,SAAS,EAAE,UAAU;QACrB,SAAS;QACT,YAAY;QACZ,UAAU;QACV,QAAQ;QACR,WAAW;QACX,oBAAoB;KACrB,CAAC,CAAC;IACH,IAAI,CAAC,CAAC,MAAM,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,yCAAyC,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;IACpC,CAAC;IAED,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,cAAc,GAAG,sBAAsB,IAAI,cAAc,IAAI,CAAC,EAAE,CAAC;QAC5F,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,4CAA4C,sBAAsB,aAAa;YAC7E,iBAAiB,SAAS,4BAA4B,CACzD,CAAC;IACJ,CAAC;IAED,IAAI,EAAC,4BAA4B,EAAE,oBAAoB,EAAC;IACtD,0DAA0D,CAAC,CAC3D,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,CACnD,CAAC;IACF,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,OAAO,GAAG,gBAAC,CAAC,SAAS,CAAC,YAAY,CAAC;YACvC,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,eAAe,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAI,CAAC,SAAS,CACnD,gBAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CACxB,gCAAgC,GAAG,IAAI,YAAY,oBAAoB,CACzE,CAAC;QACJ,CAAC;QACD,4BAA4B,GAAG,4BAA4B,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;SAAM,CAAC;QACN,4BAA4B,GAAG,SAAS,CAAC;IAC3C,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,0DAA0D;gBAC1D,IAAI,QAAQ,oBAAoB,CACjC,CAAC;QACJ,CAAC;QACD,oBAAoB,GAAG,oBAAoB,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,CAAC;SAAM,CAAC;QACN,oBAAoB,GAAG,SAAS,CAAC;IACnC,CAAC;IACD,IAAI,cAAI,CAAC,QAAQ,CAAC,4BAA4B,CAAC,IAAI,cAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACvF,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,EAAE;YAClD,QAAQ,EAAE;gBACR,4BAA4B;gBAC5B,oBAAoB;aACrB;SACF,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC;QACH,MAAM,cAAc,CAAC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,CAAC,CAAC;IACV,CAAC;IACD,IAAI,CAAC,qBAAqB,GAAG,cAAc,CAAC;IAE5C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,mBAAmB,CAAC,OAAO,GAAG,EAAE;IACpD,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;QAC5E,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,CAAC;QAC5D,IAAI,CAAC,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,yCAAyC;gBACzC,4CAA4C,SAAS,GAAG,CACzD,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,IAAA,4BAAoB,EAAC,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;IACpC,CAAC;AACH,CAAC;AAED;;GAEG"}

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

@@ -0,0 +1,16 @@
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>}
+ */
+export function getScreenshot(this: import("../driver").XCUITestDriver): Promise<string>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function getElementScreenshot(this: import("../driver").XCUITestDriver, el: any): Promise<string>;
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>}
+ */
+export function getViewportScreenshot(this: import("../driver").XCUITestDriver): Promise<string>;
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=screenshots.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"screenshots.d.ts","sourceRoot":"","sources":["../../../lib/commands/screenshots.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH,yEAFa,OAAO,CAAC,MAAM,CAAC,CAgE3B;AAED;;GAEG;AACH,yGAoBC;AAED;;;GAGG;AACH,iFAFa,OAAO,CAAC,MAAM,CAAC,CAgC3B;6BAGY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/screenshots.js

@@ -0,0 +1,129 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getScreenshot = getScreenshot;
+exports.getElementScreenshot = getElementScreenshot;
+exports.getViewportScreenshot = getViewportScreenshot;
+const asyncbox_1 = require("asyncbox");
+const lodash_1 = __importDefault(require("lodash"));
+const driver_1 = require("appium/driver");
+const support_1 = require("appium/support");
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>}
+ */
+async function getScreenshot() {
+    if (this.isWebContext()) {
+        const webScreenshotMode = (await this.settings.getSettings()).webScreenshotMode;
+        switch (lodash_1.default.toLower(webScreenshotMode)) {
+            case 'page':
+            case 'viewport':
+                return await ( /** @type {import('appium-remote-debugger').RemoteDebugger} */(this.remote)).captureScreenshot({
+                    coordinateSystem: /** @type {'Viewport'|'Page'} */ (lodash_1.default.capitalize(webScreenshotMode)),
+                });
+            case 'native':
+            case undefined:
+            case null:
+                break;
+            default:
+                this.log.warn(`The webScreenshotMode setting value '${webScreenshotMode}' is not known. ` +
+                    `Supported values are: page, viewport and native. Falling back to the native mode.`);
+                break;
+        }
+    }
+    const getScreenshotFromWDA = async () => {
+        this.log.debug(`Taking screenshot with WDA`);
+        const data = await this.proxyCommand('/screenshot', 'GET');
+        if (!lodash_1.default.isString(data)) {
+            throw new Error(`Unable to take screenshot. WDA returned '${JSON.stringify(data)}'`);
+        }
+        return data;
+    };
+    // if we've specified an mjpeg server, use that
+    if (this.mjpegStream) {
+        this.log.info(`mjpeg video stream provided, returning latest frame as screenshot`);
+        const data = await this.mjpegStream.lastChunkPNGBase64();
+        if (data) {
+            return data;
+        }
+        this.log.warn('Tried to get screenshot from active MJPEG stream, but there ' +
+            'was no data yet. Falling back to regular screenshot methods.');
+    }
+    try {
+        return await getScreenshotFromWDA();
+    }
+    catch (err) {
+        this.log.warn(`Error getting screenshot: ${err.message}`);
+    }
+    // simulator attempt
+    if (this.isSimulator()) {
+        this.log.info(`Falling back to 'simctl io screenshot' API`);
+        const payload = await /** @type {import('../driver').Simulator} */ (this.device).simctl.getScreenshot();
+        if (!payload) {
+            throw new driver_1.errors.UnableToCaptureScreen();
+        }
+        return payload;
+    }
+    // Retry for real devices only. Fail fast on Simulator if simctl does not work as expected
+    return /** @type {string} */ (await (0, asyncbox_1.retryInterval)(2, 1000, getScreenshotFromWDA));
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function getElementScreenshot(el) {
+    el = support_1.util.unwrapElement(el);
+    if (this.isWebContext()) {
+        const atomsElement = this.getAtomsElement(el);
+        const { width, height } = await this.executeAtom('get_size', [atomsElement]);
+        if (!width || !height) {
+            throw new driver_1.errors.UnableToCaptureScreen('Cannot take a screenshot of a zero-size element');
+        }
+        const { x, y } = await this.executeAtom('get_top_left_coordinates', [atomsElement]);
+        return await ( /** @type {import('appium-remote-debugger').RemoteDebugger} */(this.remote))
+            .captureScreenshot({ rect: { x, y, width, height } });
+    }
+    const data = await this.proxyCommand(`/element/${el}/screenshot`, 'GET');
+    if (!lodash_1.default.isString(data)) {
+        throw new driver_1.errors.UnableToCaptureScreen(`Unable to take an element screenshot. WDA returned: ${JSON.stringify(data)}`);
+    }
+    return data;
+}
+/**
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>}
+ */
+async function getViewportScreenshot() {
+    if (this.isWebContext()) {
+        return await ( /** @type {import('appium-remote-debugger').RemoteDebugger} */(this.remote))
+            .captureScreenshot();
+    }
+    const screenshot = await this.getScreenshot();
+    // if we don't have a status bar, there's nothing to crop, so we can avoid
+    // extra calls and return straight away
+    if ((await this.getStatusBarHeight()) === 0) {
+        return screenshot;
+    }
+    const sharp = support_1.imageUtil.requireSharp();
+    const { width, height } = await sharp(Buffer.from(screenshot, 'base64')).metadata();
+    if (!width || !height) {
+        throw new driver_1.errors.UnableToCaptureScreen('The device screenshot is empty');
+    }
+    this.log.debug(`Screenshot dimensions: ${width}x${height}`);
+    const region = await this.getViewportRect();
+    if (region.width + region.left > width) {
+        this.log.info('Viewport region exceeds screenshot width, adjusting region to fit');
+        region.width = width - region.left;
+    }
+    if (region.height + region.top > height) {
+        this.log.info('Viewport region exceeds screenshot height, adjusting region to fit');
+        region.height = height - region.top;
+    }
+    this.log.debug(`Calculated viewport rect: ${JSON.stringify(region)}`);
+    return await support_1.imageUtil.cropBase64Image(screenshot, region);
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=screenshots.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../../../lib/commands/screenshots.js"],"names":[],"mappings":";;;;;AASA,sCA8DC;AAKD,oDAoBC;AAMD,sDA8BC;AApID,uCAAuC;AACvC,oDAAuB;AACvB,0CAAqC;AACrC,4CAA+C;AAE/C;;;GAGG;AACI,KAAK,UAAU,aAAa;IACjC,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,iBAAiB,CAAC;QAChF,QAAQ,gBAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACrC,KAAK,MAAM,CAAC;YACZ,KAAK,UAAU;gBACb,OAAO,MAAM,EAAC,8DAA+D,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC;oBAC5G,gBAAgB,EAAE,gCAAgC,CAAC,CAAC,gBAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;iBACrF,CAAC,CAAC;YACL,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,IAAI;gBACP,MAAM;YACR;gBACE,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,wCAAwC,iBAAiB,kBAAkB;oBAC3E,mFAAmF,CACpF,CAAC;gBACF,MAAM;QACV,CAAC;IACH,CAAC;IAED,MAAM,oBAAoB,GAAG,KAAK,IAAI,EAAE;QACtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,+CAA+C;IAC/C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC;QACzD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,8DAA8D;YAC5D,8DAA8D,CACjE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,oBAAoB,EAAE,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,oBAAoB;IACpB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QACxG,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,eAAM,CAAC,qBAAqB,EAAE,CAAC;QAC3C,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,0FAA0F;IAC1F,OAAO,qBAAqB,CAAC,CAAC,MAAM,IAAA,wBAAa,EAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC;AACpF,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,oBAAoB,CAAC,EAAE;IAC3C,EAAE,GAAG,cAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC5B,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YACtB,MAAM,IAAI,eAAM,CAAC,qBAAqB,CAAC,iDAAiD,CAAC,CAAC;QAC5F,CAAC;QACD,MAAM,EAAC,CAAC,EAAE,CAAC,EAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;QAClF,OAAO,MAAM,EAAC,8DAA+D,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACxF,iBAAiB,CAAC,EAAC,IAAI,EAAE,EAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAC,EAAC,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;IACzE,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,eAAM,CAAC,qBAAqB,CACpC,uDAAuD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAC9E,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,qBAAqB;IACzC,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,OAAO,MAAM,EAAC,8DAA+D,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACxF,iBAAiB,EAAE,CAAC;IACzB,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IAC9C,0EAA0E;IAC1E,uCAAuC;IACvC,IAAI,CAAC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,KAAK,GAAG,mBAAS,CAAC,YAAY,EAAE,CAAC;IACvC,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAClF,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,IAAI,eAAM,CAAC,qBAAqB,CAAC,gCAAgC,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,KAAK,IAAI,MAAM,EAAE,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;IAC5C,IAAI,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,GAAG,KAAK,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QACnF,MAAM,CAAC,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;IACrC,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,GAAG,MAAM,EAAE,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;QACpF,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC;IACtC,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtE,OAAO,MAAM,mBAAS,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED;;GAEG"}

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

@@ -0,0 +1,27 @@
+/**
+ * Run the given command with arguments as `xcrun simctl` subcommand.
+ * This method works behind the 'simctl' security flag.
+ * @this {XCUITestDriver}
+ * @param {string} command Subcommand to run with `xcrun simctl`
+ * @param {string[]} [args=[]] arguments for the subcommand. The arguments should be after <device> in the help.
+ * @param {number|undefined} timeout - The maximum number of milliseconds
+ * @returns {Promise<SimctlExecResponse>}
+ * @throws {Error} If the simctl subcommand command returns non-zero return code, or the given subcommand was invalid.
+ */
+export function mobileSimctl(this: import("./../driver").XCUITestDriver, command: string, args?: string[], timeout?: number | undefined): Promise<SimctlExecResponse>;
+export type SimctlExecResponse = {
+    /**
+     * The output of standard out.
+     */
+    stdout: Buffer<ArrayBufferLike>;
+    /**
+     * The output of standard error.
+     */
+    stderr: Buffer<ArrayBufferLike>;
+    /**
+     * Return code.
+     */
+    code: number;
+};
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=simctl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"simctl.d.ts","sourceRoot":"","sources":["../../../lib/commands/simctl.js"],"names":[],"mappings":"AA+BA;;;;;;;;;GASG;AACH,kFANW,MAAM,SACN,MAAM,EAAE,YACR,MAAM,GAAC,SAAS,GACd,OAAO,CAAC,kBAAkB,CAAC,CAqBvC;;;;;YAIa,MAAM,CAAC,eAAe,CAAC;;;;YACvB,MAAM,CAAC,eAAe,CAAC;;;;UACvB,MAAM;;6BAIP,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/simctl.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileSimctl = mobileSimctl;
+const driver_1 = require("appium/driver");
+/**
+ * List of subcommands for `simctl` we provide as mobile simctl command.
+ * They accept 'device' target.
+ */
+const SUBCOMMANDS_HAS_DEVICE = [
+    'boot',
+    'get_app_container',
+    'getenv',
+    'icloud_sync',
+    'install',
+    'install_app_data',
+    'io',
+    'keychain',
+    'launch',
+    'location',
+    'logverbose',
+    'openurl',
+    'pbcopy',
+    'pbpaste',
+    'privacy',
+    'push',
+    'shutdown',
+    'spawn',
+    'status_bar',
+    'terminate',
+    'ui',
+    'uninstall'
+];
+/**
+ * Run the given command with arguments as `xcrun simctl` subcommand.
+ * This method works behind the 'simctl' security flag.
+ * @this {XCUITestDriver}
+ * @param {string} command Subcommand to run with `xcrun simctl`
+ * @param {string[]} [args=[]] arguments for the subcommand. The arguments should be after <device> in the help.
+ * @param {number|undefined} timeout - The maximum number of milliseconds
+ * @returns {Promise<SimctlExecResponse>}
+ * @throws {Error} If the simctl subcommand command returns non-zero return code, or the given subcommand was invalid.
+ */
+async function mobileSimctl(command, args = [], timeout = undefined) {
+    if (!this.isSimulator()) {
+        throw new driver_1.errors.UnsupportedOperationError(`Only simulator is supported.`);
+    }
+    if (!this.opts.udid) {
+        throw new driver_1.errors.InvalidArgumentError(`Unknown device or simulator UDID: '${this.opts.udid}'`);
+    }
+    if (!SUBCOMMANDS_HAS_DEVICE.includes(command)) {
+        throw new driver_1.errors.InvalidArgumentError(`The given command '${command}' is not supported. ` +
+            `Available subcommands are ${SUBCOMMANDS_HAS_DEVICE.join(',')}`);
+    }
+    return await /** @type {import('./../driver').Simulator} */ (this.device).simctl.exec(command, { args: [this.opts.udid, ...args], timeout });
+}
+/**
+ * @typedef {Object} SimctlExecResponse
+ * @property {Buffer<ArrayBufferLike>} stdout The output of standard out.
+ * @property {Buffer<ArrayBufferLike>} stderr The output of standard error.
+ * @property {number} code Return code.
+ */
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=simctl.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"simctl.js","sourceRoot":"","sources":["../../../lib/commands/simctl.js"],"names":[],"mappings":";;AAyCA,oCAkBC;AA3DD,0CAAuC;AAEvC;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC7B,MAAM;IACN,mBAAmB;IACnB,QAAQ;IACR,aAAa;IACb,SAAS;IACT,kBAAkB;IAClB,IAAI;IACJ,UAAU;IACV,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,SAAS;IACT,QAAQ;IACR,SAAS;IACT,SAAS;IACT,MAAM;IACN,UAAU;IACV,OAAO;IACP,YAAY;IACZ,WAAW;IACX,IAAI;IACJ,WAAW;CACZ,CAAC;AAEF;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,GAAG,SAAS;IACxE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,eAAM,CAAC,yBAAyB,CAAC,8BAA8B,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,sCAAsC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,sBAAsB,OAAO,sBAAsB;YACvF,6BAA6B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,MAAM,8CAA8C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CACnF,OAAO,EACP,EAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,OAAO,EAAC,CAC3C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AAEH;;GAEG"}

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

@@ -0,0 +1,16 @@
+/**
+ * @this {XCUITestDriver}
+ */
+export function getPageSource(this: import("../driver").XCUITestDriver): Promise<any>;
+/**
+ * Retrieve the source tree of the current page in XML or JSON format.
+ *
+ * @param {import('./types').SourceFormat} format - Page tree source representation format.
+ * @param {string} [excludedAttributes] A comma-separated string of attribute names to exclude from the output. Only works if `format` is `xml`.
+ * @privateRemarks Why isn't `excludedAttributes` an array?
+ * @returns {Promise<string>} The source tree of the current page in the given format.
+ * @this {XCUITestDriver}
+ */
+export function mobileGetSource(this: import("../driver").XCUITestDriver, format?: import("./types").SourceFormat, excludedAttributes?: string): Promise<string>;
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=source.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../lib/commands/source.js"],"names":[],"mappings":"AAKA;;GAEG;AACH,sFAiBC;AAED;;;;;;;;GAQG;AACH,mFANW,OAAO,SAAS,EAAE,YAAY,uBAC9B,MAAM,GAEJ,OAAO,CAAC,MAAM,CAAC,CAe3B;6BAiFY,OAAO,WAAW,EAAE,cAAc"}