graceful-updater 1.2.0 → 34.0.2

package/README.en.md

@@ -188,11 +188,11 @@ Triggered when an error occurs inside the updater
 
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/4081746?v=4" width="100px;"/><br/><sub><b>zlyi</b></sub>](https://github.com/zlyi)<br/>|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|
-| :---: | :---: | :---: |
+|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/4081746?v=4" width="100px;"/><br/><sub><b>zlyi</b></sub>](https://github.com/zlyi)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|[<img src="https://avatars.githubusercontent.com/u/46579290?v=4" width="100px;"/><br/><sub><b>yinrouni</b></sub>](https://github.com/yinrouni)<br/>|
+| :---: | :---: | :---: | :---: |
 
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Tue Jan 31 2023 14:31:40 GMT+0800`.
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed May 21 2025 20:05:27 GMT+0800`.
 
 <!-- GITCONTRIBUTOR_END -->
 

package/README.md

@@ -186,13 +186,13 @@ electronUpdator.on(EventType.UPDATE_DOWNLOAD_PROGRESS, (data) => {
 
 <!-- GITCONTRIBUTOR_START -->
 
-## Contributors
+## 贡献者
 
-|[<img src="https://avatars.githubusercontent.com/u/4081746?v=4" width="100px;"/><br/><sub><b>zlyi</b></sub>](https://github.com/zlyi)<br/>|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|
-| :---: | :---: | :---: |
+|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/4081746?v=4" width="100px;"/><br/><sub><b>zlyi</b></sub>](https://github.com/zlyi)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|[<img src="https://avatars.githubusercontent.com/u/46579290?v=4" width="100px;"/><br/><sub><b>yinrouni</b></sub>](https://github.com/yinrouni)<br/>|
+| :---: | :---: | :---: | :---: |
 
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Tue Jan 31 2023 14:31:40 GMT+0800`.
+[git-contributor 说明](https://github.com/xudafeng/git-contributor)，自动生成时间：`Wed May 21 2025 20:05:27 GMT+0800`。
 
 <!-- GITCONTRIBUTOR_END -->
 

package/build/app-updator.d.ts

@@ -0,0 +1,42 @@
+import { EventEmitter } from 'eventemitter3';
+import { ILogger, IInstallResult, IAppUpdatorOptions, IUpdateInfo, IAvailableUpdate, IAppAdapter } from "./common/types";
+import { ExecuteType } from "./common/constants";
+export declare abstract class AppUpdator extends EventEmitter {
+    private state;
+    updateInfo?: IUpdateInfo | undefined;
+    logger: ILogger;
+    availableUpdate: IAvailableUpdate;
+    options?: IAppUpdatorOptions;
+    startUuid: string;
+    protected _windowHelperExeDir?: string;
+    protected readonly app: IAppAdapter;
+    constructor(options: IAppUpdatorOptions, app?: IAppAdapter);
+    _getStartUuid(): string;
+    _wrapLogger(logger: ILogger): {
+        info(message: string, ...args: any[]): void;
+        warn(message: string, ...args: any[]): void;
+        error(message: string | Error, ...args: any[]): void;
+    };
+    private setState;
+    setFeedUrl(url: string): void;
+    checkForUpdates(executeType?: ExecuteType): Promise<void>;
+    downloadUpdate(executeType?: ExecuteType): Promise<void>;
+    quitAndInstall(): Promise<void>;
+    protected preCheckForAsar(): Promise<IInstallResult>;
+    protected preCheck(executeType: ExecuteType): Promise<IInstallResult | {
+        success: boolean;
+        error: any;
+    }>;
+    protected downloadUpdateFile(updateInfo: IUpdateInfo, executeType: ExecuteType): Promise<void>;
+    protected unzip(): Promise<IInstallResult>;
+    dispatchError(e: Error): void;
+    logError(e: Error): void;
+    /**
+     * 由子类实现的自定义方法
+     */
+    protected abstract doGetAvailableUpdateInfo(updateInfo: IUpdateInfo): IAvailableUpdate;
+    protected abstract doPreCheckForPackage(): Promise<IInstallResult>;
+    protected abstract doQuitAndInstallAsar(): Promise<IInstallResult>;
+    protected abstract doQuitAndInstallPackage(): Promise<IInstallResult>;
+    protected abstract doUnzip(): Promise<IInstallResult>;
+}

package/build/app-updator.js

@@ -242,4 +242,3 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
     }
 }
 exports.AppUpdator = AppUpdator;
-//# sourceMappingURL=app-updator.js.map

package/build/common/constants.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 更新包备份前缀
+ */
+export declare const OldArchivePrefix = "old-";
+/**
+ * 安装结果类型
+ */
+export declare enum InstallResultType {
+    UpdateUnzipError = "update-unzip-error",
+    DownloadError = "download-error",
+    UpdateSuccess = "update-success",
+    CheckForUpdatesError = "check-for-updates-error"
+}
+/**
+ * 更新状态
+ */
+export declare enum StateType {
+    /**
+     * 空闲
+     */
+    Idle = "idle",
+    /**
+     * 检查更新中
+     */
+    CheckingForUpdate = "checking-for-update",
+    /**
+     * 下载中
+     */
+    Downloading = "downloading",
+    /**
+     * 下载完成
+     */
+    Downloaded = "downloaded"
+}
+/**
+ * 更新类型
+ */
+export declare enum UpdateType {
+    /** 全量更新 */
+    Package = "package",
+    /** 动态更新 */
+    Asar = "asar",
+    /** 更新包更新 */
+    Assets = "assets"
+}
+/**
+ * 执行类型
+ */
+export declare enum ExecuteType {
+    /**
+     * 自动触发
+     */
+    User = "user",
+    /**
+     * 手动触发
+     */
+    Auto = "auto"
+}
+/**
+ * 执行类型
+ */
+export declare enum DownloadProgressStatus {
+    /**
+     * 开始
+     */
+    Begin = "begin",
+    /**
+     * 下载中
+     */
+    Downloading = "downloading",
+    /**
+     * 结束
+     */
+    End = "end"
+}
+/**
+ * 事件类型
+ */
+export declare enum EventType {
+    /**
+     * 下载完成
+     */
+    UPDATE_DOWNLOADED = "update-downloaded",
+    /**
+     * 下载进度
+     */
+    UPDATE_DOWNLOAD_PROGRESS = "update-download-progress",
+    /**
+     * 用户调用 quitAndInstall 之后发出，可在次事件后完成关闭窗口、重启等操作
+     */
+    BEFORE_QUIT_FOR_UPDATE = "before-quit-for-update",
+    /**
+     * 有可用更新
+     */
+    UPDATE_AVAILABLE = "update-available",
+    /**
+     * 开始检查更新
+     */
+    CHECKING_FOR_UPDATE = "checking-for-update",
+    /**
+     * 无可用更新
+     */
+    UPDATE_NOT_AVAILABLE = "update-not-available",
+    /**
+     * 错误
+     */
+    ERROR = "error"
+}
+export declare enum FileName {
+    TARGET_REPLACEMENT_ASAR = "latest.asar"
+}

package/build/common/constants.js

@@ -119,4 +119,3 @@ var FileName;
 (function (FileName) {
     FileName["TARGET_REPLACEMENT_ASAR"] = "latest.asar";
 })(FileName = exports.FileName || (exports.FileName = {}));
-//# sourceMappingURL=constants.js.map

package/build/common/types/index.d.ts

@@ -0,0 +1,91 @@
+import { UpdateType, InstallResultType, DownloadProgressStatus } from '../constants';
+
+export interface ILogger {
+  info(message: string, ...args: any[]): void;
+  warn(message: string, ...args: any[]): void;
+  error(message: string | Error, ...args: any[]): void;
+}
+
+export interface IUpdateInfo {
+  /** 最新版本 */
+  version: string;
+  /** 下载信息 */
+  files: [
+    {
+      /** 下载地址 */
+      url: string;
+      /** 下载签名 */
+      signature: string;
+    },
+  ];
+  /** 更新类型  */
+  updateType: UpdateType;
+}
+
+export interface IInstallResult {
+  /**
+   * 是否安装成功
+   */
+  success: boolean;
+  /**
+   * 异常类型
+   */
+  type?: InstallResultType;
+  /**
+   * 错误消息
+   */
+  message?: any;
+
+  /**
+   * 异常
+   */
+  error?: Error;
+}
+
+export interface IAppUpdatorOptions {
+  logger?: ILogger;
+  verify?: any;
+  updateInfoFormatter?: (res: object) => object;
+  dmgTitleFormatter?: (res: object, updateInfo: IUpdateInfo) => string;
+  ifNeedUpdate: (res: object) => boolean;
+  url: string;
+  autoDownload?: boolean;
+  productName?: string;
+  getWindowsHelperExeDir?: () => string;
+}
+
+interface IProgressHandleArg {
+  status: DownloadProgressStatus;
+  [key: string]: any;
+}
+
+export interface IDownloadFileOptions {
+  logger: ILogger;
+  url: string;
+  signature: string;
+  targetDir: string;
+  progressHandle: (progress: IProgressHandleArg) => void;
+}
+
+export interface IAvailableUpdate {
+  /** 资源根路径 */
+  resourcePath: string;
+  /** 下载目标路径 */
+  downloadTargetDir: string;
+  /** 最新 asar 路径 */
+  latestAsarPath: string;
+}
+
+export interface IAppAdapter {
+  readonly name: string;
+
+  readonly userDataPath: string;
+
+  readonly exePath: string;
+
+  quit(): void;
+
+  exit(code: number): void;
+
+  relaunch(code?: number): void;
+}

package/build/common/types/typing.d.ts

@@ -0,0 +1,3 @@
+declare module 'sudo-prompt-alt';
+declare module 'rimraf-alt';
+declare module 'graceful-updater-windows-helper';

package/build/elelctron-app-adapter.d.ts

@@ -0,0 +1,12 @@
+import { IAppAdapter } from "./common/types";
+export declare class ElectronAppAdapter implements IAppAdapter {
+    private readonly app;
+    constructor(app?: Electron.App);
+    get name(): string;
+    get isPackaged(): boolean;
+    get userDataPath(): string;
+    get exePath(): string;
+    exit(code: number): void;
+    relaunch(code: number): void;
+    quit(): void;
+}

package/build/elelctron-app-adapter.js

@@ -30,4 +30,3 @@ class ElectronAppAdapter {
     }
 }
 exports.ElectronAppAdapter = ElectronAppAdapter;
-//# sourceMappingURL=elelctron-app-adapter.js.map

package/build/index.d.ts

@@ -0,0 +1,3 @@
+export { UpdateType, EventType, ExecuteType, DownloadProgressStatus, StateType } from "./common/constants";
+export { MacUpdator } from "./mac-updator";
+export { WindowsUpdator } from "./windows-updator";

package/build/index.js

@@ -1,15 +1,13 @@
 "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,
-    StateType: constants_1.StateType,
-    MacUpdator: mac_updator_1.MacUpdator,
-    WindowsUpdator: windows_updator_1.WindowsUpdator,
-    DownloadProgressStatus: constants_1.DownloadProgressStatus,
-};
-//# sourceMappingURL=index.js.map
+exports.WindowsUpdator = exports.MacUpdator = exports.StateType = exports.DownloadProgressStatus = exports.ExecuteType = exports.EventType = exports.UpdateType = void 0;
+var constants_1 = require("./common/constants");
+Object.defineProperty(exports, "UpdateType", { enumerable: true, get: function () { return constants_1.UpdateType; } });
+Object.defineProperty(exports, "EventType", { enumerable: true, get: function () { return constants_1.EventType; } });
+Object.defineProperty(exports, "ExecuteType", { enumerable: true, get: function () { return constants_1.ExecuteType; } });
+Object.defineProperty(exports, "DownloadProgressStatus", { enumerable: true, get: function () { return constants_1.DownloadProgressStatus; } });
+Object.defineProperty(exports, "StateType", { enumerable: true, get: function () { return constants_1.StateType; } });
+var mac_updator_1 = require("./mac-updator");
+Object.defineProperty(exports, "MacUpdator", { enumerable: true, get: function () { return mac_updator_1.MacUpdator; } });
+var windows_updator_1 = require("./windows-updator");
+Object.defineProperty(exports, "WindowsUpdator", { enumerable: true, get: function () { return windows_updator_1.WindowsUpdator; } });

package/build/mac-updator.d.ts

@@ -0,0 +1,13 @@
+import { AppUpdator } from "./app-updator";
+import { IInstallResult, IUpdateInfo, IAvailableUpdate } from "./common/types";
+export declare class MacUpdator extends AppUpdator {
+    protected doGetAvailableUpdateInfo(updateInfo: IUpdateInfo): IAvailableUpdate;
+    protected doPreCheckForPackage(): Promise<IInstallResult>;
+    /**
+     * 资源解压
+     * @return
+     */
+    protected doUnzip(): Promise<IInstallResult>;
+    protected doQuitAndInstallAsar(): Promise<IInstallResult>;
+    protected doQuitAndInstallPackage(): Promise<IInstallResult>;
+}

package/build/mac-updator.js

@@ -115,4 +115,3 @@ class MacUpdator extends app_updator_1.AppUpdator {
     }
 }
 exports.MacUpdator = MacUpdator;
-//# sourceMappingURL=mac-updator.js.map

package/build/utils/download-file.d.ts

@@ -0,0 +1,11 @@
+import { IDownloadFileOptions } from "../common/types";
+/**
+ * 文件下载
+ * @param updator 更新实例
+ * @param url 下载地址
+ * @param signature 下载签名
+ * @param targeDir 下载目录
+ * @param progressHandle 下载状态回调
+ * @return
+ */
+export declare const downloadFile: ({ logger, url, signature, targetDir, progressHandle }: IDownloadFileOptions) => Promise<unknown>;

package/build/utils/download-file.js

@@ -75,4 +75,3 @@ const downloadFile = async ({ logger, url, signature, targetDir, progressHandle
     });
 };
 exports.downloadFile = downloadFile;
-//# sourceMappingURL=download-file.js.map

package/build/utils/index.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import sudoPrompt from 'sudo-prompt-alt';
+import { exec } from 'child_process';
+import { rename, exists, readdir, existsSync, createWriteStream } from 'original-fs';
+import { IUpdateInfo, IAppUpdatorOptions } from "../common/types";
+export declare const renameAsync: typeof rename.__promisify__;
+export declare const existsAsync: typeof exists.__promisify__;
+export declare const readdirAsync: typeof readdir.__promisify__;
+export declare const rimrafAsync: Function;
+export declare const execAsync: typeof exec.__promisify__;
+export declare const isWin: boolean;
+export declare const isMac: boolean;
+export { createWriteStream, existsSync, sudoPrompt };
+export declare const getMacOSAppPath: () => string;
+export declare const sleep: (ms: number) => Promise<unknown>;
+export declare const waitUntil: (handle: () => boolean, options?: {
+    retryTime: number;
+    ms: number;
+}) => Promise<any>;
+export declare const spawnAsync: (command: string, options: any) => Promise<unknown>;
+export declare const cleanOldArchive: (resourcePath: string) => Promise<void[] | undefined>;
+export declare const existFile: (path: string) => Promise<boolean>;
+export declare const requestUpdateInfo: (options: IAppUpdatorOptions) => Promise<IUpdateInfo>;
+export declare const getExecuteFile: (helperExeFileDir: string, file: string) => string;

package/build/utils/index.js

@@ -119,4 +119,3 @@ const getExecuteFile = (helperExeFileDir, file) => {
     return path_1.default.join(helperExeFileDir, file);
 };
 exports.getExecuteFile = getExecuteFile;
-//# sourceMappingURL=index.js.map

package/build/utils/install-macos-dmg.d.ts

@@ -0,0 +1,3 @@
+import { IInstallResult, IAppUpdatorOptions, IUpdateInfo, ILogger, IAvailableUpdate } from "../common/types";
+declare const _default: (updatorOptions: IAppUpdatorOptions, logger: ILogger, availableUpdate: IAvailableUpdate, updateInfo: IUpdateInfo, preCheck?: boolean) => Promise<IInstallResult>;
+export default _default;

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

@@ -152,4 +152,3 @@ exports.default = async (updatorOptions, logger, availableUpdate, updateInfo, pr
         success: true,
     };
 };
-//# sourceMappingURL=install-macos-dmg.js.map

package/build/utils/sudo-prompt-exec.d.ts

@@ -0,0 +1,3 @@
+import { ILogger } from "../common/types";
+declare function sudoPromptExec(logger: ILogger, shell: string): Promise<unknown>;
+export { sudoPromptExec };

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

@@ -20,4 +20,3 @@ function sudoPromptExec(logger, shell) {
     });
 }
 exports.sudoPromptExec = sudoPromptExec;
-//# sourceMappingURL=sudo-prompt-exec.js.map

package/build/windows-updator.d.ts

@@ -0,0 +1,9 @@
+import { IInstallResult, IUpdateInfo, IAvailableUpdate } from "./common/types";
+import { AppUpdator } from "./app-updator";
+export declare class WindowsUpdator extends AppUpdator {
+    protected doGetAvailableUpdateInfo(updateInfo: IUpdateInfo): IAvailableUpdate;
+    protected doPreCheckForPackage(): Promise<IInstallResult>;
+    protected doUnzip(): Promise<IInstallResult>;
+    protected doQuitAndInstallPackage(): Promise<IInstallResult>;
+    protected doQuitAndInstallAsar(): Promise<IInstallResult>;
+}

package/build/windows-updator.js

@@ -99,4 +99,3 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
     }
 }
 exports.WindowsUpdator = WindowsUpdator;
-//# sourceMappingURL=windows-updator.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graceful-updater",
-  "version": "1.2.0",
+  "version": "34.0.2",
   "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",
@@ -11,13 +11,15 @@
     "dev": "ttsc -p tsconfig.json -watch"
   },
   "main": "./build",
+  "types": "./build/index.d.ts",
   "keywords": [
     "electron",
     "updator",
     "auto-updator"
   ],
   "files": [
-    "build/**/*.js"
+    "build/**/*.js",
+    "build/**/*.d.ts"
   ],
   "repository": {
     "type": "git",
@@ -46,8 +48,8 @@
     "cross-env": "^7.0.3",
     "detect-port": "1",
     "egg-bin": "^5.9.0",
-    "electron": "18",
-    "electron-windows": "18",
+    "electron": "34",
+    "electron-windows": "34",
     "eslint": "^7.32.0",
     "eslint-config-egg": "^12.1.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
@@ -70,4 +72,4 @@
     }
   },
   "license": "MIT"
-}
+}