@appium/support 7.0.4 → 7.0.6

package/build/lib/mjpeg.js

@@ -8,10 +8,9 @@ const lodash_1 = __importDefault(require("lodash"));
 const logger_1 = __importDefault(require("./logger"));
 const bluebird_1 = __importDefault(require("bluebird"));
 const image_util_1 = require("./image-util");
-const stream_1 = require("stream");
+const node_stream_1 = require("node:stream");
 const node_1 = require("./node");
 const axios_1 = __importDefault(require("axios"));
-// lazy load this, as it might not be available
 let MJpegConsumer = null;
 /**
  * @throws {Error} If `mjpeg-consumer` module is not installed or cannot be loaded
@@ -19,29 +18,32 @@ let MJpegConsumer = null;
 async function initMJpegConsumer() {
     if (!MJpegConsumer) {
         try {
-            MJpegConsumer = await (0, node_1.requirePackage)('mjpeg-consumer');
+            MJpegConsumer = (await (0, node_1.requirePackage)('mjpeg-consumer'));
+        }
+        catch {
+            throw new Error('mjpeg-consumer module is required to use MJPEG-over-HTTP features. ' +
+                'Please install it first (npm i -g mjpeg-consumer) and restart Appium.');
         }
-        catch { }
-    }
-    if (!MJpegConsumer) {
-        throw new Error('mjpeg-consumer module is required to use MJPEG-over-HTTP features. ' +
-            'Please install it first (npm i -g mjpeg-consumer) and restart Appium.');
     }
+    return MJpegConsumer;
 }
-// amount of time to wait for the first image in the stream
 const MJPEG_SERVER_TIMEOUT_MS = 10000;
 /** Class which stores the last bit of data streamed into it */
