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

package/dist/index.cjs

@@ -1,285 +1,246 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+'use strict';
 
-// src/entry.ts
-var entry_exports = {};
-__export(entry_exports, {
-  ErrorInfo: () => ErrorInfo,
-  Updater: () => Updater,
-  UpdaterError: () => UpdaterError,
-  initApp: () => initApp,
-  startupWithUpdater: () => startupWithUpdater
-});
-module.exports = __toCommonJS(entry_exports);
-var import_node_path2 = require("path");
-var import_node_fs5 = require("fs");
-var import_electron4 = require("electron");
+var fs3 = require('fs');
+var events = require('events');
+var electron = require('electron');
+var path = require('path');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
-// src/updater/core.ts
-var import_node_fs3 = require("fs");
-var import_electron2 = require("electron");
+var fs3__default = /*#__PURE__*/_interopDefault(fs3);
+var electron__default = /*#__PURE__*/_interopDefault(electron);
+var path__default = /*#__PURE__*/_interopDefault(path);
+
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
 
 // src/utils/version.ts
 function isUpdateJSON(json) {
-  const is = (j) => !!(j && j.minimumVersion && j.signature && j.size && j.version);
+  const is = (j) => !!(j && j.minimumVersion && j.signature && j.version);
   return is(json) && is(json?.beta);
 }
-
-// src/utils/electron.ts
-var import_node_fs = require("fs");
-var import_node_path = require("path");
-var import_electron = require("electron");
 var isDev = __EIU_IS_DEV__;
-var isWin = process.platform === "win32";
-var isMac = process.platform === "darwin";
-var isLinux = process.platform === "linux";
-function getPathFromAppNameAsar(...path) {
-  return isDev ? "DEV.asar" : (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${import_electron.app.name}.asar`, ...path);
+process.platform === "win32";
+process.platform === "darwin";
+process.platform === "linux";
+function getPathFromAppNameAsar(...paths) {
+  return isDev ? "DEV.asar" : path__default.default.join(path__default.default.dirname(electron__default.default.app.getAppPath()), `${electron__default.default.app.name}.asar`, ...paths);
 }
 function getAppVersion() {
-  return isDev ? getEntryVersion() : (0, import_node_fs.readFileSync)(getPathFromAppNameAsar("version"), "utf-8");
+  return isDev ? getEntryVersion() : fs3__default.default.readFileSync(getPathFromAppNameAsar("version"), "utf-8");
 }
 function getEntryVersion() {
-  return import_electron.app.getVersion();
+  return electron__default.default.app.getVersion();
 }
 function restartApp() {
-  import_electron.app.relaunch();
-  import_electron.app.quit();
-}
-
-// src/utils/unzip.ts
-var import_node_fs2 = require("fs");
-var import_node_zlib = require("zlib");
-async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
-  if (!(0, import_node_fs2.existsSync)(gzipPath)) {
-    throw new Error(`path to zipped file not exist: ${gzipPath}`);
-  }
-  const compressedBuffer = (0, import_node_fs2.readFileSync)(gzipPath);
-  return new Promise((resolve, reject) => {
-    (0, import_node_zlib.brotliDecompress)(compressedBuffer, (err, buffer) => {
-      (0, import_node_fs2.rmSync)(gzipPath);
-      if (err) {
-        reject(err);
-      }
-      (0, import_node_fs2.writeFileSync)(targetFilePath, buffer);
-      resolve(null);
-    });
-  });
+  electron__default.default.app.relaunch();
+  electron__default.default.app.quit();
 }
 
-// src/updater/types.ts
+// src/entry/types.ts
 var ErrorInfo = {
-  download: "Download failed",
-  validate: "Validate failed",
-  param: "Missing params",
-  version: "Unsatisfied version"
+  download: "Download Failed",
+  validate: "Validate Failed",
+  param: "Missing Params",
+  network: "Network Error"
 };
 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 {
-  CERT = __EIU_SIGNATURE_CERT__;
+// src/entry/updater.ts
+var Updater = class extends events.EventEmitter {
+  CERT;
+  controller;
   info;
-  options;
-  asarPath;
-  gzipPath;
-  tmpFilePath;
   provider;
   /**
-   * updater logger
+   * 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}`)
-   * }
+   * Whether to receive beta update
    */
-  onDownloading;
+  receiveBeta;
   /**
-   * 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}
-   * @param url source url
-   * @param isDownloadAsar whether is download asar
+   * Whether force update in DEV
    */
-  handleURL;
+  forceUpdate;
   /**
-   * whether receive beta version
+   * Initialize incremental updater
+   * @param options UpdaterOption
    */
