Download working

nwutils · Dec 31, 2023 · 872644d · 872644d
1 parent 7e8f5d1
commit 872644d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 14 deletions.
diff --git a/api-type-definitions.cjs b/api-type-definitions.cjs
@@ -37,9 +37,9 @@
 
 /**
  * @typedef  {object} NEWWINDOW
- * @property {string} [entry]   The file to load in the window, like 'index.html'.
- * @property {object} [window]  Any NW.js window subfield options.
- *                              [Docs](https://docs.nwjs.io/en/latest/References/Manifest%20Format/#window-subfields)
+ * @property {string} [entry]    The file to load in the window, like 'index.html'.
+ * @property {object} [window]   Any NW.js window subfield options.
+ *                               [Docs](https://docs.nwjs.io/en/latest/References/Manifest%20Format/#window-subfields)
  */
 
 /**
@@ -52,9 +52,16 @@
  */
 
 /**
- * @typedef  {object} DOWNLOADPROGRESS
- * @property {number} percent           Overall percent (between 0 to 1)
- * @property {number} speed             The download speed in bytes/sec (ex: 554732)
+ * @typedef  {object} DOWNLOADPROGRESSTOTAL
+ * @property {number} bytes                  The total number of bytes downloaded so far
+ * @property {number} percent                Overall percent (0-100), if server returned the total filesize, otherwise stays 0
+ * @property {number} speed                  The download speed in bytes/sec (ex: 554732)
+ */
+
+/**
+ * @typedef  {object}                DOWNLOADPROGRESS
+ * @property {array}                 details           An array of details
+ * @property {DOWNLOADPROGRESSTOTAL} total             The total download bytes, current speed, and percent
  */
 
 /**

diff --git a/nw-testing/manual-testing.cjs b/nw-testing/manual-testing.cjs
@@ -92,7 +92,7 @@ function manualTesting () {
        * Called when an update occurs during download/extract.
        *
        * @param {object} update                   Object containing percents
-       * @param {number} update.downloadProgress  The download progress percent
+       * @param {object} update.downloadProgress  The download progress percent
        * @param {number} update.extractProgress   The extract progress percent
        */
       onUpdate: function ({ downloadProgress, extractProgress }) {
@@ -102,7 +102,7 @@ function manualTesting () {
           console.log('Download progress:', downloadProgress);
         }
         if (extractProgress) {
-          console.log('Unzipping: ' + downloadProgress + '%');
+          console.log('Unzipping: ' + extractProgress + '%');
         }
       },
       /**

diff --git a/src/downloadZip.cjs b/src/downloadZip.cjs
@@ -26,7 +26,12 @@ async function downloadZip (options, downloadUrl, latestRemote) {
   const downloadOptions = {
     existBehavior: 'overwrite',
     maxRetry: options.autoUpdate.downloadRetries,
-    reportInterval: 1250
+    reportInterval: 1250,
+    httpOptions: {
+      headers: {
+        'User-Agent': 'nw-splasher-auto-update'
+      }
+    }
   };
 
   return new EasyDl(downloadUrl, zipFilePath, downloadOptions)
@@ -35,18 +40,18 @@ async function downloadZip (options, downloadUrl, latestRemote) {
       /**
        * Callback for when progress events occur while downloading zip file.
        *
-       * @param {DOWNLOADPROGRESS} downloadProgress  Details about the progress of the download
+       * @param {DOWNLOADPROGRESS} progress  Details about the progress of the download
        */
-      function (downloadProgress) {
-        options.autoUpdate.onUpdate({ downloadProgress });
+      function (progress) {
+        options.autoUpdate.onUpdate({ downloadProgress: progress.total });
       }
     )
     .wait()
     .then((completed) => {
-      console.log('Downloaded?', completed);
+      console.log({ completed });
     })
     .catch((error) => {
-      console.log('[error]', error);
+      console.log({ error });
     });
 };