-class MJpegStream extends stream_1.Writable {
-    /**
-     * @type {number}
-     */
+class MJpegStream extends node_stream_1.Writable {
+    errorHandler;
+    url;
+    /** Number of JPEG frames received so far (reset on {@linkcode clear}). Use stream['updateCount'] in tests if needed. */
     updateCount = 0;
+    /** Last received JPEG chunk (base64 via {@linkcode lastChunkBase64}); `null` when no data yet or after {@linkcode clear}/stop. Use stream['lastChunk'] in tests if needed. */
+    lastChunk = null;
+    registerStartSuccess = null;
+    registerStartFailure = null;
+    responseStream = null;
+    consumer = null;
     /**
-     * Create an MJpegStream
-     * @param {string} mJpegUrl - URL of MJPEG-over-HTTP stream
-     * @param {function} [errorHandler=noop] - additional function that will be
-     * called in the case of any errors.
-     * @param {object} [options={}] - Options to pass to the Writable constructor
+     * @param mJpegUrl - URL of MJPEG-over-HTTP stream
+     * @param errorHandler - additional function that will be called in the case of any errors
+     * @param options - Options to pass to the Writable constructor
      */
     constructor(mJpegUrl, errorHandler = lodash_1.default.noop, options = {}) {
         super(options);
@@ -49,49 +51,30 @@ class MJpegStream extends stream_1.Writable {
         this.url = mJpegUrl;
         this.clear();
     }
-    /**
-     * Get the base64-encoded version of the JPEG
-     *
-     * @returns {?string} base64-encoded JPEG image data
-     * or `null` if no image can be parsed
-     */
     get lastChunkBase64() {
-        const lastChunk = /** @type {Buffer} */ (this.lastChunk);
-        return !lodash_1.default.isEmpty(this.lastChunk) && lodash_1.default.isBuffer(this.lastChunk)
-            ? lastChunk.toString('base64')
-            : null;
+        const lastChunk = this.lastChunk;
+        if (lastChunk && !lodash_1.default.isEmpty(lastChunk) && lodash_1.default.isBuffer(lastChunk)) {
+            return lastChunk.toString('base64');
+        }
+        return null;
     }
-    /**
-     * Get the PNG version of the JPEG buffer
-     *
-     * @returns {Promise<Buffer?>} PNG image data or `null` if no PNG
-     * image can be parsed
-     */
     async lastChunkPNG() {
-        const lastChunk = /** @type {Buffer} */ (this.lastChunk);
-        if (lodash_1.default.isEmpty(lastChunk) || !lodash_1.default.isBuffer(lastChunk)) {
+        const chunk = this.lastChunk;
+        if (!chunk || lodash_1.default.isEmpty(chunk) || !lodash_1.default.isBuffer(chunk)) {
             return null;
         }
         try {
-            return await (0, image_util_1.requireSharp)()(lastChunk).png().toBuffer();
+            return await (0, image_util_1.requireSharp)()(chunk).png().toBuffer();
         }
-        catch {
+        catch (err) {
+            logger_1.default.warn(`Cannot convert MJPEG chunk to PNG: ${err.message}`);
             return null;
         }
     }
-    /**
-     * Get the base64-encoded version of the PNG
-     *
-     * @returns {Promise<string?>} base64-encoded PNG image data
-     * or `null` if no image can be parsed
-     */
     async lastChunkPNGBase64() {
         const png = await this.lastChunkPNG();
         return png ? png.toString('base64') : null;
     }
-    /**
-     * Reset internal state
-     */
     clear() {
         this.registerStartSuccess = null;
         this.registerStartFailure = null;
@@ -100,14 +83,10 @@ class MJpegStream extends stream_1.Writable {
         this.lastChunk = null;
         this.updateCount = 0;
     }
-    /**
-     * Start reading the MJpeg stream and storing the last image
-     */
     async start(serverTimeout = MJPEG_SERVER_TIMEOUT_MS) {
-        // ensure we're not started already
         this.stop();
-        await initMJpegConsumer();
-        this.consumer = new MJpegConsumer();
+        const Consumer = await initMJpegConsumer();
+        this.consumer = new Consumer();
         const url = this.url;
         try {
             this.responseStream = (await (0, axios_1.default)({
@@ -117,11 +96,19 @@ class MJpegStream extends stream_1.Writable {
             })).data;
         }
         catch (e) {
-            throw new Error(`Cannot connect to the MJPEG stream at ${url}. ` +
-                `Original error: ${lodash_1.default.has(e, 'response') ? JSON.stringify(e.response) : /** @type {Error} */ (e).message}`);
+            let message;
+            if (e && typeof e === 'object' && 'response' in e) {
+                message = JSON.stringify(e.response);
+            }
+            else if (e instanceof Error) {
+                message = e.message;
+            }
+            else {
+                message = String(e);
+            }
+            throw new Error(`Cannot connect to the MJPEG stream at ${url}. Original error: ${message}`);
         }
-        const onErr = (/** @type {Error} */ err) => {
-            // Make sure we don't get an outdated screenshot if there was an error
+        const onErr = (err) => {
             this.lastChunk = null;
             logger_1.default.error(`Error getting MJpeg screenshot chunk: ${err.message}`);
             this.errorHandler(err);
@@ -133,26 +120,18 @@ class MJpegStream extends stream_1.Writable {
             logger_1.default.debug(`The connection to MJPEG server at ${url} has been closed`);
             this.lastChunk = null;
         };
-        // use the deferred pattern so we can wait for the start of the stream
-        // based on what comes in from an external pipe
+        // TODO: replace with native Promises in Appium 4
         const startPromise = new bluebird_1.default((res, rej) => {
             this.registerStartSuccess = res;
             this.registerStartFailure = rej;
-        })
-            // start a timeout so that if the server does not return data, we don't
-            // block forever.
-            .timeout(serverTimeout, `Waited ${serverTimeout}ms but the MJPEG server never sent any images`);
+        }).timeout(serverTimeout, `Waited ${serverTimeout}ms but the MJPEG server never sent any images`);
         this.responseStream
             .once('close', onClose)
-            .on('error', onErr) // ensure we do something with errors
-            .pipe(this.consumer) // allow chunking and transforming of jpeg data
-            .pipe(this); // send the actual jpegs to ourself
+            .on('error', onErr)
+            .pipe(this.consumer)
+            .pipe(this);
         await startPromise;
     }
-    /**
-     * Stop reading the MJpeg stream. Ensure we disconnect all the pipes and stop
-     * the HTTP request itself. Then reset the state.
-     */
     stop() {
         if (this.consumer) {
             this.consumer.unpipe(this);
@@ -165,14 +144,12 @@ class MJpegStream extends stream_1.Writable {
         }
         this.clear();
     }
-    /**
-     * Override the Writable write() method in order to save the last image and
-     * log the number of images we have received
-     * @override
-     * @param {Buffer} data - binary data streamed from the MJpeg consumer
-     */
-    write(data) {
-        this.lastChunk = data;
+    /* eslint-disable @typescript-eslint/no-unused-vars -- Writable.write signature requires encoding and callback */
+    /* eslint-disable promise/prefer-await-to-callbacks -- Node Writable.write is callback-based */
+    write(data, encoding, callback) {
+        /* eslint-enable @typescript-eslint/no-unused-vars */
+        /* eslint-enable promise/prefer-await-to-callbacks */
+        this.lastChunk = Buffer.isBuffer(data) ? data : Buffer.from(data);
         this.updateCount++;
         if (this.registerStartSuccess) {
             this.registerStartSuccess();

package/build/lib/mjpeg.js.map

@@ -1 +1 @@
-{"version":3,"file":"mjpeg.js","sourceRoot":"","sources":["../../lib/mjpeg.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,sDAA2B;AAC3B,wDAAyB;AACzB,6CAA0C;AAC1C,mCAAgC;AAChC,iCAAsC;AACtC,kDAA0B;AAE1B,+CAA+C;AAC/C,IAAI,aAAa,GAAG,IAAI,CAAC;AAEzB;;GAEG;AACH,KAAK,UAAU,iBAAiB;IAC9B,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,aAAa,GAAG,MAAM,IAAA,qBAAc,EAAC,gBAAgB,CAAC,CAAC;QACzD,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,qEAAqE;YACnE,uEAAuE,CAC1E,CAAC;IACJ,CAAC;AACH,CAAC;AAED,2DAA2D;AAC3D,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,+DAA+D;AAC/D,MAAM,WAAY,SAAQ,iBAAQ;IAChC;;OAEG;IACH,WAAW,GAAG,CAAC,CAAC;IAEhB;;;;;;OAMG;IACH,YAAY,QAAQ,EAAE,YAAY,GAAG,gBAAC,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC;QACpB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,IAAI,eAAe;QACjB,MAAM,SAAS,GAAG,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,OAAO,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAC7D,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC9B,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,SAAS,GAAG,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,gBAAC,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC;YACH,OAAO,MAAM,IAAA,yBAAY,GAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB;QACtB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,aAAa,GAAG,uBAAuB;QACjD,mCAAmC;QACnC,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,MAAM,iBAAiB,EAAE,CAAC;QAE1B,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC;YACH,IAAI,CAAC,cAAc,GAAG,CACpB,MAAM,IAAA,eAAK,EAAC;gBACV,GAAG;gBACH,YAAY,EAAE,QAAQ;gBACtB,OAAO,EAAE,aAAa;aACvB,CAAC,CACH,CAAC,IAAI,CAAC;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,yCAAyC,GAAG,IAAI;gBAChD,mBAAmB,gBAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAC1G,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,oBAAoB,CAAC,GAAG,EAAE,EAAE;YACzC,sEAAsE;YACtE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,gBAAG,CAAC,KAAK,CAAC,yCAAyC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC9B,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,gBAAG,CAAC,KAAK,CAAC,qCAAqC,GAAG,kBAAkB,CAAC,CAAC;YACtE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC;QACF,sEAAsE;QACtE,+CAA+C;QAC/C,MAAM,YAAY,GAAG,IAAI,kBAAC,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACtC,IAAI,CAAC,oBAAoB,GAAG,GAAG,CAAC;YAChC,IAAI,CAAC,oBAAoB,GAAG,GAAG,CAAC;QAClC,CAAC,CAAC;YACA,uEAAuE;YACvE,iBAAiB;aAChB,OAAO,CACN,aAAa,EACb,UAAU,aAAa,+CAA+C,CACvE,CAAC;QAEJ,IAAI,CAAC,cAAc;aAChB,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;aACtB,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,qCAAqC;aACxD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,+CAA+C;aACnE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,mCAAmC;QAElD,MAAM,YAAY,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACnC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAEO,kCAAW"}
+{"version":3,"file":"mjpeg.js","sourceRoot":"","sources":["../../lib/mjpeg.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,sDAA2B;AAC3B,wDAAyB;AACzB,6CAA0C;AAC1C,6CAA0E;AAC1E,iCAAsC;AACtC,kDAA0B;AAK1B,IAAI,aAAa,GAAoC,IAAI,CAAC;AAE1D;;GAEG;AACH,KAAK,UAAU,iBAAiB;IAC9B,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,aAAa,GAAG,CAAC,MAAM,IAAA,qBAAc,EAAC,gBAAgB,CAAC,CAA6B,CAAC;QACvF,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CACb,qEAAqE;gBACnE,uEAAuE,CAC1E,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,+DAA+D;AAC/D,MAAa,WAAY,SAAQ,sBAAQ;IAC9B,YAAY,CAAuB;IACnC,GAAG,CAAS;IACrB,wHAAwH;IAChH,WAAW,GAAG,CAAC,CAAC;IACxB,8KAA8K;IACtK,SAAS,GAAkB,IAAI,CAAC;IAChC,oBAAoB,GAAwB,IAAI,CAAC;IACjD,oBAAoB,GAAkC,IAAI,CAAC;IAC3D,cAAc,GAAoB,IAAI,CAAC;IACvC,QAAQ,GAAkC,IAAI,CAAC;IAEvD;;;;OAIG;IACH,YACE,QAAgB,EAChB,eAAqC,gBAAC,CAAC,IAAI,EAC3C,UAA2B,EAAE;QAE7B,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC;QACpB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,IAAI,eAAe;QACjB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,SAAS,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAChE,OAAO,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC;QAC7B,IAAI,CAAC,KAAK,IAAI,gBAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,IAAA,yBAAY,GAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QACtD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,gBAAG,CAAC,IAAI,CAAC,sCAAsC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAED,KAAK;QACH,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,aAAa,GAAG,uBAAuB;QACjD,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,MAAM,QAAQ,GAAG,MAAM,iBAAiB,EAAE,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC;YACH,IAAI,CAAC,cAAc,GAAG,CACpB,MAAM,IAAA,eAAK,EAAC;gBACV,GAAG;gBACH,YAAY,EAAE,QAAQ;gBACtB,OAAO,EAAE,aAAa;aACvB,CAAC,CACH,CAAC,IAAgB,CAAC;QACrB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,OAAe,CAAC;YACpB,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;gBAClD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAE,CAAyB,CAAC,QAAQ,CAAC,CAAC;YAChE,CAAC;iBAAM,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBAC9B,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;YACD,MAAM,IAAI,KAAK,CACb,yCAAyC,GAAG,qBAAqB,OAAO,EAAE,CAC3E,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,GAAU,EAAE,EAAE;YAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,gBAAG,CAAC,KAAK,CAAC,yCAAyC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC9B,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,gBAAG,CAAC,KAAK,CAAC,qCAAqC,GAAG,kBAAkB,CAAC,CAAC;YACtE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC;QAEF,iDAAiD;QACjD,MAAM,YAAY,GAAG,IAAI,kBAAC,CAAO,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC5C,IAAI,CAAC,oBAAoB,GAAG,GAAG,CAAC;YAChC,IAAI,CAAC,oBAAoB,GAAG,GAAG,CAAC;QAClC,CAAC,CAAC,CAAC,OAAO,CACR,aAAa,EACb,UAAU,aAAa,+CAA+C,CACvE,CAAC;QAED,IAAI,CAAC,cAAoE;aACvE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;aACtB,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;aAClB,IAAI,CAAC,IAAI,CAAC,QAA+B,CAAC;aAC1C,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,MAAM,YAAY,CAAC;IACrB,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,iHAAiH;IACjH,+FAA+F;IACtF,KAAK,CACZ,IAAkC,EAClC,QAA2D,EAC3D,QAAwC;QAExC,qDAAqD;QACrD,qDAAqD;QACrD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxJD,kCAwJC"}

package/build/lib/mkdirp.d.ts

@@ -1,2 +1,5 @@
-export const mkdirp: (dir: PathLike) => Promise<string | undefined>;
+/**
+ * @deprecated Use `fs.mkdirp` instead.
+ */
+export declare const mkdirp: (dir: import("fs").PathLike) => Promise<string | undefined>;
 //# sourceMappingURL=mkdirp.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mkdirp.d.ts","sourceRoot":"","sources":["../../lib/mkdirp.js"],"names":[],"mappings":""}
+{"version":3,"file":"mkdirp.d.ts","sourceRoot":"","sources":["../../lib/mkdirp.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAO,MAAM,6DAAM,CAAC"}

package/build/lib/mkdirp.js

@@ -5,6 +5,5 @@ const fs_1 = require("./fs");
 /**
  * @deprecated Use `fs.mkdirp` instead.
  */
-const { mkdirp } = fs_1.fs;
-exports.mkdirp = mkdirp;
+exports.mkdirp = fs_1.fs.mkdirp;
 //# sourceMappingURL=mkdirp.js.map

package/build/lib/mkdirp.js.map

@@ -1 +1 @@
-{"version":3,"file":"mkdirp.js","sourceRoot":"","sources":["../../lib/mkdirp.js"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB;;GAEG;AACH,MAAM,EAAC,MAAM,EAAC,GAAG,OAAE,CAAC;AACZ,wBAAM"}
+{"version":3,"file":"mkdirp.js","sourceRoot":"","sources":["../../lib/mkdirp.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;GAEG;AACW,cAAM,GAAI,OAAE,QAAC"}

package/build/lib/net.d.ts

@@ -1,99 +1,61 @@
+import { type Method } from 'axios';
+import type { HTTPHeaders } from '@appium/types';
+/** Common options for {@linkcode uploadFile} and {@linkcode downloadFile}. */
+export interface NetOptions {
+    /** Whether to log the actual download performance (e.g. timings and speed). Defaults to true. */
+    isMetered?: boolean;
+    /** Authentication credentials */
+    auth?: AuthCredentials;
+}
+/** Basic auth credentials; used by {@linkcode NetOptions}. */
+export interface AuthCredentials {
+    /** Non-empty user name (or use `username` for axios-style) */
+    user?: string;
+    /** Non-empty password (or use `password` for axios-style) */
+    pass?: string;
+    username?: string;
+    password?: string;
+}
+/** Specific options for {@linkcode downloadFile}. */
+export interface DownloadOptions extends NetOptions {
+    /** Request timeout in milliseconds; defaults to {@linkcode DEFAULT_TIMEOUT_MS} */
+    timeout?: number;
+    /** Request headers mapping */
+    headers?: Record<string, unknown>;
+}
+/** Options for {@linkcode uploadFile} when the remote uses the `http(s)` protocol. */
+export interface HttpUploadOptions extends NetOptions {
+    /** Additional request headers */
+    headers?: HTTPHeaders;
+    /** HTTP method for file upload. Defaults to 'POST'. */
+    method?: Method;
+    /** Request timeout in milliseconds; defaults to {@linkcode DEFAULT_TIMEOUT_MS} */
+    timeout?: number;
+    /**
+     * Name of the form field containing the file. Any falsy value uses non-multipart upload.
+     * Defaults to 'file'.
+     */
+    fileFieldName?: string;
+    /**
+     * Additional form fields. Only considered if `fileFieldName` is set.
+     */
+    formFields?: Record<string, unknown> | [string, unknown][];
+}
 /**
- * Common options for {@linkcode uploadFile} and {@linkcode downloadFile}.
+ * Options for {@linkcode uploadFile} when the remote uses the `ftp` protocol.
  */
-export type NetOptions = {
-    /**
-     * - Whether to log the actual download performance
-     * (e.g. timings and speed)
-     */
-    isMetered?: boolean | undefined;
-    /**
-     * - Authentication credentials
-     */
-    auth?: AuthCredentials | undefined;
-};
-/**
- * Specific options for {@linkcode downloadFile}.
- */
-export type DownloadOptions = {
-    /**
-     * - The actual request timeout in milliseconds; defaults to {@linkcode DEFAULT_TIMEOUT_MS}
-     */
-    timeout?: number | undefined;
-    /**
-     * - Request headers mapping
-     */
-    headers?: Record<string, any> | undefined;
-};
-/**
- * Basic auth credentials; used by {@linkcode NetOptions}.
- */
-export type AuthCredentials = {
-    /**
-     * - Non-empty user name
-     */
-    user: string;
-    /**
-     * - Non-empty password
-     */
-    pass: string;
-};
+export interface FtpUploadOptions extends NetOptions {
+}
+/** @deprecated Use {@linkcode FtpUploadOptions} instead. */
+export type NotHttpUploadOptions = FtpUploadOptions;
 /**
- * This type is used in {@linkcode uploadFile} if the remote location uses the `ftp` protocol, and distinguishes the type from {@linkcode HttpUploadOptions}.
- */
-export type NotHttpUploadOptions = {
-    headers: never;
-    method: never;
-    timeout: never;
-    fileFieldName: never;
-    formFields: never;
-};
-/**
- * Specific options for {@linkcode uploadFile} if the remote location uses the `http(s)` protocol
- */
-export type HttpUploadOptions = {
-    /**
-     * - Additional request headers mapping
-     */
-    headers?: import("@appium/types").HTTPHeaders | undefined;
-    /**
-     * - The HTTP method used for file upload
-     */
-    method?: axios.Method | undefined;
-    /**
-     * - The actual request timeout in milliseconds; defaults to {@linkcode DEFAULT_TIMEOUT_MS}
-     */
-    timeout?: number | undefined;
-    /**
-     * - The name of the form field containing the file
-     * content to be uploaded. Any falsy value make the request to use non-multipart upload
-     */
-    fileFieldName?: string | undefined;
-    /**
-     * - The additional form fields
-     * to be included into the upload request. This property is only considered if
-     * `fileFieldName` is set
-     */
-    formFields?: Record<string, any> | [string, any][] | undefined;
-};
-/**
- * Uploads the given file to a remote location. HTTP(S) and FTP
- * protocols are supported.
- *
- * @param {string} localPath - The path to a file on the local storage.
- * @param {string} remoteUri - The remote URI to upload the file to.
- * @param {(HttpUploadOptions|NotHttpUploadOptions) & NetOptions} [uploadOptions]
- * @returns {Promise<void>}
+ * Uploads the given file to a remote location. HTTP(S) and FTP protocols are supported.
  */
-export function uploadFile(localPath: string, remoteUri: string, uploadOptions?: (HttpUploadOptions | NotHttpUploadOptions) & NetOptions): Promise<void>;
+export declare function uploadFile(localPath: string, remoteUri: string, uploadOptions?: HttpUploadOptions | FtpUploadOptions): Promise<void>;
 /**
- * Downloads the given file via HTTP(S)
+ * Downloads the given file via HTTP(S).
  *
- * @param {string} remoteUrl - The remote url
- * @param {string} dstPath - The local path to download the file to
- * @param {DownloadOptions & NetOptions} [downloadOptions]
  * @throws {Error} If download operation fails
  */
-export function downloadFile(remoteUrl: string, dstPath: string, downloadOptions?: DownloadOptions & NetOptions): Promise<void>;
-import axios from 'axios';
+export declare function downloadFile(remoteUrl: string, dstPath: string, downloadOptions?: DownloadOptions): Promise<void>;
 //# sourceMappingURL=net.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"net.d.ts","sourceRoot":"","sources":["../../lib/net.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAsTc,MAAM;;;;UACN,MAAM;;;;;;aAMN,KAAK;YACL,KAAK;aACL,KAAK;mBACL,KAAK;gBACL,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAzJnB;;;;;;;;GAQG;AACH,sCALW,MAAM,aACN,MAAM,kBACN,CAAC,iBAAiB,GAAC,oBAAoB,CAAC,GAAG,UAAU,GACnD,OAAO,CAAC,IAAI,CAAC,CAyCzB;AAED;;;;;;;GAOG;AACH,wCALW,MAAM,WACN,MAAM,oBACN,eAAe,GAAG,UAAU,iBAiEtC;kBAzRiB,OAAO"}
+{"version":3,"file":"net.d.ts","sourceRoot":"","sources":["../../lib/net.ts"],"names":[],"mappings":"AAMA,OAAc,EAA6B,KAAK,MAAM,EAA6B,MAAM,OAAO,CAAC;AAEjG,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAI/C,8EAA8E;AAC9E,MAAM,WAAW,UAAU;IACzB,iGAAiG;IACjG,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iCAAiC;IACjC,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,sFAAsF;AACtF,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,iCAAiC;IACjC,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;CAAG;AAEvD,4DAA4D;AAC5D,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAEpD;;GAEG;AACH,wBAAsB,UAAU,CAC9B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,aAAa,GAAE,iBAAiB,GAAG,gBAAqB,GACvD,OAAO,CAAC,IAAI,CAAC,CAmCf;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,eAAe,GAAE,eAAoB,GACpC,OAAO,CAAC,IAAI,CAAC,CAwDf"}