graceful-updater 1.1.0 → 1.1.1-beta.1

package/README.en.md

@@ -15,6 +15,9 @@
 [download-url]: https://npmjs.org/package/graceful-updater
 
 > Software updates solution for Electron applications, It is convenient to complete full software update and dynamic update.
+
+English | [简体中文](./README.md) 
+
 ## Installment
 
 ```bash
@@ -26,7 +29,7 @@ $ npm i graceful-updater --save
 please visit: https://github.com/electron-modules/electron-modules-sample
 
 ```typescript
-// 1. 构造 options
+// 1. options
 const options = {
   url: getFeedUrl(),
   logger: console, // logger
@@ -43,9 +46,10 @@ const options = {
       res.project_version > currentBuildNumber;
   },
 };
-// 2. 初始化 updator 实例
+// 2. initialization
 const electronUpdator = new MacUpdator(options);
-// 3. 绑定全局事件
+
+// 3. Bind events
 electronUpdator.on(EventType.UPDATE_DOWNLOADED, (...args) => {
   console.log('updator >> %s, args: %j', EventType.UPDATE_DOWNLOADED, args);
 });
@@ -92,41 +96,92 @@ electronUpdator.on(EventType.UPDATE_DOWNLOAD_PROGRESS, (data) => {
 
 ### Options
 
-| 字段 | 类型 | 是否必须 | 描述 | 备注 |
+| Param | Type | Required | Description | Default value |
 | --- | --- | --- | --- | --- |
-| url | String | 必须 | 检测更新的远程地址，返回数据遵循 UpdateInfo 字段 | |
-| ifNeedUpdate | Function | 非必须 | 返回是否需要更新 | |
-| updateInfoFormatter | Function | 非必须 | 服务端返回数据格式适配 | 如果返回的格式无法与需要的字段相匹配时，参数进行格式化 |
-| logger | Object | 非必须 | 日志 | |
-| productName | String | 产品名 | 应用名 | |
+| url | String | Yes | Check for update remote address, and the returned data follows the `UpdateInfo` object | |
+| ifNeedUpdate | Function | Yes | Check if update is required | |
+| updateInfoFormatter | Function | No | The server returns data format adaptation. If the returned format cannot match the `UpdateInfo`, this method can be used to format |
+| logger | Object | No | Log method | `console` |
+| productName | String | Yes | Application Name | |
+| autoDownload | String | No | Whether to download automatically | false |
+
 
 ### UpdateInfo
 
-| 字段 | 类型 | 是否必须 | 描述 | 备注 |
+| Param | Type | Required | Description | Default value |
 | --- | --- | --- | --- | --- |
-| version | String | 必须 | 版本号 | |
-| projectVersion | Number | 必须 | 构建号 | |
-| files | Array<Object> | 必须 | 需要下载的文件列表 | |
-| updateType | Enum<String> | 必须 | 更新类型，是否动态替换更新 | Package or Asar |
-| releaseNotes | Array<String> | 必须 | 更新日志 | |
+| version | String | Yes | version | |
+| projectVersion | Number | No | project version | |
+| files | Array\<Object\> | Yes | The list of files to be downloaded. The returned data follows the `File` object | |
+| updateType | Enum\<String\> | Yes | Update type, full update or dynamic update.Package is full update，Asar is dynamic update | |
+| releaseNotes | Array\<String\> | Yes | The release notes. | |
+
+### File
+
+| Param | Type | Required | Description | Default value |
+| --- | --- | --- | --- | --- |
+| url | String | No | download address | |
+| signature | String | No | download address signature | |
+| updateType | Enum\<String\> | Yes | Update type, full update or dynamic update.Package is full update，Asar is dynamic update | |
 
 ### Methods
 
-1. checkForUpdates()
+1. checkForUpdates(ExecuteType)
+
+- `ExecuteType` ExecuteType(User or Auto)
+
+Check whether there is content to be updated. If the `ExecuteType` is User, the `update-available` event will be triggered directly after the update is detected. Otherwise, the `update-available` event will be triggered after the package is automatically downloaded
+
+2. setFeedUrl(url)
+
+- url: New update URL
+According to the needs of different scenarios, dynamically set the URL for checking updates
 
-检测是否有需要更新的内容
+2. downloadUpdate(ExecuteType)
 
-2. downloadUpdate()
+- `ExecuteType` ExecuteType(User or Auto)
+
+Start downloading the installation package. If the `ExecuteType` is User, no pre-check will be performed. After the download is completed, the `update-downloaded` event will be triggered directly. Otherwise, the `update-downloaded` event will be triggered after the internal pre-check is completed
 
-开始下载
 
 3. quitAndInstall()
+Exit the app and start the installation. If the installation package has been downloaded, the application will be restarted directly and the new version will be installed. Otherwise, enter the download process
 
 ### Events
 
 1. checking-for-update
 
-当开始检查更新的时候触发
+Triggered when checking for updates
+
+2. update-available
+- params: update info
+- params.updateInfo: `UpdateInfo`
+
+Triggered when an available update is checked
+
+3. update-not-available
+- params: update info
+- params.updateInfo: `UpdateInfo`
+ 
+Triggered when no updates are checked
+
+4. update-download-progress
+
+- params: status and file info the download process.
+- params.status: download status `begin`, `downloading`, `end`
+- params.progress: Current download progress percentage. 0 ~ 100
+- params.data: The file stream of downloaded content can be used for signature verification
+
+Triggering during download
+
+5. update-downloaded
+
+Triggered when the download is complete
+
+6. error
+- params: `Error`
+
+Triggered when an error occurs inside the updater
 
 <!-- GITCONTRIBUTOR_START -->
 

package/README.md

@@ -14,16 +14,19 @@
 [download-image]: https://img.shields.io/npm/dm/graceful-updater.svg
 [download-url]: https://npmjs.org/package/graceful-updater
 
-> Software updates solution for Electron applications, It is convenient to complete full software update and dynamic update.
+> Electron 应用软件更新解决方案，方便完成软件的全量更新和动态更新。
+
+[English](./README.en.md) | 简体中文
+
 ## Installment
 
 ```bash
 $ npm i graceful-updater --save
 ```
 
-## Sample
+## 样例
 
-please visit: https://github.com/electron-modules/electron-modules-sample
+点击查看： https://github.com/electron-modules/electron-modules-sample
 
 ```typescript
 // 1. 构造 options
@@ -88,46 +91,98 @@ electronUpdator.on(EventType.UPDATE_DOWNLOAD_PROGRESS, (data) => {
 });
 ```
 
-## Documents
+## 文档
 
-### Options
+### 参数
 
-| 字段 | 类型 | 是否必须 | 描述 | 备注 |
+| 字段 | 类型 | 是否必须 | 说明 | 默认值 |
 | --- | --- | --- | --- | --- |
-| url | String | 必须 | 检测更新的远程地址，返回数据遵循 UpdateInfo 字段 | |
-| ifNeedUpdate | Function | 非必须 | 返回是否需要更新 | |
-| updateInfoFormatter | Function | 非必须 | 服务端返回数据格式适配 | 如果返回的格式无法与需要的字段相匹配时，参数进行格式化 |
-| logger | Object | 非必须 | 日志 | |
-| productName | String | 产品名 | 应用名 | |
+| url | String | 必须 | 检测更新的远程地址，返回数据遵循 `UpdateInfo` 对象 | |
+| ifNeedUpdate | Function | 必须 | 返回是否需要更新 | |
+| updateInfoFormatter | Function | 非必须 | 服务端返回数据格式适配。如果返回的格式无法与 `UpdateInfo` 相匹配时，可通过此方法进行格式化 |
+| logger | Object | 非必须 | 日志 | `console` |
+| productName | String | 必须 | 应用完整名称 | |
+| autoDownload | String | 非必须 | 是否自动下载 | false |
+
 
 ### UpdateInfo
 
-| 字段 | 类型 | 是否必须 | 描述 | 备注 |
+| 字段 | 类型 | 是否必须 | 说明 | 默认值 |
 | --- | --- | --- | --- | --- |
 | version | String | 必须 | 版本号 | |
-| projectVersion | Number | 必须 | 构建号 | |
-| files | Array<Object> | 必须 | 需要下载的文件列表 | |
-| updateType | Enum<String> | 必须 | 更新类型，是否动态替换更新 | Package or Asar |
-| releaseNotes | Array<String> | 必须 | 更新日志 | |
+| projectVersion | Number | 非必须 | 构建号 | |
+| files | Array\<Object\> | 必须 | 需要下载的文件列表，返回数据遵循 `File` 对象 | |
+| updateType | Enum\<String\> | 必须 | 更新类型，全量更新或者动态更新。Package 为全量更新，Asar 为动态更新 | |
+| releaseNotes | Array\<String\> | 必须 | 更新日志 | |
+
+### File
+
+| 字段 | 类型 | 是否必须 | 说明 | 默认值 |
+| --- | --- | --- | --- | --- |
+| url | String | 必须 | 下载地址 | |
+| signature | String | 非必须 | 下载签名 | |
+| updateType | Enum\<String\> | 必须 | 更新类型，针对动态更新或全量更新提供的下载地址。Package or Asar | |
 
-### Methods
+### 方法
 
-1. checkForUpdates()
+1. checkForUpdates(ExecuteType)
 
-检测是否有需要更新的内容
+- `ExecuteType` 执行类型（User or Auto）
 
-2. downloadUpdate()
+检测是否有需要更新的内容，如果 `ExecuteType` 为 User，则检查到更新后直接触发 `update-available` 事件，否则将自动下载完成安装包后触发 `update-available` 事件
 
-开始下载
+2. setFeedUrl(url)
+
+- url 新的更新 URL
+根据不同场景需要，动态设置检查更新的 URL
+
+2. downloadUpdate(ExecuteType)
+
+- `ExecuteType` 执行类型（User or Auto）
+
+开始下载安装包，如果 `ExecuteType` 为 User，则不进行预检查，下载完成后直接触发 `update-downloaded` 事件，否则完成内部完成预检查后再触发 `update-downloaded` 事件
 
 3. quitAndInstall()
+退出应用并开始安装。如果安装包已下载完成，将直接重启应用并进行新版本安装。否则进入下载流程
+
 
-### Events
+### 事件
 
 1. checking-for-update
 
 当开始检查更新的时候触发
 
+2. update-available
+- params：更新信息
+- params.updateInfo：本次更新的信息 `UpdateInfo`
+
+检测到有可用更新时触发
+
+3. update-not-available
+- params：更新信息
+- params.updateInfo：本次更新的信息 `UpdateInfo`
+ 
+检测到无可用更新时触发
+
+4. update-download-progress
+
+- params：下载过程中的进度及文件流信息。
+- params.status 下载状态。 `begin` 开始下载，`downloading` 下载中，`end` 下载结束
+- params.progress 当前下载进度百分比，0 ~ 100
+- params.data 下载内容的文件流，可利用此数据进行签名校验
+
+
+正在下载过程中触发
+
+5. update-downloaded
+
+完成下载时触发
+
+6. error
+- params：错误信息 `Error`
+
+更新程序内部出现错误时触发
+
 <!-- GITCONTRIBUTOR_START -->
 
 ## Contributors

package/build/app-updator.js

@@ -13,6 +13,7 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         this.state = constants_1.StateType.Idle;
         this.options = options;
         this.logger = this._wrapLogger(options.logger);
+        this._windowHelperExeDir = this.options.getWindowsHelperExeDir?.();
         this.app = app || new elelctron_app_adapter_1.ElectronAppAdapter();
         this.startUuid = this._getStartUuid();
         this.logger.info('constructor');

package/build/utils/index.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.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;
+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 util_1 = __importDefault(require("util"));
 const urllib_1 = __importDefault(require("urllib"));
@@ -115,4 +115,8 @@ const requestUpdateInfo = async (options) => {
     return res.data;
 };
 exports.requestUpdateInfo = requestUpdateInfo;
+const getExecuteFile = (helperExeFileDir, file) => {
+    return path_1.default.join(helperExeFileDir, file);
+};
+exports.getExecuteFile = getExecuteFile;
 //# sourceMappingURL=index.js.map

package/build/windows-updator.js

@@ -36,10 +36,10 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
         const { downloadTargetDir, resourcePath, latestAsarPath } = this.availableUpdate;
         this.logger.info('WindowsUpdator#doUnzip:start');
         try {
-            const unzipExe = graceful_updater_windows_helper_1.unzipExeFilePath;
+            const unzipExe = (0, utils_1.getExecuteFile)(this._windowHelperExeDir, graceful_updater_windows_helper_1.unzipExeFileName);
             const executeCommand = `"${unzipExe}" -o "${downloadTargetDir}" -d "${resourcePath}"`;
             await (0, utils_1.execAsync)(executeCommand);
-            if (!await (0, utils_1.existsAsync)(latestAsarPath)) {
+            if (!(await (0, utils_1.existsAsync)(latestAsarPath))) {
                 const zipInfoCommand = `"${unzipExe}" -Z -1 "${downloadTargetDir}"`;
                 const zipInfo = await (0, utils_1.execAsync)(zipInfoCommand, {
                     cwd: resourcePath,
@@ -85,7 +85,7 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
         const productName = this.options?.productName;
         const { resourcePath } = this.availableUpdate;
         const exePath = this.app.exePath;
-        const updateExePath = graceful_updater_windows_helper_1.installerExeFilePath;
+        const updateExePath = (0, utils_1.getExecuteFile)(this._windowHelperExeDir, graceful_updater_windows_helper_1.installerExeFileName);
         const targetPath = path_1.default.resolve(exePath, '..', 'resources');
         const executeCommand = `"${updateExePath}" "${targetPath}" "${resourcePath}" "${productName}.exe" "${exePath}"`;
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graceful-updater",
-  "version": "1.1.0",
+  "version": "1.1.1-beta.1",
   "description": "graceful-updater 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",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "eventemitter3": "^4.0.0",
-    "graceful-updater-windows-helper": "1",
+    "graceful-updater-windows-helper": "1.0.3-beta.1",
     "lodash": "4",
     "moment": "2",
     "nanoid": "^3.3.4",