electron-updator 0.1.0 → 0.1.2

package/README.md

@@ -8,21 +8,20 @@
 
 [npm-image]: https://img.shields.io/npm/v/electron-updator.svg
 [npm-url]: https://npmjs.org/package/electron-updator
-[ci-image]: https://github.com/xudafeng/electron-updator/actions/workflows/ci.yml/badge.svg
-[ci-url]: https://github.com/xudafeng/electron-updator/actions/workflows/ci.yml
-[codecov-image]: https://img.shields.io/codecov/c/github/xudafeng/electron-updator.svg?logo=codecov
-[codecov-url]: https://codecov.io/gh/xudafeng/electron-updator
+[ci-image]: https://github.com/electron-modules/electron-updator/actions/workflows/ci.yml/badge.svg
+[ci-url]: https://github.com/electron-modules/electron-updator/actions/workflows/ci.yml
+[codecov-image]: https://img.shields.io/codecov/c/github/electron-modules/electron-updator.svg?logo=codecov
+[codecov-url]: https://codecov.io/gh/electron-modules/electron-updator
 [node-image]: https://img.shields.io/badge/node.js-%3E=_16-green.svg
 [node-url]: http://nodejs.org/download/
 [download-image]: https://img.shields.io/npm/dm/electron-updator.svg
 [download-url]: https://npmjs.org/package/electron-updator
 
-> electron-updator
-
+> electron updator
 ## Installment
 
 ```bash
-$ npm i electron-updator --save-dev
+$ npm i electron-updator --save
 ```
 
 ## License

package/build/app-updator.js

