cuki-bailx 1.1.2 → 1.2.3

package/lib/Utils/messages-media.js

@@ -15,47 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStatusCodeForMediaRetry = exports.decryptMediaRetryData = exports.decodeMediaRetryNode = exports.encryptMediaRetryRequest = exports.getWAUploadToServer = exports.downloadEncryptedContent = exports.downloadContentFromMessage = exports.getUrlFromDirectPath = exports.encryptedStream = exports.prepareStream = exports.getHttpStream = exports.getStream = exports.toBuffer = exports.toReadable = exports.mediaMessageSHA256B64 = exports.generateProfilePicture = exports.encodeBase64EncodedStringForUpload = exports.extractImageThumb = exports.extractVideoThumb = exports.hkdfInfoKey = void 0;
-exports.getMediaKeys = getMediaKeys;
-exports.uploadFile = uploadFile;
-exports.vid2jpg = vid2jpg;
-exports.getAudioDuration = getAudioDuration;
-exports.getAudioWaveform = getAudioWaveform;
-exports.generateThumbnail = generateThumbnail;
-exports.extensionForMediaMessage = extensionForMediaMessage;
+exports.getStatusCodeForMediaRetry = exports.decryptMediaRetryData = exports.decodeMediaRetryNode = exports.encryptMediaRetryRequest = exports.getWAUploadToServer = exports.extensionForMediaMessage = exports.downloadEncryptedContent = exports.downloadContentFromMessage = exports.getUrlFromDirectPath = exports.encryptedStream = exports.prepareStream = exports.getHttpStream = exports.generateThumbnail = exports.getStream = exports.toBuffer = exports.toReadable = exports.getAudioWaveform = exports.getAudioDuration = exports.mediaMessageSHA256B64 = exports.generateProfilePicture = exports.encodeBase64EncodedStringForUpload = exports.extractImageThumb = exports.getMediaKeys = exports.hkdfInfoKey = void 0;
 const boom_1 = require("@hapi/boom");
-const axios_1 = __importDefault(require("axios"));
-const form_data_1 = __importDefault(require("form-data"));
-const cheerio = __importStar(require("cheerio"));
+const child_process_1 = require("child_process");
 const Crypto = __importStar(require("crypto"));
 const events_1 = require("events");
 const fs_1 = require("fs");
 const os_1 = require("os");
 const path_1 = require("path");
-const jimp_1 = __importDefault(require("jimp"));
 const stream_1 = require("stream");
-const child_process_1 = require("child_process");
 const WAProto_1 = require("../../WAProto");
 const Defaults_1 = require("../Defaults");
 const WABinary_1 = require("../WABinary");
