electron-smallest-updater 0.1.0 → 0.2.0

package/README.md

@@ -1,5 +1,7 @@
 # electron-smallest-updater
 
+[更新日志](./CHANGELOG.md)
+
 用于最小更新 Electron Resources 的更新器。
 
 - 与 electron-updater 有相近的配置和用法。
@@ -33,7 +35,7 @@ exports.default = async (context) => {
 }
 ```
 
-以上配置打包后会在指定的输出目录生成 `{productName}-{version}-smallest.zip`(资源压缩包) 和 `latest-smallest.json`(更新频道文件)。然后你可以把生成内容放到文件服务器上。
+以上配置打包后会在指定的输出目录生成 `{name}-{version}-smallest.zip`(资源压缩包) 和 `latest-smallest.json`(更新频道文件)。然后你可以把生成内容放到文件服务器上。
 
 ```json
 // latest-smallest.json
@@ -46,7 +48,7 @@ exports.default = async (context) => {
   },
   "releaseDate": "2024-04-08T02:23:43.648Z",
   "releaseName": "Update 1.1.0",
-  "releaseNotes": "Update for version 1.1.0 is available"
+  // "releaseNotes": "Update for version 1.1.0 is available"
 }
 ```
 
@@ -201,5 +203,6 @@ export interface ProgressInfo {
   total: number
   percent: number
   transferred: number
+  bytesPerSecond: number
 }
 ```

package/dist/builder.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.smallestBuilder = void 0;
+exports.smallestBuilder = smallestBuilder;
 const path_1 = __importDefault(require("path"));
 const adm_zip_1 = __importDefault(require("adm-zip"));
 const fast_glob_1 = __importDefault(require("fast-glob"));
@@ -27,12 +27,12 @@ function smallestBuilder(context, options) {
         const resources = (options === null || options === void 0 ? void 0 : options.resources) || defaultResources;
         const outChannelName = (options === null || options === void 0 ? void 0 : options.channel) || defaultChannel;
         const outChannelPath = path_1.default.join(context.outDir, outChannelName);
-        const outResourceFileName = `${appInfo.productName}-${appInfo.version}-smallest.zip`;
+        const outResourceFileName = `${appInfo.name}-${appInfo.version}-smallest.zip`;
         const outResourceFilePath = path_1.default.join(context.outDir, outResourceFileName);
         // find resources
         let resourcesPath;
         if (platform === 'darwin') {
-            resourcesPath = path_1.default.join(context.appOutDir, `${appInfo.productName}.app`, 'Contents', 'Resources');
+            resourcesPath = path_1.default.join(context.appOutDir, `${appInfo.name}.app`, 'Contents', 'Resources');
         }
         else {
             resourcesPath = path_1.default.join(context.appOutDir, 'resources');
@@ -58,9 +58,8 @@ function smallestBuilder(context, options) {
             },
             releaseDate: new Date().toISOString(),
             releaseName: `Update ${appInfo.version}`,
-            releaseNotes: `Update for version ${appInfo.version} is available`,
+            // releaseNotes: `Update for version ${appInfo.version} is available`,
         };
         yield fs_extra_1.default.writeJSON(outChannelPath, publishJSON, { spaces: 2 });
     });
 }
-exports.smallestBuilder = smallestBuilder;

package/dist/types.d.ts