@@ -0,0 +1,246 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppUpdator = void 0;
+const eventemitter3_1 = require("eventemitter3");
+const constants_1 = require("./common/constants");
+const download_file_1 = require("./utils/download-file");
+const utils_1 = require("./utils");
+const elelctron_app_adapter_1 = require("./elelctron-app-adapter");
+class AppUpdator extends eventemitter3_1.EventEmitter {
+    constructor(options, app) {
+        super();
+        this.state = "idle" /* StateType.Idle */;
+        this.options = options;
+        this.logger = this._wrapLogger(options.logger);
+        this.app = app || new elelctron_app_adapter_1.ElectronAppAdapter();
+        this.startTimeStamp = new Date().getTime();
+        this.logger.info('AppUpdator#constructor');
+        this.availableUpdate = {
+            resourcePath: '',
+            latestAsarPath: '',
+            downloadTargetDir: '',
+        };
+    }
+    _wrapLogger(logger) {
+        if (!logger) {
+            logger = console;
+        }
+        const _logger = { ...logger };
+        const _wrap = (message, callback) => {
+            callback(`ElectronUpdator(${this.startTimeStamp})${message}`);
+        };
+        _logger.error = (message) => {
+            _wrap(message, logger.error);
+        };
+        _logger.info = (message) => {
+            _wrap(message, logger.info);
+        };
+        _logger.warn = (message) => {
+            _wrap(message, logger.warn);
+        };
+        return _logger;
+    }
+    setState(state) {
+        this.logger.info(`AppUpdator#setState${state}`);
+        this.state = state;
+    }
+    setFeedUrl(url) {
+        this.logger.info(`AppUpdator#setFeedUrl:url is ${url}`);
+        if (url && this.options) {
+            this.options.url = url;
+        }
+    }
+    async checkForUpdates(executeType = constants_1.ExecuteType.Auto) {
+        this.logger.info(`AppUpdator#checkForUpdates:state is ${this.state}`);
+        if (executeType === constants_1.ExecuteType.User) {
+            if (this.state === "downloaded" /* StateType.Downloaded */) {
+                this.logger.info(`AppUpdator#checkForUpdates:UPDATE_DOWNLOADED`);
+                this.emit(constants_1.EventType.UPDATE_DOWNLOADED, {
+                    executeType,
+                });
+            }
+            else {
+                this.logger.info(`AppUpdator#checkForUpdates:UPDATE_NOT_AVAILABLE`);
+                this.emit(constants_1.EventType.UPDATE_NOT_AVAILABLE, { updateInfo: this.updateInfo });
+            }
+            return;
+        }
+        this.setState("idle" /* StateType.Idle */);
+        try {
+            // 新一轮更新流程，更新 TimeStamp
+            this.startTimeStamp = new Date().getTime();
+            this.setState("checking-for-update" /* StateType.CheckingForUpdate */);
+            this.emit(constants_1.EventType.CHECKING_FOR_UPDATE);
+            const updateInfoResponse = await (0, utils_1.requestUpdateInfo)(this.options);
+            this.updateInfo = (this.options?.responseFormatter ? this.options?.responseFormatter(updateInfoResponse) : updateInfoResponse);
+            const needUpdate = this.options?.needUpdate(updateInfoResponse);
+            if (!needUpdate) {
+                this.logger.info(`updateInfo is ${JSON.stringify(this.updateInfo)},needUpdate is false`);
+                this.emit(constants_1.EventType.UPDATE_NOT_AVAILABLE, { updateInfo: this.updateInfo });
+                this.setState("idle" /* StateType.Idle */);
+                return;
+            }
+            this.logger.info(`AppUpdator#checkForUpdates:needUpdate is true`);
+            this.availableUpdate = this.doGetAvailableUpdateInfo(this.updateInfo);
+            if (!this.options?.autoDownload) {
+                this.logger.info(`AppUpdator#checkForUpdates:emit UPDATE_AVAILABLE`);
+                this.emit(constants_1.EventType.UPDATE_AVAILABLE, {
+                    executeType,
+                    updateInfo: this.updateInfo,
+                });
+                return;
+            }
+            this.downloadUpdate(executeType);
+        }
+        catch (e) {
+            e.customMessage = e.customMessage ? e.customMessage : `${constants_1.InstallResultType.CheckForUpdatesError}_${e.message}`;
+            this.logError(e);
+            this.setState("idle" /* StateType.Idle */);
+        }
+    }
+    async downloadUpdate(executeType = constants_1.ExecuteType.User) {
+        this.logger.info(`AppUpdator#downloadUpdate:executeType is ${executeType}`);
+        await this.downloadUpdateFile(this.updateInfo);
+        const result = await this.preCheck();
+        if (result.success) {
+            this.logger.info(`AppUpdator#downloadUpdate:emit UPDATE_DOWNLOADED`);
+            this.emit(constants_1.EventType.UPDATE_DOWNLOADED, {
+                executeType,
+            });
+        }
+        else {
+            this.logError(result.error);
+            this.setState("idle" /* StateType.Idle */);
+        }
+    }
+    async quitAndInstall() {
+        this.logger.info(`AppUpdator#quitAndInstall:state is ${this.state}`);
+        if (this.state !== "downloaded" /* StateType.Downloaded */) {
+            return;
+        }
+        this.setState("idle" /* StateType.Idle */);
+        try {
+            let result = { success: false };
+            if (this.updateInfo?.updateType === constants_1.UpdateType.Package) {
+                result = await this.doQuitAndInstallPackage();
+            }
+            else {
+                result = await this.doQuitAndInstallAsar();
+            }
+            if (result.success) {
+                this.logger.warn(`AppUpdator#quitAndInstall:install success`);
+                this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
+            }
+            else {
+                result.message = `error: ${result.error?.message}`;
+                this.dispatchError(result.error);
+            }
+        }
+        catch (e) {
+            this.dispatchError(e);
+        }
+    }
+    async preCheckForAsar() {
+        this.logger.info(`AppUpdator#preCheckForAsar`);
+        return await this.unzip();
+    }
+    async preCheck() {
+        this.logger.info(`AppUpdator#preCheck`);
+        const { resourcePath } = this.availableUpdate;
+        if (this.state !== "downloaded" /* StateType.Downloaded */) {
+            return {
+                success: false,
+                error: new Error(`AppUpdator#preCheck:update status(${this.state}) error`),
+            };
+        }
+        // 清理老包
+        try {
+            this.logger.info(`AppUpdator#preCheck:cleanOldArchive`);
+            await (0, utils_1.cleanOldArchive)(resourcePath);
+        }
+        catch (e) {
+            this.logError(e);
+        }
+        let result = { success: true };
+        const { downloadTargetDir } = this.availableUpdate;
+        try {
+            const hasLatestFile = await (0, utils_1.existsAsync)(downloadTargetDir);
+            // 下载失败返回提示
+            if (!hasLatestFile) {
+                return {
+                    success: false,
+                    error: new Error('file is notfound'),
+                };
+            }
+        }
+        catch (e) {
+            return {
+                success: false,
+                error: e,
+            };
+        }
+        if (this.updateInfo?.updateType === constants_1.UpdateType.Package) {
+            result = await this.doPreCheckForPackage();
+        }
+        else {
+            result = await this.preCheckForAsar();
+        }
+        return result;
+    }
+    async downloadUpdateFile(updateInfo) {
+        if (this.state !== "checking-for-update" /* StateType.CheckingForUpdate */) {
+            throw new Error(`AppUpdator#downloadUpdateFile:update status(${this.state}) error`);
+        }
+        const { url, signature } = updateInfo.files[0];
+        const { downloadTargetDir } = this.availableUpdate;
+        this.setState("downloading" /* StateType.Downloading */);
+        try {
+            await (0, download_file_1.downloadFile)({
+                logger: this.logger,
+                url,
+                signature,
+                targetDir: downloadTargetDir,
+                emit: this.emit,
+                progressHandle: (data) => {
+                    this.emit(constants_1.EventType.UPDATE_DOWNLOAD_PROGRESS, data);
+                },
+            });
+            this.logger.info(`AppUpdator#downloadUpdateFile:Downloaded`);
+            this.setState("downloaded" /* StateType.Downloaded */);
+        }
+        catch (e) {
+            this.setState("idle" /* StateType.Idle */);
+            e.customMessage = `${constants_1.InstallResultType.DownloadError}_${e.message}`;
+            this.logError(e);
+        }
+    }
+    async unzip() {
+        this.logger.info(`AppUpdator#unzip:start`);
+        try {
+            const result = await this.doUnzip();
+            if (!result.success) {
+                return result;
+            }
+            const { latestAsarPath } = this.availableUpdate;
+            const exist = await (0, utils_1.existFile)(latestAsarPath);
+            return Promise.resolve({ success: exist });
+        }
+        catch (error) {
+            error.customMessage = constants_1.InstallResultType.UpdateUnzipError;
+            return Promise.resolve({
+                success: false,
+                error,
+            });
+        }
+    }
+    dispatchError(e) {
+        this.logError(e);
+        this.emit(constants_1.EventType.ERROR, e.message);
+    }
+    logError(e) {
+        const message = (e.stack || e).toString();
+        this.logger.error(message);
+    }
+}
+exports.AppUpdator = AppUpdator;
+//# sourceMappingURL=app-updator.js.map

