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

package/dist/index.cjs

@@ -17,67 +17,53 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  DownloadError: () => DownloadError,
-  MinimumVersionError: () => MinimumVersionError,
+// src/entry.ts
+var entry_exports = {};
+__export(entry_exports, {
+  ErrorInfo: () => ErrorInfo,
   Updater: () => Updater,
-  VerifyFailedError: () => VerifyFailedError,
-  createUpdater: () => createUpdater,
+  UpdaterError: () => UpdaterError,
   initApp: () => initApp,
   startupWithUpdater: () => startupWithUpdater
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(entry_exports);
 var import_node_path2 = require("path");
-var import_node_fs4 = require("fs");
+var import_node_fs5 = require("fs");
 var import_electron4 = require("electron");
 
 // src/updater/core.ts
 var import_node_fs3 = require("fs");
-var import_electron3 = require("electron");
+var import_electron2 = require("electron");
+
+// src/utils/version.ts
+function isUpdateJSON(json) {
+  const is = (j) => !!(j && j.minimumVersion && j.signature && j.size && 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_node_os = require("os");
 var import_electron = require("electron");
-var is = {
-  dev: !import_electron.app.isPackaged,
-  win: process.platform === "win32",
-  mac: process.platform === "darwin",
-  linux: process.platform === "linux"
-};
+var isDev = __EIU_IS_DEV__;
+var isWin = process.platform === "win32";
+var isMac = process.platform === "darwin";
+var isLinux = process.platform === "linux";
 function getPathFromAppNameAsar(...path) {
-  return is.dev ? "DEV.asar" : (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${import_electron.app.name}.asar`, ...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);
 }
-function getVersions() {
-  const platform = is.win ? "Windows" : is.mac ? "MacOS" : process.platform.toUpperCase();
-  return {
-    appVersion: is.dev ? import_electron.app.getVersion() : (0, import_node_fs.readFileSync)(getPathFromAppNameAsar("version"), "utf-8"),
-    entryVersion: import_electron.app.getVersion(),
-    electronVersion: process.versions.electron,
-    nodeVersion: process.versions.node,
-    systemVersion: `${platform} ${(0, import_node_os.release)()}`
-  };
+function getAppVersion() {
+  return isDev ? getEntryVersion() : (0, import_node_fs.readFileSync)(getPathFromAppNameAsar("version"), "utf-8");
+}
+function getEntryVersion() {
+  return import_electron.app.getVersion();
 }
 function restartApp() {
   import_electron.app.relaunch();
   import_electron.app.quit();
 }
-function waitAppReady(timeout = 1e3) {
-  return import_electron.app.isReady() ? Promise.resolve() : new Promise((resolve2, reject) => {
-    const _ = setTimeout(() => {
-      reject(new Error("app is not ready"));
-    }, timeout);
-    import_electron.app.whenReady().then(() => {
-      clearTimeout(_);
-      resolve2();
-    });
-  });
-}
 
-// src/utils/zip.ts
+// 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)) {
@@ -85,201 +71,40 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
     throw new Error(`path to zipped file not exist: ${gzipPath}`);
   }
   const compressedBuffer = (0, import_node_fs2.readFileSync)(gzipPath);
-  return new Promise((resolve2, reject) => {
+  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);
-      resolve2(null);
+      resolve(null);
     });
   });
 }
 
-// src/utils/pure.ts
-function parseVersion(version) {
-  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-z0-9.-]+))?/i;
-  const match = semver.exec(version);
-  if (!match) {
-    throw new TypeError(`invalid version: ${version}`);
-  }
-  const [major, minor, patch] = match.slice(1, 4).map(Number);
-  const ret = {
-    major,
-    minor,
-    patch,
-    stage: "",
-    stageVersion: -1
-  };
-  if (match[4]) {
-    let [stage, _v] = match[4].split(".");
-    ret.stage = stage;
-    ret.stageVersion = Number(_v) || -1;
-  }
-  if (Number.isNaN(major) || Number.isNaN(minor) || Number.isNaN(patch) || Number.isNaN(ret.stageVersion)) {
-    throw new TypeError(`invalid version: ${version}`);
-  }
-  return ret;
-}
-function isUpdateJSON(json) {
-  const is2 = (j) => !!(j && j.minimumVersion && j.signature && j.size && j.version);
-  return is2(json) && is2(json?.beta);
-}
-
-// src/crypto/dec.ts
-var import_node_crypto2 = require("crypto");
-
-// src/crypto/utils.ts
-var import_node_crypto = require("crypto");
-function hashString(data, length) {
-  const hash = (0, import_node_crypto.createHash)("SHA256").update(data).digest("binary");
-  return Buffer.from(hash).subarray(0, length);
-}
-
-// src/crypto/dec.ts
-function decrypt(encryptedText, key, iv) {
-  const decipher = (0, import_node_crypto2.createDecipheriv)("aes-256-cbc", key, iv);
-  let decrypted = decipher.update(encryptedText, "base64url", "utf8");
-  decrypted += decipher.final("utf8");
-  return decrypted;
-}
-var verify = (buffer, signature, cert) => {
-  try {
-    const [sig, version] = decrypt(signature, hashString(cert, 32), hashString(buffer, 16)).split("%");
-    const result = (0, import_node_crypto2.createVerify)("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : false;
-  } catch (error) {
-    return false;
-  }
-};
-
-// src/crypto/enc.ts
-var import_node_crypto3 = require("crypto");
-
 // src/updater/types.ts
-var MinimumVersionError = class extends Error {
-  currentVersion;
-  minVersion;
-  constructor(version, minimumVersion) {
-    super(`current entry version is ${version}, less than the minimumVersion ${minimumVersion}`);
-    this.currentVersion = version;
-    this.minVersion = minimumVersion;
-  }
-};
-var VerifyFailedError = class extends Error {
-  signature;
-  cert;
-  constructor(signature, cert) {
-    super("verify failed, invalid signature or certificate");
-    this.signature = signature;
-    this.cert = cert;
-  }
-};
-var DownloadError = class extends Error {
-  constructor(msg) {
-    super(`download update error, ${msg}`);
-  }
-};
-
-// src/updater/defaultFunctions/download.ts
-var import_electron2 = require("electron");
-var downloadJSONDefault = async (url, headers) => {
-  await waitAppReady();
-  return new Promise((resolve2, reject) => {
-    const request = import_electron2.net.request({
-      url,
-      method: "GET",
-      redirect: "follow"
-    });
-    Object.keys(headers).forEach((key) => {
-      request.setHeader(key, headers[key]);
-    });
-    request.on("response", (res) => {
-      let data = "";
-      res.on("data", (chunk) => data += chunk);
-      res.on("end", () => {
-        try {
-          const json = JSON.parse(data);
-          if (isUpdateJSON(json)) {
-            resolve2(json);
-          } else {
-            throw Error;
-          }
-        } catch (e) {
-          reject(new Error("invalid json"));
-        }
-      });
-    });
-    request.on("error", (e) => {
-      reject(e);
-    });
-    request.end();
-  });
+var ErrorInfo = {
+  download: "Download failed",
+  validate: "Validate failed",
+  param: "Missing params",
+  version: "Unsatisfied version"
 };
-var downloadBufferDefault = async (url, headers, total, onDownloading) => {
-  await waitAppReady();
-  let current = 0;
-  return new Promise((resolve2, reject) => {
-    const request = import_electron2.net.request({
-      url,
-      method: "GET",
-      redirect: "follow"
-    });
-    Object.keys(headers).forEach((key) => {
-      request.setHeader(key, headers[key]);
-    });
-    request.on("response", (res) => {
-      let data = [];
-      res.on("data", (chunk) => {
-        current += chunk.length;
-        onDownloading?.({
-          percent: `${+(current / total).toFixed(2) * 100}%`,
-          total,
-          current
-        });
-        data.push(chunk);
-      });
-      res.on("end", () => {
-        resolve2(Buffer.concat(data));
-      });
-    }).on("error", (e) => {
-      reject(e);
-    });
-    request.end();
-  });
-};
-
-// src/updater/defaultFunctions/compareVersion.ts
-var compareVersionDefault = (version1, version2) => {
-  const oldV = parseVersion(version1);
-  const newV = parseVersion(version2);
-  function compareStrings(str1, str2) {
-    if (str1 === "") {
-      return str2 !== "";
-    } else if (str2 === "") {
-      return true;
-    }
-    return str1 < str2;
+var UpdaterError = class extends Error {
+  constructor(msg, info) {
+    super(msg + ": " + info);
   }
-  for (let key of Object.keys(oldV)) {
-    if (key === "stage" && compareStrings(oldV[key], newV[key])) {
-      return true;
-    } else if (oldV[key] !== newV[key]) {
-      return oldV[key] < newV[key];
-    }
-  }
-  return false;
 };
 
 // src/updater/core.ts
 var Updater = class {
-  CERT = __SIGNATURE_CERT__;
+  CERT = __EIU_SIGNATURE_CERT__;
   info;
-  option;
+  options;
   asarPath;
   gzipPath;
   tmpFilePath;
+  provider;
   /**
    * updater logger
    */
@@ -293,36 +118,54 @@ var Updater = class {
    * }
    */
   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}
+   * @param url source url
+   * @param isDownloadAsar whether is download asar
+   */
+  handleURL;
   /**
    * whether receive beta version
    */
   get receiveBeta() {
-    return !!this.option.receiveBeta;
+    return !!this.options.receiveBeta;
   }
   set receiveBeta(receiveBeta) {
-    this.option.receiveBeta = receiveBeta;
+    this.options.receiveBeta = receiveBeta;
   }
   /**
    * initialize incremental updater
+   * @param provider update provider
    * @param option UpdaterOption
    */
-  constructor(option = {}) {
-    this.option = option;
+  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) {
-    const compare = this.option.overrideFunctions?.compareVersion ?? compareVersionDefault;
-    const { appVersion, entryVersion } = getVersions();
-    if (await compare(entryVersion, minVersion)) {
-      throw new MinimumVersionError(entryVersion, 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 compare(appVersion, version);
+    return await isLowerVersion(appVersion, version);
   }
   async parseData(format, data) {
     if ((0, import_node_fs3.existsSync)(this.tmpFilePath)) {
@@ -333,63 +176,23 @@ var Updater = class {
       this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
       (0, import_node_fs3.rmSync)(this.gzipPath);
     }
-    if (!["string", "object", "undefined"].includes(typeof data)) {
-      throw new TypeError(`invalid type at format '${format}': ${data}`);
-    }
-    if (typeof data === "object" && (format === "json" && isUpdateJSON(data) || format === "buffer" && Buffer.isBuffer(data))) {
-      return data;
-    }
     if (typeof data === "object") {
-      throw new TypeError(`invalid type at format '${format}': ${data}`);
-    }
-    const ua = this.option.downloadConfig?.userAgent || "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
-    const headers = {
-      Accept: `application/${format === "json" ? "json" : "octet-stream"}`,
-      UserAgent: ua,
-      ...this.option.downloadConfig?.extraHeader
-    };
-    this.logger?.info(`download headers: ${JSON.stringify(headers, null, 2)}`);
-    const config = format === "json" ? {
-      name: "updateJsonURL",
-      url: this.option.updateJsonURL,
-      repoFallback: `${this.option.repository.replace("github.com", "raw.githubusercontent.com")}/master/version.json`,
-      fn: this.option.overrideFunctions?.downloadJSON ?? downloadJSONDefault
-    } : {
-      name: "releaseAsarURL",
-      url: this.option.releaseAsarURL,
-      repoFallback: `${this.option.repository}/releases/download/v${this.info?.version}/${import_electron3.app.name}-${this.info?.version}.asar.gz`,
-      fn: this.option.overrideFunctions?.downloadBuffer ?? downloadBufferDefault
-    };
-    data ??= config.url;
-    if (!data) {
-      this.logger?.debug(`no ${config.name}, fallback to use repository`);
-      if (!this.option.repository) {
-        throw new Error(`${config.name} or repository are not set`);
-      }
-      if (format === "buffer" && !this.info?.version) {
-        throw new Error("version are not set");
+      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)}`);
       }
-      data = config.repoFallback;
     }
-    this.logger?.info(`download ${format} from ${data}`);
+    this.logger?.debug(`download from ${this.provider.name}`);
     try {
-      const ret = format === "json" ? await config.fn(data, headers) : await config.fn(data, headers, this.info.size, this.onDownloading);
-      this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
-      return ret;
+      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}` : ""}`);
+      return result;
     } catch (e) {
-      throw new DownloadError(e.toString());
+      this.logger?.warn(`download ${format} failed: ${e}`);
+      throw new UpdaterError(ErrorInfo.download, `download ${format} failed: ${e}`);
     }
   }