-  get receiveBeta() {
-    return !!this.options.receiveBeta;
-  }
-  set receiveBeta(receiveBeta) {
-    this.options.receiveBeta = receiveBeta;
-  }
-  /**
-   * initialize incremental updater
-   * @param provider update provider
-   * @param option UpdaterOption
-   */
-  constructor(provider, option = {}) {
-    this.provider = provider;
-    this.options = option;
-    if (option.SIGNATURE_CERT) {
-      this.CERT = option.SIGNATURE_CERT;
-    }
-    if (option.logger) {
-      this.logger = option.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;
+  constructor(options = {}) {
+    super();
+    this.provider = options.provider;
+    this.receiveBeta = options.receiveBeta;
+    this.CERT = options.SIGNATURE_CERT || __EIU_SIGNATURE_CERT__;
+    this.logger = options.logger;
+    this.controller = new AbortController();
+    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");
     }
-    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})`);
+    if (!this.provider) {
+      this.logger?.debug("WARN: No update provider");
     }
-    this.logger?.info(`check update: current version is ${appVersion}, new version is ${version}`);
-    return await isLowerVersion(appVersion, version);
   }
-  async parseData(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);
-    }
-    if ((0, import_node_fs3.existsSync)(this.gzipPath)) {
-      this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
-      (0, import_node_fs3.rmSync)(this.gzipPath);
-    }
+  async fetch(format, data) {
     if (typeof data === "object") {
       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}`);
+    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);
-      this.logger?.debug(`download ${format} success${format === "buffer" ? `, file size: ${result.length}` : ""}`);
+      const result = format === "json" ? await this.provider.downloadJSON(__EIU_VERSION_PATH__, this.controller.signal) : await this.provider.downloadAsar(electron.app.name, this.info, this.controller.signal, (info) => this.emit("download-progress", info));
+      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(`Fetch ${format} failed`, "network", `Download ${format} failed: ${e}`);
     }
   }
-  async checkUpdate(data) {
+  /**
+   * 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 checkForUpdates(data) {
+    const emitUnavailable = (msg) => {
+      this.logger?.info(msg);
+      this.emit("update-not-available", msg);
+      return false;
+    };
+    if (!data && !this.provider) {
+      const errorInfo = "No update json or provider";
+      this.err("Check update failed", "param", errorInfo);
+      return emitUnavailable(errorInfo);
+    }
+    const _data = await this.fetch("json", data);
+    if (!_data) {
+      return emitUnavailable("Failed to get update info");
+    }
+    let { signature, version, minimumVersion, beta } = _data;
+    if (this.receiveBeta) {
+      version = beta.version;
+      signature = beta.signature;
+      minimumVersion = beta.minimumVersion;
+    }
+    this.logger?.debug(`Checked update, version: ${version}, signature: ${signature}`);
+    if (isDev && !this.forceUpdate && !data) {
+      return emitUnavailable("Skip check update in dev mode. To force update, set `updater.forceUpdate` to true or call checkUpdate with UpdateJSON");
+    }
+    const isLowerVersion = this.provider.isLowerVersion;
+    const entryVersion = getEntryVersion();
+    const appVersion = getAppVersion();
     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;
+      if (isLowerVersion(entryVersion, minimumVersion)) {
+        return emitUnavailable(`Entry Version (${entryVersion}) < MinimumVersion (${minimumVersion})`);
       }
-      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 };
+      this.logger?.info(`Check update: current version is ${appVersion}, new version is ${version}`);
+      if (!isLowerVersion(appVersion, version)) {
+        return emitUnavailable(`Current version (${appVersion}) < New version (${version})`);
       }
-    } catch (error) {
-      this.logger?.error("check update failed", error);
-      return {
-        success: false,
-        data: error instanceof UpdaterError ? error : new UpdaterError(ErrorInfo.download, error.toString())
-      };
+      this.logger?.info(`Update available: ${version}`);
+      this.info = { signature, minimumVersion, version };
+      this.emit("update-available", this.info);
+      return true;
+    } catch {
+      this.err("Fail to parse version", "validate", "Fail to parse version string");
+      return false;
     }
   }
-  async download(data, sig) {
+  async downloadUpdate(data, info) {
+    const _sig = info?.signature ?? this.info?.signature;
+    const _version = info?.version ?? this.info?.version;
+    if (!_sig || !_version) {
+      this.err("Download failed", "param", "No update signature, please call `checkUpdate` first or manually setup params");
+      return false;
+    }
+    if (!data && !this.provider) {
+      this.err("Download failed", "param", "No update asar buffer and provider");
+      return false;
+    }
+    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");
+    if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
+      this.err("Download failed", "validate", "Invalid update asar file");
+      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}`);
+      const tmpFilePath = getPathFromAppNameAsar() + ".tmp";
+      this.logger?.debug(`Install to ${tmpFilePath}`);
+      fs3__default.default.writeFileSync(tmpFilePath, await this.provider.unzipFile(buffer));
+      this.logger?.info(`Download success, version: ${_version}`);
       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("Download failed", "download", `Fail to unwrap asar file, ${error}`);
+      return false;
     }
   }
   /**
    * quit App and install
    */
   quitAndInstall() {
-    this.logger?.info("quit and install");
+    this.logger?.info("Quit and install");
     restartApp();
   }
+  cancel() {
+    if (this.controller.signal.aborted) {
+      return;
+    }
+    this.controller.abort();
+    this.logger?.info("Cancel update");
+    this.emit("update-cancelled");
+    this.controller = new AbortController();
+  }
 };