package/build/common/constants.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventType = exports.DownloadProgressStatus = exports.ExecuteType = exports.UpdateType = exports.InstallResultType = exports.OldArchivePrefix = void 0;
+/**
+ * 更新包备份前缀
+ */
+exports.OldArchivePrefix = 'old-';
+/**
+ * 安装结果类型
+ */
+var InstallResultType;
+(function (InstallResultType) {
+    InstallResultType["UpdateUnzipError"] = "update-unzip-error";
+    InstallResultType["DownloadError"] = "download-error";
+    InstallResultType["UpdateSuccess"] = "update-success";
+    InstallResultType["CheckForUpdatesError"] = "check-for-updates-error";
+})(InstallResultType = exports.InstallResultType || (exports.InstallResultType = {}));
+/**
+ * 更新类型
+ */
+var UpdateType;
+(function (UpdateType) {
+    /** 全量更新 */
+    UpdateType["Package"] = "package";
+    /** 动态更新 */
+    UpdateType["Asar"] = "asar";
+    /** 更新包更新 */
+    UpdateType["Assets"] = "assets";
+})(UpdateType = exports.UpdateType || (exports.UpdateType = {}));
+/**
+ * 执行类型
+ */
+var ExecuteType;
+(function (ExecuteType) {
+    /**
+     * 自动触发
+     */
+    ExecuteType["User"] = "user";
+    /**
+     * 手动触发
+     */
+    ExecuteType["Auto"] = "auto";
+})(ExecuteType = exports.ExecuteType || (exports.ExecuteType = {}));
+/**
+ * 执行类型
+ */
+var DownloadProgressStatus;
+(function (DownloadProgressStatus) {
+    /**
+     * 开始
+     */
+    DownloadProgressStatus["Begin"] = "begin";
+    /**
+     * 下载中
+     */
+    DownloadProgressStatus["Downloading"] = "downloading";
+    /**
+     * 结束
+     */
+    DownloadProgressStatus["End"] = "end";
+})(DownloadProgressStatus = exports.DownloadProgressStatus || (exports.DownloadProgressStatus = {}));
+/**
+ * 事件类型
+ */
+var EventType;
+(function (EventType) {
+    /**
+     * 下载完成
+     */
+    EventType["UPDATE_DOWNLOADED"] = "update-downloaded";
+    /**
+     * 下载进度
+     */
+    EventType["UPDATE_DOWNLOAD_PROGRESS"] = "update-download-progress";
+    /**
+     * 用户调用 quitAndInstall 之后发出，可在次事件后完成关闭窗口、重启等操作
+     */
+    EventType["BEFORE_QUIT_FOR_UPDATE"] = "before-quit-for-update";
+    /**
+     * 有可用更新
+     */
+    EventType["UPDATE_AVAILABLE"] = "update-available";
+    /**
+     * 开始检查更新
+     */
+    EventType["CHECKING_FOR_UPDATE"] = "checking-for-update";
+    /**
+     * 无可用更新
+     */
+    EventType["UPDATE_NOT_AVAILABLE"] = "update-not-available";
+    /**
+     * 错误
+     */
+    EventType["ERROR"] = "error";
+})(EventType = exports.EventType || (exports.EventType = {}));
+//# sourceMappingURL=constants.js.map

package/build/elelctron-app-adapter.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ElectronAppAdapter = void 0;
+const electron_1 = require("electron");
+class ElectronAppAdapter {
+    constructor(app = electron_1.app) {
+        this.app = app;
+    }
+    get name() {
+        return this.app.getName();
+    }
+    get isPackaged() {
+        return this.app.isPackaged === true;
+    }
+    get userDataPath() {
+        return this.app.getPath('userData');
+    }
+    get exePath() {
+        return this.app.getPath('exe');
+    }
+    exit(code) {
+        this.app.exit(code);
+    }
+    relaunch(code) {
+        this.app.relaunch();
+        this.app.exit(code);
+    }
+    quit() {
+        this.app.quit();
+    }
+}
+exports.ElectronAppAdapter = ElectronAppAdapter;
+//# sourceMappingURL=elelctron-app-adapter.js.map