-  /**
-   * check update info
-   *
-   * if you want to update **offline**, you can set `data` and `sig` add update info
-   * @param data custom download URL of `updatejson` or existing update json
-   * @returns
-   * - Available:`{size: number, version: string}`
-   * - Unavailable: `undefined`
-   * - Fail: `CheckResultError`
-   */
   async checkUpdate(data) {
     try {
       let { signature, size, version, minimumVersion, beta } = await this.parseData("json", data);
@@ -399,59 +202,49 @@ var Updater = class {
         minimumVersion = beta.minimumVersion;
         size = beta.size;
       }
-      this.logger?.info(`checked version: ${version}, size: ${size}, signature: ${signature}`);
+      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 void 0;
+        return { success: false, data: version };
       } else {
         this.logger?.info(`update available: ${version}`);
-        this.info = {
-          signature,
-          minimumVersion,
-          version,
-          size
-        };
-        return this.info;
+        this.info = { signature, minimumVersion, version, size };
+        return { success: true, data: this.info };
       }
     } catch (error) {
       this.logger?.error("check update failed", error);
-      return error;
+      return {
+        success: false,
+        data: error instanceof UpdaterError ? error : new UpdaterError(ErrorInfo.download, error.toString())
+      };
     }
   }
-  /**
-   * download update
-   *
-   * if you want to update **offline**, you can set both `data` and `sig` to verify and install
-   * @param data custom download URL of `asar.gz` or existing `asar.gz` buffer
-   * @param sig signature
-   * @returns
-   * - `true`: success
-   * - `DownloadResultError`: fail
-   */
   async download(data, sig) {
     try {
-      const _sig = sig ?? this.info?.signature;
-      if (!_sig) {
-        throw new Error("signature are not set, please checkUpdate first or set the second parameter");
+      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?.info("verify start");
-      const _verify = this.option.overrideFunctions?.verifySignaure ?? verify;
-      const _ver = await _verify(buffer, _sig, this.CERT);
+      this.logger?.debug("verify start");
+      const _ver = await this.provider.verifySignaure(buffer, _sig, this.CERT);
       if (!_ver) {
-        throw new VerifyFailedError(_sig, this.CERT);
+        throw new UpdaterError(ErrorInfo.validate, "invalid signature or certificate");
       }
-      this.logger?.info("verify success");
-      this.logger?.info(`write to ${this.gzipPath}`);
+      this.logger?.debug("verify success");
+      this.logger?.debug(`write to ${this.gzipPath}`);
       (0, import_node_fs3.writeFileSync)(this.gzipPath, buffer);
-      this.logger?.info(`extract to ${this.tmpFilePath}`);
+      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 true;
+      return { success: true };
     } catch (error) {
       this.logger?.error("download asar failed", error);
-      return error;
+      return {
+        success: false,
+        data: error instanceof UpdaterError ? error : new UpdaterError(ErrorInfo.download, error.toString())
+      };
     }
   }
   /**
@@ -463,65 +256,67 @@ var Updater = class {
   }
 };
 
-// src/updater/index.ts
-function createUpdater(option) {
-  return new Updater(option);
-}
+// src/utils/zip.ts
+var import_node_fs4 = require("fs");
+var import_node_zlib2 = require("zlib");
 
-// src/index.ts
+// 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
 function startupWithUpdater(fn) {
   return fn;
 }
 var defaultOnInstall = (install, _, __, logger) => {
   install();
-  logger?.info(`update success!`);
+  logger.info(`update success!`);
 };
-async function initApp(appOptions = {}) {
+async function initApp(appOptions) {
   const {
+    provider,
     updater,
-    electronDevDistPath = "../dist-electron",
-    mainPath = "main/index.js",
-    hooks
-  } = appOptions || {};
-  const {
     onInstall = defaultOnInstall,
     beforeStart,
     onStartError
-  } = hooks || {};
-  function handleError(err, logger2) {
-    console.error(err);
-    onStartError?.(err, logger2);
-    import_electron4.app.quit();
-  }
+  } = appOptions;
   let updaterInstance;
   if (typeof updater === "object" || !updater) {
-    updaterInstance = createUpdater(updater);
+    updaterInstance = new Updater(provider, updater);
   } else {
     updaterInstance = await updater();
   }
-  const logger = updaterInstance.logger;
+  const logger = updaterInstance.logger || console;
   try {
     const appNameAsarPath = getPathFromAppNameAsar();
     const tempAsarPath = `${appNameAsarPath}.tmp`;
-    if ((0, import_node_fs4.existsSync)(tempAsarPath)) {
-      logger?.info(`installing new asar: ${tempAsarPath}`);
-      await onInstall(() => (0, import_node_fs4.renameSync)(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
+    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);
     }
-    const mainDir = is.dev ? electronDevDistPath : appNameAsarPath;
-    const entry = (0, import_node_path2.resolve)(__dirname, mainDir, mainPath);
-    await beforeStart?.(entry, logger);
-    require(entry)(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) {
-    handleError(error, logger);
+    logger.error("startup error", error);
+    onStartError?.(error, logger);
+    import_electron4.app.quit();
   }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  DownloadError,
-  MinimumVersionError,
+  ErrorInfo,
   Updater,
-  VerifyFailedError,
-  createUpdater,
+  UpdaterError,
   initApp,
   startupWithUpdater
 });