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

package/build/lib/commands/log.js

@@ -0,0 +1,287 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportedLogTypes = void 0;
+exports.extractLogs = extractLogs;
+exports.startLogCapture = startLogCapture;
+exports.mobileStartLogsBroadcast = mobileStartLogsBroadcast;
+exports.mobileStopLogsBroadcast = mobileStopLogsBroadcast;
+exports.assignBiDiLogListener = assignBiDiLogListener;
+const lodash_1 = __importDefault(require("lodash"));
+const bluebird_1 = __importDefault(require("bluebird"));
+const driver_1 = require("appium/driver");
+const ios_crash_log_1 = require("../device-log/ios-crash-log");
+const ios_simulator_log_1 = require("../device-log/ios-simulator-log");
+const ios_device_log_1 = require("../device-log/ios-device-log");
+const ws_1 = __importDefault(require("ws"));
+const safari_console_log_1 = require("../device-log/safari-console-log");
+const safari_network_log_1 = require("../device-log/safari-network-log");
+const helpers_1 = require("../device-log/helpers");
+const utils_1 = require("../utils");
+const constants_1 = require("./bidi/constants");
+const models_1 = require("./bidi/models");
+/**
+ * Determines the websocket endpoint based on the `sessionId`
+ * @param {string} sessionId
+ * @returns {string}
+ */
+const WEBSOCKET_ENDPOINT = (sessionId) => `${driver_1.DEFAULT_WS_PATHNAME_PREFIX}/session/${sessionId}/appium/device/syslog`;
+const COLOR_CODE_PATTERN = /\u001b\[(\d+(;\d+)*)?m/g; // eslint-disable-line no-control-regex
+const GET_SERVER_LOGS_FEATURE = 'get_server_logs';
+/**
+ * @type {import('@appium/types').LogDefRecord}
+ * @privateRemarks The return types for these getters should be specified
+ */
+const SUPPORTED_LOG_TYPES = {
+    syslog: {
+        description: 'System Logs - Device logs for iOS applications on real devices and simulators',
+        getter: async (self) => await self.extractLogs('syslog', self.logs),
+    },
+    crashlog: {
+        description: 'Crash Logs - Crash reports for iOS applications on real devices and simulators',
+        getter: async (self) => await self.extractLogs('crashlog', self.logs),
+    },
+    performance: {
+        description: 'Performance Logs - Debug Timelines on real devices and simulators',
+        getter: async (self) => await self.extractLogs('performance', self.logs),
+    },
+    safariConsole: {
+        description: 'Safari Console Logs - data written to the JS console in Safari',
+        getter: async (self) => await self.extractLogs('safariConsole', self.logs),
+    },
+    safariNetwork: {
+        description: 'Safari Network Logs - information about network operations undertaken by Safari',
+        getter: async (self) => await self.extractLogs('safariNetwork', self.logs),
+    },
+    server: {
+        description: 'Appium server logs',
+        /**
+         * @returns {import('./types').LogEntry[]}
+         */
+        getter: (self) => {
+            self.assertFeatureEnabled(GET_SERVER_LOGS_FEATURE);
+            return self.log.unwrap().record.map(nativeLogEntryToSeleniumEntry);
+        },
+    },
+};
+const LOG_NAMES_TO_CAPABILITY_NAMES_MAP = {
+    safariConsole: 'showSafariConsoleLog',
+    safariNetwork: 'showSafariNetworkLog',
+    enablePerformanceLogging: 'enablePerformanceLogging',
+};
+exports.supportedLogTypes = SUPPORTED_LOG_TYPES;
+/**
+ *
+ * @param {XCUITestDriverLogTypes} logType
+ * @param {Partial<Record<XCUITestDriverLogTypes,{getLogs(): Promise<any>}>>} [logsContainer]
+ * @this {XCUITestDriver}
+ */
+async function extractLogs(logType, logsContainer = {}) {
+    // make sure that we have logs at all
+    // otherwise it's not been initialized
+    if (lodash_1.default.isEmpty(logsContainer)) {
+        throw new Error('No logs currently available. Is the device/simulator started?');
+    }
+    // If logs captured successfully send response with data, else send error
+    const logObject = logsContainer[logType];
+    if (logObject) {
+        return await logObject.getLogs();
+    }
+    if (logType in LOG_NAMES_TO_CAPABILITY_NAMES_MAP) {
+        throw new Error(`${logType} logs are not enabled. Make sure you've set a proper value ` +
+            `to the 'appium:${LOG_NAMES_TO_CAPABILITY_NAMES_MAP[logType]}' capability.`);
+    }
+    throw new Error(`No logs of type '${logType}' found. Supported log types are: ${lodash_1.default.keys(SUPPORTED_LOG_TYPES)}.`);
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function startLogCapture() {
+    this.logs = this.logs || {};
+    if (!lodash_1.default.isUndefined(this.logs.syslog) && this.logs.syslog.isCapturing) {
+        this.log.warn('Trying to start iOS log capture but it has already started!');
+        return true;
+    }
+    if (lodash_1.default.isUndefined(this.logs.syslog)) {
+        [this.logs.crashlog,] = assignBiDiLogListener.bind(this)(new ios_crash_log_1.IOSCrashLog({
+            sim: /** @type {import('@limrun/appium-ios-simulator').Simulator} */ (this.device),
+            udid: this.isRealDevice() ? this.opts.udid : undefined,
+            log: this.log,
+        }), {
+            type: 'crashlog',
+        });
+        [this.logs.syslog,] = assignBiDiLogListener.bind(this)(this.isRealDevice()
+            ? new ios_device_log_1.IOSDeviceLog({
+                udid: this.opts.udid,
+                showLogs: this.opts.showIOSLog,
+                log: this.log,
+            })
+            : new ios_simulator_log_1.IOSSimulatorLog({
+                sim: /** @type {import('@limrun/appium-ios-simulator').Simulator} */ (this.device),
+                showLogs: this.opts.showIOSLog,
+                iosSimulatorLogsPredicate: this.opts.iosSimulatorLogsPredicate,
+                simulatorLogLevel: this.opts.simulatorLogLevel,
+                log: this.log,
+                iosSyslogFile: this.opts.iosSyslogFile
+            }), {
+            type: 'syslog',
+        });
+        if (lodash_1.default.isBoolean(this.opts.showSafariConsoleLog)) {
+            [this.logs.safariConsole,] = assignBiDiLogListener.bind(this)(new safari_console_log_1.SafariConsoleLog({
+                showLogs: this.opts.showSafariConsoleLog,
+                log: this.log,
+            }), {
+                type: 'safariConsole',
+            });
+        }
+        if (lodash_1.default.isBoolean(this.opts.showSafariNetworkLog)) {
+            [this.logs.safariNetwork,] = assignBiDiLogListener.bind(this)(new safari_network_log_1.SafariNetworkLog({
+                showLogs: this.opts.showSafariNetworkLog,
+                log: this.log,
+            }), {
+                type: 'safariNetwork',
+            });
+        }
+        if (this.isFeatureEnabled(GET_SERVER_LOGS_FEATURE)) {
+            [, this._bidiServerLogListener] = assignBiDiLogListener.bind(this)(this.log.unwrap(), {
+                type: 'server',
+                srcEventName: 'log',
+                entryTransformer: nativeLogEntryToSeleniumEntry,
+            });
+        }
+    }
+    let didStartSyslog = false;
+    /** @type {Promise[]} */
+    const promises = [
+        (async () => {
+            try {
+                await this.logs.syslog?.startCapture();
+                didStartSyslog = true;
+                this.eventEmitter.emit('syslogStarted', this.logs.syslog);
+            }
+            catch (err) {
+                this.log.debug(err.stack);
+                this.log.warn(`Continuing without capturing device logs: ${err.message}`);
+            }
+        })(),
+        this.logs.crashlog?.startCapture() ?? bluebird_1.default.resolve(),
+    ];
+    await bluebird_1.default.all(promises);
+    return didStartSyslog;
+}
+/**
+ * Starts an iOS system logs broadcast websocket.
+ *
+ * The websocket listens on the same host and port as Appium.  The endpoint created is `/ws/session/:sessionId:/appium/syslog`.
+ *
+ * If the websocket is already running, this command does nothing.
+ *
+ * Each connected webcoket listener will receive syslog lines as soon as they are visible to Appium.
+ * @see https://appiumpro.com/editions/55-using-mobile-execution-commands-to-continuously-stream-device-logs-with-appium
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+async function mobileStartLogsBroadcast() {
+    const pathname = WEBSOCKET_ENDPOINT(/** @type {string} */ (this.sessionId));
+    if (!lodash_1.default.isEmpty(await /** @type {import('@appium/types').AppiumServer} */ (this.server).getWebSocketHandlers(pathname))) {
+        this.log.debug(`The system logs broadcasting web socket server is already listening at ${pathname}`);
+        return;
+    }
+    this.log.info(`Assigning system logs broadcasting web socket server to ${pathname}`);
+    // https://github.com/websockets/ws/blob/master/doc/ws.md
+    const wss = new ws_1.default.Server({
+        noServer: true,
+    });
+    wss.on('connection', (ws, req) => {
+        if (req) {
+            const remoteIp = lodash_1.default.isEmpty(req.headers['x-forwarded-for'])
+                ? req.connection?.remoteAddress
+                : req.headers['x-forwarded-for'];
+            this.log.debug(`Established a new system logs listener web socket connection from ${remoteIp}`);
+        }
+        else {
+            this.log.debug('Established a new system logs listener web socket connection');
+        }
+        if (lodash_1.default.isEmpty(this._syslogWebsocketListener)) {
+            this._syslogWebsocketListener = (logRecord) => {
+                if (ws?.readyState === ws_1.default.OPEN) {
+                    ws.send(logRecord.message);
+                }
+            };
+        }
+        this.logs.syslog?.on('output', this._syslogWebsocketListener);
+        ws.on('close', (code, reason) => {
+            if (!lodash_1.default.isEmpty(this._syslogWebsocketListener)) {
+                this.logs.syslog?.removeListener('output', this._syslogWebsocketListener);
+                this._syslogWebsocketListener = null;
+            }
+            let closeMsg = 'System logs listener web socket is closed.';
+            if (!lodash_1.default.isEmpty(code)) {
+                closeMsg += ` Code: ${code}.`;
+            }
+            if (!lodash_1.default.isEmpty(reason)) {
+                closeMsg += ` Reason: ${reason.toString()}.`;
+            }
+            this.log.debug(closeMsg);
+        });
+    });
+    await /** @type {AppiumServer} */ (this.server).addWebSocketHandler(pathname, 
+    /** @type {import('@appium/types').WSServer} */ (wss));
+}
+/**
+ * Stops the syslog broadcasting wesocket server previously started by `mobile: startLogsBroadcast`.
+ * If no websocket server is running, this command does nothing.
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+async function mobileStopLogsBroadcast() {
+    const pathname = WEBSOCKET_ENDPOINT(/** @type {string} */ (this.sessionId));
+    if (lodash_1.default.isEmpty(await /** @type {AppiumServer} */ (this.server).getWebSocketHandlers(pathname))) {
+        return;
+    }
+    this.log.debug('Stopping the system logs broadcasting web socket server');
+    await /** @type {AppiumServer} */ (this.server).removeWebSocketHandler(pathname);
+}
+/**
+ * https://w3c.github.io/webdriver-bidi/#event-log-entryAdded
+ *
+ * @template {import('node:events').EventEmitter} EE
+ * @this {XCUITestDriver}
+ * @param {EE} logEmitter
+ * @param {BiDiListenerProperties} properties
+ * @returns {[EE, import('./types').LogListener]}
+ */
+function assignBiDiLogListener(logEmitter, properties) {
+    const { type, context = utils_1.NATIVE_WIN, srcEventName = 'output', entryTransformer, } = properties;
+    const listener = (/** @type {import('./types').LogEntry} */ logEntry) => {
+        const finalEntry = entryTransformer ? entryTransformer(logEntry) : logEntry;
+        this.eventEmitter.emit(constants_1.BIDI_EVENT_NAME, (0, models_1.makeLogEntryAddedEvent)(finalEntry, context, type));
+    };
+    logEmitter.on(srcEventName, listener);
+    return [logEmitter, listener];
+}
+/**
+ *
+ * @param {Object} x
+ * @returns {import('./types').LogEntry}
+ */
+function nativeLogEntryToSeleniumEntry(x) {
+    const msg = lodash_1.default.isEmpty(x.prefix) ? x.message : `[${x.prefix}] ${x.message}`;
+    return (0, helpers_1.toLogEntry)(lodash_1.default.replace(msg, COLOR_CODE_PATTERN, ''), 
+    /** @type {any} */ (x).timestamp ?? Date.now());
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ * @typedef {keyof typeof SUPPORTED_LOG_TYPES} XCUITestDriverLogTypes
+ * @typedef {import('@appium/types').AppiumServer} AppiumServer
+ */
+/**
+ * @typedef {Object} BiDiListenerProperties
+ * @property {string} type
+ * @property {string} [srcEventName='output']
+ * @property {string} [context=NATIVE_WIN]
+ * @property {(x: Object) => import('./types').LogEntry} [entryTransformer]
+ */
+//# sourceMappingURL=log.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":";;;;;;AA2EA,kCAqBC;AAKD,0CAqFC;AAcD,4DA2DC;AAQD,0DAQC;AAWD,sDAaC;AA3SD,oDAAuB;AACvB,wDAAyB;AACzB,0CAAyD;AACzD,+DAAwD;AACxD,uEAAgE;AAChE,iEAA0D;AAC1D,4CAA2B;AAC3B,yEAAoE;AACpE,yEAAoE;AACpE,mDAAmD;AACnD,oCAAsC;AACtC,gDAAmD;AACnD,0CAAuD;AAEvD;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,EAAE,CACvC,GAAG,mCAA0B,YAAY,SAAS,uBAAuB,CAAC;AAC5E,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,CAAC,uCAAuC;AAC7F,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AAElD;;;GAGG;AACH,MAAM,mBAAmB,GAAG;IAC1B,MAAM,EAAE;QACN,WAAW,EAAE,+EAA+E;QAC5F,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC;KACpE;IACD,QAAQ,EAAE;QACR,WAAW,EAAE,gFAAgF;QAC7F,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC;KACtE;IACD,WAAW,EAAE;QACX,WAAW,EAAE,mEAAmE;QAChF,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC;KACzE;IACD,aAAa,EAAE;QACb,WAAW,EAAE,gEAAgE;QAC7E,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC;KAC3E;IACD,aAAa,EAAE;QACb,WAAW,EAAE,iFAAiF;QAC9F,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC;KAC3E;IACD,MAAM,EAAE;QACN,WAAW,EAAE,oBAAoB;QACjC;;WAEG;QACH,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACf,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QACrE,CAAC;KACF;CACF,CAAC;AAEF,MAAM,iCAAiC,GAAG;IACxC,aAAa,EAAE,sBAAsB;IACrC,aAAa,EAAE,sBAAsB;IACrC,wBAAwB,EAAE,0BAA0B;CACrD,CAAC;AAEW,QAAA,iBAAiB,GAAG,mBAAmB,CAAC;AAErD;;;;;GAKG;AACI,KAAK,UAAU,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,EAAE;IAC3D,qCAAqC;IACrC,sCAAsC;IACtC,IAAI,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAED,yEAAyE;IACzE,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IACD,IAAI,OAAO,IAAI,iCAAiC,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,6DAA6D;YACvE,kBAAkB,iCAAiC,CAAC,OAAO,CAAC,eAAe,CAC5E,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,qCAAqC,gBAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAC/F,CAAC;AACJ,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;IAC5B,IAAI,CAAC,gBAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACrE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,gBAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACtD,IAAI,2BAAW,CAAC;YACd,GAAG,EAAE,+DAA+D,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YAClF,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACtD,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC,EAAE;YACF,IAAI,EAAE,UAAU;SACjB,CACF,CAAC;QACF,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CACpD,IAAI,CAAC,YAAY,EAAE;YACjB,CAAC,CAAC,IAAI,6BAAY,CAAC;gBACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;gBACpB,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;gBAC9B,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CAAC;YACF,CAAC,CAAC,IAAI,mCAAe,CAAC;gBACpB,GAAG,EAAE,+DAA+D,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;gBAClF,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;gBAC9B,yBAAyB,EAAE,IAAI,CAAC,IAAI,CAAC,yBAAyB;gBAC9D,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB;gBAC9C,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;aACvC,CAAC,EACJ;YACE,IAAI,EAAE,QAAQ;SACf,CACF,CAAC;QACF,IAAI,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAChD,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAC3D,IAAI,qCAAgB,CAAC;gBACnB,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,oBAAoB;gBACxC,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CAAC,EAAE;gBACF,IAAI,EAAE,eAAe;aACtB,CACF,CAAC;QACJ,CAAC;QACD,IAAI,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAChD,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAC3D,IAAI,qCAAgB,CAAC;gBACnB,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,oBAAoB;gBACxC,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CAAC,EAAE;gBACF,IAAI,EAAE,eAAe;aACtB,CACF,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACnD,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAChE,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE;gBACjB,IAAI,EAAE,QAAQ;gBACd,YAAY,EAAE,KAAK;gBACnB,gBAAgB,EAAE,6BAA6B;aAChD,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,wBAAwB;IACxB,MAAM,QAAQ,GAAG;QACf,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC;gBACvC,cAAc,GAAG,IAAI,CAAC;gBACtB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5D,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,6CAA6C,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC,CAAC,EAAE;QACJ,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,kBAAC,CAAC,OAAO,EAAE;KAClD,CAAC;IACF,MAAM,kBAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEtB,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,wBAAwB;IAC5C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5E,IACE,CAAC,gBAAC,CAAC,OAAO,CACR,MAAM,mDAAmD,CAAC,CACxD,IAAI,CAAC,MAAM,CACZ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CACjC,EACD,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,0EAA0E,QAAQ,EAAE,CACrF,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2DAA2D,QAAQ,EAAE,CAAC,CAAC;IACrF,yDAAyD;IACzD,MAAM,GAAG,GAAG,IAAI,YAAS,CAAC,MAAM,CAAC;QAC/B,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;QAC/B,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;gBACxD,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa;gBAC/B,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;YACnC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qEAAqE,QAAQ,EAAE,CAAC,CAAC;QAClG,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAC;QACjF,CAAC;QAED,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,wBAAwB,GAAG,CAAC,SAAS,EAAE,EAAE;gBAC5C,IAAI,EAAE,EAAE,UAAU,KAAK,YAAS,CAAC,IAAI,EAAE,CAAC;oBACtC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAE9D,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YAC9B,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBAC1E,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC;YACvC,CAAC;YAED,IAAI,QAAQ,GAAG,4CAA4C,CAAC;YAC5D,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,QAAQ,IAAI,UAAU,IAAI,GAAG,CAAC;YAChC,CAAC;YACD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvB,QAAQ,IAAI,YAAY,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC;YAC/C,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,mBAAmB,CACjE,QAAQ;IACR,+CAA+C,CAAC,CAAC,GAAG,CAAC,CACtD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,uBAAuB;IAC3C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5E,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC9F,OAAO;IACT,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC1E,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;AACnF,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CAAE,UAAU,EAAE,UAAU;IAC3D,MAAM,EACJ,IAAI,EACJ,OAAO,GAAG,kBAAU,EACpB,YAAY,GAAG,QAAQ,EACvB,gBAAgB,GACjB,GAAG,UAAU,CAAC;IACf,MAAM,QAAQ,GAAG,CAAC,yCAAyC,CAAC,QAAQ,EAAE,EAAE;QACtE,MAAM,UAAU,GAAG,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC5E,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,2BAAe,EAAE,IAAA,+BAAsB,EAAC,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC;IACF,UAAU,CAAC,EAAE,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACtC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChC,CAAC;AAED;;;;GAIG;AACH,SAAS,6BAA6B,CAAE,CAAC;IACvC,MAAM,GAAG,GAAG,gBAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IAC3E,OAAO,IAAA,oBAAU,EACf,gBAAC,CAAC,OAAO,CAAC,GAAG,EAAE,kBAAkB,EAAE,EAAE,CAAC;IACtC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,CAC/C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AAEH;;;;;;GAMG"}

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates Low Memory warning on the given application
+ *
+ * @since Xcode 15
+ * @param {string} bundleId - The bundle identifier of the target app. The app must be running
+ * @this {XCUITestDriver}
+ * @throws {Error} if the app is not running or is not installed
+ */
+export function mobileSendMemoryWarning(this: import("../driver").XCUITestDriver, bundleId: string): Promise<void>;
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=memory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../../lib/commands/memory.js"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,4FAJW,MAAM,iBAuChB;6BAGY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/memory.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileSendMemoryWarning = mobileSendMemoryWarning;
+const lodash_1 = __importDefault(require("lodash"));
+const driver_1 = require("appium/driver");
+/**
+ * Simulates Low Memory warning on the given application
+ *
+ * @since Xcode 15
+ * @param {string} bundleId - The bundle identifier of the target app. The app must be running
+ * @this {XCUITestDriver}
+ * @throws {Error} if the app is not running or is not installed
+ */
+async function mobileSendMemoryWarning(bundleId) {
+    if (!this.isRealDevice()) {
+        throw new Error('Memory warning simulation is only supported on real devices');
+    }
+    const device = /** @type {import('../real-device').RealDevice} */ (this.device);
+    const appInfos = await device.devicectl.listApps(bundleId);
+    if (lodash_1.default.isEmpty(appInfos)) {
+        throw new driver_1.errors.InvalidArgumentError(`The application identified by ${bundleId} cannot be found on the device. Is it installed?`);
+    }
+    // This regexp tries to match the process name of the main bundle executable.
+    // For example, if 'url' contains something like
+    // `file:///private/var/containers/Bundle/Application/093ACA6D-8F0B-4601-87B9-4099E43A1A20/Target.app/`
+    // and the following processes might be running:
+    // `file:///private/var/containers/Bundle/Application/093ACA6D-8F0B-4601-87B9-4099E43A1A20/Target.app/Target`
+    // `file:///private/var/containers/Bundle/Application/093ACA6D-8F0B-4601-87B9-4099E43A1A20/Target.app/PlugIns/WidgetExtension.appex/WidgetExtension`
+    // then we only want to match the first one.
+    // Unfortunately devicectl does not provide more info which would
+    // allow to connect a bundle id to a process id.
+    const pattern = new RegExp(`^${lodash_1.default.escapeRegExp(appInfos[0].url)}[^/]+$`);
+    /** @type {number[]} */
+    const pids = (await device.devicectl.listProcesses())
+        .filter(({ executable }) => pattern.test(executable))
+        .map(({ processIdentifier }) => processIdentifier);
+    if (lodash_1.default.isEmpty(pids)) {
+        throw new driver_1.errors.InvalidArgumentError(`The application identified by ${bundleId} must be running in order to simulate the Low Memory warning`);
+    }
+    this.log.info(`Emulating Low Memory warning for the process id ${pids[0]}, bundle id ${bundleId}`);
+    await device.devicectl.sendMemoryWarning(pids[0]);
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=memory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","sourceRoot":"","sources":["../../../lib/commands/memory.js"],"names":[],"mappings":";;;;;AAWA,0DAmCC;AA9CD,oDAAuB;AACvB,0CAAuC;AAEvC;;;;;;;GAOG;AACI,KAAK,UAAU,uBAAuB,CAAC,QAAQ;IACpD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,MAAM,GAAG,kDAAkD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEhF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAI,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,iCAAiC,QAAQ,kDAAkD,CAC5F,CAAC;IACJ,CAAC;IAED,6EAA6E;IAC7E,gDAAgD;IAChD,uGAAuG;IACvG,gDAAgD;IAChD,6GAA6G;IAC7G,oJAAoJ;IACpJ,4CAA4C;IAC5C,iEAAiE;IACjE,gDAAgD;IAChD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,IAAI,gBAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACxE,uBAAuB;IACvB,MAAM,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;SAClD,MAAM,CAAC,CAAC,EAAC,UAAU,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClD,GAAG,CAAC,CAAC,EAAC,iBAAiB,EAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC;IACnD,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,iCAAiC,QAAQ,8DAA8D,CACxG,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mDAAmD,IAAI,CAAC,CAAC,CAAC,eAAe,QAAQ,EAAE,CAAC,CAAC;IACnG,MAAM,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;GAEG"}

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

@@ -0,0 +1,44 @@
+/**
+ * @this {XCUITestDriver}
+ */
+export function back(this: import("../driver").XCUITestDriver): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function forward(this: import("../driver").XCUITestDriver): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function closeWindow(this: import("../driver").XCUITestDriver): Promise<any>;
+/**
+ * Opens the given URL with the default application assigned to handle it based on the URL
+ * scheme, or the application provided as an optional parameter
+ *
+ * (Note: the version of Xcode must be 14.3+ and iOS must be 16.4+)
+ *
+ * @param {string} url - the URL to be opened, e.g. `myscheme://yolo`
+ * @param {string} [bundleId] - the application to open the given URL with. If not provided, then
+ * the application assigned by the operating system to handle URLs of the appropriate type
+ * @returns {Promise<void>}
+ * @since 4.17
+ * @this {XCUITestDriver}
+ */
+export function mobileDeepLink(this: import("../driver").XCUITestDriver, url: string, bundleId?: string): Promise<void>;
+/**
+ * @this {XCUITestDriver}
+ */
+export function nativeBack(this: import("../driver").XCUITestDriver): Promise<unknown>;
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+export type DeepLinkOptions = {
+    /**
+     * The URL to be opened. This parameter is manadatory
+     */
+    url: string;
+    /**
+     * The bundle identifier of an application to open the
+     * given url with. If not provided then the default application for the given url scheme
+     * is going to be used.
+     */
+    bundleId: string | null;
+};
+//# sourceMappingURL=navigation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../../lib/commands/navigation.js"],"names":[],"mappings":"AASA;;GAEG;AACH,8EAMC;AAED;;GAEG;AACH,iFAIC;AAED;;GAEG;AACH,oFAsBC;AAED;;;;;;;;;;;;GAYG;AACH,8EAPW,MAAM,aACN,MAAM,GAEJ,OAAO,CAAC,IAAI,CAAC,CASzB;AAED;;GAEG;AACH,uFAiCC;6BAGY,OAAO,WAAW,EAAE,cAAc;;;;;SAKjC,MAAM;;;;;;cACN,MAAM,OAAC"}

package/build/lib/commands/navigation.js

@@ -0,0 +1,121 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.back = back;
+exports.forward = forward;
+exports.closeWindow = closeWindow;
+exports.mobileDeepLink = mobileDeepLink;
+exports.nativeBack = nativeBack;
+const driver_1 = require("appium/driver");
+const lodash_1 = __importDefault(require("lodash"));
+const asyncbox_1 = require("asyncbox");
+const utils_1 = require("../utils");
+// these two constitute the wait after closing a window
+const CLOSE_WINDOW_TIMEOUT = 5000;
+const CLOSE_WINDOW_INTERVAL = 100;
+/**
+ * @this {XCUITestDriver}
+ */
+async function back() {
+    if (!this.isWebContext()) {
+        await this.nativeBack();
+    }
+    else {
+        await this.mobileWebNav('back');
+    }
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function forward() {
+    if (!this.isWebContext()) {
+    }
+    await this.mobileWebNav('forward');
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function closeWindow() {
+    if (!this.isWebContext()) {
+        throw new driver_1.errors.NotImplementedError();
+    }
+    // since the window will be closed and the execution context gone, return
+    // first before closing. Waiting for close will happen in the finally block
+    const script = `setTimeout(function () {window.open('','_self').close();}, 0); return true;`;
+    const context = this.curContext;
+    try {
+        return await this.executeAtom('execute_script', [script, []], true);
+    }
+    finally {
+        // wait for the window to successfully change...
+        try {
+            await (0, asyncbox_1.waitForCondition)(() => this.curContext !== context, {
+                waitMs: CLOSE_WINDOW_TIMEOUT,
+                intervalMs: CLOSE_WINDOW_INTERVAL,
+            });
+        }
+        catch {
+            this.log.debug('Context has not yet been changed after closing window. Continuing...');
+        }
+    }
+}
+/**
+ * Opens the given URL with the default application assigned to handle it based on the URL
+ * scheme, or the application provided as an optional parameter
+ *
+ * (Note: the version of Xcode must be 14.3+ and iOS must be 16.4+)
+ *
+ * @param {string} url - the URL to be opened, e.g. `myscheme://yolo`
+ * @param {string} [bundleId] - the application to open the given URL with. If not provided, then
+ * the application assigned by the operating system to handle URLs of the appropriate type
+ * @returns {Promise<void>}
+ * @since 4.17
+ * @this {XCUITestDriver}
+ */
+async function mobileDeepLink(url, bundleId) {
+    return await this.proxyCommand('/url', 'POST', {
+        url,
+        bundleId,
+    });
+}
+/**
+ * @this {XCUITestDriver}
+ */
+async function nativeBack() {
+    if ((0, utils_1.isTvOs)(this.opts.platformName)) {
+        this.log.debug(`Sending Menu button as back behavior in tvOS`);
+        return await this.mobilePressButton('Menu');
+    }
+    try {
+        let navBar = await this.findNativeElementOrElements('class name', 'XCUIElementTypeNavigationBar', false);
+        let buttons = await this.findNativeElementOrElements('class name', 'XCUIElementTypeButton', true, navBar);
+        if (buttons?.length === 0) {
+            throw new Error('No buttons found in navigation bar');
+        }
+        let backButton = lodash_1.default.filter(buttons, (value) => value.label === 'Back')[0];
+        if (backButton) {
+            this.log.debug(`Found navigation bar 'back' button. Clicking.`);
+        }
+        else {
+            this.log.debug(`Unable to find 'Back' button. Trying first button in navigation bar`);
+            backButton = buttons?.[0];
+        }
+        await this.nativeClick(/** @type {string} */ (backButton));
+    }
+    catch (err) {
+        this.log.error(`Unable to find navigation bar and back button: ${err.message}`);
+    }
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+/**
+ * @typedef {Object} DeepLinkOptions
+ * @property {string} url The URL to be opened. This parameter is manadatory
+ * @property {string?} bundleId The bundle identifier of an application to open the
+ * given url with. If not provided then the default application for the given url scheme
+ * is going to be used.
+ */
+//# sourceMappingURL=navigation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.js","sourceRoot":"","sources":["../../../lib/commands/navigation.js"],"names":[],"mappings":";;;;;AAYA,oBAMC;AAKD,0BAIC;AAKD,kCAsBC;AAeD,wCAKC;AAKD,gCAiCC;AAhHD,0CAAqC;AACrC,oDAAuB;AACvB,uCAA0C;AAC1C,oCAAkC;AAElC,uDAAuD;AACvD,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAClC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAElC;;GAEG;AACI,KAAK,UAAU,IAAI;IACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,OAAO;IAC3B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;IAC3B,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;AACrC,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,WAAW;IAC/B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,MAAM,IAAI,eAAM,CAAC,mBAAmB,EAAE,CAAC;IACzC,CAAC;IAED,yEAAyE;IACzE,2EAA2E;IAC3E,MAAM,MAAM,GAAG,6EAA6E,CAAC;IAC7F,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC;IAChC,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;YAAS,CAAC;QACT,gDAAgD;QAChD,IAAI,CAAC;YACH,MAAM,IAAA,2BAAgB,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE;gBACxD,MAAM,EAAE,oBAAoB;gBAC5B,UAAU,EAAE,qBAAqB;aAClC,CAAC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sEAAsE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,cAAc,CAAC,GAAG,EAAE,QAAQ;IAChD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE;QAC7C,GAAG;QACH,QAAQ;KACT,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,UAAU;IAC9B,IAAI,IAAA,cAAM,EAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC/D,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,CAAC;QACH,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,2BAA2B,CACjD,YAAY,EACZ,8BAA8B,EAC9B,KAAK,CACN,CAAC;QACF,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAClD,YAAY,EACZ,uBAAuB,EACvB,IAAI,EACJ,MAAM,CACP,CAAC;QACF,IAAI,OAAO,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,UAAU,GAAG,gBAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzE,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qEAAqE,CAAC,CAAC;YACtF,UAAU,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kDAAkD,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED;;GAEG;AAEH;;;;;;GAMG"}

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

@@ -0,0 +1,28 @@
+/**
+ * Simulates push notification delivery to a simulated device.
+ *
+ * **Only "remote" push notifications are supported.** VoIP, Complication, File Provider, and other types are unsupported.
+ *
+ * Supported in Xcode SDK 11.4+.
+ * @param {string} bundleId - The bundle identifier of the target application
+ * @param {import('./types').PushPayload} payload - Valid push payload.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+export function mobilePushNotification(this: import("../driver").XCUITestDriver, bundleId: string, payload: import("./types").PushPayload): Promise<void>;
+/**
+ * Blocks until the expected notification is delivered.
+ *
+ * This method is a thin wrapper over the
+ * [`XCTNSNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctnsnotificationexpectation?language=objc) and
+ * [`XCTDarwinNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctdarwinnotificationexpectation?language=objc) entities.
+ *
+ * @param {string} name - The name of the notification to expect
+ * @param {import('./types').NotificationType} type - Which notification type to expect.
+ * @param {number} timeoutSeconds - For how long to wait until the notification is delivered (in float seconds).
+ * @throws A [`TimeoutError`](https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/lib/error_exports_TimeoutError.html) if the expected notification has not been delivered within the given timeout.
+ * @this {XCUITestDriver}
+ */
+export function mobileExpectNotification(this: import("../driver").XCUITestDriver, name: string, type?: import("./types").NotificationType, timeoutSeconds?: number): Promise<unknown>;
+export type XCUITestDriver = import("../driver").XCUITestDriver;
+//# sourceMappingURL=notifications.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../../lib/commands/notifications.js"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,2FALW,MAAM,WACN,OAAO,SAAS,EAAE,WAAW,iBA8BvC;AAED;;;;;;;;;;;;GAYG;AACH,yFANW,MAAM,SACN,OAAO,SAAS,EAAE,gBAAgB,mBAClC,MAAM,oBAUhB;6BAGY,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/notifications.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobilePushNotification = mobilePushNotification;
+exports.mobileExpectNotification = mobileExpectNotification;
+const driver_1 = require("appium/driver");
+const lodash_1 = __importDefault(require("lodash"));
+/**
+ * Simulates push notification delivery to a simulated device.
+ *
+ * **Only "remote" push notifications are supported.** VoIP, Complication, File Provider, and other types are unsupported.
+ *
+ * Supported in Xcode SDK 11.4+.
+ * @param {string} bundleId - The bundle identifier of the target application
+ * @param {import('./types').PushPayload} payload - Valid push payload.
+ * @group Simulator Only
+ * @this {XCUITestDriver}
+ */
+async function mobilePushNotification(bundleId, payload) {
+    if (!this.isSimulator()) {
+        throw new Error('This extension only works on Simulator');
+    }
+    if (!bundleId) {
+        throw new driver_1.errors.InvalidArgumentError(`'bundleId' argument must be a valid bundle identifier string`);
+    }
+    if (!lodash_1.default.isPlainObject(payload)) {
+        throw new driver_1.errors.InvalidArgumentError(`The 'payload' argument value must be a valid dictionary. ` +
+            `Got ${JSON.stringify(payload)} instead`);
+    }
+    if (!lodash_1.default.isPlainObject(payload.aps)) {
+        throw new driver_1.errors.InvalidArgumentError(`The 'payload.aps' value must be a valid dictionary. ` +
+            `Got ${JSON.stringify(payload.aps)} instead`);
+    }
+    return await /** @type {import('../driver').Simulator} */ (this.device).pushNotification({
+        ...payload,
+        'Simulator Target Bundle': bundleId,
+    });
+}
+/**
+ * Blocks until the expected notification is delivered.
+ *
+ * This method is a thin wrapper over the
+ * [`XCTNSNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctnsnotificationexpectation?language=objc) and
+ * [`XCTDarwinNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctdarwinnotificationexpectation?language=objc) entities.
+ *
+ * @param {string} name - The name of the notification to expect
+ * @param {import('./types').NotificationType} type - Which notification type to expect.
+ * @param {number} timeoutSeconds - For how long to wait until the notification is delivered (in float seconds).
+ * @throws A [`TimeoutError`](https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/lib/error_exports_TimeoutError.html) if the expected notification has not been delivered within the given timeout.
+ * @this {XCUITestDriver}
+ */
+async function mobileExpectNotification(name, type = 'plain', timeoutSeconds = 60) {
+    return await this.proxyCommand('/wda/expectNotification', 'POST', {
+        name,
+        type,
+        timeout: timeoutSeconds,
+    });
+}
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */
+//# sourceMappingURL=notifications.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../../lib/commands/notifications.js"],"names":[],"mappings":";;;;;AAcA,wDA0BC;AAeD,4DAMC;AA7DD,0CAAqC;AACrC,oDAAuB;AAEvB;;;;;;;;;;GAUG;AACI,KAAK,UAAU,sBAAsB,CAAC,QAAQ,EAAE,OAAO;IAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,2DAA2D;YACzD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAC3C,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,sDAAsD;YACpD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAC/C,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,4CAA4C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,gBAAgB,CAAC;QACvF,GAAG,OAAO;QACV,yBAAyB,EAAE,QAAQ;KACpC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,wBAAwB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,EAAE,cAAc,GAAG,EAAE;IACtF,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,MAAM,EAAE;QAChE,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;GAEG"}