package/build/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("./common/constants");
+const mac_updator_1 = require("./mac-updator");
+const windows_updator_1 = require("./windows-updator");
+exports.default = {
+    UpdateType: constants_1.UpdateType, EventType: constants_1.EventType, ExecuteType: constants_1.ExecuteType,
+    MacUpdator: mac_updator_1.MacUpdator, WindowsUpdator: windows_updator_1.WindowsUpdator, DownloadProgressStatus: constants_1.DownloadProgressStatus,
+};
+//# sourceMappingURL=index.js.map

package/build/mac-updator.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MacUpdator = void 0;
+const path_1 = __importDefault(require("path"));
+const app_updator_1 = require("./app-updator");
+const constants_1 = require("./common/constants");
+const install_macos_dmg_1 = __importDefault(require("./utils/install-macos-dmg"));
+const utils_1 = require("./utils");
+class MacUpdator extends app_updator_1.AppUpdator {
+    constructor(options) {
+        super(options);
+    }
+    doGetAvailableUpdateInfo(updateInfo) {
+        this.logger.info('MacUpdator#doGetAvailableUpdateInfo:start');
+        const exePath = this.app.exePath;
+        const resourcePath = path_1.default.resolve(exePath, '..', '..', 'Resources');
+        const latestAsarPath = path_1.default.resolve(resourcePath, 'latest.asar');
+        const latestAppPath = path_1.default.resolve(resourcePath, 'latest');
+        let downloadTargetDir = `${latestAsarPath}.zip`;
+        if (updateInfo.updateType === constants_1.UpdateType.Package) {
+            downloadTargetDir = `${latestAppPath}.dmg`;
+        }
+        return {
+            resourcePath,
+            downloadTargetDir,
+            latestAsarPath,
+        };
+    }
+    async doPreCheckForPackage() {
+        this.logger.info('MacUpdator#doPreCheckForPackage:start');
+        // Mac 全量安装前，先进行 dmg 安装检查
+        return await (0, install_macos_dmg_1.default)(this.options, this.logger, this.availableUpdate, this.updateInfo, true);
+    }
+    /**
+     * 资源解压
+     * @return
+     */
+    async doUnzip() {
+        this.logger.info('MacUpdator#doUnzip:start');
+        const { resourcePath, downloadTargetDir } = this.availableUpdate;
+        try {
+            // 直接解压
+            await (0, utils_1.execAsync)(`unzip -o ${downloadTargetDir}`, {
+                cwd: resourcePath,
+                maxBuffer: 2 ** 28,
+            });
+            return {
+                success: true,
+            };
+        }
+        catch (error) {
+            return {
+                success: false,
+                error,
+            };
+        }
+    }
+    async doQuitAndInstallAsar() {
+        this.logger.info('MacUpdator#doQuitAndInstallAsar:start');
+        if (!this.availableUpdate) {
+            this.logger.error('MacUpdator#doQuitAndInstallAsar:not availableUpdate');
+            return Promise.resolve({ success: false });
+        }
+        const { resourcePath, latestAsarPath } = this.availableUpdate;
+        const oldAsarPath = path_1.default.resolve(resourcePath, `${constants_1.OldArchivePrefix}${new Date().getTime()}.asar`);
+        const currentAsarPath = path_1.default.resolve(resourcePath, 'app.asar');
+        try {
+            // 将老包改名 app.asar => old-xxxx.asar
+            if (await (0, utils_1.existsAsync)(currentAsarPath)) {
+                await (0, utils_1.renameAsync)(currentAsarPath, oldAsarPath);
+            }
+        }
+        catch (error) {
+            return {
+                success: false,
+                error,
+            };
+        }
+        try {
+            // 新包替换
+            await (0, utils_1.renameAsync)(latestAsarPath, currentAsarPath);
+        }
+        catch (error) {
+            // 替换出错，需要把老包还原
+            await (0, utils_1.renameAsync)(oldAsarPath, currentAsarPath);
+            return {
+                success: false,
+                error,
+            };
+        }
+        this.logger.warn('AppUpdator#quitAndInstall:install success');
+        this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
+        // 重启应用
+        this.app.relaunch();
+        return {
+            success: true,
+        };
+    }
+    async doQuitAndInstallPackage() {
+        this.logger.info('AppUpdator#doQuitAndInstallPackage:start');
+        return await (0, install_macos_dmg_1.default)(this.options, this.logger, this.availableUpdate, this.updateInfo);
+    }
+}
+exports.MacUpdator = MacUpdator;
+//# sourceMappingURL=mac-updator.js.map

