electron-incremental-update 0.7.7 → 0.7.9

package/dist/index.mjs

@@ -2,12 +2,19 @@ import {
   verify
 } from "./chunk-Q2K52LOG.mjs";
 import {
-  __require,
   getEntryVersion,
   getProductAsarPath,
+  getProductVersion,
+  parseVersion,
   unzipFile,
   waitAppReady
-} from "./chunk-67MCNA7W.mjs";
+} from "./chunk-4TION32M.mjs";
+import {
+  isUpdateJSON
+} from "./chunk-2JVXVTC5.mjs";
+import {
+  __require
+} from "./chunk-ZFXKCRJC.mjs";
 
 // src/index.ts
 import { resolve } from "node:path";
@@ -15,22 +22,14 @@ import { existsSync as existsSync2, renameSync } from "node:fs";
 import { app } from "electron";
 
 // src/updater/index.ts
-import { EventEmitter } from "node:events";
-import { Buffer as Buffer2 } from "node:buffer";
 import { existsSync } from "node:fs";
+import { Buffer as Buffer2 } from "node:buffer";
 import { rm, writeFile } from "node:fs/promises";
 
 // src/updater/defaultFunctions.ts
 import { Buffer } from "node:buffer";
 import { net } from "electron";
-
-// src/updater/types.ts
-function isUpdateJSON(json) {
-  return "signature" in json && "version" in json && "size" in json;
-}
-
-// src/updater/defaultFunctions.ts
-async function downloadJSONDefault(url, updater, headers) {
+var downloadJSONDefault = async (url, headers) => {
   await waitAppReady();
   return new Promise((resolve2, reject) => {
     const request = net.request({
@@ -62,10 +61,10 @@ async function downloadJSONDefault(url, updater, headers) {
     });
     request.end();
   });
-}
-async function downloadBufferDefault(url, updater, headers) {
+};
+var downloadBufferDefault = async (url, headers, total, onDownloading) => {
   await waitAppReady();
-  let progress = 0;
+  let current = 0;
   return new Promise((resolve2, reject) => {
     const request = net.request({
       url,
@@ -78,8 +77,12 @@ async function downloadBufferDefault(url, updater, headers) {
     request.on("response", (res) => {
       let data = [];
       res.on("data", (chunk) => {
-        progress += chunk.length;
-        updater.emit("downloading", progress);
+        current += chunk.length;
+        onDownloading?.({
+          percent: `${+(current / total).toFixed(2) * 100}%`,
+          total,
+          current
+        });
         data.push(chunk);
       });
       res.on("end", () => {
@@ -90,168 +93,192 @@ async function downloadBufferDefault(url, updater, headers) {
     });
     request.end();
   });
-}
-var compareVersionDefault = (oldVersion, newVersion) => {
-  if (!oldVersion || !newVersion || typeof oldVersion !== "string" || typeof newVersion !== "string") {
-    throw new TypeError("invalid version");
-  }
-  const parseVersion = (version) => {
-    const [versionNumber, stage] = version.split("-", 2);
-    if (!versionNumber || !versionNumber.includes(".")) {
-      throw new TypeError("invalid version");
-    }
-    const [major, minor, patch] = versionNumber.split(".").map(Number);
-    if (isNaN(major) || isNaN(minor) || isNaN(patch)) {
-      throw new TypeError("invalid version");
+};
+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 { major, minor, patch, stage };
-  };
-  const oldV = parseVersion(oldVersion);
-  const newV = parseVersion(newVersion);
-  if (oldV.major < newV.major || oldV.major === newV.major && oldV.minor < newV.minor || oldV.major === newV.major && oldV.minor === newV.minor && oldV.patch < newV.patch) {
-    return true;
+    return str1 < str2;
   }
-  if (oldV.stage < newV.stage || !newV.stage && oldV.stage) {
-    return true;
+  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/index.ts
-function createUpdater(updaterOptions) {
-  const {
-    SIGNATURE_CERT,
-    repository,
-    productName,
-    releaseAsarURL: _release,
-    updateJsonURL: _update,
-    debug = false,
-    downloadConfig: { extraHeader, userAgent } = {},
-    overrideFunctions: {
-      compareVersion,
-      verifySignaure,
-      downloadBuffer,
-      downloadJSON
-    } = {}
-  } = updaterOptions;
-  const updater = new EventEmitter();
-  let signature;
-  let version;
-  const asarPath = getProductAsarPath(productName);
-  const gzipPath = `${asarPath}.gz`;
-  const tmpFilePath = `${asarPath}.tmp`;
-  function log(msg) {
-    debug && updater.emit("debug", msg);
+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;
   }
-  function needUpdate(version2) {
-    const currentVersion = getEntryVersion();
-    log(`check update: current version is ${currentVersion}, new version is ${version2}`);
-    const _compare = compareVersion ?? compareVersionDefault;
-    return _compare(currentVersion, version2);
+};
+var VerifyFailedError = class extends Error {
+  signature;
+  cert;
+  constructor(signature, cert) {
+    super("verify failed, invalid signature or certificate");
+    this.signature = signature;
+    this.cert = cert;
   }
-  async function parseData(format, data, version2) {
-    if (existsSync(tmpFilePath)) {
-      log(`remove tmp file: ${tmpFilePath}`);
-      await rm(tmpFilePath);
+};
+var IncrementalUpdater = class {
+  info;
+  option;
+  asarPath;
+  gzipPath;
+  tmpFilePath;
+  logger;
+  onDownloading;
+  get productName() {
+    return this.option.productName;
+  }
+  set productName(name) {
+    this.option.productName = name;
+  }
+  get receiveBeta() {
+    return !!this.option.receiveBeta;
+  }
+  set receiveBeta(receiveBeta) {
+    this.option.receiveBeta = receiveBeta;
+  }
+  constructor(option) {
+    this.option = option;
+    this.asarPath = getProductAsarPath(this.productName);
+    this.gzipPath = `${this.asarPath}.gz`;
+    this.tmpFilePath = `${this.asarPath}.tmp`;
+  }
+  async needUpdate(version, minVersion) {
+    const compare = this.option.overrideFunctions?.compareVersion ?? compareVersionDefault;
+    const productVersion = getProductVersion(this.option.productName);
+    const entryVersion = getEntryVersion();
+    if (await compare(entryVersion, minVersion)) {
+      throw new MinimumVersionError(entryVersion, minVersion);
     }
-    if (existsSync(gzipPath)) {
-      log(`remove .gz file: ${gzipPath}`);
-      await rm(gzipPath);
+    this.logger?.info(`check update: current version is ${productVersion}, new version is ${version}`);
+    return await compare(productVersion, version);
+  }
+  async parseData(format, data) {
+    if (existsSync(this.tmpFilePath)) {
+      this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
+      await rm(this.tmpFilePath);
+    }
+    if (existsSync(this.gzipPath)) {
+      this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
+      await rm(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" && Buffer2.isBuffer(data))) {
+      return data;
     }
     if (typeof data === "object") {
-      if (format === "json" && isUpdateJSON(data) || format === "buffer" && Buffer2.isBuffer(data)) {
-        return data;
-      } else {
-        throw new Error(`invalid type at format '${format}': ${data}`);
-      }
-    } else if (["string", "undefined"].includes(typeof data)) {
-      const ua = 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,
-        ...extraHeader
-      };
-      log(`download headers: ${JSON.stringify(headers, null, 2)}`);
-      const info = format === "json" ? {
-        name: "updateJsonURL",
-        url: _update,
-        repoFallback: `${repository.replace("github.com", "raw.githubusercontent.com")}/master/version.json`,
-        fn: downloadJSON ?? downloadJSONDefault
-      } : {
-        name: "releaseAsarURL",
-        url: _release,
-        repoFallback: `${repository}/releases/download/v${version2}/${productName}-${version2}.asar.gz`,
-        fn: downloadBuffer ?? downloadBufferDefault
-      };
-      data ??= info.url;
-      if (!data) {
-        log(`no ${info.name}, fallback to use repository`);
-        if (!repository) {
-          throw new Error(`${info.name} or repository are not set`);
-        }
-        if (format === "buffer" && !version2) {
-          throw new Error("version are not set");
-        }
-        data = info.repoFallback;
+      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}/${this.productName}-${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`);
       }
-      log(`download ${format} from ${data}`);
-      const ret = await info.fn(data, updater, headers);
-      log(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
-      if (format === "buffer") {
-        updater.emit("downloadBuffer", ret);
+      if (format === "buffer" && !this.info?.version) {
+        throw new Error("version are not set");
       }
-      return ret;
-    } else {
-      throw new Error(`invalid type at format '${format}': ${data}`);
+      data = config.repoFallback;
     }
+    this.logger?.info(`download ${format} from ${data}`);
+    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;
   }
-  updater.productName = productName;
-  updater.debugMode = debug;
-  updater.checkUpdate = async (data) => {
+  async checkUpdate(data) {
     try {
-      const { signature: _sig, size, version: _ver } = await parseData("json", data);
-      log(`checked version: ${_ver}, size: ${size}, signature: ${_sig}`);
-      if (!needUpdate(_ver)) {
-        log(`update unavailable: ${_ver}`);
+      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?.info(`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;
       } else {
-        log(`update available: ${_ver}`);
-        signature = _sig;
-        version = _ver;
-        return { size, version: _ver };
+        this.logger?.info(`update available: ${version}`);
+        this.info = {
+          signature,
+          minimumVersion,
+          version,
+          size
+        };
+        return { size, version };
       }
     } catch (error) {
-      log(error);
+      this.logger?.error("check update failed", error);
       return error;
     }
-  };
-  updater.download = async (data, sig) => {
+  }
+  async download(data, sig) {
     try {
-      const _sig = sig ?? signature;
+      const _sig = sig ?? this.info?.signature;
       if (!_sig) {
         throw new Error("signature are not set, please checkUpdate first or set the second parameter");
       }
-      const buffer = await parseData("buffer", data, version);
-      log("verify start");
-      const _verify = verifySignaure ?? verify;
-      const _ver = _verify(buffer, _sig, SIGNATURE_CERT);
+      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.option.SIGNATURE_CERT);
       if (!_ver) {
-        throw new Error("verify failed, invalid signature");
+        throw new VerifyFailedError(_sig, this.option.SIGNATURE_CERT);
       }
-      log("verify success");
-      log(`write to ${gzipPath}`);
-      await writeFile(gzipPath, buffer);
-      log(`extract to ${tmpFilePath}`);
-      await unzipFile(gzipPath, tmpFilePath);
-      log(`download success, version: ${_ver}`);
-      signature = "";
+      this.logger?.info("verify success");
+      this.logger?.info(`write to ${this.gzipPath}`);
+      await writeFile(this.gzipPath, buffer);
+      this.logger?.info(`extract to ${this.tmpFilePath}`);
+      await unzipFile(this.gzipPath, this.tmpFilePath);
+      this.logger?.info(`download success${typeof _ver === "string" ? `, version: ${_ver}` : ""}`);
+      this.info = void 0;
       return true;
     } catch (error) {
-      log(error);
+      this.logger?.error("download asar failed", error);
       return error;
     }
-  };
-  return updater;
+  }
+};
+function createUpdater(option) {
+  return new IncrementalUpdater(option);
 }
 
 // src/index.ts
@@ -297,6 +324,9 @@ function initApp(appOptions) {
   };
 }
 export {
+  IncrementalUpdater,
+  MinimumVersionError,
+  VerifyFailedError,
   createUpdater,
   initApp
 };

package/dist/updateJson.d.mts

@@ -0,0 +1,12 @@
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+
+export { UpdateInfo, UpdateJSON, isUpdateJSON };

package/dist/updateJson.d.ts

@@ -0,0 +1,12 @@
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+
+export { UpdateInfo, UpdateJSON, isUpdateJSON };

package/dist/updateJson.js

@@ -0,0 +1,33 @@
+"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);
+
+// src/updateJson.ts
+var updateJson_exports = {};
+__export(updateJson_exports, {
+  isUpdateJSON: () => isUpdateJSON
+});
+module.exports = __toCommonJS(updateJson_exports);
+function isUpdateJSON(json) {
+  const is = (j) => "signature" in j && "version" in j && "size" in j && "minimumVersion" in j;
+  return is(json) && "beta" in json && is(json.beta);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isUpdateJSON
+});

package/dist/updateJson.mjs

@@ -0,0 +1,7 @@
+import {
+  isUpdateJSON
+} from "./chunk-2JVXVTC5.mjs";
+import "./chunk-ZFXKCRJC.mjs";
+export {
+  isUpdateJSON
+};

package/dist/utils.d.mts

@@ -9,20 +9,27 @@ declare function getProductAsarPath(name: string): string;
 declare function getEntryVersion(): string;
 /**
  * get the version of application (name.asar)
+ *
+ * if is dev, return {@link getEntryVersion}
  * @param name - The name of the application
  */
 declare function getProductVersion(name: string): string;
+declare class NoSuchNativeModuleError extends Error {
+    moduleName: string;
+    constructor(moduleName: string);
+}
 /**
  * require native package from app.asar
  * @param packageName native package name
+ * @throws error: {@link NoSuchNativeModuleError}
  */
 declare function requireNative<T = any>(packageName: string): T;
 /**
- * get github version.json CDN URL for accelerating the speed of downloading version info
+ * parse Github CDN URL for accelerating the speed of downloading
  */
 declare function parseGithubCdnURL(repository: string, cdnPrefix: string, relativeFilePath: string): string;
 /**
- * get group of github file CDN prefix for accelerating the speed of downloading release
+ * get group of Github file CDN prefix for accelerating the speed of downloading project files
  */
 declare function getGithubFileCdnGroup(): {
     cdnPrefix: string;
@@ -35,10 +42,24 @@ declare function getGithubReleaseCdnGroup(): {
     cdnPrefix: string;
     source: string;
 }[];
+/**
+ * Restarts the Electron app.
+ */
 declare function restartApp(): void;
-declare function waitAppReady(duration?: number): Promise<unknown>;
-declare function unzipFile(gzipPath: string, targetFilePath: string): Promise<unknown>;
+/**
+ * ensure app is ready.
+ */
+declare function waitAppReady(duration?: number): Promise<void>;
+declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
 declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
 declare function handleUnexpectedErrors(callback: (err: Error) => void): void;
+interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+    stage: string;
+    stageVersion: number;
+}
+declare function parseVersion(version: string): Version;
 
-export { getEntryVersion, getGithubFileCdnGroup, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, requireNative, restartApp, unzipFile, waitAppReady, zipFile };
+export { NoSuchNativeModuleError, Version, getEntryVersion, getGithubFileCdnGroup, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, parseVersion, requireNative, restartApp, unzipFile, waitAppReady, zipFile };

package/dist/utils.d.ts

@@ -9,20 +9,27 @@ declare function getProductAsarPath(name: string): string;
 declare function getEntryVersion(): string;
 /**
  * get the version of application (name.asar)
+ *
+ * if is dev, return {@link getEntryVersion}
  * @param name - The name of the application
  */
 declare function getProductVersion(name: string): string;
+declare class NoSuchNativeModuleError extends Error {
+    moduleName: string;
+    constructor(moduleName: string);
+}
 /**
  * require native package from app.asar
  * @param packageName native package name
+ * @throws error: {@link NoSuchNativeModuleError}
  */
 declare function requireNative<T = any>(packageName: string): T;
 /**
- * get github version.json CDN URL for accelerating the speed of downloading version info
+ * parse Github CDN URL for accelerating the speed of downloading
  */
 declare function parseGithubCdnURL(repository: string, cdnPrefix: string, relativeFilePath: string): string;
 /**
- * get group of github file CDN prefix for accelerating the speed of downloading release
+ * get group of Github file CDN prefix for accelerating the speed of downloading project files
  */
 declare function getGithubFileCdnGroup(): {
     cdnPrefix: string;
@@ -35,10 +42,24 @@ declare function getGithubReleaseCdnGroup(): {
     cdnPrefix: string;
     source: string;
 }[];
+/**
+ * Restarts the Electron app.
+ */
 declare function restartApp(): void;
-declare function waitAppReady(duration?: number): Promise<unknown>;
-declare function unzipFile(gzipPath: string, targetFilePath: string): Promise<unknown>;
+/**
+ * ensure app is ready.
+ */
+declare function waitAppReady(duration?: number): Promise<void>;
+declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
 declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
 declare function handleUnexpectedErrors(callback: (err: Error) => void): void;
+interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+    stage: string;
+    stageVersion: number;
+}
+declare function parseVersion(version: string): Version;
 
-export { getEntryVersion, getGithubFileCdnGroup, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, requireNative, restartApp, unzipFile, waitAppReady, zipFile };
+export { NoSuchNativeModuleError, Version, getEntryVersion, getGithubFileCdnGroup, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, parseVersion, requireNative, restartApp, unzipFile, waitAppReady, zipFile };