appium-android-driver 5.14.7 → 6.0.0

package/build/lib/commands/log.js

@@ -1,20 +1,28 @@
 "use strict";
+// @ts-check
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.helpers = exports.commands = void 0;
-const logger_1 = __importDefault(require("../logger"));
-const os_1 = __importDefault(require("os"));
+const driver_1 = require("appium/driver");
 const lodash_1 = __importDefault(require("lodash"));
+const node_os_1 = __importDefault(require("node:os"));
 const ws_1 = __importDefault(require("ws"));
-const driver_1 = require("appium/driver");
+const logger_1 = __importDefault(require("../logger"));
+const mixins_1 = require("./mixins");
 const GET_SERVER_LOGS_FEATURE = 'get_server_logs';
-let commands = {}, helpers = {}, extensions = {};
-exports.commands = commands;
-exports.helpers = helpers;
+/**
+ * @param {string} sessionId
+ * @returns {string}
+ */
 const WEBSOCKET_ENDPOINT = (sessionId) => `${driver_1.DEFAULT_WS_PATHNAME_PREFIX}/session/${sessionId}/appium/device/logcat`;
-// https://github.com/SeleniumHQ/selenium/blob/0d425676b3c9df261dd641917f867d4d5ce7774d/java/client/src/org/openqa/selenium/logging/LogEntry.java
+/**
+ *
+ * @see {@link https://github.com/SeleniumHQ/selenium/blob/0d425676b3c9df261dd641917f867d4d5ce7774d/java/client/src/org/openqa/selenium/logging/LogEntry.java}
+ * @param {number} timestamp
+ * @param {string} level
+ * @param {string} message
+ */
 function toLogRecord(timestamp, level, message) {
     return {
         timestamp,
@@ -22,115 +30,145 @@ function toLogRecord(timestamp, level, message) {
         message,
     };
 }
-extensions.supportedLogTypes = {
-    logcat: {
-        description: 'Logs for Android applications on real device and emulators via ADB',
-        getter: async (self) => await self.adb.getLogcatLogs(),
-    },
-    bugreport: {
-        description: `'adb bugreport' output for advanced issues diagnostic`,
-        getter: async (self) => {
-            const output = await self.adb.bugreport();
-            const timestamp = Date.now();
-            return output.split(os_1.default.EOL)
-                .map((x) => toLogRecord(timestamp, 'ALL', x));
+/**
+ * @type {import('./mixins').LogMixin & ThisType<import('../driver').AndroidDriver>}
+ * @satisfies {import('@appium/types').ExternalDriver}
+ */
+const LogMixin = {
+    supportedLogTypes: {
+        logcat: {
+            description: 'Logs for Android applications on real device and emulators via ADB',
+            /**
+             *
+             * @param {import('../driver').AndroidDriver} self
+             * @returns
+             */
+            getter: (self) => /** @type {ADB} */ (self.adb).getLogcatLogs(),
         },
-    },
-    server: {
-        description: 'Appium server logs',
-        getter: (self) => {
-            self.ensureFeatureEnabled(GET_SERVER_LOGS_FEATURE);
-            const timestamp = Date.now();
-            return logger_1.default.unwrap().record
-                .map((x) => toLogRecord(timestamp, 'ALL', lodash_1.default.isEmpty(x.prefix) ? x.message : `[${x.prefix}] ${x.message}`));
+        bugreport: {
+            description: `'adb bugreport' output for advanced issues diagnostic`,
+            /**
+             *
+             * @param {import('../driver').AndroidDriver} self
+             * @returns
+             */
+            getter: async (self) => {
+                const output = await /** @type {ADB} */ (self.adb).bugreport();
+                const timestamp = Date.now();
+                return output.split(node_os_1.default.EOL).map((x) => toLogRecord(timestamp, 'ALL', x));
+            },
+        },
+        server: {
+            description: 'Appium server logs',
+            /**
+             *
+             * @param {import('../driver').AndroidDriver} self
+             * @returns
+             */
+            getter: (self) => {
+                self.ensureFeatureEnabled(GET_SERVER_LOGS_FEATURE);
+                const timestamp = Date.now();
+                return logger_1.default
+                    .unwrap()
+                    .record.map((x) => toLogRecord(timestamp, 'ALL', lodash_1.default.isEmpty(x.prefix) ? x.message : `[${x.prefix}] ${x.message}`));
+            },
         },
     },
-};
-/**
- * Starts Android logcat broadcast websocket on the same host and port
- * where Appium server is running at `/ws/session/:sessionId:/appium/logcat` endpoint. The method
- * will return immediately if the web socket is already listening.
- *
- * Each connected websocket listener will receive logcat log lines
- * as soon as they are visible to Appium.
- */
-commands.mobileStartLogsBroadcast = async function mobileStartLogsBroadcast() {
-    const pathname = WEBSOCKET_ENDPOINT(this.sessionId);
-    if (!lodash_1.default.isEmpty(await this.server.getWebSocketHandlers(pathname))) {
-        logger_1.default.debug(`The logcat broadcasting web socket server is already listening at ${pathname}`);
-        return;
-    }
-    logger_1.default.info(`Starting logcat broadcasting on web socket server ` +
-        `${JSON.stringify(this.server.address())} 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'];
-            logger_1.default.debug(`Established a new logcat listener web socket connection from ${remoteIp}`);
+    /**
+     * Starts Android logcat broadcast websocket on the same host and port
+     * where Appium server is running at `/ws/session/:sessionId:/appium/logcat` endpoint. The method
+     * will return immediately if the web socket is already listening.
+     *
+     * Each connected websocket listener will receive logcat log lines
+     * as soon as they are visible to Appium.
+     */
+    async mobileStartLogsBroadcast() {
+        const server = /** @type {import('@appium/types').AppiumServer} */ (this.server);
+        const adb = /** @type {ADB} */ (this.adb);
+        const pathname = WEBSOCKET_ENDPOINT(/** @type {string} */ (this.sessionId));
+        if (!lodash_1.default.isEmpty(await server.getWebSocketHandlers(pathname))) {
+            logger_1.default.debug(`The logcat broadcasting web socket server is already listening at ${pathname}`);
+            return;
         }
-        else {
-            logger_1.default.debug('Established a new logcat listener web socket connection');
-        }
-        if (lodash_1.default.isEmpty(this._logcatWebsocketListener)) {
-            this._logcatWebsocketListener = (logRecord) => {
-                if (ws?.readyState === ws_1.default.OPEN) {
-                    ws.send(logRecord.message);
-                }
-            };
-        }
-        this.adb.setLogcatListener(this._logcatWebsocketListener);
-        ws.on('close', (code, reason) => {
-            if (!lodash_1.default.isEmpty(this._logcatWebsocketListener)) {
-                try {
-                    this.adb.removeLogcatListener(this._logcatWebsocketListener);
-                }
-                catch (ign) { }
-                this._logcatWebsocketListener = null;
+        logger_1.default.info(`Starting logcat broadcasting on web socket server ` +
+            `${JSON.stringify(server.address())} 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'];
+                logger_1.default.debug(`Established a new logcat listener web socket connection from ${remoteIp}`);
             }
-            let closeMsg = 'Logcat listener web socket is closed.';
-            if (!lodash_1.default.isEmpty(code)) {
-                closeMsg += ` Code: ${code}.`;
+            else {
+                logger_1.default.debug('Established a new logcat listener web socket connection');
             }
-            if (!lodash_1.default.isEmpty(reason)) {
-                closeMsg += ` Reason: ${reason.toString()}.`;
+            if (lodash_1.default.isEmpty(this._logcatWebsocketListener)) {
+                this._logcatWebsocketListener = (logRecord) => {
+                    if (ws?.readyState === ws_1.default.OPEN) {
+                        ws.send(logRecord.message);
+                    }
+                };
             }
-            logger_1.default.debug(closeMsg);
+            adb.setLogcatListener(this._logcatWebsocketListener);
+            ws.on('close', (code, reason) => {
+                if (!lodash_1.default.isEmpty(this._logcatWebsocketListener)) {
+                    try {
+                        adb.removeLogcatListener(this._logcatWebsocketListener);
+                    }
+                    catch (ign) { }
+                    this._logcatWebsocketListener = undefined;
+                }
+                let closeMsg = 'Logcat listener web socket is closed.';
+                if (!lodash_1.default.isEmpty(code)) {
+                    closeMsg += ` Code: ${code}.`;
+                }
+                if (!lodash_1.default.isEmpty(reason)) {
+                    closeMsg += ` Reason: ${reason.toString()}.`;
+                }
+                logger_1.default.debug(closeMsg);
+            });
         });
-    });
-    await this.server.addWebSocketHandler(pathname, wss);
+        await server.addWebSocketHandler(pathname, 
+        /** @type {import('@appium/types').WSServer} */ (wss));
+    },
+    /**
+     * Stops the previously started logcat broadcasting wesocket server.
+     * This method will return immediately if no server is running.
+     */
+    async mobileStopLogsBroadcast() {
+        const pathname = WEBSOCKET_ENDPOINT(/** @type {string} */ (this.sessionId));
+        const server = /** @type {import('@appium/types').AppiumServer} */ (this.server);
+        if (lodash_1.default.isEmpty(await server.getWebSocketHandlers(pathname))) {
+            return;
+        }
+        logger_1.default.debug(`Stopping logcat broadcasting on web socket server ` +
+            `${JSON.stringify(server.address())} to ${pathname}`);
+        await server.removeWebSocketHandler(pathname);
+    },
+    async getLogTypes() {
+        // XXX why doesn't `super` work here?
+        const nativeLogTypes = await driver_1.BaseDriver.prototype.getLogTypes.call(this);
+        if (this.isWebContext()) {
+            const webLogTypes = /** @type {string[]} */ (await /** @type {import('appium-chromedriver').Chromedriver} */ (this.chromedriver).jwproxy.command('/log/types', 'GET'));
+            return [...nativeLogTypes, ...webLogTypes];
+        }
+        return nativeLogTypes;
+    },
+    async getLog(logType) {
+        if (this.isWebContext() && !lodash_1.default.keys(this.supportedLogTypes).includes(logType)) {
+            return await /** @type {import('appium-chromedriver').Chromedriver} */ (this.chromedriver).jwproxy.command('/log', 'POST', { type: logType });
+        }
+        // XXX why doesn't `super` work here?
+        return await driver_1.BaseDriver.prototype.getLog.call(this, logType);
+    },
 };
+(0, mixins_1.mixin)(LogMixin);
+exports.default = LogMixin;
 /**
- * Stops the previously started logcat broadcasting wesocket server.
- * This method will return immediately if no server is running.
+ * @typedef {import('appium-adb').ADB} ADB
  */
-commands.mobileStopLogsBroadcast = async function mobileStopLogsBroadcast() {
-    const pathname = WEBSOCKET_ENDPOINT(this.sessionId);
-    if (lodash_1.default.isEmpty(await this.server.getWebSocketHandlers(pathname))) {
-        return;
-    }
-    logger_1.default.debug(`Stopping logcat broadcasting on web socket server ` +
-        `${JSON.stringify(this.server.address())} to ${pathname}`);
-    await this.server.removeWebSocketHandler(pathname);
-};
-commands.getLogTypes = async function getLogTypes() {
-    const nativeLogTypes = await driver_1.BaseDriver.prototype.getLogTypes.call(this);
-    if (this.isWebContext()) {
-        const webLogTypes = await this.chromedriver.jwproxy.command('/log/types', 'GET');
-        return [...nativeLogTypes, ...webLogTypes];
-    }
-    return nativeLogTypes;
-};
-commands.getLog = async function getLog(logType) {
-    if (this.isWebContext() && !lodash_1.default.keys(this.supportedLogTypes).includes(logType)) {
-        return await this.chromedriver.jwproxy.command('/log', 'POST', { type: logType });
-    }
-    return await driver_1.BaseDriver.prototype.getLog.call(this, logType);
-};
-Object.assign(extensions, commands, helpers);
-exports.default = extensions;
 //# sourceMappingURL=log.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":";;;;;;AAAA,uDAA4B;AAC5B,4CAAoB;AACpB,oDAAuB;AACvB,4CAA2B;AAC3B,0CAAuE;AAEvE,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AAElD,IAAI,QAAQ,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,UAAU,GAAG,EAAE,CAAC;AAsIxC,4BAAQ;AAAE,0BAAO;AApI1B,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,mCAA0B,YAAY,SAAS,uBAAuB,CAAC;AAEpH,iJAAiJ;AACjJ,SAAS,WAAW,CAAE,SAAS,EAAE,KAAK,EAAE,OAAO;IAC7C,OAAO;QACL,SAAS;QACT,KAAK;QACL,OAAO;KACR,CAAC;AACJ,CAAC;AAED,UAAU,CAAC,iBAAiB,GAAG;IAC7B,MAAM,EAAE;QACN,WAAW,EAAE,oEAAoE;QACjF,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE;KACvD;IACD,SAAS,EAAE;QACT,WAAW,EAAE,uDAAuD;QACpE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC,KAAK,CAAC,YAAE,CAAC,GAAG,CAAC;iBACxB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAClD,CAAC;KACF;IACD,MAAM,EAAE;QACN,WAAW,EAAE,oBAAoB;QACjC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACf,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;YACnD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,OAAO,gBAAG,CAAC,MAAM,EAAE,CAAC,MAAM;iBACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,EACT,KAAK,EACL,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,CACtF,CAAC;QACN,CAAC;KACF;CACF,CAAC;AAEF;;;;;;;GAOG;AACH,QAAQ,CAAC,wBAAwB,GAAG,KAAK,UAAU,wBAAwB;IACzE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACpD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,EAAE;QAChE,gBAAG,CAAC,KAAK,CAAC,qEAAqE,QAAQ,EAAE,CAAC,CAAC;QAC3F,OAAO;KACR;IAED,gBAAG,CAAC,IAAI,CAAC,oDAAoD;QAC3D,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,QAAQ,EAAE,CAAC,CAAC;IAC7D,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;YACP,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,gBAAG,CAAC,KAAK,CAAC,gEAAgE,QAAQ,EAAE,CAAC,CAAC;SACvF;aAAM;YACL,gBAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;SACtE;QAED,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE;YAC5C,IAAI,CAAC,wBAAwB,GAAG,CAAC,SAAS,EAAE,EAAE;gBAC5C,IAAI,EAAE,EAAE,UAAU,KAAK,YAAS,CAAC,IAAI,EAAE;oBACrC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBAC5B;YACH,CAAC,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAE1D,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YAC9B,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE;gBAC7C,IAAI;oBACF,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;iBAC9D;gBAAC,OAAO,GAAG,EAAE,GAAE;gBAChB,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC;aACtC;YAED,IAAI,QAAQ,GAAG,uCAAuC,CAAC;YACvD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACpB,QAAQ,IAAI,UAAU,IAAI,GAAG,CAAC;aAC/B;YACD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACtB,QAAQ,IAAI,YAAY,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC;aAC9C;YACD,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF;;;GAGG;AACH,QAAQ,CAAC,uBAAuB,GAAG,KAAK,UAAU,uBAAuB;IACvE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACpD,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,EAAE;QAC/D,OAAO;KACR;IAED,gBAAG,CAAC,KAAK,CAAC,oDAAoD;QAC5D,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,QAAQ,EAAE,CAAC,CAAC;IAC7D,MAAM,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,QAAQ,CAAC,WAAW,GAAG,KAAK,UAAU,WAAW;IAC/C,MAAM,cAAc,GAAG,MAAM,mBAAU,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzE,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;QACvB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACjF,OAAO,CAAC,GAAG,cAAc,EAAE,GAAG,WAAW,CAAC,CAAC;KAC5C;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,QAAQ,CAAC,MAAM,GAAG,KAAK,UAAU,MAAM,CAAE,OAAO;IAC9C,IAAI,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QAC5E,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,mBAAU,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAE7C,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":";AAAA,YAAY;;;;;AAEZ,0CAAqE;AACrE,oDAAuB;AACvB,sDAAyB;AACzB,4CAA2B;AAC3B,uDAA4B;AAC5B,qCAA+B;AAE/B,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AAElD;;;GAGG;AACH,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,EAAE,CACvC,GAAG,mCAA0B,YAAY,SAAS,uBAAuB,CAAC;AAE5E;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO;IAC5C,OAAO;QACL,SAAS;QACT,KAAK;QACL,OAAO;KACR,CAAC;AACJ,CAAC;AACD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,iBAAiB,EAAE;QACjB,MAAM,EAAE;YACN,WAAW,EAAE,oEAAoE;YACjF;;;;eAIG;YACH,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE;SAChE;QACD,SAAS,EAAE;YACT,WAAW,EAAE,uDAAuD;YACpE;;;;eAIG;YACH,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBACrB,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,OAAO,MAAM,CAAC,KAAK,CAAC,iBAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3E,CAAC;SACF;QACD,MAAM,EAAE;YACN,WAAW,EAAE,oBAAoB;YACjC;;;;eAIG;YACH,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBACf,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;gBACnD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,OAAO,gBAAG;qBACP,MAAM,EAAE;qBACR,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAChB,WAAW,CACT,SAAS,EACT,KAAK,EACL,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,CAC/D,CACF,CAAC;YACN,CAAC;SACF;KACF;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB;QAC5B,MAAM,MAAM,GAAG,mDAAmD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjF,MAAM,GAAG,GAAG,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,EAAE;YAC3D,gBAAG,CAAC,KAAK,CAAC,qEAAqE,QAAQ,EAAE,CAAC,CAAC;YAC3F,OAAO;SACR;QAED,gBAAG,CAAC,IAAI,CACN,oDAAoD;YAClD,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,QAAQ,EAAE,CACvD,CAAC;QACF,yDAAyD;QACzD,MAAM,GAAG,GAAG,IAAI,YAAS,CAAC,MAAM,CAAC;YAC/B,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;YAC/B,IAAI,GAAG,EAAE;gBACP,MAAM,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;oBACxD,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa;oBAC/B,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;gBACnC,gBAAG,CAAC,KAAK,CAAC,gEAAgE,QAAQ,EAAE,CAAC,CAAC;aACvF;iBAAM;gBACL,gBAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;aACtE;YAED,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE;gBAC5C,IAAI,CAAC,wBAAwB,GAAG,CAAC,SAAS,EAAE,EAAE;oBAC5C,IAAI,EAAE,EAAE,UAAU,KAAK,YAAS,CAAC,IAAI,EAAE;wBACrC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;qBAC5B;gBACH,CAAC,CAAC;aACH;YACD,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAErD,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;gBAC9B,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE;oBAC7C,IAAI;wBACF,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;qBACzD;oBAAC,OAAO,GAAG,EAAE,GAAE;oBAChB,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;iBAC3C;gBAED,IAAI,QAAQ,GAAG,uCAAuC,CAAC;gBACvD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBACpB,QAAQ,IAAI,UAAU,IAAI,GAAG,CAAC;iBAC/B;gBACD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;oBACtB,QAAQ,IAAI,YAAY,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC;iBAC9C;gBACD,gBAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,CAAC,mBAAmB,CAC9B,QAAQ;QACR,+CAA+C,CAAC,CAAC,GAAG,CAAC,CACtD,CAAC;IACJ,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,uBAAuB;QAC3B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,mDAAmD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjF,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,EAAE;YAC1D,OAAO;SACR;QAED,gBAAG,CAAC,KAAK,CACP,oDAAoD;YAClD,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,QAAQ,EAAE,CACvD,CAAC;QACF,MAAM,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,WAAW;QACf,qCAAqC;QACrC,MAAM,cAAc,GAAG,MAAM,mBAAU,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzE,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;YACvB,MAAM,WAAW,GAAG,uBAAuB,CAAC,CAC1C,MAAM,yDAAyD,CAAC,CAC9D,IAAI,CAAC,YAAY,CAClB,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CACvC,CAAC;YACF,OAAO,CAAC,GAAG,cAAc,EAAE,GAAG,WAAW,CAAC,CAAC;SAC5C;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAO;QAClB,IAAI,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC5E,OAAO,MAAM,yDAAyD,CAAC,CACrE,IAAI,CAAC,YAAY,CAClB,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,CAAC,CAAC;SACpD;QACD,qCAAqC;QACrC,OAAO,MAAM,mBAAU,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF,CAAC;AAEF,IAAA,cAAK,EAAC,QAAQ,CAAC,CAAC;AAEhB,kBAAe,QAAQ,CAAC;AAExB;;GAEG"}

package/build/lib/commands/media-projection.d.ts

@@ -1,144 +1,8 @@
-export default commands;
-export type StartRecordingOptions = {
-    /**
-     * Maximum supported resolution on-device (Detected
-     * automatically by the app itself), which usually equals to Full HD 1920x1080 on most
-     * phones however you can change it to following supported resolutions
-     * as well: "1920x1080", "1280x720", "720x480", "320x240", "176x144".
-     */
-    resolution: string | null;
-    /**
-     * [900] Default value: 900 seconds which means
-     * maximum allowed duration is 15 minute, you can increase it if your test takes
-     * longer than that.
-     */
-    maxDurationSec: number | null;
-    /**
-     * [high] Means recording thread priority is maximum
-     * however if you face performance drops during testing with recording enabled, you
-     * can reduce recording priority to "normal" or "low".
-     */
-    priority: string | null;
-    /**
-     * You can type recording video file name as you want,
-     * but recording currently supports only "mp4" format so your filename must end with ".mp4".
-     * An invalid file name will fail to start the recording.
-     * If not provided then the current timestamp will be used as file name.
-     */
-    filename: string | null;
-};
-export type StopRecordingOptions = {
-    /**
-     * The path to the remote location, where the resulting video 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 encoded as Base64 and passed as the endpoont response value.
-     * An exception will be thrown if the generated media file is too big to
-     * fit into the available process memory.
-     */
-    remotePath: string | null;
-    /**
-     * The name of the user for the remote authentication.
-     */
-    user: string | null;
-    /**
-     * The password for the remote authentication.
-     */
-    pass: string | null;
-    /**
-     * The http multipart upload method name. The 'PUT' one is used by default.
-     */
-    method: string | null;
-    /**
-     * Additional headers mapping for multipart http(s) uploads
-     */
-    headers: any | null;
-    /**
-     * [file] The name of the form field, where the file content BLOB should be stored for
-     * http(s) uploads
-     */
-    fileFieldName: string | null;
-    /**
-     * Additional form fields for multipart http(s) uploads
-     */
-    formFields: any | (Array<Pair> | null);
-    /**
-     * - The actual media upload request timeout in milliseconds;
-     * defaults to
-     */
-    uploadTimeout: number | null;
-};
-export namespace commands {
-    /**
-     * @typedef {Object} StartRecordingOptions
-     *
-     * @property {string?} resolution Maximum supported resolution on-device (Detected
-     * automatically by the app itself), which usually equals to Full HD 1920x1080 on most
-     * phones however you can change it to following supported resolutions
-     * as well: "1920x1080", "1280x720", "720x480", "320x240", "176x144".
-     * @property {number?} maxDurationSec [900] Default value: 900 seconds which means
-     * maximum allowed duration is 15 minute, you can increase it if your test takes
-     * longer than that.
-     * @property {string?} priority [high] Means recording thread priority is maximum
-     * however if you face performance drops during testing with recording enabled, you
-     * can reduce recording priority to "normal" or "low".
-     * @property {string?} filename You can type recording video file name as you want,
-     * but recording currently supports only "mp4" format so your filename must end with ".mp4".
-     * An invalid file name will fail to start the recording.
-     * If not provided then the current timestamp will be used as file name.
-     */
-    /**
-     * Record the display of a real devices running Android 10 (API level 29) and higher.
-     * The screen activity is recorded to a MPEG-4 file. Audio is also recorded by default
-     * (only for apps that allow it in their manifests).
-     * If another recording has been already started then the command will exit silently.
-     * The previously recorded video file is deleted when a new recording session is started.
-     * Recording continues it is stopped explicitly or until the timeout happens.
-     *
-     * @param {?StartRecordingOptions} options Available options.
-     * @returns {boolean} True if a new recording has successfully started.
-     * @throws {Error} If recording has failed to start or is not supported on the device under test.
-     */
-    function mobileStartMediaProjectionRecording(options?: StartRecordingOptions | null): boolean;
-    /**
-     * Checks if a media projection-based recording is currently running.
-     *
-     * @returns {boolean} True if a recording is in progress.
-     * @throws {Error} If a recording is not supported on the device under test.
-     */
-    function mobileIsMediaProjectionRecordingRunning(): boolean;
-    /**
-     * @typedef {Object} StopRecordingOptions
-     *
-     * @property {string?} remotePath The path to the remote location, where the resulting video 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 encoded as Base64 and passed as the endpoont response value.
-     * An exception will be thrown if the generated media file is too big to
-     * fit into the available process memory.
-     * @property {string?} user The name of the user for the remote authentication.
-     * @property {string?} pass The password for the remote authentication.
-     * @property {string?} method The http multipart upload method name. The 'PUT' one is used by default.
-     * @property {Object?} headers Additional headers mapping for multipart http(s) uploads
-     * @property {string?} fileFieldName [file] The name of the form field, where the file content BLOB should be stored for
-     * http(s) uploads
-     * @property {Object|Array<Pair>?} formFields Additional form fields for multipart http(s) uploads
-     * @property {number?} uploadTimeout - The actual media upload request timeout in milliseconds;
-     * defaults to @appium/support net DEFAULT_TIMEOUT_MS
-     */
-    /**
-     * Stop a media projection-based recording.
-     * If no recording has been started before then an error is thrown.
-     * If the recording has been already finished before this API has been called
-     * then the most recent recorded file is returned.
-     *
-     * @param {?StopRecordingOptions} options Available options.
-     * @returns {string} Base64-encoded content of the recorded media file if 'remotePath'
-     * parameter is falsy or an empty string.
-     * @throws {Error} If there was an error while stopping a recording,
-     * fetching the content of the remote media file,
-     * or if a recording is not supported on the device under test.
-     */
-    function mobileStopMediaProjectionRecording(options?: StopRecordingOptions | null): string;
-}
+export default MediaProjectionMixin;
+export type ADB = import('appium-adb').ADB;
+/**
+ * @type {import('./mixins').MediaProjectionMixin & ThisType<import('../driver').AndroidDriver>}
+ * @satisfies {import('@appium/types').ExternalDriver}
+ */
+declare const MediaProjectionMixin: import('./mixins').MediaProjectionMixin & ThisType<import('../driver').AndroidDriver>;
 //# sourceMappingURL=media-projection.d.ts.map

package/build/lib/commands/media-projection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"media-projection.d.ts","sourceRoot":"","sources":["../../../lib/commands/media-projection.js"],"names":[],"mappings":";;;;;;;;gBAsKc,MAAM;;;;;;oBAIN,MAAM;;;;;;cAGN,MAAM;;;;;;;cAGN,MAAM;;;;;;;;;;;gBAsDN,MAAM;;;;UAMN,MAAM;;;;UACN,MAAM;;;;YACN,MAAM;;;;;;;;;mBAEN,MAAM;;;;gBAEN,OAAO,WAAW,QAAC;;;;;mBACnB,MAAM;;;IAhFpB;;;;;;;;;;;;;;;;;OAiBG;IAEH;;;;;;;;;;;OAWG;IACH,8FAkBC;IAED;;;;;OAKG;IACH,4DAKC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IAEH;;;;;;;;;;;;OAYG;IACH,2FAwBC"}
+{"version":3,"file":"media-projection.d.ts","sourceRoot":"","sources":["../../../lib/commands/media-projection.js"],"names":[],"mappings":";kBAoQa,OAAO,YAAY,EAAE,GAAG;AAzErC;;;GAGG;AACH,oCAHU,OAAO,UAAU,EAAE,oBAAoB,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CAiE7F"}