electron-incremental-update 2.0.0-beta.1 → 2.0.0-beta.2

package/README.md

@@ -181,7 +181,7 @@ initApp({
 in `electron/main/index.ts`
 
 ```ts
-import { startupWithUpdater, UpdaterError } from 'electron-incremental-update'
+import { UpdaterError, startupWithUpdater } from 'electron-incremental-update'
 import { getPathFromAppNameAsar, getVersions } from 'electron-incremental-update/utils'
 import { app } from 'electron'
 
@@ -199,7 +199,7 @@ export default startupWithUpdater((updater) => {
   }
   updater.logger = console
   updater.receiveBeta = true
-  
+
   updater.checkUpdate().then(async (result) => {
     if (result === undefined) {
       console.log('Update Unavailable')
@@ -276,7 +276,7 @@ import Database from 'better-sqlite3'
 
 const db = new Database(':memory:', { nativeBinding: './better_sqlite3.node' })
 
-export function test() {
+export function test(): void {
   db.exec(
     'DROP TABLE IF EXISTS employees; '
     + 'CREATE TABLE IF NOT EXISTS employees (name TEXT, salary INTEGER)',

package/dist/{chunk-RSLOPAIZ.js → chunk-BG22XZAB.js}

@@ -30,7 +30,9 @@ function restartApp() {
   app.quit();
 }
 function setAppUserModelId(id) {
-  isWin && app.setAppUserModelId(id ?? `org.${app.name}`);
+  if (isWin) {
+    app.setAppUserModelId(id ?? `org.${app.name}`);
+  }
 }
 function disableHWAccForWin7() {
   if (__require("node:os").release().startsWith("6.1")) {
@@ -39,15 +41,19 @@ function disableHWAccForWin7() {
 }
 function singleInstance(window) {
   const result = app.requestSingleInstanceLock();
-  result ? app.on("second-instance", () => {
-    if (window) {
-      window.show();
-      if (window.isMinimized()) {
-        window.restore();
+  if (result) {
+    app.on("second-instance", () => {
+      if (window) {
+        window.show();
+        if (window.isMinimized()) {
+          window.restore();
+        }
+        window.focus();
       }
-      window.focus();
-    }
-  }) : app.quit();
+    });
+  } else {
+    app.quit();
+  }
   return result;
 }
 function setPortableAppDataPath(dirName = "data") {
@@ -69,7 +75,11 @@ function waitAppReady(timeout = 1e3) {
   });
 }
 function loadPage(win, htmlFilePath = "index.html") {
-  isDev ? win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath) : win.loadFile(getPathFromAppNameAsar("renderer", htmlFilePath));
+  if (isDev) {
+    win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath);
+  } else {
+    win.loadFile(getPathFromAppNameAsar("renderer", htmlFilePath));
+  }
 }
 function getPathFromPreload(...paths) {
   return isDev ? join(app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "preload", ...paths) : getPathFromAppNameAsar("preload", ...paths);
@@ -95,7 +105,7 @@ async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
         reject(err);
       }
       writeFileSync(targetFilePath, buffer2);
-      resolve(null);
+      resolve();
     });
   });
 }
@@ -115,7 +125,7 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
         reject(err);
       }
       writeFileSync2(targetFilePath, buffer);
-      resolve(null);
+      resolve();
     });
   });
 }
@@ -195,7 +205,7 @@ function verifySignatureDefault(buffer, signature2, cert) {
     const [sig, version] = decrypt(signature2, hashString(cert, 32), hashString(buffer, 16)).split("%");
     const result = createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
     return result ? version : void 0;
-  } catch (error) {
+  } catch {
     return void 0;
   }
 }

package/dist/{decrypt-BNBcodiO.d.cts → decrypt-D9WdXYjH.d.cts}

@@ -1,4 +1,4 @@
 declare function decrypt(encryptedText: string, key: Buffer, iv: Buffer): string;
-declare function verifySignatureDefault(buffer: Buffer, signature: string, cert: string): string | undefined | Promise<string | undefined>;
+declare function verifySignatureDefault(buffer: Buffer, signature: string, cert: string): string | undefined;
 
 export { decrypt as d, verifySignatureDefault as v };

package/dist/{decrypt-BNBcodiO.d.ts → decrypt-D9WdXYjH.d.ts}

@@ -1,4 +1,4 @@
 declare function decrypt(encryptedText: string, key: Buffer, iv: Buffer): string;
-declare function verifySignatureDefault(buffer: Buffer, signature: string, cert: string): string | undefined | Promise<string | undefined>;
+declare function verifySignatureDefault(buffer: Buffer, signature: string, cert: string): string | undefined;
 
 export { decrypt as d, verifySignatureDefault as v };

package/dist/index.cjs

@@ -33,6 +33,7 @@ var import_electron4 = require("electron");
 
 // src/updater/core.ts
 var import_node_fs3 = require("fs");
+var import_node_stream = require("stream");
 var import_electron2 = require("electron");
 
 // src/utils/version.ts
@@ -78,7 +79,7 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
         reject(err);
       }
       (0, import_node_fs2.writeFileSync)(targetFilePath, buffer);
-      resolve(null);
+      resolve();
     });
   });
 }
@@ -87,17 +88,18 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
 var ErrorInfo = {
   download: "Download failed",
   validate: "Validate failed",
-  param: "Missing params",
-  version: "Unsatisfied version"
+  param: "Missing params"
 };
 var UpdaterError = class extends Error {
+  code;
   constructor(msg, info) {
-    super(msg + ": " + info);
+    super(ErrorInfo[msg] + ": " + info);
+    this.code = msg;
   }
 };
 
 // src/updater/core.ts
-var Updater = class {
+var Updater = class extends import_node_stream.EventEmitter {
   CERT = __EIU_SIGNATURE_CERT__;
   info;
   options;
@@ -109,19 +111,10 @@ var Updater = class {
    * updater logger
    */
   logger;
-  /**
-   * downloading progress hook
-   * @param progress download progress
-   * @example
-   * updater.onDownloading = ({ percent, total, current }) => {
-   *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
-   * }
-   */
-  onDownloading;
   /**
    * URL handler hook
    *
-   * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
+   * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDNs}
    * @param url source url
    * @param isDownloadAsar whether is download asar
    */
@@ -141,6 +134,7 @@ var Updater = class {
    * @param option UpdaterOption
    */
   constructor(provider, option = {}) {
+    super();
     this.provider = provider;
     this.options = option;
     if (option.SIGNATURE_CERT) {
@@ -149,25 +143,20 @@ var Updater = class {
     if (option.logger) {
       this.logger = option.logger;
     }
+    if (isDev && !this.logger) {
+      this.logger = {
+        info: (...args) => console.log("[EIU-INFO ]", ...args),
+        debug: (...args) => console.log("[EIU-DEBUG]", ...args),
+        warn: (...args) => console.log("[EIU-WARN ]", ...args),
+        error: (...args) => console.error("[EIU-ERROR]", ...args)
+      };
+      this.logger.info("no logger set, enable dev-only logger");
+    }
     this.asarPath = getPathFromAppNameAsar();
     this.gzipPath = `${this.asarPath}.gz`;
     this.tmpFilePath = `${this.asarPath}.tmp`;
   }
-  async needUpdate(version, minVersion) {
-    if (isDev) {
-      this.logger?.warn(`in dev mode, skip check update`);
-      return false;
-    }
-    const isLowerVersion = this.provider.isLowerVersion;
-    const entryVersion = getEntryVersion();
-    const appVersion = getAppVersion();
-    if (await isLowerVersion(entryVersion, minVersion)) {
-      throw new UpdaterError(ErrorInfo.version, `entry version (${entryVersion}) < minimumVersion (${minVersion})`);
-    }
-    this.logger?.info(`check update: current version is ${appVersion}, new version is ${version}`);
-    return await isLowerVersion(appVersion, version);
-  }
-  async parseData(format, data) {
+  async fetch(format, data) {
     if ((0, import_node_fs3.existsSync)(this.tmpFilePath)) {
       this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
       (0, import_node_fs3.rmSync)(this.tmpFilePath);
@@ -180,71 +169,96 @@ var Updater = class {
       if (format === "json" && isUpdateJSON(data) || format === "buffer" && Buffer.isBuffer(data)) {
         return data;
       } else {
-        throw new UpdaterError(ErrorInfo.param, `invalid type at format '${format}': ${JSON.stringify(data)}`);
+        this.err("invalid type", "param", `invalid type at format '${format}': ${JSON.stringify(data)}`);
+        return;
       }
     }
     this.logger?.debug(`download from ${this.provider.name}`);
     try {
-      const result = format === "json" ? await this.provider.downloadJSON(data ?? __EIU_VERSION_PATH__) : await this.provider.downloadBuffer(import_electron2.app.name, this.info, this.onDownloading);
+      const result = format === "json" ? await this.provider.downloadJSON(data ?? __EIU_VERSION_PATH__) : await this.provider.downloadAsar(import_electron2.app.name, this.info, (data2) => this.emit("download-progress", data2));
       this.logger?.debug(`download ${format} success${format === "buffer" ? `, file size: ${result.length}` : ""}`);
       return result;
     } catch (e) {
-      this.logger?.warn(`download ${format} failed: ${e}`);
-      throw new UpdaterError(ErrorInfo.download, `download ${format} failed: ${e}`);
+      this.err(`download ${format} failed`, "download", `download ${format} failed: ${e}`);
     }
   }
+  /**
+   * handle error message and emit error event
+   */
+  err(msg, code, errorInfo) {
+    const err = new UpdaterError(code, errorInfo);
+    this.logger?.error(msg, err);
+    this.emit("error", err);
+  }
   async checkUpdate(data) {
-    try {
-      let { signature, size, version, minimumVersion, beta } = await this.parseData("json", data);
-      if (this.receiveBeta) {
-        version = beta.version;
-        signature = beta.signature;
-        minimumVersion = beta.minimumVersion;
-        size = beta.size;
-      }
-      this.logger?.debug(`checked update, version: ${version}, size: ${size}, signature: ${signature}`);
-      if (!await this.needUpdate(version, minimumVersion)) {
-        this.logger?.info(`update unavailable: ${version} is the latest version`);
-        return { success: false, data: version };
-      } else {
-        this.logger?.info(`update available: ${version}`);
-        this.info = { signature, minimumVersion, version, size };
-        return { success: true, data: this.info };
-      }
-    } catch (error) {
-      this.logger?.error("check update failed", error);
-      return {
-        success: false,
-        data: error instanceof UpdaterError ? error : new UpdaterError(ErrorInfo.download, error.toString())
-      };
+    const emitUnavailable = (msg) => {
+      this.logger?.info(msg);
+      this.emit("update-unavailable", msg);
+    };
+    const _data = await this.fetch("json", data);
+    if (!_data) {
+      emitUnavailable("failed to get update info");
+      return false;
     }
+    let { signature, size, version, minimumVersion, beta } = _data;
+    if (this.receiveBeta) {
+      version = beta.version;
+      signature = beta.signature;
+      minimumVersion = beta.minimumVersion;
+      size = beta.size;
+    }
+    this.logger?.debug(`checked update, version: ${version}, size: ${size}, signature: ${signature}`);
+    if (isDev) {
+      emitUnavailable("in dev mode, skip check update");
+      return false;
+    }
+    const isLowerVersion = this.provider.isLowerVersion;
+    const entryVersion = getEntryVersion();
+    const appVersion = getAppVersion();
+    if (isLowerVersion(entryVersion, minimumVersion)) {
+      emitUnavailable(`entry version (${entryVersion}) < minimumVersion (${minimumVersion})`);
+      return false;
+    }
+    this.logger?.info(`check update: current version is ${appVersion}, new version is ${version}`);
+    if (!isLowerVersion(appVersion, version)) {
+      emitUnavailable(`current version (${appVersion}) < new version (${version})`);
+      return false;
+    }
+    this.logger?.info(`update available: ${version}`);
+    this.info = { signature, minimumVersion, version, size };
+    this.emit("update-available", this.info);
+    return true;
   }
   async download(data, sig) {
+    if (!this.info) {
+      this.err("download failed", "param", "no update info, call `checkUpdate` first");
+      return false;
+    }
+    const _sig = sig ?? this.info.signature;
+    const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
+    if (!buffer) {
+      this.err("download failed", "param", "no update asar file buffer");
+      return false;
+    }
+    this.logger?.debug("verify start");
+    const _ver = await this.provider.verifySignaure(buffer, _sig, this.CERT);
+    if (!_ver) {
+      this.err("verify failed", "validate", "invalid signature / certificate pair");
+      return false;
+    }
+    this.logger?.debug("verify success");
     try {
-      if (!this.info) {
-        throw new UpdaterError(ErrorInfo.param, "no update info");
-      }
-      const _sig = sig ?? this.info.signature;
-      const buffer = await this.parseData("buffer", data);
-      this.logger?.debug("verify start");
-      const _ver = await this.provider.verifySignaure(buffer, _sig, this.CERT);
-      if (!_ver) {
-        throw new UpdaterError(ErrorInfo.validate, "invalid signature or certificate");
-      }
-      this.logger?.debug("verify success");
       this.logger?.debug(`write to ${this.gzipPath}`);
       (0, import_node_fs3.writeFileSync)(this.gzipPath, buffer);
       this.logger?.debug(`extract to ${this.tmpFilePath}`);
       await unzipFile(this.gzipPath, this.tmpFilePath);
       this.logger?.info(`download success, version: ${_ver}`);
       this.info = void 0;
-      return { success: true };
+      this.emit("update-downloaded");
+      return true;
     } catch (error) {
-      this.logger?.error("download asar failed", error);
-      return {
-        success: false,
-        data: error instanceof UpdaterError ? error : new UpdaterError(ErrorInfo.download, error.toString())
-      };
+      this.err("unwrap asar failed", "download", `fail to unwrap asar file, ${error}`);
+      return false;
     }
   }
   /**

package/dist/index.d.cts

@@ -1,15 +1,16 @@
-import { U as UpdateJSON } from './version-CffZWDhZ.cjs';
-import { O as OnDownloading, U as URLHandler, I as IProvider } from './types-DxPmQmaq.cjs';
+import { EventEmitter } from 'node:stream';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.cjs';
+import { D as DownloadingInfo, U as URLHandler, I as IProvider } from './types-COqp44eg.cjs';
 import '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
     readonly download: "Download failed";
     readonly validate: "Validate failed";
     readonly param: "Missing params";
-    readonly version: "Unsatisfied version";
 };
 declare class UpdaterError extends Error {
-    constructor(msg: typeof ErrorInfo[keyof typeof ErrorInfo], info: string);
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, info: string);
 }
 type CheckResult<T extends UpdateJSON> = {
     success: true;
@@ -49,7 +50,14 @@ interface UpdaterOption {
     logger?: Logger;
 }
 
-declare class Updater {
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-unavailable': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+}> {
     private CERT;
     private info?;
     private options;
@@ -61,19 +69,10 @@ declare class Updater {
      * updater logger
      */
     logger?: Logger;
-    /**
-     * downloading progress hook
-     * @param progress download progress
-     * @example
-     * updater.onDownloading = ({ percent, total, current }) => {
-     *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
-     * }
-     */
-    onDownloading?: OnDownloading;
     /**
      * URL handler hook
      *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDNs}
      * @param url source url
      * @param isDownloadAsar whether is download asar
      */
@@ -89,7 +88,6 @@ declare class Updater {
      * @param option UpdaterOption
      */
     constructor(provider: IProvider, option?: UpdaterOption);
-    private needUpdate;
     /**
      * this function is used to parse download data.
      * - if format is `'json'`
@@ -101,36 +99,30 @@ declare class Updater {
      * @param format 'json' or 'buffer'
      * @param data download URL or update json or buffer
      */
-    private parseData;
+    private fetch;
     /**
-     * check update info using default options
+     * handle error message and emit error event
      */
-    checkUpdate<T extends UpdateJSON>(): Promise<CheckResult<T>>;
+    private err;
     /**
-     * check update info using custom url
-     * @param url custom download URL of `updatejson`
+     * check update info using default options
      */
-    checkUpdate<T extends UpdateJSON>(url: string): Promise<CheckResult<T>>;
+    checkUpdate(): Promise<boolean>;
     /**
      * check update info using existing update json
      * @param data existing update json
      */
-    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
     /**
      * download update using default options
      */
-    download(): Promise<DownloadResult>;
-    /**
-     * download update using custom url
-     * @param url custom download URL
-     */
-    download(url: string): Promise<DownloadResult>;
+    download(): Promise<boolean>;
     /**
      * download update using existing `asar.gz` buffer and signature
      * @param data existing `asar.gz` buffer
      * @param sig signature
      */
-    download(data: Buffer, sig: string): Promise<DownloadResult>;
+    download(data: Uint8Array, sig: string): Promise<boolean>;
     /**
      * quit App and install
      */

package/dist/index.d.ts

@@ -1,15 +1,16 @@
-import { U as UpdateJSON } from './version-CffZWDhZ.js';
-import { O as OnDownloading, U as URLHandler, I as IProvider } from './types-seJf3Wbc.js';
+import { EventEmitter } from 'node:stream';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.js';
+import { D as DownloadingInfo, U as URLHandler, I as IProvider } from './types-CPq1MrYZ.js';
 import '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
     readonly download: "Download failed";
     readonly validate: "Validate failed";
     readonly param: "Missing params";
-    readonly version: "Unsatisfied version";
 };
 declare class UpdaterError extends Error {
-    constructor(msg: typeof ErrorInfo[keyof typeof ErrorInfo], info: string);
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, info: string);
 }
 type CheckResult<T extends UpdateJSON> = {
     success: true;
@@ -49,7 +50,14 @@ interface UpdaterOption {
     logger?: Logger;
 }
 
-declare class Updater {
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-unavailable': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+}> {
     private CERT;
     private info?;
     private options;
@@ -61,19 +69,10 @@ declare class Updater {
      * updater logger
      */
     logger?: Logger;
-    /**
-     * downloading progress hook
-     * @param progress download progress
-     * @example
-     * updater.onDownloading = ({ percent, total, current }) => {
-     *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
-     * }
-     */
-    onDownloading?: OnDownloading;
     /**
      * URL handler hook
      *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDNs}
      * @param url source url
      * @param isDownloadAsar whether is download asar
      */
@@ -89,7 +88,6 @@ declare class Updater {
      * @param option UpdaterOption
      */
     constructor(provider: IProvider, option?: UpdaterOption);
-    private needUpdate;
     /**
      * this function is used to parse download data.
      * - if format is `'json'`
@@ -101,36 +99,30 @@ declare class Updater {
      * @param format 'json' or 'buffer'
      * @param data download URL or update json or buffer
      */
-    private parseData;
+    private fetch;
     /**
-     * check update info using default options
+     * handle error message and emit error event
      */
-    checkUpdate<T extends UpdateJSON>(): Promise<CheckResult<T>>;
+    private err;
     /**
-     * check update info using custom url
-     * @param url custom download URL of `updatejson`
+     * check update info using default options
      */
-    checkUpdate<T extends UpdateJSON>(url: string): Promise<CheckResult<T>>;
+    checkUpdate(): Promise<boolean>;
     /**
      * check update info using existing update json
      * @param data existing update json
      */
-    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
     /**
      * download update using default options
      */
-    download(): Promise<DownloadResult>;
-    /**
-     * download update using custom url
-     * @param url custom download URL
-     */
-    download(url: string): Promise<DownloadResult>;
+    download(): Promise<boolean>;
     /**
      * download update using existing `asar.gz` buffer and signature
      * @param data existing `asar.gz` buffer
      * @param sig signature
      */
-    download(data: Buffer, sig: string): Promise<DownloadResult>;
+    download(data: Uint8Array, sig: string): Promise<boolean>;
     /**
      * quit App and install
      */