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

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

@@ -0,0 +1,23 @@
+/**
+ * Sets the Simulator's pasteboard content to the given value.
+ *
+ * Does not work for real devices.
+ * @param {string} content - The content to set
+ * @param {string} encoding - The content's encoding
+ * @group Simulator Only
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function mobileSetPasteboard(this: import("../driver").XCUITestDriver, content: string, encoding?: string): Promise<void>;
+/**
+ * Gets the Simulator's pasteboard content.
+ *
+ * Does not work for real devices.
+ * @param {BufferEncoding} encoding - Expected encoding of returned string
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>} The pasteboard content string
+ */
+export function mobileGetPasteboard(this: import("../driver").XCUITestDriver, encoding?: BufferEncoding): Promise<string>;
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=pasteboard.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pasteboard.d.ts","sourceRoot":"","sources":["../../../lib/commands/pasteboard.js"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,uFANW,MAAM,aACN,MAAM,GAEJ,OAAO,CAAC,IAAI,CAAC,CAczB;AAED;;;;;;;;GAQG;AACH,yFALW,cAAc,GAGZ,OAAO,CAAC,MAAM,CAAC,CAO3B;6BAGY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/pasteboard.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileSetPasteboard = mobileSetPasteboard;
+exports.mobileGetPasteboard = mobileGetPasteboard;
+/**
+ * Sets the Simulator's pasteboard content to the given value.
+ *
+ * Does not work for real devices.
+ * @param {string} content - The content to set
+ * @param {string} encoding - The content's encoding
+ * @group Simulator Only
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+async function mobileSetPasteboard(content, encoding = 'utf8') {
+    if (!this.isSimulator()) {
+        throw new Error('Setting pasteboard content is not supported on real devices');
+    }
+    if (!content) {
+        // can be empty string
+        throw new Error('Pasteboard content is mandatory to set');
+    }
+    return await /** @type {import('../driver').Simulator} */ (this.device).simctl.setPasteboard(content, /** @type {BufferEncoding} */ (encoding));
+}
+/**
+ * Gets the Simulator's pasteboard content.
+ *
+ * Does not work for real devices.
+ * @param {BufferEncoding} encoding - Expected encoding of returned string
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ * @returns {Promise<string>} The pasteboard content string
+ */
+async function mobileGetPasteboard(encoding = 'utf8') {
+    if (!this.isSimulator()) {
+        throw new Error('Getting pasteboard content is not supported on real devices');
+    }
+    return await /** @type {import('../driver').Simulator} */ (this.device).simctl.getPasteboard(encoding);
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=pasteboard.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pasteboard.js","sourceRoot":"","sources":["../../../lib/commands/pasteboard.js"],"names":[],"mappings":";;AAUA,kDAWC;AAWD,kDAKC;AArCD;;;;;;;;;GASG;AACI,KAAK,UAAU,mBAAmB,CAAC,OAAO,EAAE,QAAQ,GAAG,MAAM;IAClE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACjF,CAAC;IACD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,sBAAsB;QACtB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,aAAa,CAC1F,OAAO,EAAE,6BAA6B,CAAC,CAAC,QAAQ,CAAC,CAClD,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,mBAAmB,CAAC,QAAQ,GAAG,MAAM;IACzD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AACzG,CAAC;AAED;;GAEG"}

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

@@ -0,0 +1,54 @@
+/**
+ * Records the given network traffic capture into a .pcap file.
+ *
+ * @param {number} timeLimitSec - The maximum recording time, in seconds. The maximum value is `43200` (12 hours).
+ * @param {boolean} forceRestart - Whether to restart traffic capture process forcefully when startPcap is called (`true`) or ignore the call until the current traffic capture is completed (`false`, the default value).
+ * @throws {Error} If network traffic capture has failed to start.
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function mobileStartPcap(this: import("../driver").XCUITestDriver, timeLimitSec?: number, forceRestart?: boolean): Promise<void>;
+export class mobileStartPcap {
+    /**
+     * Records the given network traffic capture into a .pcap file.
+     *
+     * @param {number} timeLimitSec - The maximum recording time, in seconds. The maximum value is `43200` (12 hours).
+     * @param {boolean} forceRestart - Whether to restart traffic capture process forcefully when startPcap is called (`true`) or ignore the call until the current traffic capture is completed (`false`, the default value).
+     * @throws {Error} If network traffic capture has failed to start.
+     * @returns {Promise<void>}
+     * @this {XCUITestDriver}
+     */
+    constructor(this: import("../driver").XCUITestDriver, timeLimitSec?: number, forceRestart?: boolean);
+    _trafficCapture: TrafficCapture;
+}
+/**
+ * Stops network traffic capture.
+ *
+ * If no traffic capture process is running, then the endpoint will try to get the recently recorded file.
+ *
+ * If no previously recorded file is found and no active traffic capture processes are running, then the method returns an empty string.
+ *
+ * @remarks Network capture files can be viewed in [Wireshark](https://www.wireshark.org/) and other similar applications.
+ * @returns {Promise<string>} Base64-encoded content of the recorded pcap file or an empty string if no traffic capture has been started before.
+ * @throws {Error} If there was an error while getting the capture file.
+ * @this {XCUITestDriver}
+ */
+export function mobileStopPcap(this: import("../driver").XCUITestDriver): Promise<string>;
+export class mobileStopPcap {
+    _trafficCapture: any;
+}
+export class TrafficCapture {
+    constructor(udid: any, log: any, resultPath: any);
+    /** @type {import('teen_process').SubProcess|null} */
+    mainProcess: any | null;
+    udid: any;
+    log: any;
+    resultPath: any;
+    start(timeoutSeconds: any): Promise<void>;
+    isCapturing(): boolean;
+    interrupt(force?: boolean): Promise<boolean>;
+    finish(): Promise<any>;
+    cleanup(): Promise<void>;
+}
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=pcap.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pcap.d.ts","sourceRoot":"","sources":["../../../lib/commands/pcap.js"],"names":[],"mappings":"AAyEA;;;;;;;;GAQG;AACH,yFANW,MAAM,iBACN,OAAO,GAEL,OAAO,CAAC,IAAI,CAAC,CAgDzB;;IAtDD;;;;;;;;OAQG;IACH,qEANW,MAAM,iBACN,OAAO,EAkDjB;IAzBG,gCAA2B;;AA2B/B;;;;;;;;;;;GAWG;AACH,0EAJa,OAAO,CAAC,MAAM,CAAC,CA0B3B;;IAJG,qBAA2B;;AAvJ/B;IAGE,kDAKC;IAPD,qDAAqD;IACrD,aADW,GAAiC,GAAC,IAAI,CACrC;IAEV,UAAgB;IAChB,SAAc;IACd,gBAA4B;IAI9B,0CAmBC;IAED,uBAEC;IAED,6CAgBC;IAED,uBAGC;IAED,yBAIC;CACF;6BA+FY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/pcap.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrafficCapture = void 0;
+exports.mobileStartPcap = mobileStartPcap;
+exports.mobileStopPcap = mobileStopPcap;
+const py_ios_device_client_1 = require("../real-device-clients/py-ios-device-client");
+const support_1 = require("appium/support");
+const utils_1 = require("../utils");
+const driver_1 = require("appium/driver");
+const MAX_CAPTURE_TIME_SEC = 60 * 60 * 12;
+const DEFAULT_EXT = '.pcap';
+class TrafficCapture {
+    /** @type {import('teen_process').SubProcess|null} */
+    mainProcess;
+    constructor(udid, log, resultPath) {
+        this.udid = udid;
+        this.log = log;
+        this.resultPath = resultPath;
+        this.mainProcess = null;
+    }
+    async start(timeoutSeconds) {
+        this.mainProcess = /** @type {import('teen_process').SubProcess} */ (await new py_ios_device_client_1.Pyidevice({
+            udid: this.udid,
+            log: this.log,
+        }).collectPcap(this.resultPath));
+        this.mainProcess.on('line-stderr', (line) => this.log.info(`[Pcap] ${line}`));
+        this.log.info(`Starting network traffic capture session on the device '${this.udid}'. ` +
+            `Will timeout in ${timeoutSeconds}s`);
+        setTimeout(async () => await this.interrupt(), timeoutSeconds * 1000);
+        this.mainProcess.once('exit', (code, signal) => {
+            this.log.debug(`The traffic capture session on the device '${this.udid}' has exited ` +
+                `with code ${code}, signal ${signal}`);
+        });
+    }
+    isCapturing() {
+        return !!this.mainProcess?.isRunning;
+    }
+    async interrupt(force = false) {
+        if (this.isCapturing()) {
+            const interruptPromise = this.mainProcess?.stop(force ? 'SIGTERM' : 'SIGINT');
+            this.mainProcess = null;
+            try {
+                await interruptPromise;
+            }
+            catch (e) {
+                this.log.warn(`Cannot ${force ? 'terminate' : 'interrupt'} the traffic capture session. ` +
+                    `Original error: ${e.message}`);
+                return false;
+            }
+        }
+        return true;
+    }
+    async finish() {
+        await this.interrupt();
+        return this.resultPath;
+    }
+    async cleanup() {
+        if (await support_1.fs.exists(this.resultPath)) {
+            await support_1.fs.rimraf(this.resultPath);
+        }
+    }
+}
+exports.TrafficCapture = TrafficCapture;
+/**
+ * Records the given network traffic capture into a .pcap file.
+ *
+ * @param {number} timeLimitSec - The maximum recording time, in seconds. The maximum value is `43200` (12 hours).
+ * @param {boolean} forceRestart - Whether to restart traffic capture process forcefully when startPcap is called (`true`) or ignore the call until the current traffic capture is completed (`false`, the default value).
+ * @throws {Error} If network traffic capture has failed to start.
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+async function mobileStartPcap(timeLimitSec = 180, forceRestart = false) {
+    if (this.isSimulator()) {
+        throw this.log.errorWithException('Network traffic capture only works on real devices');
+    }
+    if (this._trafficCapture?.isCapturing()) {
+        this.log.info(`There is an active traffic capture process`);
+        if (forceRestart) {
+            this.log.info(`Stopping it because 'forceRestart' option is set to true`);
+            await this._trafficCapture.interrupt(true);
+        }
+        else {
+            this.log.info(`Doing nothing. ` +
+                `Set 'forceRestart' option to true if you'd like to start a new traffic capture session`);
+            return;
+        }
+    }
+    if (this._trafficCapture) {
+        await this._trafficCapture.cleanup();
+        this._trafficCapture = null;
+    }
+    const resultPath = await support_1.tempDir.path({
+        prefix: `appium_${support_1.util.uuidV4().substring(0, 8)}`,
+        suffix: DEFAULT_EXT,
+    });
+    const trafficCollector = new TrafficCapture(this.device.udid, this.log, resultPath);
+    const timeoutSeconds = parseInt(String(timeLimitSec), 10);
+    if (isNaN(timeoutSeconds) || timeoutSeconds > MAX_CAPTURE_TIME_SEC || timeoutSeconds <= 0) {
+        throw new driver_1.errors.InvalidArgumentError(`The timeLimitSec value must be in range [1, ${MAX_CAPTURE_TIME_SEC}] seconds. ` +
+            `The value of '${timeLimitSec}' has been passed instead.`);
+    }
+    try {
+        await trafficCollector.start(timeoutSeconds);
+    }
+    catch (e) {
+        await trafficCollector.interrupt(true);
+        await trafficCollector.cleanup();
+        throw e;
+    }
+    this._trafficCapture = trafficCollector;
+}
+/**
+ * Stops network traffic capture.
+ *
+ * If no traffic capture process is running, then the endpoint will try to get the recently recorded file.
+ *
+ * If no previously recorded file is found and no active traffic capture processes are running, then the method returns an empty string.
+ *
+ * @remarks Network capture files can be viewed in [Wireshark](https://www.wireshark.org/) and other similar applications.
+ * @returns {Promise<string>} Base64-encoded content of the recorded pcap file or an empty string if no traffic capture has been started before.
+ * @throws {Error} If there was an error while getting the capture file.
+ * @this {XCUITestDriver}
+ */
+async function mobileStopPcap() {
+    if (!this._trafficCapture) {
+        this.log.info('Network traffic collector has not been started. There is nothing to stop');
+        return '';
+    }
+    let resultPath;
+    try {
+        resultPath = await this._trafficCapture.finish();
+        if (!(await support_1.fs.exists(resultPath))) {
+            throw this.log.errorWithException(`The network traffic capture utility has failed ` +
+                `to store the actual traffic capture at '${resultPath}'`);
+        }
+    }
+    catch (e) {
+        await this._trafficCapture.interrupt(true);
+        await this._trafficCapture.cleanup();
+        this._trafficCapture = null;
+        throw e;
+    }
+    return await (0, utils_1.encodeBase64OrUpload)(resultPath);
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=pcap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pcap.js","sourceRoot":"","sources":["../../../lib/commands/pcap.js"],"names":[],"mappings":";;;AAkFA,0CA6CC;AAcD,wCAsBC;AAnKD,sFAAwE;AACxE,4CAAiD;AACjD,oCAA8C;AAC9C,0CAAqC;AAErC,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAC1C,MAAM,WAAW,GAAG,OAAO,CAAC;AAE5B,MAAa,cAAc;IACzB,qDAAqD;IACrD,WAAW,CAAC;IACZ,YAAY,IAAI,EAAE,GAAG,EAAE,UAAU;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,cAAc;QACxB,IAAI,CAAC,WAAW,GAAG,gDAAgD,CAAC,CAClE,MAAM,IAAI,gCAAS,CAAC;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAChC,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,2DAA2D,IAAI,CAAC,IAAI,KAAK;YACvE,mBAAmB,cAAc,GAAG,CACvC,CAAC;QACF,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,EAAE,cAAc,GAAG,IAAI,CAAC,CAAC;QACtE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YAC7C,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,8CAA8C,IAAI,CAAC,IAAI,eAAe;gBACpE,aAAa,IAAI,YAAY,MAAM,EAAE,CACxC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAK,GAAG,KAAK;QAC3B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC9E,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,gCAAgC;oBACzE,mBAAmB,CAAC,CAAC,OAAO,EAAE,CACjC,CAAC;gBACF,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACrC,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;CACF;AA/DD,wCA+DC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,eAAe,CAAC,YAAY,GAAG,GAAG,EAAE,YAAY,GAAG,KAAK;IAC5E,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,oDAAoD,CAAC,CAAC;IAC1F,CAAC;IAED,IAAI,IAAI,CAAC,eAAe,EAAE,WAAW,EAAE,EAAE,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;QAC5D,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;YAC1E,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,iBAAiB;gBACf,wFAAwF,CAC3F,CAAC;YACF,OAAO;QACT,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,iBAAO,CAAC,IAAI,CAAC;QACpC,MAAM,EAAE,UAAU,cAAI,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QACjD,MAAM,EAAE,WAAW;KACpB,CAAC,CAAC;IACH,MAAM,gBAAgB,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAEpF,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC;IAC1D,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,cAAc,GAAG,oBAAoB,IAAI,cAAc,IAAI,CAAC,EAAE,CAAC;QAC1F,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,+CAA+C,oBAAoB,aAAa;YAC9E,iBAAiB,YAAY,4BAA4B,CAC5D,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,gBAAgB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,gBAAgB,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,CAAC,CAAC;IACV,CAAC;IACD,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;QAC1F,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,UAAU,CAAC;IACf,IAAI,CAAC;QACH,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACjD,IAAI,CAAC,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAC/B,iDAAiD;gBAC/C,2CAA2C,UAAU,GAAG,CAC3D,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,MAAM,CAAC,CAAC;IACV,CAAC;IACD,OAAO,MAAM,IAAA,4BAAoB,EAAC,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;GAEG"}

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

@@ -0,0 +1,85 @@
+/**
+ * Starts performance profiling for the device under test.
+ *
+ * Relaxing security is mandatory for simulators. It can always work for real devices.
+ *
+ * Since XCode 12 the method tries to use `xctrace` tool to record performance stats.
+ *
+ * The `instruments` developer utility is used as a fallback for this purpose if `xctrace` is not available.
+ *
+ * It is possible to record multiple profiles at the same time.
+ *
+ * Read [Recording, Pausing, and Stopping Traces](https://developer.apple.com/library/content/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/Recording,Pausing,andStoppingTraces.html) for more details.
+ *
+ * @param {number} timeout - The maximum count of milliseconds to record the profiling information.
+ * @param {string} profileName - The name of existing performance profile to apply. Can also contain the full path to the chosen template on the server file system. Note: not all profiles are supported on mobile devices.
+ * @param {number|'current'} [pid] -  The ID of the process to measure the performance for. Set it to `current` in order to measure the performance of the process, which belongs to the currently active application.  All processes running on the device are measured if `pid` is unset (the default setting).
+ * @this {XCUITestDriver}
+ */
+export function mobileStartPerfRecord(this: import("../driver").XCUITestDriver, timeout?: number, profileName?: string, pid?: number | "current"): Promise<void>;
+export class mobileStartPerfRecord {
+    /**
+     * Starts performance profiling for the device under test.
+     *
+     * Relaxing security is mandatory for simulators. It can always work for real devices.
+     *
+     * Since XCode 12 the method tries to use `xctrace` tool to record performance stats.
+     *
+     * The `instruments` developer utility is used as a fallback for this purpose if `xctrace` is not available.
+     *
+     * It is possible to record multiple profiles at the same time.
+     *
+     * Read [Recording, Pausing, and Stopping Traces](https://developer.apple.com/library/content/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/Recording,Pausing,andStoppingTraces.html) for more details.
+     *
+     * @param {number} timeout - The maximum count of milliseconds to record the profiling information.
+     * @param {string} profileName - The name of existing performance profile to apply. Can also contain the full path to the chosen template on the server file system. Note: not all profiles are supported on mobile devices.
+     * @param {number|'current'} [pid] -  The ID of the process to measure the performance for. Set it to `current` in order to measure the performance of the process, which belongs to the currently active application.  All processes running on the device are measured if `pid` is unset (the default setting).
+     * @this {XCUITestDriver}
+     */
+    constructor(this: import("../driver").XCUITestDriver, timeout?: number, profileName?: string, pid?: number | "current");
+    _perfRecorders: PerfRecorder[] | undefined;
+}
+/**
+ * Stops performance recording operation previously started by {@linkcode XCUITestDriver.mobileStartPerfRecord mobile: startPerfRecord}.
+ *
+ * If the previous call has already been completed due to the timeout, then its result is returned immediately. An error is thrown if the performance recording failed to start.
+ *
+ * The resulting file in `.trace` format can be either returned directly as base64-encoded zip archive or uploaded to a remote location (such files can be pretty large). Afterwards it is possible to unarchive and open such files with Xcode Dev Tools.
+ *
+ * @param {string} [remotePath] - The path to the remote location, where the resulting zipped `.trace` file should be uploaded.  The following protocols are supported: `http`, `https`, `ftp`. Null or empty string value (the default setting) means the content of resulting file should be zipped, encoded as Base64 and passed as the endpoint response value. An exception will be thrown if the generated file is too big to fit into the available process memory.
+ * @param {string} [user] - The name of the user for the remote authentication. Only works if `remotePath` is provided.
+ * @param {string} [pass] - The password for the remote authentication. Only works if `remotePath` is provided.
+ * @param {import('axios').Method} [method] -  The http multipart upload method name. Only works if `remotePath` is provided. Defaults to `PUT`
+ * @param {string} profileName -  The name of existing performance profile to stop the recording for. Multiple recorders for different profile names could be executed at the same time.
+ * @param {Record<string,any>} [headers] - Additional headers mapping for multipart http(s) uploads
+ * @param {string} [fileFieldName] -  The name of the form field, where the file content BLOB should be stored for http(s) uploads. Defaults to `file`
+ * @param {Record<string,any>|([string, any])[]} [formFields] - Additional form fields for multipart http(s) uploads
+ *
+ * @returns {Promise<string>} The resulting file in `.trace` format. This file can either be returned directly as base64-encoded `.zip` archive or uploaded to a remote location (note that such files may be large), _depending on the `remotePath` argument value._  Thereafter, the file may be unarchived and opened with Xcode Developer Tools.
+ * @throws {Error} If no performance recording with given profile name/device udid combination
+ * has been started before or the resulting .trace file has not been generated properly.
+ * @this {XCUITestDriver}
+ */
+export function mobileStopPerfRecord(this: import("../driver").XCUITestDriver, remotePath?: string, user?: string, pass?: string, method?: import("axios").Method, profileName?: string, headers?: Record<string, any>, fileFieldName?: string, formFields?: Record<string, any> | ([string, any])[]): Promise<string>;
+export class PerfRecorder {
+    constructor(reportRoot: any, udid: any, opts?: {});
+    /** @type {import('teen_process').SubProcess|null} */
+    _process: any | null;
+    _zippedReportPath: string;
+    _timeout: any;
+    _profileName: any;
+    _reportPath: string;
+    _pid: any;
+    _udid: any;
+    _logger: import("@appium/types").AppiumLogger;
+    _archivePromise: Promise<string> | null;
+    get profileName(): any;
+    getOriginalReportPath(): Promise<string>;
+    getZippedReportPath(): Promise<string>;
+    isRunning(): boolean;
+    _enforceTermination(): Promise<string>;
+    start(): Promise<void>;
+    stop(force?: boolean): Promise<string>;
+}
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=performance.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"performance.d.ts","sourceRoot":"","sources":["../../../lib/commands/performance.js"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;;;;;;GAiBG;AACH,0FALW,MAAM,gBACN,MAAM,QACN,MAAM,GAAC,SAAS,iBA4C1B;;IA3DD;;;;;;;;;;;;;;;;;OAiBG;IACH,gEALW,MAAM,gBACN,MAAM,QACN,MAAM,GAAC,SAAS,EA4C1B;IADC,2CAAgE;;AAGlE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,4FAdW,MAAM,SACN,MAAM,SACN,MAAM,WACN,OAAO,OAAO,EAAE,MAAM,gBACtB,MAAM,YACN,MAAM,CAAC,MAAM,EAAC,GAAG,CAAC,kBAClB,MAAM,eACN,MAAM,CAAC,MAAM,EAAC,GAAG,CAAC,GAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,GAElC,OAAO,CAAC,MAAM,CAAC,CAoD3B;AA2BD;IAGE,mDAeC;IAjBD,qDAAqD;IACrD,UADW,GAAiC,GAAC,IAAI,CACxC;IAGP,0BAA2B;IAC3B,cAAoF;IACpF,kBAA4D;IAC5D,oBAGC;IACD,UAAoB;IACpB,WAAiB;IACjB,8CAEC;IACD,wCAA2B;IAG7B,uBAEC;IAED,yCAEC;IAED,uCAsBC;IAED,qBAEC;IAED,uCAgCC;IAED,uBAiGC;IAED,uCAkBC;CACF;6BAGY,OAAO,WAAW,EAAE,cAAc"}