package/build/utils/download-file.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadFile = void 0;
+const urllib_1 = __importDefault(require("urllib"));
+const constants_1 = require("../common/constants");
+const _1 = require(".");
+/**
+ * 文件下载
+ * @param updator 更新实例
+ * @param url 下载地址
+ * @param signature 下载签名
+ * @param targeDir 下载目录
+ * @param progressHandle 下载状态回调
+ * @return
+ */
+const downloadFile = async ({ logger, url, signature, targetDir, progressHandle }) => {
+    logger.info('downloadFile#downloadFile (start)');
+    const writeStream = (0, _1.createWriteStream)(targetDir);
+    let currentLength = 0;
+    progressHandle({
+        status: constants_1.DownloadProgressStatus.Begin,
+    });
+    return new Promise((resolve, reject) => {
+        urllib_1.default
+            .request(url, {
+            streaming: true,
+            followRedirect: true,
+            timeout: 10 * 60 * 1000,
+        })
+            .then((res) => {
+            const totalLength = res.headers['content-length'];
+            logger.info(`downloadFile#downloadFile (then),totalLength is ${totalLength}`);
+            res.res.on('data', (data) => {
+                try {
+                    currentLength += data.length;
+                    const progress = (currentLength / totalLength) * 100;
+                    progressHandle({
+                        status: constants_1.DownloadProgressStatus.Downloading,
+                        progress,
+                        url,
+                        signature,
+                        data,
+                    });
+                    writeStream.write(data);
+                }
+                catch (e) {
+                    reject(e);
+                }
+            });
+            res.res.on('end', () => {
+                // 推迟调用 end(): https://stackoverflow.com/a/53878933
+                process.nextTick(() => writeStream.end());
+                try {
+                    progressHandle({
+                        status: constants_1.DownloadProgressStatus.End,
+                        url,
+                        signature,
+                    });
+                    logger.info('download file success, url:%s, to %s', url, targetDir);
+                    resolve();
+                }
+                catch (e) {
+                    reject(e);
+                }
+            });
+            res.res.on('error', reject);
+        });
+    });
+};
+exports.downloadFile = downloadFile;
+//# sourceMappingURL=download-file.js.map

package/build/utils/index.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExecuteFile = exports.requestUpdateInfo = exports.existFile = exports.cleanOldArchive = exports.spawnAsync = exports.waitUntil = exports.sleep = exports.getMacOSAppPath = exports.sudoPrompt = exports.existsSync = exports.createWriteStream = exports.isMac = exports.isWin = exports.execAsync = exports.rimrafAsync = exports.readdirAsync = exports.existsAsync = exports.renameAsync = void 0;
+const path_1 = __importDefault(require("path"));
+const child_process_1 = require("child_process");
+const util_1 = __importDefault(require("util"));
+const urllib_1 = __importDefault(require("urllib"));
+const sudo_prompt_alt_1 = __importDefault(require("sudo-prompt-alt"));
+exports.sudoPrompt = sudo_prompt_alt_1.default;
+const rimraf_alt_1 = __importDefault(require("rimraf-alt"));
+const original_fs_1 = require("original-fs");
+Object.defineProperty(exports, "existsSync", { enumerable: true, get: function () { return original_fs_1.existsSync; } });
+Object.defineProperty(exports, "createWriteStream", { enumerable: true, get: function () { return original_fs_1.createWriteStream; } });
+const constants_1 = require("../common/constants");
+exports.renameAsync = util_1.default.promisify(original_fs_1.rename);
+exports.existsAsync = util_1.default.promisify(original_fs_1.exists);
+exports.readdirAsync = util_1.default.promisify(original_fs_1.readdir);
+exports.rimrafAsync = util_1.default.promisify(rimraf_alt_1.default);
+exports.execAsync = util_1.default.promisify(child_process_1.exec);
+exports.isWin = process.platform === 'win32';
+exports.isMac = process.platform === 'darwin';
+const getMacOSAppPath = () => {
+    const sep = path_1.default.sep;
+    const execPath = process.execPath;
+    const contentPath = ['', 'Contents', 'MacOS'].join(sep);
+    return execPath.split(contentPath)[0];
+};
+exports.getMacOSAppPath = getMacOSAppPath;
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+exports.sleep = sleep;
+const waitUntil = async (handle, options = { retryTime: 10, ms: 1000 }) => {
+    let retryTime = 0;
+    const p = async () => {
+        const isOk = handle();
+        if (!isOk) {
+            if (retryTime === options.retryTime) {
+                return false;
+            }
+            retryTime++;
+            await (0, exports.sleep)(options.ms);
+            return await p();
+        }
+        return true;
+    };
+    return await p();
+};
+exports.waitUntil = waitUntil;
+const spawnAsync = (command, options) => {
+    let stdout = '';
+    let stderr = '';
+    const child = (0, child_process_1.spawn)(command, options);
+    child.stdout.on('data', (data) => {
+        stdout += data;
+    });
+    child.stderr.on('data', (data) => {
+        stderr += data;
+    });
+    return new Promise((resolve, reject) => {
+        child.on('error', reject);
+        child.on('close', (code) => {
+            if (code === 0) {
+                return resolve(stdout.toString());
+            }
+            const err = new Error(`child exited with code ${code}`);
+            err.code = code;
+            err.stderr = stderr.toString();
+            reject(err);
+        });
+    });
+};
+exports.spawnAsync = spawnAsync;
+const cleanOldArchive = async (resourcePath) => {
+    const resourceArray = await (0, exports.readdirAsync)(resourcePath);
+    if (!resourceArray || !resourceArray.length) {
+        return;
+    }
+    const oldArchiveSource = resourceArray.filter((item) => item.startsWith(constants_1.OldArchivePrefix));
+    return await Promise.all(oldArchiveSource.map(async (file) => {
+        const filePath = path_1.default.join(resourcePath, file);
+        if (await (0, exports.existsAsync)(filePath)) {
+            await (0, exports.rimrafAsync)(filePath);
+        }
+    }));
+};
+exports.cleanOldArchive = cleanOldArchive;
+const existFile = async (path) => {
+    const _existFile = await (0, exports.waitUntil)(() => (0, original_fs_1.existsSync)(path), {
+        ms: 1000,
+        retryTime: 30,
+    });
+    return _existFile;
+};
+exports.existFile = existFile;
+const requestUpdateInfo = async (options) => {
+    const { url } = options;
+    if (!url) {
+        throw new Error('request url can\'t be empty');
+    }
+    let res = null;
+    try {
+        res = await urllib_1.default.request(url, {
+            dataType: 'json',
+            timeout: 10 * 1000,
+        });
+    }
+    catch (e) {
+        throw e;
+    }
+    if (!res || res.status !== 200) {
+        throw new Error(`request failure,status is ${res.status}`);
+    }
+    return res.data;
+};
+exports.requestUpdateInfo = requestUpdateInfo;
+const getExecuteFile = (file) => {
+    return path_1.default.join(__dirname, '..', 'libs', file);
+};
+exports.getExecuteFile = getExecuteFile;
+//# sourceMappingURL=index.js.map

