electron-incremental-update 1.2.0 → 1.3.0

package/dist/index.js

@@ -8,7 +8,7 @@ import {
   restartApp,
   unzipFile,
   waitAppReady
-} from "./chunk-RQCTJY4L.js";
+} from "./chunk-SBPTSLG7.js";
 
 // src/index.ts
 import { resolve } from "node:path";
@@ -47,100 +47,67 @@ var verify = (buffer, signature, cert) => {
 };
 
 // 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 ErrorInfo = {
+  downlaod: "Download failed",
+  validate: "Validate failed",
+  param: "Missing params",
+  version: "Unsatisfied version"
 };
-var DownloadError = class extends Error {
-  constructor(msg) {
-    super(`download update error, ${msg}`);
+var UpdaterError = class extends Error {
+  constructor(msg, info) {
+    super(msg + ": " + info);
   }
 };
 
 // src/updater/defaultFunctions/download.ts
 import { net } from "electron";
-var downloadJSONDefault = async (url, headers) => {
+async function downlaodFn(url, headers, onResponse) {
   await waitAppReady();
   return new Promise((resolve2, reject) => {
-    const request = 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"));
+    const request = net.request({ url, method: "GET", redirect: "follow" });
+    Object.keys(headers).forEach((key) => request.setHeader(key, headers[key]));
+    request.on("response", (res) => onResponse(res, resolve2, reject));
+    request.on("error", reject);
+    request.end();
+  });
+}
+var downloadJSONDefault = async (url, headers) => {
+  return await downlaodFn(url, headers, (resp, resolve2, reject) => {
+    let data = "";
+    resp.on("data", (chunk) => data += chunk);
+    resp.on("end", () => {
+      try {
+        const json = JSON.parse(data);
+        if (isUpdateJSON(json)) {
+          resolve2(json);
+        } else {
+          throw Error;
         }
-      });
-    });
-    request.on("error", (e) => {
-      reject(e);
+      } catch (ignore) {
+        reject(new Error("invalid update json"));
+      }
     });
-    request.end();
+    resp.on("aborted", () => reject(new Error("aborted")));
+    resp.on("error", () => reject(new Error("download error")));
   });
 };
 var downloadBufferDefault = async (url, headers, total, onDownloading) => {
-  await waitAppReady();
   let current = 0;
-  return new Promise((resolve2, reject) => {
-    const request = 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);
+  return await downlaodFn(url, headers, (resp, resolve2, reject) => {
+    let data = [];
+    resp.on("data", (chunk) => {
+      current += chunk.length;
+      onDownloading?.({ percent: `${+(current / total).toFixed(2) * 100}%`, total, current });
+      data.push(chunk);
     });
-    request.end();
+    resp.on("end", () => resolve2(Buffer.concat(data)));
+    resp.on("aborted", () => reject(new Error("aborted")));
+    resp.on("error", () => reject(new Error("download error")));
   });
 };
 
 // src/updater/defaultFunctions/compareVersion.ts
-var compareVersionDefault = (version1, version2) => {
+var isLowerVersionDefault = (version1, version2) => {
   const oldV = parseVersion(version1);
   const newV = parseVersion(version2);
   function compareStrings(str1, str2) {
@@ -205,13 +172,13 @@ var Updater = class {
     this.tmpFilePath = `${this.asarPath}.tmp`;
   }
   async needUpdate(version, minVersion) {
-    const compare = this.option.overrideFunctions?.compareVersion ?? compareVersionDefault;
+    const isLowerVersion = this.option.overrideFunctions?.isLowerVersion ?? isLowerVersionDefault;
     const { appVersion, entryVersion } = getVersions();
-    if (await compare(entryVersion, minVersion)) {
-      throw new MinimumVersionError(entryVersion, minVersion);
+    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 (existsSync(this.tmpFilePath)) {
@@ -222,14 +189,12 @@ var Updater = class {
       this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
       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}`);
+      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)}`);
+      }
     }
     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 = {
@@ -237,11 +202,11 @@ var Updater = class {
       UserAgent: ua,
       ...this.option.downloadConfig?.extraHeader
     };
-    this.logger?.info(`download headers: ${JSON.stringify(headers, null, 2)}`);
+    this.logger?.debug(`download headers: ${JSON.stringify(headers)}`);
     const config = format === "json" ? {
       name: "updateJsonURL",
       url: this.option.updateJsonURL,
-      repoFallback: `${this.option.repository.replace("github.com", "raw.githubusercontent.com")}/master/version.json`,
+      repoFallback: `${this.option.repository?.replace("github.com", "raw.githubusercontent.com")}/master/version.json`,
       fn: this.option.overrideFunctions?.downloadJSON ?? downloadJSONDefault
     } : {
       name: "releaseAsarURL",
@@ -253,32 +218,22 @@ var Updater = class {
     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`);
+        throw new UpdaterError(ErrorInfo.param, `${config.name} or repository is not set`);
       }
       if (format === "buffer" && !this.info?.version) {
-        throw new Error("version are not set");
+        throw new UpdaterError(ErrorInfo.param, "version is not set");
       }
       data = config.repoFallback;
     }
-    this.logger?.info(`download ${format} from ${data}`);
+    this.logger?.debug(`download ${format} from ${data}`);
     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}` : ""}`);
+      this.logger?.debug(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
       return ret;
     } catch (e) {
-      throw new DownloadError(e.toString());
+      throw new UpdaterError(ErrorInfo.downlaod, e.toString());
     }
   }
-  /**
-   * 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);
@@ -288,7 +243,7 @@ var Updater = class {
         minimumVersion = beta.minimumVersion;
         size = beta.size;
       }
-      this.logger?.info(`checked version: ${version}, size: ${size}, signature: ${signature}`);
+      this.logger?.debug(`checked 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;
@@ -307,33 +262,23 @@ var Updater = class {
       return error;
     }
   }
-  /**
-   * 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");
+        throw new UpdaterError(ErrorInfo.param, "signature is empty");
       }
       const buffer = await this.parseData("buffer", data);
-      this.logger?.info("verify start");
+      this.logger?.debug("verify start");
       const _verify = this.option.overrideFunctions?.verifySignaure ?? verify;
       const _ver = await _verify(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}`);
       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;
@@ -405,11 +350,13 @@ async function initApp(appOptions = {}) {
   }
 }
 export {
-  DownloadError,
-  MinimumVersionError,
+  ErrorInfo,
   Updater,
-  VerifyFailedError,
+  UpdaterError,
   createUpdater,
+  downloadBufferDefault,
+  downloadJSONDefault,
   initApp,
+  isLowerVersionDefault,
   startupWithUpdater
 };

package/dist/utils.cjs

@@ -221,8 +221,7 @@ function handleUnexpectedErrors(callback) {
   process.on("unhandledRejection", callback);
 }
 function parseVersion(version) {
-  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-z0-9.-]+))?/i;
-  const match = semver.exec(version);
+  const match = /^(\d+)\.(\d+)\.(\d+)(?:-([a-z0-9.-]+))?/i.exec(version);
   if (!match) {
     throw new TypeError(`invalid version: ${version}`);
   }

package/dist/utils.js

@@ -16,7 +16,7 @@ import {
   unzipFile,
   waitAppReady,
   zipFile
-} from "./chunk-RQCTJY4L.js";
+} from "./chunk-SBPTSLG7.js";
 export {
   disableHWAccForWin7,
   getPathFromAppNameAsar,

package/dist/vite.js

@@ -36,8 +36,7 @@ var signature = (buffer, privateKey, cert, version) => {
 
 // src/utils/pure.ts
 function parseVersion(version) {
-  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-z0-9.-]+))?/i;
-  const match = semver.exec(version);
+  const match = /^(\d+)\.(\d+)\.(\d+)(?:-([a-z0-9.-]+))?/i.exec(version);
   if (!match) {
     throw new TypeError(`invalid version: ${version}`);
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",