@@ -65,11 +41,13 @@ const getTmpFilesDirectory = () => (0, os_1.tmpdir)();
 const getImageProcessingLibrary = async () => {
     const [_jimp, sharp] = await Promise.all([
         (async () => {
-            const jimp = await (Promise.resolve().then(() => __importStar(require('jimp'))).catch(() => { }));
+            const jimp = await (import('jimp')
+                .catch(() => { }));
             return jimp;
         })(),
         (async () => {
-            const sharp = await (Promise.resolve().then(() => __importStar(require('sharp'))).catch(() => { }));
+            const sharp = await (import('sharp')
+                .catch(() => { }));
             return sharp;
         })()
     ]);
@@ -88,7 +66,7 @@ const hkdfInfoKey = (type) => {
 };
 exports.hkdfInfoKey = hkdfInfoKey;
 /** generates all the keys required to encrypt/decrypt & sign a media message */
-async function getMediaKeys(buffer, mediaType) {
+function getMediaKeys(buffer, mediaType) {
     if (!buffer) {
         throw new boom_1.Boom('Cannot derive from empty media key');
     }
@@ -96,183 +74,26 @@ async function getMediaKeys(buffer, mediaType) {
         buffer = Buffer.from(buffer.replace('data:;base64,', ''), 'base64');
     }
     // expand using HKDF to 112 bytes, also pass in the relevant app info
-    const expandedMediaKey = await (0, crypto_1.hkdf)(buffer, 112, { info: (0, exports.hkdfInfoKey)(mediaType) });
+    const expandedMediaKey = (0, crypto_1.hkdf)(buffer, 112, { info: (0, exports.hkdfInfoKey)(mediaType) });
     return {
         iv: expandedMediaKey.slice(0, 16),
         cipherKey: expandedMediaKey.slice(16, 48),
         macKey: expandedMediaKey.slice(48, 80),
     };
 }
-async function uploadFile(buffer, logger) {
-    const { fromBuffer } = await Promise.resolve().then(() => __importStar(require('file-type')));
-    const fileType = await fromBuffer(buffer);
-    if (!fileType)
-        throw new Error("Failed to detect file type.");
-    const { ext, mime } = fileType;
-    const services = [
-        {
-            name: "catbox",
-            url: "https://catbox.moe/user/api.php",
-            buildForm: () => {
-                const form = new form_data_1.default();
-                form.append("fileToUpload", buffer, {
-                    filename: `file.${ext}`,
-                    contentType: mime || "application/octet-stream"
-                });
-                form.append("reqtype", "fileupload");
-                return form;
-            },
-            parseResponse: res => res.data
-        },
-        {
-            name: "pdi.moe",
-            url: "https://scdn.pdi.moe/upload",
-            buildForm: () => {
-                const form = new form_data_1.default();
-                form.append("file", buffer, {
-                    filename: `file.${ext}`,
-                    contentType: mime
-                });
-                return form;
-            },
-            parseResponse: res => res.data.result.url
-        },
-        {
-            name: "qu.ax",
-            url: "https://qu.ax/upload.php",
-            buildForm: () => {
-                const form = new form_data_1.default();
-                form.append("files[]", buffer, {
-                    filename: `file.${ext}`,
-                    contentType: mime || "application/octet-stream"
-                });
-                return form;
-            },
-            parseResponse: res => {
-                var _a, _b, _c;
-                if (!((_c = (_b = (_a = res.data) === null || _a === void 0 ? void 0 : _a.files) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.url))
-                    throw new Error("Failed to get URL from qu.ax");
-                return res.data.files[0].url;
-            }
-        },
-        {
-            name: "uguu.se",
-            url: "https://uguu.se/upload.php",
-            buildForm: () => {
-                const form = new form_data_1.default();
-                form.append("files[]", buffer, {
-                    filename: `file.${ext}`,
-                    contentType: mime || "application/octet-stream"
-                });
-                return form;
-            },
-            parseResponse: res => {
-                var _a, _b, _c;
-                if (!((_c = (_b = (_a = res.data) === null || _a === void 0 ? void 0 : _a.files) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.url))
-                    throw new Error("Failed to get URL from uguu.se");
-                return res.data.files[0].url;
-            }
-        },
-        {
-            name: "tmpfiles",
-            url: "https://tmpfiles.org/api/v1/upload",
-            buildForm: () => {
-                const form = new form_data_1.default();
-                form.append("file", buffer, {
-                    filename: `file.${ext}`,
-                    contentType: mime
-                });
-                return form;
-            },
-            parseResponse: res => {
-                const match = res.data.data.url.match(/https:\/\/tmpfiles\.org\/(.*)/);
-                if (!match)
-                    throw new Error("Failed to parse tmpfiles URL.");
-                return `https://tmpfiles.org/dl/${match[1]}`;
-            }
-        }
-    ];
-    for (const service of services) {
-        try {
-            const form = service.buildForm();
-            const res = await axios_1.default.post(service.url, form, {
-                headers: form.getHeaders()
-            });
-            const url = service.parseResponse(res);
-            return url;
-        }
-        catch (error) {
-            logger === null || logger === void 0 ? void 0 : logger.debug(`[${service.name}] eror:`, (error === null || error === void 0 ? void 0 : error.message) || error);
-        }
-    }
-    throw new Error("All upload services failed.");
-}
-async function vid2jpg(videoUrl) {
-    try {
-        const { data } = await axios_1.default.get(`https://ezgif.com/video-to-jpg?url=${encodeURIComponent(videoUrl)}`);
-        const $ = cheerio.load(data);
-        const fileToken = $('input[name="file"]').attr("value");
-        if (!fileToken) {
-            throw new Error("Failed to retrieve file token. The video URL may be invalid or inaccessible.");
-        }
-        const formData = new URLSearchParams();
-        formData.append("file", fileToken);
-        formData.append("end", "1");
-        formData.append("video-to-jpg", "Convert to JPG!");
-        const convert = await axios_1.default.post(`https://ezgif.com/video-to-jpg/${fileToken}`, formData);
-        const $2 = cheerio.load(convert.data);
-        let imageUrl = $2("#output img").first().attr("src");
-        if (!imageUrl) {
-            throw new Error("Could not locate the converted image output.");
-        }
-        if (imageUrl.startsWith("//")) {
-            imageUrl = "https:" + imageUrl;
+exports.getMediaKeys = getMediaKeys;
+/** Extracts video thumb using FFMPEG */
+const extractVideoThumb = async (path, destPath, time, size) => new Promise((resolve, reject) => {
+    const cmd = `ffmpeg -ss ${time} -i ${path} -y -vf scale=${size.width}:-1 -vframes 1 -f image2 ${destPath}`;
+    (0, child_process_1.exec)(cmd, (err) => {
+        if (err) {
+            reject(err);
         }
-        else if (imageUrl.startsWith("/")) {
-            const cdnMatch = imageUrl.match(/\/(s\d+\..+?)\/.*/);
-            if (cdnMatch) {
-                imageUrl = "https://" + imageUrl.slice(2);
-            }
-            else {
-                imageUrl = "https://ezgif.com" + imageUrl;
-            }
+        else {
+            resolve();
         }
-        return imageUrl;
-    }
-    catch (error) {
-        throw new Error("Failed to convert video to JPG: " + error.message);
-    }
-}
-/**
- * Extracts video thumbnail using FFmpeg
- */
-const extractVideoThumb = async (videoPath, time = '00:00:00', size = { width: 256 }) => {
-    return new Promise((resolve, reject) => {
-        const args = [
-            '-ss', time,
-            '-i', videoPath,
-            '-y',
-            '-vf', `scale=${size.width}:-1`,
-            '-vframes', '1',
-            '-f', 'image2',
-            '-vcodec', 'mjpeg',
-            'pipe:1'
-        ];
-        const ffmpeg = (0, child_process_1.spawn)('ffmpeg', args);
-        const chunks = [];
-        let errorOutput = '';
-        ffmpeg.stdout.on('data', chunk => chunks.push(chunk));
-        ffmpeg.stderr.on('data', data => {
-            errorOutput += data.toString();
-        });
-        ffmpeg.on('error', reject);
-        ffmpeg.on('close', code => {
-            if (code === 0) return resolve(Buffer.concat(chunks));
-            reject(new Error(`ffmpeg exited with code ${code}\n${errorOutput}`));
-        });
     });
-};
-exports.extractVideoThumb = extractVideoThumb;
+});
 const extractImageThumb = async (bufferOrFilePath, width = 32) => {
     var _a, _b;
     if (bufferOrFilePath instanceof stream_1.Readable) {
@@ -321,8 +142,8 @@ const encodeBase64EncodedStringForUpload = (b64) => (encodeURIComponent(b64
     .replace(/\=+$/, '')));
 exports.encodeBase64EncodedStringForUpload = encodeBase64EncodedStringForUpload;
 const generateProfilePicture = async (mediaUpload) => {
+    var _a, _b;
     let bufferOrFilePath;
-    let img;
     if (Buffer.isBuffer(mediaUpload)) {
         bufferOrFilePath = mediaUpload;
     }
@@ -332,11 +153,29 @@ const generateProfilePicture = async (mediaUpload) => {
     else {
         bufferOrFilePath = await (0, exports.toBuffer)(mediaUpload.stream);
     }
-    const jimp = await jimp_1.default.read(bufferOrFilePath);
-    const cropped = jimp.getWidth() > jimp.getHeight() ? jimp.resize(550, -1) : jimp.resize(-1, 650);
-    img = cropped
-        .quality(100)
-        .getBufferAsync(jimp_1.default.MIME_JPEG);
+    const lib = await getImageProcessingLibrary();
+    let img;
+    if ('sharp' in lib && typeof ((_a = lib.sharp) === null || _a === void 0 ? void 0 : _a.default) === 'function') {
+        img = lib.sharp.default(bufferOrFilePath)
+            .resize(640, 640)
+            .jpeg({
+            quality: 50,
+        })
+            .toBuffer();
+    }
+    else if ('jimp' in lib && typeof ((_b = lib.jimp) === null || _b === void 0 ? void 0 : _b.read) === 'function') {
+        const { read, MIME_JPEG, RESIZE_BILINEAR } = lib.jimp;
+        const jimp = await read(bufferOrFilePath);
+        const min = Math.min(jimp.getWidth(), jimp.getHeight());
+        const cropped = jimp.crop(0, 0, min, min);
+        img = cropped
+            .quality(50)
+            .resize(640, 640, RESIZE_BILINEAR)
+            .getBufferAsync(MIME_JPEG);
+    }
+    else {
+        throw new boom_1.Boom('No image processing library available');
+    }
     return {
         img: await img,
     };
@@ -349,25 +188,32 @@ const mediaMessageSHA256B64 = (message) => {
 };
 exports.mediaMessageSHA256B64 = mediaMessageSHA256B64;
 async function getAudioDuration(buffer) {
-    const musicMetadata = await Promise.resolve().then(() => __importStar(require('music-metadata')));
+    const musicMetadata = await import('music-metadata');
     let metadata;
-    const options = {
-        duration: true
-    };
     if (Buffer.isBuffer(buffer)) {
-        metadata = await musicMetadata.parseBuffer(buffer, undefined, options);
+        metadata = await musicMetadata.parseBuffer(buffer, undefined, { duration: true });
     }
     else if (typeof buffer === 'string') {
-        metadata = await musicMetadata.parseFile(buffer, options);
+        const rStream = (0, fs_1.createReadStream)(buffer);
+        try {
+            metadata = await musicMetadata.parseStream(rStream, undefined, { duration: true });
+        }
+        finally {
+            rStream.destroy();
+        }
     }
     else {
-        metadata = await musicMetadata.parseStream(buffer, undefined, options);
+        metadata = await musicMetadata.parseStream(buffer, undefined, { duration: true });
     }
     return metadata.format.duration;
 }
+exports.getAudioDuration = getAudioDuration;
+/**
+  referenced from and modifying https://github.com/wppconnect-team/wa-js/blob/main/src/chat/functions/prepareAudioWaveform.ts
+ */
 async function getAudioWaveform(buffer, logger) {
     try {
-        const { default: decoder } = await eval('import(\'audio-decode\')');
+        const audioDecode = (buffer) => import('audio-decode').then(({ default: audioDecode }) => audioDecode(buffer));
         let audioData;
         if (Buffer.isBuffer(buffer)) {
             audioData = buffer;
@@ -379,21 +225,23 @@ async function getAudioWaveform(buffer, logger) {
         else {
             audioData = await (0, exports.toBuffer)(buffer);
         }
-        const audioBuffer = await decoder(audioData);
-        const rawData = audioBuffer.getChannelData(0);
-        const samples = 64;
-        const blockSize = Math.floor(rawData.length / samples);
+        const audioBuffer = await audioDecode(audioData);
+        const rawData = audioBuffer.getChannelData(0); // We only need to work with one channel of data
+        const samples = 64; // Number of samples we want to have in our final data set
+        const blockSize = Math.floor(rawData.length / samples); // the number of samples in each subdivision
         const filteredData = [];
         for (let i = 0; i < samples; i++) {
-            const blockStart = blockSize * i;
+            const blockStart = blockSize * i; // the location of the first sample in the block
             let sum = 0;
             for (let j = 0; j < blockSize; j++) {
-                sum = sum + Math.abs(rawData[blockStart + j]);
+                sum = sum + Math.abs(rawData[blockStart + j]); // find the sum of all the samples in the block
             }
-            filteredData.push(sum / blockSize);
+            filteredData.push(sum / blockSize); // divide the sum by the block size to get the average
         }
+        // This guarantees that the largest data point will be set to 1, and the rest of the data will scale proportionally.
         const multiplier = Math.pow(Math.max(...filteredData), -1);
         const normalizedData = filteredData.map((n) => n * multiplier);
+        // Generate waveform like WhatsApp
         const waveform = new Uint8Array(normalizedData.map((n) => Math.floor(100 * n)));
         return waveform;
     }
@@ -401,6 +249,7 @@ async function getAudioWaveform(buffer, logger) {
         logger === null || logger === void 0 ? void 0 : logger.debug('Failed to generate waveform: ' + e);
     }
 }
+exports.getAudioWaveform = getAudioWaveform;
 const toReadable = (buffer) => {
     const readable = new stream_1.Readable({ read: () => { } });
     readable.push(buffer);
@@ -446,28 +295,12 @@ async function generateThumbnail(file, mediaType, options) {
         }
     }
     else if (mediaType === 'video') {
+        const imgFilename = (0, path_1.join)(getTmpFilesDirectory(), (0, generics_1.generateMessageID)() + '.jpg');
         try {
-            let videoPath = file;
-            if (Buffer.isBuffer(file) || file instanceof stream_1.Readable) {
-                videoPath = (0, path_1.join)(getTmpFilesDirectory(), (0, generics_1.generateMessageIDV2)() + '.mp4');
-                const buffer = Buffer.isBuffer(file) ? file : await (0, exports.toBuffer)(file);
-                await fs_1.promises.writeFile(videoPath, buffer);
-            }
-            const thumbnailBuffer = await (0, exports.extractVideoThumb)(videoPath);
-            const imgFilename = (0, path_1.join)(getTmpFilesDirectory(), (0, generics_1.generateMessageIDV2)() + '.jpg');
-            await fs_1.promises.writeFile(imgFilename, thumbnailBuffer);
-            const { buffer: processedThumbnailBuffer, original } = await (0, exports.extractImageThumb)(imgFilename);
-            thumbnail = processedThumbnailBuffer.toString('base64');
-            if (original.width && original.height) {
-                originalImageDimensions = {
-                    width: original.width,
-                    height: original.height,
-                };
-            }
+            await extractVideoThumb(file, imgFilename, '00:00:00', { width: 32, height: 32 });
+            const buff = await fs_1.promises.readFile(imgFilename);
+            thumbnail = buff.toString('base64');
             await fs_1.promises.unlink(imgFilename);
-            if (videoPath !== file) {
-                await fs_1.promises.unlink(videoPath);
-            }
         }
         catch (err) {
             (_a = options.logger) === null || _a === void 0 ? void 0 : _a.debug('could not generate video thumb: ' + err);
@@ -478,8 +311,10 @@ async function generateThumbnail(file, mediaType, options) {
         originalImageDimensions
     };
 }
+exports.generateThumbnail = generateThumbnail;
 const getHttpStream = async (url, options = {}) => {
-    const fetched = await axios_1.default.get(url.toString(), { ...options, responseType: 'stream' });
+    const { default: axios } = await import('axios');
+    const fetched = await axios.get(url.toString(), { ...options, responseType: 'stream' });
     return fetched.data;
 };
 exports.getHttpStream = getHttpStream;
@@ -494,7 +329,7 @@ const prepareStream = async (media, mediaType, { logger, saveOriginalFileIfRequi
             bodyPath = media.url;
         }
         else if (saveOriginalFileIfRequired) {
-            bodyPath = (0, path_1.join)(getTmpFilesDirectory(), mediaType + (0, generics_1.generateMessageIDV2)());
+            bodyPath = (0, path_1.join)(getTmpFilesDirectory(), mediaType + (0, generics_1.generateMessageID)());
             (0, fs_1.writeFileSync)(bodyPath, buffer);
             didSaveToTmpPath = true;
         }
@@ -513,6 +348,7 @@ const prepareStream = async (media, mediaType, { logger, saveOriginalFileIfRequi
         };
     }
     catch (error) {
+        // destroy all streams with error
         stream.destroy();
         if (didSaveToTmpPath) {
             try {
@@ -530,7 +366,7 @@ const encryptedStream = async (media, mediaType, { logger, saveOriginalFileIfReq
     const { stream, type } = await (0, exports.getStream)(media, opts);
     logger === null || logger === void 0 ? void 0 : logger.debug('fetched media stream');
     const mediaKey = Crypto.randomBytes(32);
-    const { cipherKey, iv, macKey } = await getMediaKeys(mediaKey, mediaType);
+    const { cipherKey, iv, macKey } = getMediaKeys(mediaKey, mediaType);
     const encWriteStream = new stream_1.Readable({ read: () => { } });
     let bodyPath;
     let writeStream;
@@ -539,7 +375,7 @@ const encryptedStream = async (media, mediaType, { logger, saveOriginalFileIfReq
         bodyPath = media.url;
     }
     else if (saveOriginalFileIfRequired) {
-        bodyPath = (0, path_1.join)(getTmpFilesDirectory(), mediaType + (0, generics_1.generateMessageIDV2)());
+        bodyPath = (0, path_1.join)(getTmpFilesDirectory(), mediaType + (0, generics_1.generateMessageID)());
         writeStream = (0, fs_1.createWriteStream)(bodyPath);
         didSaveToTmpPath = true;
     }
@@ -588,6 +424,7 @@ const encryptedStream = async (media, mediaType, { logger, saveOriginalFileIfReq
         };
     }
     catch (error) {
+        // destroy all streams with error
         encWriteStream.destroy();
         writeStream === null || writeStream === void 0 ? void 0 : writeStream.destroy();
         aes.destroy();
@@ -619,20 +456,21 @@ const toSmallestChunkSize = (num) => {
 };
 const getUrlFromDirectPath = (directPath) => `https://${DEF_HOST}${directPath}`;
 exports.getUrlFromDirectPath = getUrlFromDirectPath;
-const downloadContentFromMessage = async ({ mediaKey, directPath, url }, type, opts = {}) => {
-    const isValidMediaUrl = url === null || url === void 0 ? void 0 : url.startsWith('https://mmg.whatsapp.net/');
-    const downloadUrl = isValidMediaUrl ? url : (0, exports.getUrlFromDirectPath)(directPath);
-    if (!downloadUrl) {
-        throw new boom_1.Boom('No valid media URL or directPath present in message', { statusCode: 400 });
-    }
-    const keys = await getMediaKeys(mediaKey, type);
+const downloadContentFromMessage = ({ mediaKey, directPath, url }, type, opts = {}) => {
+    const downloadUrl = url || (0, exports.getUrlFromDirectPath)(directPath);
+    const keys = getMediaKeys(mediaKey, type);
     return (0, exports.downloadEncryptedContent)(downloadUrl, keys, opts);
 };
 exports.downloadContentFromMessage = downloadContentFromMessage;
+/**
+ * Decrypts and downloads an AES256-CBC encrypted file given the keys.
+ * Assumes the SHA256 of the plaintext is appended to the end of the ciphertext
+ * */
 const downloadEncryptedContent = async (downloadUrl, { cipherKey, iv }, { startByte, endByte, options } = {}) => {
     let bytesFetched = 0;
     let startChunk = 0;
     let firstBlockIsIV = false;
+    // if a start byte is specified -- then we need to fetch the previous chunk as that will form the IV
     if (startByte) {
         const chunk = toSmallestChunkSize(startByte || 0);
         if (chunk) {
@@ -652,6 +490,7 @@ const downloadEncryptedContent = async (downloadUrl, { cipherKey, iv }, { startB
             headers.Range += endChunk;
         }
     }
+    // download the message
     const fetched = await (0, exports.getHttpStream)(downloadUrl, {
         ...options || {},
         headers,
@@ -684,6 +523,8 @@ const downloadEncryptedContent = async (downloadUrl, { cipherKey, iv }, { startB
                     data = data.slice(AES_CHUNK_SIZE);
                 }
                 aes = Crypto.createDecipheriv('aes-256-cbc', cipherKey, ivValue);
+                // if an end byte that is not EOF is specified
+                // stop auto padding (PKCS7) -- otherwise throws an error for decryption
                 if (endByte) {
                     aes.setAutoPadding(false);
                 }
@@ -724,9 +565,12 @@ function extensionForMediaMessage(message) {
     }
     return extension;
 }
+exports.extensionForMediaMessage = extensionForMediaMessage;
 const getWAUploadToServer = ({ customUploadHosts, fetchAgent, logger, options }, refreshMediaConn) => {
     return async (stream, { mediaType, fileEncSha256B64, newsletter, timeoutMs }) => {
         var _a, _b;
+        const { default: axios } = await import('axios');
+        // send a query JSON to obtain the url & auth token to upload our media
         let uploadInfo = await refreshMediaConn(false);
         let urls;
         const hosts = [...customUploadHosts, ...uploadInfo.hosts];
@@ -744,14 +588,14 @@ const getWAUploadToServer = ({ customUploadHosts, fetchAgent, logger, options },
         }
         for (const { hostname, maxContentLengthBytes } of hosts) {
             logger.debug(`uploading to "${hostname}"`);
-            const auth = encodeURIComponent(uploadInfo.auth);
+            const auth = encodeURIComponent(uploadInfo.auth); // the auth token
             const url = `https://${hostname}${media}/${fileEncSha256B64}?auth=${auth}&token=${fileEncSha256B64}`;
             let result;
             try {
                 if (maxContentLengthBytes && reqBody.length > maxContentLengthBytes) {
                     throw new boom_1.Boom(`Body too large for "${hostname}"`, { statusCode: 413 });
                 }
-                const body = await axios_1.default.post(url, reqBody, {
+                const body = await axios.post(url, reqBody, {
                     ...options,
                     headers: {
                         ...options.headers || {},
@@ -779,7 +623,7 @@ const getWAUploadToServer = ({ customUploadHosts, fetchAgent, logger, options },
                 }
             }
             catch (error) {
-                if (axios_1.default.isAxiosError(error)) {
+                if (axios.isAxiosError(error)) {
                     result = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data;
                 }
                 const isLast = hostname === ((_b = hosts[uploadInfo.hosts.length - 1]) === null || _b === void 0 ? void 0 : _b.hostname);
@@ -796,11 +640,14 @@ exports.getWAUploadToServer = getWAUploadToServer;
 const getMediaRetryKey = (mediaKey) => {
     return (0, crypto_1.hkdf)(mediaKey, 32, { info: 'WhatsApp Media Retry Notification' });
 };
-const encryptMediaRetryRequest = async (key, mediaKey, meId) => {
+/**
+ * Generate a binary node that will request the phone to re-upload the media & return the newly uploaded URL
+ */
+const encryptMediaRetryRequest = (key, mediaKey, meId) => {
     const recp = { stanzaId: key.id };
     const recpBuffer = WAProto_1.proto.ServerErrorReceipt.encode(recp).finish();
     const iv = Crypto.randomBytes(12);
-    const retryKey = await getMediaRetryKey(mediaKey);
+    const retryKey = getMediaRetryKey(mediaKey);
     const ciphertext = (0, crypto_1.aesEncryptGCM)(recpBuffer, retryKey, iv, Buffer.from(key.id));
     const req = {
         tag: 'receipt',
@@ -810,6 +657,9 @@ const encryptMediaRetryRequest = async (key, mediaKey, meId) => {
             type: 'server-error'
         },
         content: [
+            // this encrypt node is actually pretty useless
+            // the media is returned even without this node
+            // keeping it here to maintain parity with WA Web
             {
                 tag: 'encrypt',
                 attrs: {},
@@ -823,6 +673,7 @@ const encryptMediaRetryRequest = async (key, mediaKey, meId) => {
                 attrs: {
                     jid: key.remoteJid,
                     'from_me': (!!key.fromMe).toString(),
+                    // @ts-ignore
                     participant: key.participant || undefined
                 }
             }
@@ -860,8 +711,8 @@ const decodeMediaRetryNode = (node) => {
     return event;
 };
 exports.decodeMediaRetryNode = decodeMediaRetryNode;
-const decryptMediaRetryData = async ({ ciphertext, iv }, mediaKey, msgId) => {
-    const retryKey = await getMediaRetryKey(mediaKey);
+const decryptMediaRetryData = ({ ciphertext, iv }, mediaKey, msgId) => {
+    const retryKey = getMediaRetryKey(mediaKey);
     const plaintext = (0, crypto_1.aesDecryptGCM)(ciphertext, retryKey, iv, Buffer.from(msgId));
     return WAProto_1.proto.MediaRetryNotification.decode(plaintext);
 };
@@ -874,6 +725,7 @@ const MEDIA_RETRY_STATUS_MAP = {
     [WAProto_1.proto.MediaRetryNotification.ResultType.NOT_FOUND]: 404,
     [WAProto_1.proto.MediaRetryNotification.ResultType.GENERAL_ERROR]: 418,
 };
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 function __importStar(arg0) {
     throw new Error('Function not implemented.');
-}
+}