package/build/utils/install-macos-dmg.js

@@ -0,0 +1,151 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const _1 = require(".");
+const index_1 = require("./index");
+const _log = (logger, e) => {
+    const message = (e.stack || e).toString();
+    logger.error?.(message);
+};
+exports.default = async (updatorOptions, logger, availableUpdate, updateInfo, preCheck = false) => {
+    const { productName } = updatorOptions || {};
+    const { downloadTargetDir } = availableUpdate || {};
+    const appPath = (0, _1.getMacOSAppPath)();
+    const tmpPath = path_1.default.join(os_1.default.tmpdir(), String(new Date().getTime())); // 本地临时文件使用的目录
+    const volumesPath = path_1.default.join('/Volumes', updatorOptions.dmgTitleFormatter ? updatorOptions.dmgTitleFormatter(updatorOptions, updateInfo) : productName);
+    const volumesAppPath = path_1.default.join(volumesPath, `${productName}.app`);
+    // step 1: 检测是否支持 hdiutil;
+    try {
+        const res = (await (0, index_1.spawnAsync)('which', ['hdiutil']));
+        if (!res.includes('/bin/hdiutil')) {
+            throw new Error('hdiutil not found');
+        }
+    }
+    catch (error) {
+        if (preCheck) {
+            _log(logger, error);
+        }
+        return {
+            success: false,
+            error,
+        };
+    }
+    // step 2: eject 一次 volume 下的 app，兜底，避免上一次结束时执行失败
+    try {
+        await (0, index_1.spawnAsync)('hdiutil', ['eject', volumesPath]);
+    }
+    catch (e) {
+        // 如果前一次更新时 eject 成功，这里文件不存在会报错，是个正常的 case，不用处理上报
+    }
+    finally {
+        const volumeAppNotExist = await (0, _1.waitUntil)(() => !(0, index_1.existsSync)(volumesAppPath), {
+            ms: 300,
+            retryTime: 5,
+        });
+        if (!volumeAppNotExist) {
+            const error = new Error('volume not exists');
+            if (preCheck) {
+                _log(logger, error);
+            }
+            return {
+                success: false,
+                error,
+            };
+        }
+    }
+    // step 3: 执行 hdiutil attach，挂载 dmg
+    try {
+        await (0, index_1.spawnAsync)('hdiutil', ['attach', downloadTargetDir]);
+    }
+    catch (error) {
+        _log(logger, error);
+    }
+    finally {
+        // 判断有没有新的 dmg 文件，没有的话提示用户重新下载
+        const volumeAppExist = await (0, _1.waitUntil)(() => (0, index_1.existsSync)(volumesAppPath), {
+            ms: 300,
+            retryTime: 5,
+        });
+        if (!volumeAppExist) {
+            const error = new Error('attach fail');
+            if (preCheck) {
+                _log(logger, error);
+            }
+            return {
+                success: false,
+                error,
+            };
+        }
+    }
+    if (preCheck) {
+        // 如果是预检查，直接返回
+        try {
+            await (0, index_1.spawnAsync)('hdiutil', ['eject', volumesPath]);
+        }
+        catch (error) {
+            _log(logger, error);
+        }
+        return {
+            success: true,
+        };
+    }
+    // step 4: 将当前目录下的 app 移到临时目录，如果后续操作失败了兜底用
+    try {
+        await (0, index_1.spawnAsync)('mv', [appPath, tmpPath]);
+    }
+    catch (error) {
+        error.customMessage = 'step4 mv to tmp path error';
+        _log(logger, error);
+    }
+    finally {
+        // 看临时目录文件是否移动成功
+        const tmpPathExist = await (0, _1.waitUntil)(() => (0, index_1.existsSync)(tmpPath), {
+            ms: 300,
+            retryTime: 5,
+        });
+        if (!tmpPathExist) {
+            const error = new Error('cp to tmp path fail');
+            return {
+                success: false,
+                error,
+            };
+        }
+    }
+    // step 5: 将新的 app 文件移动到 Applications 目录下，如果失败 or 查不到移入文件，将临时目录下的文件移动回来
+    try {
+        await (0, index_1.spawnAsync)('cp', ['-R', volumesAppPath, appPath]);
+    }
+    catch (error) {
+        _log(logger, error);
+    }
+    finally {
+        const appExist = await (0, _1.waitUntil)(() => (0, index_1.existsSync)(appPath), {
+            ms: 300,
+            retryTime: 5,
+        });
+        // 查不到新移入的 dmg，将原 dmg 再移动回来
+        if (!appExist) {
+            const error = new Error('cp to app fail');
+            await (0, index_1.spawnAsync)('mv', [tmpPath, appPath]);
+            return {
+                success: false,
+                error,
+            };
+        }
+    }
+    // step 6: 执行 hdiutil eject，推出
+    try {
+        await (0, index_1.spawnAsync)('hdiutil', ['eject', volumesPath]);
+    }
+    catch (error) {
+        _log(logger, error);
+    }
+    return {
+        success: true,
+    };
+};
+//# sourceMappingURL=install-macos-dmg.js.map

