electron-smallest-updater 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 haiweilian<https://github.com/haiweilian>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,206 @@
+# electron-smallest-updater
+
+用于最小更新 Electron Resources 的更新器。
+
+- 与 electron-updater 有相近的配置和用法。
+- 可手动指定更新 Resources 目录下的任意资源。
+- 自动生成更新所需的资源压缩包和元数据文件。
+- 支持 Windows 任意目录下的更新无需额外依赖。
+
+## 安装
+
+```sh
+npm install electron-smallest-updater
+```
+
+## 构建
+
+利用 `electron-builder` 的 `afterPack` 钩子自动生成更新所需的资源压缩包和元数据文件。
+
+```yml
+# electron-builder.yml
+afterPack: ./afterPack.js
+```
+
+```js
+// afterPack.js
+const { smallestBuilder } = require('electron-smallest-updater')
+
+exports.default = async (context) => {
+  return smallestBuilder(context, {
+    // options
+  })
+}
+```
+
+以上配置打包后会在指定的输出目录生成 `{productName}-{version}-smallest.zip`(资源压缩包) 和 `latest-smallest.json`(更新频道文件)。然后你可以把生成内容放到文件服务器上。
+
+```json
+// latest-smallest.json
+{
+  "version": "1.1.0",
+  "releaseFile": {
+    "url": "electron-updater-example-1.1.0-smallest.zip",
+    "size": 9334322,
+    "sha512": "28d21a3e1d15e5c5b7bbc7ee4298df66e160cd5330cdb0a135a614d5077..."
+  },
+  "releaseDate": "2024-04-08T02:23:43.648Z",
+  "releaseName": "Update 1.1.0",
+  "releaseNotes": "Update for version 1.1.0 is available"
+}
+```
+
+### 配置
+
+| 名称      | 描述             | 默认值                                           |
+| --------- | ---------------- | ------------------------------------------------ |
+| channel   | 更新频道名称     | latest-smallest.json                             |
+| resources | 生成压缩包的资源 | \['app.asar', 'app/**', 'app.asar.unpacked/**'\] |
+| urlPrefix | 文件资源路径前缀 |                                                  |
+
+## 使用
+
+在主进程中接入更新逻辑，以下是一个可直接使用的示例。
+
+```ts
+import { dialog, BrowserWindow } from 'electron'
+import logger from 'electron-log'
+import ProgressBar from 'electron-progressbar'
+import { SmallestUpdater } from 'electron-smallest-updater'
+
+export function initSmallestUpdater(mainWindow: BrowserWindow): SmallestUpdater {
+  // 下载进度条
+  const progressBar = new ProgressBar({
+    title: '更新',
+    text: '下载更新',
+    detail: '等待下载',
+    indeterminate: false,
+    closeOnComplete: true,
+    browserWindow: {
+      show: false,
+      modal: true,
+      parent: mainWindow,
+    },
+  })
+  // @ts-expect-error
+  progressBar._window.hide()
+  // @ts-expect-error
+  progressBar._window.setProgressBar(-1)
+
+  // 创建实例
+  const smallestUpdater = new SmallestUpdater({
+    logger,
+    publish: {
+      url: 'http://localhost:3000/smallest-updates',
+    },
+    autoDownload: false,
+    forceDevUpdateConfig: true,
+  })
+
+  // 更新可用
+  smallestUpdater.on('update-available', (info) => {
+    console.log('[electron-updater]', '更新可用', info)
+    const version = info.version
+    const releaseNotes = info.releaseNotes
+    dialog
+      .showMessageBox(mainWindow, {
+        title: '版本更新',
+        message: `发现新版本${version}，是否更新\n\n${releaseNotes}`,
+        type: 'info',
+        buttons: ['稍后更新', '立即更新'],
+      })
+      .then(({ response }) => {
+        if (response === 1) {
+          // @ts-expect-error
+          progressBar._window.show()
+          // @ts-expect-error
+          progressBar._window.setProgressBar(0)
+          smallestUpdater.downloadUpdate() // 手动下载更新
+        }
+      })
+  })
+
+  // 更新不可用
+  smallestUpdater.on('update-not-available', () => {
+    progressBar.close()
+  })
+
+  // 下载进度
+  smallestUpdater.on('download-progress', (progress) => {
+    console.log('[electron-updater]', '下载进度', progress)
+    progressBar.value = progress.percent * 100
+    progressBar.detail = `下载中 ${(progress.transferred / 1000 / 1000).toFixed(2)}/${(progress.total / 1000 / 1000).toFixed(2)}`
+  })
+
+  // 下载完成
+  smallestUpdater.on('update-downloaded', (info) => {
+    console.log('[electron-updater]', '下载完成', info)
+    dialog
+      .showMessageBox(mainWindow, {
+        title: '下载完成',
+        message: `重启可应用新版本`,
+        type: 'info',
+        buttons: ['稍后重启', '立即重启'],
+      })
+      .then(({ response }) => {
+        if (response === 1) {
+          smallestUpdater.quitAndInstall() // 退出并安装重启
+        }
+      })
+  })
+
+  // 检查更新
+  smallestUpdater.checkForUpdates()
+
+  return smallestUpdater
+}
+```
+
+### 配置
+
+| 名称                 | 描述                 | 默认值                                 |
+| -------------------- | -------------------- | -------------------------------------- |
+| logger               | 自定义日志           | console                                |
+| channel              | 更新频道名称         | latest-smallest.json                   |
+| publish              | 发布配置             | { url: string, options?: Got.Options } |
+| autoDownload         | 是否自动下载         | true                                   |
+| autoInstallOnAppQuit | 是否退出时自动安装   | true                                   |
+| forceDevUpdateConfig | 是否允许开发环境更新 | false                                  |
+
+### 事件
+
+| 名称                 | 描述         | 回调                                     |
+| -------------------- | ------------ | ---------------------------------------- |
+| error                | 更新错误     | (error: Error, message?: string) => void |
+| checking-for-update  | 检查更新     | () => void                               |
+| update-available     | 更新可用     | (info: UpdateInfo) => void               |
+| update-not-available | 更新不可用   | (info: UpdateInfo) => void               |
+| update-downloaded    | 更新下载完成 | (event: UpdateDownloadedInfo) => void    |
+| download-progress    | 更新下载进度 | (info: ProgressInfo) => void             |
+| update-cancelled     | 更新取消     | (info: UpdateInfo) => void               |
+
+**UpdateInfo**
+
+```ts
+interface UpdateInfo {
+  version: string
+  releaseFile: {
+    url: string
+    size: number
+    sha512: string
+  }
+  releaseDate: string
+  releaseName?: string
+  releaseNotes?: string
+}
+```
+
+**ProgressInfo**
+
+```ts
+export interface ProgressInfo {
+  total: number
+  percent: number
+  transferred: number
+}
+```