-
-// src/utils/zip.ts
-var import_node_fs4 = require("fs");
-var import_node_zlib2 = require("zlib");
-
-// src/utils/crypto/decrypt.ts
-var import_node_crypto2 = require("crypto");
-
-// src/utils/crypto/utils.ts
-var import_node_crypto = require("crypto");
-
-// src/utils/crypto/encrypt.ts
-var import_node_crypto3 = require("crypto");
-
-// src/entry.ts
+async function autoUpdate(updater) {
+  if (await updater.checkForUpdates() && await updater.downloadUpdate()) {
+    updater.quitAndInstall();
+  }
+}
 function startupWithUpdater(fn) {
   return fn;
 }
 var defaultOnInstall = (install, _, __, logger) => {
   install();
-  logger.info(`update success!`);
+  logger?.info(`update success!`);
 };
-async function initApp(appOptions) {
+async function createElectronApp(appOptions = {}) {
+  const appNameAsarPath = getPathFromAppNameAsar();
   const {
-    provider,
+    mainPath = path__default.default.join(
+      isDev ? path__default.default.join(electron.app.getAppPath(), __EIU_MAIN_DEV_DIR__) : appNameAsarPath,
+      "main",
+      __EIU_MAIN_FILE__
+    ),
     updater,
     onInstall = defaultOnInstall,
     beforeStart,
@@ -287,36 +248,35 @@ async function initApp(appOptions) {
   } = appOptions;
   let updaterInstance;
   if (typeof updater === "object" || !updater) {
-    updaterInstance = new Updater(provider, updater);
+    updaterInstance = new Updater(updater);
   } else {
     updaterInstance = await updater();
   }
-  const logger = updaterInstance.logger || console;
+  const logger = updaterInstance.logger;
   try {
-    const appNameAsarPath = getPathFromAppNameAsar();
     const tempAsarPath = `${appNameAsarPath}.tmp`;
-    if ((0, import_node_fs5.existsSync)(tempAsarPath)) {
-      logger.info(`installing new asar: ${tempAsarPath}`);
-      await onInstall(() => (0, import_node_fs5.renameSync)(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
+    if (fs3__default.default.existsSync(tempAsarPath)) {
+      logger?.info(`Installing new asar from ${tempAsarPath}`);
+      await onInstall(() => fs3__default.default.renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
+    }
+    await beforeStart?.(mainPath, logger);
+    if (__EIU_IS_ESM__) {
+      (await import("file://" + mainPath)).default(updaterInstance);
+    } else {
+      __require(mainPath)(updaterInstance);
     }
-    const mainFilePath = (0, import_node_path2.join)(
-      isDev ? (0, import_node_path2.join)(import_electron4.app.getAppPath(), __EIU_MAIN_DEV_DIR__) : appNameAsarPath,
-      "main",
-      __EIU_MAIN_FILE__
-    );
-    await beforeStart?.(mainFilePath, logger);
-    require(mainFilePath)(updaterInstance);
   } catch (error) {
-    logger.error("startup error", error);
+    logger?.error("startup error", error);
     onStartError?.(error, logger);
-    import_electron4.app.quit();
+    electron.app.quit();
   }
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ErrorInfo,
-  Updater,
-  UpdaterError,
-  initApp,
-  startupWithUpdater
-});
+var initApp = createElectronApp;
+
+exports.ErrorInfo = ErrorInfo;
+exports.Updater = Updater;
+exports.UpdaterError = UpdaterError;
+exports.autoUpdate = autoUpdate;
+exports.createElectronApp = createElectronApp;
+exports.initApp = initApp;
+exports.startupWithUpdater = startupWithUpdater;