package/build/utils/sudo-prompt-exec.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sudoPromptExec = void 0;
+const index_1 = require("./index");
+function sudoPromptExec(appUpdatorOptions, logger, shell) {
+    const options = {
+        name: appUpdatorOptions.productName,
+    };
+    return new Promise((resolve, reject) => {
+        logger.warn(`update#sudoPromptExec_shell_${shell}`);
+        index_1.sudoPrompt.exec(shell, options, (error, stdout, _) => {
+            if (error) {
+                reject(error);
+                logger.error(`update#sudoPromptExec_error_${error}`);
+                return;
+            }
+            resolve(stdout);
+            logger.warn(`update#sudoPromptExec_stdout_${stdout}`);
+        });
+    });
+}
+exports.sudoPromptExec = sudoPromptExec;
+//# sourceMappingURL=sudo-prompt-exec.js.map

package/build/windows-updator.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WindowsUpdator = void 0;
+const path_1 = __importDefault(require("path"));
+const electron_1 = require("electron");
+const constants_1 = require("./common/constants");
+const sudo_prompt_exec_1 = require("./utils/sudo-prompt-exec");
+const app_updator_1 = require("./app-updator");
+const utils_1 = require("./utils");
+class WindowsUpdator extends app_updator_1.AppUpdator {
+    doGetAvailableUpdateInfo(updateInfo) {
+        this.logger.info(`WindowsUpdator#doGetAvailableUpdateInfo:start`);
+        let resourcePath = path_1.default.resolve(this.app.userDataPath);
+        const latestAsarPath = path_1.default.resolve(resourcePath, 'latest.asar');
+        const latestAppPath = path_1.default.resolve(resourcePath, 'latest');
+        let downloadTargetDir = `${latestAsarPath}.zip`;
+        if (updateInfo.updateType === constants_1.UpdateType.Package) {
+            downloadTargetDir = `${latestAppPath}.exe`;
+        }
+        return {
+            resourcePath,
+            downloadTargetDir,
+            latestAsarPath,
+        };
+    }
+    async doPreCheckForPackage() {
+        this.logger.info(`WindowsUpdator#doPreCheckForPackage:start`);
+        // Windows 全量安装默认预检正常
+        return Promise.resolve({ success: true });
+    }
+    async doUnzip() {
+        this.logger.info(`WindowsUpdator#doUnzip:start`);
+        try {
+            const { downloadTargetDir, resourcePath } = this.availableUpdate;
+            const unzipExe = (0, utils_1.getExecuteFile)('unzip.exe');
+            const executeCommand = `"${unzipExe}" -o "${downloadTargetDir}" -d "${resourcePath}"`;
+            await (0, utils_1.execAsync)(executeCommand);
+        }
+        catch (error) {
+            return {
+                success: false,
+                error,
+            };
+        }
+        this.logger.info(`WindowsUpdator#doUnzip:success`);
+        return {
+            success: true,
+        };
+    }
+    async doQuitAndInstallPackage() {
+        this.logger.info(`WindowsUpdator#doQuitAndInstallPackage:success`);
+        const { downloadTargetDir } = this.availableUpdate;
+        try {
+            // Windows 全量安装
+            const shellOpen = electron_1.shell.openItem || electron_1.shell.openPath;
+            shellOpen(downloadTargetDir);
+            setTimeout(() => {
+                this.app.exit(0);
+            }, 30);
+            return Promise.resolve({ success: true });
+        }
+        catch (error) {
+            return Promise.resolve({ success: false, error });
+        }
+    }
+    async doQuitAndInstallAsar() {
+        this.logger.info(`WindowsUpdator#doQuitAndInstallAsar:start`);
+        const productName = this.options?.productName;
+        const { resourcePath } = this.availableUpdate;
+        const exePath = this.app.exePath;
+        const updateExePath = (0, utils_1.getExecuteFile)('installer.exe');
+        const targetPath = path_1.default.resolve(exePath, '..', 'resources');
+        const executeCommand = `"${updateExePath}" "${targetPath}" "${resourcePath}" "${productName}.exe" "${exePath}"`;
+        try {
+            await (0, sudo_prompt_exec_1.sudoPromptExec)(this.options, this.logger, executeCommand);
+            return Promise.resolve({ success: true });
+        }
+        catch (error) {
+            return Promise.resolve({ success: false, error });
+        }
+    }
+}
+exports.WindowsUpdator = WindowsUpdator;
+//# sourceMappingURL=windows-updator.js.map