package/dist/builder.d.ts

@@ -0,0 +1,3 @@
+import { AfterPackContext } from 'electron-builder';
+import type { SmallestBuilderOptions } from './types';
+export declare function smallestBuilder(context: AfterPackContext, options?: SmallestBuilderOptions): Promise<void>;

package/dist/builder.js

@@ -0,0 +1,69 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.smallestBuilder = void 0;
+const path_1 = __importDefault(require("path"));
+const adm_zip_1 = __importDefault(require("adm-zip"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const utils_1 = require("./utils");
+const defaultChannel = 'latest-smallest.json';
+const defaultResources = ['app.asar', 'app/**', 'app.asar.unpacked/**'];
+function smallestBuilder(context, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const appInfo = context.packager.appInfo;
+        const platform = context.electronPlatformName;
+        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 outResourceFilePath = path_1.default.join(context.outDir, outResourceFileName);
+        // find resources
+        let resourcesPath;
+        if (platform === 'win32') {
+            resourcesPath = path_1.default.join(context.appOutDir, 'resources');
+        }
+        else if (platform === 'darwin') {
+            resourcesPath = path_1.default.join(context.appOutDir, `${appInfo.productName}.app`, 'Contents', 'Resources');
+        }
+        else {
+            throw new Error('todo ....');
+        }
+        // write zip file
+        const zip = new adm_zip_1.default();
+        for (const resource of resources) {
+            const files = yield (0, fast_glob_1.default)(resource, {
+                cwd: resourcesPath,
+            });
+            for (const file of files) {
+                zip.addLocalFile(path_1.default.join(resourcesPath, file), path_1.default.dirname(file));
+            }
+        }
+        zip.writeZip(outResourceFilePath);
+        // write publish json
+        const publishJSON = {
+            version: appInfo.version,
+            releaseFile: {
+                url: (options === null || options === void 0 ? void 0 : options.urlPrefix) ? `${options === null || options === void 0 ? void 0 : options.urlPrefix}/${outResourceFileName}` : outResourceFileName,
+                size: (yield fs_extra_1.default.stat(outResourceFilePath)).size,
+                sha512: yield (0, utils_1.calcSha512)(outResourceFilePath),
+            },
+            releaseDate: new Date().toISOString(),
+            releaseName: `Update ${appInfo.version}`,
+            releaseNotes: `Update for version ${appInfo.version} is available`,
+        };
+        yield fs_extra_1.default.writeJSON(outChannelPath, publishJSON, { spaces: 2 });
+    });
+}
+exports.smallestBuilder = smallestBuilder;