@@ -14,6 +14,7 @@ export interface ProgressInfo {
     total: number;
     percent: number;
     transferred: number;
+    bytesPerSecond: number;
 }
 export interface UpdateDownloadedInfo extends UpdateInfo {
     downloadFilePath: string;

package/dist/updater.d.ts

@@ -4,6 +4,7 @@ export declare class SmallestUpdater extends TypedEmitter<SmallestUpdaterEvents>
     private logger;
     private channel;
     private publish;
+    private reqOptions;
     private updateInfo;
     private downloadUrl;
     private downloadDir;

package/dist/updater.js

@@ -26,7 +26,7 @@ const tiny_typed_emitter_1 = require("tiny-typed-emitter");
 const utils_1 = require("./utils");
 class SmallestUpdater extends tiny_typed_emitter_1.TypedEmitter {
     constructor(options) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         super();
         this.downloadUrl = '';
         this.downloadDir = '';
@@ -41,10 +41,11 @@ class SmallestUpdater extends tiny_typed_emitter_1.TypedEmitter {
         this.logger = (_a = options.logger) !== null && _a !== void 0 ? _a : console;
         this.channel = (_b = options.channel) !== null && _b !== void 0 ? _b : 'latest-smallest.json';
         this.publish = options.publish;
-        this.autoDownload = (_c = options.autoDownload) !== null && _c !== void 0 ? _c : true;
-        this.autoInstallOnAppQuit = (_d = options.autoInstallOnAppQuit) !== null && _d !== void 0 ? _d : true;
-        this.forceDevUpdateConfig = (_e = options.forceDevUpdateConfig) !== null && _e !== void 0 ? _e : false;
-        this.downloadDir = electron_1.app.getPath('userData');
+        this.reqOptions = (_c = options.publish.options) !== null && _c !== void 0 ? _c : {};
+        this.autoDownload = (_d = options.autoDownload) !== null && _d !== void 0 ? _d : true;
+        this.autoInstallOnAppQuit = (_e = options.autoInstallOnAppQuit) !== null && _e !== void 0 ? _e : true;
+        this.forceDevUpdateConfig = (_f = options.forceDevUpdateConfig) !== null && _f !== void 0 ? _f : false;
+        this.downloadDir = (0, node_path_1.join)(electron_1.app.getPath('userData'), 'SmallestUpdater');
         this.resourcesPath = process.resourcesPath;
     }
     /**
@@ -69,7 +70,7 @@ class SmallestUpdater extends tiny_typed_emitter_1.TypedEmitter {
             let updateInfo;
             try {
                 this.emit('checking-for-update');
-                updateInfo = yield (0, got_1.default)(Object.assign(Object.assign({}, this.publish), { url: `${url}/${this.channel}` })).json();
+                updateInfo = yield (0, got_1.default)(`${url}/${this.channel}`, Object.assign(Object.assign({}, this.reqOptions), { isStream: false, resolveBodyOnly: false, responseType: 'text' })).json();
                 if (!(updateInfo === null || updateInfo === void 0 ? void 0 : updateInfo.version) || !updateInfo.releaseFile) {
                     throw new Error('Invalid response content');
                 }
@@ -89,6 +90,7 @@ class SmallestUpdater extends tiny_typed_emitter_1.TypedEmitter {
             else {
                 this.emit('update-not-available', updateInfo);
                 this.logger.info(`Update for version ${currentVersion} is not available (latest version: ${latestVersion}`);
+                return;
             }
             this.updateInfo = updateInfo;
             this.downloadUrl = this.formatDownloadUrl(updateInfo.releaseFile.url);
@@ -125,11 +127,17 @@ class SmallestUpdater extends tiny_typed_emitter_1.TypedEmitter {
             // download
             try {
                 this.logger.info(`Download to ${downloadFilePath}`);
-                const resStream = got_1.default.stream(downloadUrl);
-                const writeStream = (0, node_fs_1.createWriteStream)(downloadFilePath);
+                const resStream = got_1.default.stream(downloadUrl, Object.assign(Object.assign({}, this.reqOptions), { isStream: true }));
+                const startTime = Date.now();
+                let nextUpdate = startTime;
                 resStream.on('downloadProgress', (progress) => {
-                    this.emit('download-progress', progress);
+                    const nowTime = Date.now();
+                    if (nowTime >= nextUpdate || progress.percent >= 1) {
+                        nextUpdate = nowTime + 1000;
+                        this.emit('download-progress', Object.assign(Object.assign({}, progress), { percent: progress.percent * 100, bytesPerSecond: Math.round(progress.transferred / ((nowTime - startTime) / 1000)) }));
+                    }
                 });
+                const writeStream = (0, node_fs_1.createWriteStream)(downloadFilePath);
                 yield (0, promises_1.pipeline)(resStream, writeStream);
             }
             catch (error) {
@@ -153,9 +161,14 @@ class SmallestUpdater extends tiny_typed_emitter_1.TypedEmitter {
             }
             // unzip
             try {
+                /**
+                 * @link https://stackoverflow.com/questions/43645745/electron-invalid-package-on-unzip
+                 */
+                process.noAsar = true;
                 this.logger.info(`Extract to ${downloadUnzipPath}`);
                 const zip = new adm_zip_1.default(downloadFilePath);
                 zip.extractAllTo(downloadUnzipPath, true);
+                process.noAsar = false;
             }
             catch (error) {
                 this.emit('error', error, `Extract error: ${error.message}`);

package/dist/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calcSha512 = void 0;
+exports.calcSha512 = calcSha512;
 const crypto_1 = __importDefault(require("crypto"));
 const fs_1 = __importDefault(require("fs"));
 function calcSha512(filePath) {
@@ -20,4 +20,3 @@ function calcSha512(filePath) {
         });
     });
 }
-exports.calcSha512 = calcSha512;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-smallest-updater",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Electron Resources 按需最小更新、自动构建发布包及信息。",
   "main": "./dist/index.js",
   "types": "./dist",