package/package.json

@@ -1,34 +1,64 @@
 {
   "name": "electron-updator",
-  "version": "0.1.0",
-  "description": "electron-updator",
-  "keywords": ["electron-updator"],
-  "bin": {
-    "electron-updator": "./bin/electron-updator.js"
+  "version": "0.1.2",
+  "description": "electron-updator is a software updator management solution for Electron applications, It is convenient to complete full software update and dynamic update.",
+  "scripts": {
+    "build": "sh ./build.sh",
+    "test": "egg-bin test test/**/index.test.ts",
+    "lint": "eslint --fix --quiet --ext .js,.jsx ./src",
+    "prepublishOnly": "npm run build",
+    "contributor": "git-contributor",
+    "dev": "ttsc -p tsconfig.json -watch"
   },
+  "main": "./build",
+  "keywords": [
+    "electron",
+    "updator",
+    "auto-updator"
+  ],
   "files": [
-    "bin/**/*.js",
-    "lib/**/*.js"
+    "build/**/*.js",
+    "build/**/*.exe"
   ],
-  "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "git://github.com/xudafeng/electron-updator.git"
+    "url": "https://github.com/electron-modules/electron-updator"
   },
   "dependencies": {
+    "lodash": "4.17.21",
+    "moment": "2.29.4",
+    "eventemitter3": "^4.0.0",
+    "rimraf-alt": "0.2.0",
+    "urllib": "2.34.1"
   },
   "devDependencies": {
-    "eslint": "*",
-    "eslint-plugin-mocha": "^4.11.0",
-    "git-contributor": "1",
-    "husky": "*",
-    "mocha": "*",
-    "nyc": "*"
-  },
-  "scripts": {
-    "test": "nyc --reporter=lcov --reporter=text mocha",
-    "lint": "eslint . --fix",
-    "contributor": "git-contributor"
+    "@applint/spec": "^1.2.0",
+    "@types/lodash": "^4.14.181",
+    "@types/mocha": "^10.0.1",
+    "@types/mock-require": "^2.0.1",
+    "@types/react-dom": "^17.0.16",
+    "@typescript-eslint/parser": "^5.19.0",
+    "babel-plugin-module-resolver": "^4.1.0",
+    "concurrently": "^5.3.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "detect-port": "1",
+    "egg-bin": "^5.9.0",
+    "electron": "18",
+    "electron-windows": "18",
+    "eslint": "^7.32.0",
+    "git-contributor": "*",
+    "husky": "^7.0.4",
+    "mm": "^3.0.2",
+    "mock-require": "^3.0.3",
+    "prettier": "^2.6.2",
+    "prop-types": "^15.7.2",
+    "style-loader": "^1.1.2",
+    "ts-loader": "^9.2.8",
+    "ts-node": "^10.7.0",
+    "ttypescript": "^1.5.15",
+    "typescript": "^4.6.3",
+    "typescript-transform-paths": "^3.3.1"
   },
   "husky": {
     "hooks": {
@@ -36,4 +66,4 @@
     }
   },
   "license": "MIT"
-}
+}

package/bin/electron-updator.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-'use strict';

package/index.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = require('./lib/electron-updator');

package/lib/electron-updator.js

@@ -1 +0,0 @@
-'use strict';