package/dist/core.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/core.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './builder';
+export * from './updater';
+export * from './types';
+export * from './utils';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./builder"), exports);
+__exportStar(require("./updater"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+import type { Options } from 'got';
+export interface UpdateInfo {
+    version: string;
+    releaseFile: {
+        url: string;
+        size: number;
+        sha512: string;
+    };
+    releaseDate: string;
+    releaseName?: string;
+    releaseNotes?: string;
+}
+export interface ProgressInfo {
+    total: number;
+    percent: number;
+    transferred: number;
+}
+export interface UpdateDownloadedInfo extends UpdateInfo {
+    downloadFilePath: string;
+    downloadUnzipPath: string;
+}
+export interface Logger {
+    info(message?: any): void;
+    warn(message?: any): void;
+    error(message?: any): void;
+    debug?(message: string): void;
+}
+export interface Publish {
+    url: string;
+    options?: Options;
+    provider?: 'generic';
+}
+export interface SmallestUpdaterOptions {
+    logger?: Logger;
+    channel?: string;
+    publish: Publish;
+    autoDownload?: boolean;
+    autoInstallOnAppQuit?: boolean;
+    forceDevUpdateConfig?: boolean;
+}
+export interface SmallestUpdaterEvents {
+    error: (error: Error, message?: string) => void;
+    'checking-for-update': () => void;
+    'update-not-available': (info: UpdateInfo) => void;
+    'update-available': (info: UpdateInfo) => void;
+    'update-downloaded': (event: UpdateDownloadedInfo) => void;
+    'download-progress': (info: ProgressInfo) => void;
+    'update-cancelled': (info: UpdateInfo) => void;
+}
+export interface SmallestBuilderOptions {
+    channel?: string;
+    resources?: string[];
+    urlPrefix?: string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/updater.d.ts

@@ -0,0 +1,49 @@
+import { TypedEmitter } from 'tiny-typed-emitter';
+import type { SmallestUpdaterOptions, SmallestUpdaterEvents } from './types';
+export declare class SmallestUpdater extends TypedEmitter<SmallestUpdaterEvents> {
+    private logger;
+    private channel;
+    private publish;
+    private updateInfo;
+    private downloadUrl;
+    private downloadDir;
+    private downloadFileName;
+    private downloadFilePath;
+    private downloadUnzipPath;
+    private resourcesPath;
+    private quitAndInstallCalled;
+    private autoDownload;
+    private autoInstallOnAppQuit;
+    private forceDevUpdateConfig;
+    constructor(options: SmallestUpdaterOptions);
+    /**
+     * Asks the server whether there is an update.
+     */
+    checkForUpdates(): Promise<void>;
+    /**
+     * Start downloading update manually.
+     */
+    downloadUpdate(): Promise<void>;
+    /**
+     * Restarts the app and installs the update after it has been downloaded.
+     * It should only be called after `update-downloaded` has been emitted.
+     */
+    quitAndInstall(): Promise<void>;
+    /**
+     * Install on exit when quitAndInstall is not called.
+     */
+    private addQuitHandler;
+    /**
+     * Copy download resources to application resources.
+     */
+    private updateResources;
+    /**
+     * Format URL and add prefix.
+     */
+    private formatDownloadUrl;
+    /**
+     * Check for write permission by writing files to the folder.
+     * Why not fs.access: https://github.com/nodejs/node/issues/34395.
+     */
+    private checkFolderWritePermission;
+}

package/dist/updater.js

@@ -0,0 +1,278 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmallestUpdater = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const promises_1 = require("node:stream/promises");
+const adm_zip_1 = __importDefault(require("adm-zip"));
+const electron_1 = require("electron");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const got_1 = __importDefault(require("got"));
+const semver_1 = __importDefault(require("semver"));
+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;
+        super();
+        this.downloadUrl = '';
+        this.downloadDir = '';
+        this.downloadFileName = 'latest-smallest.zip';
+        this.downloadFilePath = '';
+        this.downloadUnzipPath = '';
+        this.resourcesPath = '';
+        this.quitAndInstallCalled = false;
+        this.autoDownload = true;
+        this.autoInstallOnAppQuit = true;
+        this.forceDevUpdateConfig = false;
+        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.resourcesPath = process.resourcesPath;
+    }
+    /**
+     * Asks the server whether there is an update.
+     */
+    checkForUpdates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!electron_1.app.isPackaged) {
+                if (!this.forceDevUpdateConfig) {
+                    this.logger.info('Skip checkForUpdates because application is not packed and dev update config is not forced');
+                    return;
+                }
+                // To avoid affecting application parsing errors
+                // Update development environment resources to virtual directory(electron-smallest-updater-dev)
+                this.resourcesPath = (0, node_path_1.join)(this.resourcesPath, 'electron-smallest-updater-dev');
+            }
+            const url = this.publish.url;
+            if (!url)
+                return;
+            this.logger.info('Checking for update');
+            // check
+            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();
+                if (!(updateInfo === null || updateInfo === void 0 ? void 0 : updateInfo.version) || !updateInfo.releaseFile) {
+                    throw new Error('Invalid response content');
+                }
+            }
+            catch (error) {
+                this.emit('error', error, `Cannot check for updates: ${error.message}`);
+                this.logger.error(error.stack || error);
+                throw error;
+            }
+            // diff
+            const latestVersion = updateInfo.version;
+            const currentVersion = electron_1.app.getVersion();
+            if (semver_1.default.gt(latestVersion, currentVersion)) {
+                this.emit('update-available', updateInfo);
+                this.logger.info(`Update for version ${currentVersion} is available (latest version: ${latestVersion}`);
+            }
+            else {
+                this.emit('update-not-available', updateInfo);
+                this.logger.info(`Update for version ${currentVersion} is not available (latest version: ${latestVersion}`);
+            }
+            this.updateInfo = updateInfo;
+            this.downloadUrl = this.formatDownloadUrl(updateInfo.releaseFile.url);
+            if (this.autoDownload) {
+                this.logger.info('Download triggered by autoDownload');
+                yield this.downloadUpdate();
+            }
+        });
+    }
+    /**
+     * Start downloading update manually.
+     */
+    downloadUpdate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const downloadUrl = this.downloadUrl;
+            if (!downloadUrl)
+                return;
+            this.logger.info(`Downloading update from ${downloadUrl}`);
+            // clean
+            yield fs_extra_1.default.ensureDir(this.downloadDir);
+            const downloadFilePath = (0, node_path_1.join)(this.downloadDir, this.downloadFileName);
+            if (yield fs_extra_1.default.pathExists(downloadFilePath)) {
+                yield fs_extra_1.default.remove(downloadFilePath);
+            }
+            const downloadUnzipPath = (0, node_path_1.join)(this.downloadDir, (0, node_path_1.basename)(this.downloadFileName, '.zip'));
+            if (yield fs_extra_1.default.pathExists(downloadUnzipPath)) {
+                // https://github.com/isaacs/rimraf/issues/203
+                // https://www.electronjs.org/docs/latest/tutorial/asar-archives#treating-an-asar-archive-as-a-normal-file
+                process.noAsar = true;
+                yield fs_extra_1.default.remove(downloadUnzipPath);
+                process.noAsar = false;
+            }
+            // download
+            try {
+                this.logger.info(`Download to ${downloadFilePath}`);
+                const resStream = got_1.default.stream(downloadUrl);
+                const writeStream = (0, node_fs_1.createWriteStream)(downloadFilePath);
+                resStream.on('downloadProgress', (progress) => {
+                    this.emit('download-progress', progress);
+                });
+                yield (0, promises_1.pipeline)(resStream, writeStream);
+            }
+            catch (error) {
+                this.emit('error', error, `Download error: ${error.message}`);
+                this.logger.error(error.stack || error);
+                throw error;
+            }
+            // validate
+            try {
+                const sha512 = (_a = this.updateInfo) === null || _a === void 0 ? void 0 : _a.releaseFile.sha512;
+                this.logger.info(`Validate sha512 ${sha512}`);
+                const result = yield (0, utils_1.calcSha512)(downloadFilePath);
+                if (sha512 !== result) {
+                    throw new Error('Verification of sha512 failed, file changed');
+                }
+            }
+            catch (error) {
+                this.emit('error', error, `Validate error: ${error.message}`);
+                this.logger.error(error.stack || error);
+                throw error;
+            }
+            // unzip
+            try {
+                this.logger.info(`Extract to ${downloadUnzipPath}`);
+                const zip = new adm_zip_1.default(downloadFilePath);
+                zip.extractAllTo(downloadUnzipPath, true);
+            }
+            catch (error) {
+                this.emit('error', error, `Extract error: ${error.message}`);
+                this.logger.error(error.stack || error);
+                throw error;
+            }
+            this.downloadFilePath = downloadFilePath;
+            this.downloadUnzipPath = downloadUnzipPath;
+            this.emit('update-downloaded', Object.assign(Object.assign({}, this.updateInfo), { downloadFilePath: this.downloadFilePath, downloadUnzipPath: this.downloadUnzipPath }));
+            this.addQuitHandler();
+        });
+    }
+    /**
+     * Restarts the app and installs the update after it has been downloaded.
+     * It should only be called after `update-downloaded` has been emitted.
+     */
+    quitAndInstall() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.logger.info('Auto install update on call quitAndInstall');
+                this.updateResources();
+                this.quitAndInstallCalled = true;
+            }
+            catch (error) {
+                this.emit('error', error, `Install error: ${error.message}`);
+                this.logger.error(error.stack || error);
+                throw error;
+            }
+            // quit and relaunch
+            electron_1.app.relaunch();
+            electron_1.app.quit();
+        });
+    }
+    /**
+     * Install on exit when quitAndInstall is not called.
+     */
+    addQuitHandler() {
+        electron_1.app.once('quit', (_, exitCode) => {
+            if (this.quitAndInstallCalled) {
+                this.logger.info('Update installer has already been triggered. Quitting application.');
+                return;
+            }
+            if (!this.autoInstallOnAppQuit) {
+                this.logger.info('Update will not be installed on quit because autoInstallOnAppQuit is set to false.');
+                return;
+            }
+            if (exitCode !== 0) {
+                this.logger.info(`Update will be not installed on quit because application is quitting with exit code ${exitCode}`);
+                return;
+            }
+            this.logger.info('Auto install update on quit');
+            this.updateResources();
+        });
+    }
+    /**
+     * Copy download resources to application resources.
+     */
+    updateResources() {
+        let cmd;
+        let args;
+        let options;
+        if (process.platform !== 'win32') {
+            cmd = 'cp';
+            args = ['-r', '-f', '-v', `${this.downloadUnzipPath}/.`, `${this.resourcesPath}/`];
+            options = { stdio: 'ignore' };
+        }
+        else {
+            cmd = 'Start-Process';
+            args = [
+                '-FilePath cmd',
+                '-WindowStyle hidden',
+                `-ArgumentList "/c xcopy /i /s /y \`"${this.downloadUnzipPath}\`" \`"${this.resourcesPath}\`""`,
+                // '-Verb RunAs',
+            ];
+            options = { shell: 'powershell', stdio: 'ignore' };
+            // If can write run using C:\Users\user\cmd.exe
+            // If not can write run using C:\WINDOWS\system32\cmd.exe
+            if (!this.checkFolderWritePermission(this.resourcesPath)) {
+                args.push('-Verb RunAs');
+            }
+        }
+        this.logger.info(`Start update process. Command:${cmd}, Args:${args.join(' ')}`);
+        try {
+            const childProcess = (0, node_child_process_1.spawnSync)(cmd, args, options);
+            if (childProcess.status === 1) {
+                throw new Error('The operation has been canceled by the user');
+            }
+        }
+        catch (error) {
+            throw new Error('Start shell process Error: ' + error);
+        }
+    }
+    /**
+     * Format URL and add prefix.
+     */
+    formatDownloadUrl(fileUrl) {
+        if (/^https?:\/\/.*/.test(fileUrl)) {
+            return fileUrl;
+        }
+        else {
+            return `${this.publish.url}/${fileUrl}`;
+        }
+    }
+    /**
+     * Check for write permission by writing files to the folder.
+     * Why not fs.access: https://github.com/nodejs/node/issues/34395.
+     */
+    checkFolderWritePermission(folder) {
+        try {
+            const file = (0, node_path_1.join)(folder, 'permission.txt');
+            fs_extra_1.default.writeFileSync(file, 'check folder write permission.');
+            fs_extra_1.default.removeSync(file);
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+}
+exports.SmallestUpdater = SmallestUpdater;

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare function calcSha512(filePath: string): Promise<string>;

package/dist/utils.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calcSha512 = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const fs_1 = __importDefault(require("fs"));
+function calcSha512(filePath) {
+    return new Promise((resolve, reject) => {
+        const hash = crypto_1.default.createHash('sha512');
+        const readStream = fs_1.default.createReadStream(filePath);
+        readStream.pipe(hash);
+        readStream.on('end', () => {
+            const sha512Hash = hash.digest('hex');
+            resolve(sha512Hash);
+        });
+        readStream.on('error', (err) => {
+            reject(err);
+        });
+    });
+}
+exports.calcSha512 = calcSha512;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "electron-smallest-updater",
+  "version": "0.0.2",
+  "description": "Electron Resources 按需最小更新、自动构建发布包及信息。",
+  "main": "./dist/index.js",
+  "types": "./dist",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "electron",
+    "electron-updater",
+    "electron-app-updater",
+    "electron-asar-updater",
+    "electron-unpacked-updater",
+    "electron-smallest-updater"
+  ],
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc",
+    "release": "tsc && release-it"
+  },
+  "license": "MIT",
+  "author": "haiweilian@foxmail.com",
+  "bugs": "https://github.com/haiweilian/electron-smallest-updater/issues",
+  "homepage": "https://github.com/haiweilian/electron-smallest-updater#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/haiweilian/electron-smallest-updater.git"
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.10",
+    "fast-glob": "^3.3.2",
+    "fs-extra": "^11.2.0",
+    "got": "^11.0.0",
+    "semver": "^7.6.0",
+    "tiny-typed-emitter": "^2.1.0"
+  },
+  "devDependencies": {
+    "@bfehub/eslint-config-typescript": "^2.1.0",
+    "@release-it/conventional-changelog": "^8.0.1",
+    "@types/adm-zip": "^0.5.5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/semver": "^7.5.8",
+    "electron": "^28.2.0",
+    "electron-builder": "^24.9.1",
+    "eslint": "^8.56.0",
+    "prettier": "^3.2.4",
+    "release-it": "^17.1.1",
+    "typescript": "^5.4.2"
+  }
+}