electron-incremental-update 0.7.0 → 0.7.2

package/dist/index.mjs

@@ -1,20 +1,25 @@
 import {
-  __require,
   verify
-} from "./chunk-XQ4Z2OVN.mjs";
+} from "./chunk-Q2K52LOG.mjs";
+import {
+  __require,
+  getEntryVersion,
+  getProductAsarPath,
+  unzipFile,
+  waitAppReady
+} from "./chunk-CRBEZBU5.mjs";
 
 // src/index.ts
 import { resolve as resolve2 } from "node:path";
-import { app as app3 } from "electron";
+import { app as app2 } from "electron";
 
 // src/updater/index.ts
 import { EventEmitter } from "node:events";
 import { Buffer as Buffer2 } from "node:buffer";
-import { createGunzip } from "node:zlib";
-import { createReadStream, createWriteStream, existsSync, rmSync } from "node:fs";
+import { existsSync, rmSync } from "node:fs";
 import { readFile, rename, rm, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
-import { app as app2 } from "electron";
+import { app } from "electron";
 
 // src/updater/defaultFunctions.ts
 import { Buffer } from "node:buffer";
@@ -25,66 +30,6 @@ function isUpdateJSON(json) {
   return "signature" in json && "version" in json && "size" in json;
 }
 
-// src/updater/utils.ts
-import { readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { app } from "electron";
-function getProductAsarPath(name) {
-  return app.isPackaged ? join(dirname(app.getAppPath()), `${name}.asar`) : "dev";
-}
-function getEntryVersion() {
-  return app.getVersion();
-}
-function getProductVersion(name) {
-  return app.isPackaged ? readFileSync(join(getProductAsarPath(name), "version"), "utf-8") : getEntryVersion();
-}
-function requireNative(packageName) {
-  const path = app.isPackaged ? join(app.getAppPath(), "node_modules", packageName) : packageName;
-  return __require(path);
-}
-function parseGithubCdnURL(repository, cdnPrefix, relativeFilePath) {
-  if (!repository.startsWith("https://github.com/")) {
-    throw new Error("url must start with https://github.com/");
-  }
-  repository = repository.trim().replace(/\/?$/, "/").trim();
-  relativeFilePath = relativeFilePath.trim().replace(/^\/|\/?$/g, "").trim();
-  cdnPrefix = cdnPrefix.trim().replace(/^\/?|\/?$/g, "").trim();
-  return repository.replace("github.com", cdnPrefix) + relativeFilePath;
-}
-function getGithubReleaseCdnGroup() {
-  return [
-    { cdnPrefix: "gh.gh2233.ml", maintainer: "@X.I.U/XIU2" },
-    { cdnPrefix: "ghproxy.com", maintainer: "gh-proxy" },
-    { cdnPrefix: "gh.ddlc.top", maintainer: "@mtr-static-official" },
-    { cdnPrefix: "ghdl.feizhuqwq.cf", maintainer: "feizhuqwq.com" },
-    { cdnPrefix: "slink.ltd", maintainer: "\u77E5\u4E86\u5C0F\u7AD9" },
-    { cdnPrefix: "git.xfj0.cn", maintainer: "anonymous1" },
-    { cdnPrefix: "gh.con.sh", maintainer: "anonymous2" },
-    { cdnPrefix: "ghps.cc", maintainer: "anonymous3" },
-    { cdnPrefix: "cors.isteed.cc/github.com", maintainer: "Lufs's" },
-    { cdnPrefix: "hub.gitmirror.com", maintainer: "GitMirror" },
-    { cdnPrefix: "js.xxooo.ml", maintainer: "\u996D\u592A\u786C" },
-    { cdnPrefix: "download.njuu.cf", maintainer: "LibraryCloud-njuu" },
-    { cdnPrefix: "download.yzuu.cf", maintainer: "LibraryCloud-yzuu" },
-    { cdnPrefix: "download.nuaa.cf", maintainer: "LibraryCloud-nuaa" }
-  ];
-}
-function restartApp() {
-  app.relaunch();
-  app.quit();
-}
-function waitAppReady(duration = 1e3) {
-  return new Promise((resolve3, reject) => {
-    const timeout = setTimeout(() => {
-      reject(new Error("app is not ready"));
-    }, duration);
-    app.whenReady().then(() => {
-      clearTimeout(timeout);
-      resolve3(null);
-    });
-  });
-}
-
 // src/updater/defaultFunctions.ts
 async function downloadJSONDefault(url, updater, headers) {
   await waitAppReady();
@@ -187,44 +132,24 @@ function createUpdater({
   } = {}
 }) {
   const updater = new EventEmitter();
-  let signature = "";
+  let signature, version;
   const asarPath = getProductAsarPath(productName);
   const gzipPath = `${asarPath}.gz`;
   const tmpFilePath = gzipPath.replace(".asar.gz", ".tmp.asar");
   function log(msg) {
     debug && updater.emit("debug", msg);
   }
-  async function extractFile() {
-    if (!gzipPath.endsWith(".asar.gz") || !existsSync(gzipPath)) {
-      throw new Error(".asar.gz file not exist");
-    }
-    return new Promise((resolve3, reject) => {
-      const gunzip = createGunzip();
-      const input = createReadStream(gzipPath);
-      const output = createWriteStream(tmpFilePath);
-      log(`outputFilePath: ${tmpFilePath}`);
-      input.pipe(gunzip).pipe(output).on("finish", async () => {
-        await rm(gzipPath);
-        log(`${gzipPath} unzipped`);
-        resolve3(null);
-      }).on("error", async (err) => {
-        await rm(gzipPath);
-        output.destroy(err);
-        reject(err);
-      });
-    });
-  }
-  function needUpdate(version) {
-    if (!app2.isPackaged) {
+  function needUpdate(version2) {
+    if (!app.isPackaged) {
       log("in dev mode, no need to update");
       return false;
     }
     const currentVersion = getEntryVersion();
-    log(`check update: current version is ${currentVersion}, new version is ${version}`);
+    log(`check update: current version is ${currentVersion}, new version is ${version2}`);
     const _compare = compareVersion ?? compareVersionDefault;
-    return _compare(currentVersion, version);
+    return _compare(currentVersion, version2);
   }
-  async function parseData(format, data) {
+  async function parseData(format, data, version2) {
     if (existsSync(tmpFilePath)) {
       log(`remove tmp file: ${tmpFilePath}`);
       await rm(tmpFilePath);
@@ -255,7 +180,7 @@ function createUpdater({
       } : {
         name: "releaseAsarURL",
         url: _release,
-        repoFallback: `${repository}/releases/download/latest/${productName}.asar.gz`,
+        repoFallback: `${repository}/releases/download/v${version2}/${productName}-${version2}.asar.gz`,
         fn: downloadBuffer ?? downloadBufferDefault
       };
       data ??= info.url;
@@ -264,11 +189,14 @@ function createUpdater({
         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;
       }
       log(`download ${format} from ${data}`);
       const ret = await info.fn(data, updater, headers);
-      log(`download ${format} success`);
+      log(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
       return ret;
     } else {
       throw new Error(`invalid type at format '${format}': ${data}`);
@@ -277,15 +205,16 @@ function createUpdater({
   updater.setDebug = (isDebug) => debug = isDebug;
   updater.checkUpdate = async (data) => {
     try {
-      const { signature: _sig, size, version } = await parseData("json", data);
-      log(`checked version: ${version}, size: ${size}, signature: ${_sig}`);
-      if (!needUpdate(version)) {
-        log(`update unavailable: ${version}`);
+      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}`);
         return void 0;
       } else {
-        log(`update available: ${version}`);
+        log(`update available: ${_ver}`);
         signature = _sig;
-        return { size, version };
+        version = _ver;
+        return { size, version: _ver };
       }
     } catch (error) {
       log(error);
@@ -298,29 +227,29 @@ function createUpdater({
       if (!_sig) {
         throw new Error("signature are not set, please checkUpdate first or set the second parameter");
       }
-      const buffer = await parseData("buffer", data);
+      const buffer = await parseData("buffer", data, version);
       log("verify start");
       const _verify = verifySignaure ?? verify;
-      const version = _verify(buffer, _sig, SIGNATURE_CERT);
-      if (!version) {
+      const _ver = _verify(buffer, _sig, SIGNATURE_CERT);
+      if (!_ver) {
         throw new Error("verify failed, invalid signature");
       }
       log("verify success");
-      if (!needUpdate(version)) {
-        throw new Error(`update unavailable: ${version}`);
+      if (!needUpdate(_ver)) {
+        throw new Error(`update unavailable: ${_ver}`);
       }
       log(`write file: ${gzipPath}`);
       await writeFile(gzipPath, buffer);
       log(`extract file: ${gzipPath}`);
-      await extractFile();
+      await unzipFile(gzipPath, tmpFilePath);
       const asarVersion = await readFile(resolve(tmpFilePath, "version"), "utf8");
-      if (asarVersion !== version) {
+      if (asarVersion !== _ver) {
         rmSync(tmpFilePath);
-        throw new Error(`update failed: asar version is ${asarVersion}, but it should be ${version}`);
+        throw new Error(`update failed: asar version is ${asarVersion}, but it should be ${_ver}`);
       } else {
         await rename(tmpFilePath, asarPath);
       }
-      log(`update success, version: ${version}`);
+      log(`update success, version: ${_ver}`);
       signature = "";
       return true;
     } catch (error) {
@@ -338,7 +267,7 @@ function initApp(appOptions, updaterOptions) {
     electronDistPath = "dist-electron",
     mainPath = "main/index.js"
   } = appOptions ?? {};
-  const mainDir = app3.isPackaged ? `../${productName}.asar` : electronDistPath;
+  const mainDir = app2.isPackaged ? `../${productName}.asar` : electronDistPath;
   const entry = resolve2(__dirname, mainDir, mainPath);
   if (updaterOptions) {
     __require(entry)(
@@ -354,14 +283,5 @@ function initApp(appOptions, updaterOptions) {
 }
 export {
   createUpdater,
-  getEntryVersion,
-  getGithubReleaseCdnGroup,
-  getProductAsarPath,
-  getProductVersion,
-  initApp,
-  isUpdateJSON,
-  parseGithubCdnURL,
-  requireNative,
-  restartApp,
-  waitAppReady
+  initApp
 };

package/dist/utils.d.mts

@@ -0,0 +1,37 @@
+/**
+ * get the application asar absolute path
+ * @param name The name of the application
+ */
+declare function getProductAsarPath(name: string): string;
+/**
+ * get the version of entry (app.asar)
+ */
+declare function getEntryVersion(): string;
+/**
+ * get the version of application (name.asar)
+ * @param name - The name of the application
+ */
+declare function getProductVersion(name: string): string;
+/**
+ * require native package from app.asar
+ * @param packageName native package name
+ */
+declare function requireNative<T = any>(packageName: string): T;
+/**
+ * get github version.json CDN URL for accelerating the speed of downloading version info
+ */
+declare function parseGithubCdnURL(repository: string, cdnPrefix: string, relativeFilePath: string): string;
+/**
+ * get group of github release CDN prefix for accelerating the speed of downloading release
+ */
+declare function getGithubReleaseCdnGroup(): {
+    cdnPrefix: string;
+    maintainer: string;
+}[];
+declare function restartApp(): void;
+declare function waitAppReady(duration?: number): Promise<unknown>;
+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;
+
+export { getEntryVersion, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, requireNative, restartApp, unzipFile, waitAppReady, zipFile };

package/dist/utils.d.ts

@@ -0,0 +1,37 @@
+/**
+ * get the application asar absolute path
+ * @param name The name of the application
+ */
+declare function getProductAsarPath(name: string): string;
+/**
+ * get the version of entry (app.asar)
+ */
+declare function getEntryVersion(): string;
+/**
+ * get the version of application (name.asar)
+ * @param name - The name of the application
+ */
+declare function getProductVersion(name: string): string;
+/**
+ * require native package from app.asar
+ * @param packageName native package name
+ */
+declare function requireNative<T = any>(packageName: string): T;
+/**
+ * get github version.json CDN URL for accelerating the speed of downloading version info
+ */
+declare function parseGithubCdnURL(repository: string, cdnPrefix: string, relativeFilePath: string): string;
+/**
+ * get group of github release CDN prefix for accelerating the speed of downloading release
+ */
+declare function getGithubReleaseCdnGroup(): {
+    cdnPrefix: string;
+    maintainer: string;
+}[];
+declare function restartApp(): void;
+declare function waitAppReady(duration?: number): Promise<unknown>;
+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;
+
+export { getEntryVersion, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, requireNative, restartApp, unzipFile, waitAppReady, zipFile };

package/dist/utils.js

@@ -0,0 +1,145 @@
+"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/utils.ts
+var utils_exports = {};
+__export(utils_exports, {
+  getEntryVersion: () => getEntryVersion,
+  getGithubReleaseCdnGroup: () => getGithubReleaseCdnGroup,
+  getProductAsarPath: () => getProductAsarPath,
+  getProductVersion: () => getProductVersion,
+  handleUnexpectedErrors: () => handleUnexpectedErrors,
+  parseGithubCdnURL: () => parseGithubCdnURL,
+  requireNative: () => requireNative,
+  restartApp: () => restartApp,
+  unzipFile: () => unzipFile,
+  waitAppReady: () => waitAppReady,
+  zipFile: () => zipFile
+});
+module.exports = __toCommonJS(utils_exports);
+var import_node_fs = require("fs");
+var import_node_path = require("path");
+var import_node_zlib = require("zlib");
+var import_electron = require("electron");
+function getProductAsarPath(name) {
+  return import_electron.app.isPackaged ? (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${name}.asar`) : "dev";
+}
+function getEntryVersion() {
+  return import_electron.app.getVersion();
+}
+function getProductVersion(name) {
+  return import_electron.app.isPackaged ? (0, import_node_fs.readFileSync)((0, import_node_path.join)(getProductAsarPath(name), "version"), "utf-8") : getEntryVersion();
+}
+function requireNative(packageName) {
+  const path = import_electron.app.isPackaged ? (0, import_node_path.join)(import_electron.app.getAppPath(), "node_modules", packageName) : packageName;
+  return require(path);
+}
+function parseGithubCdnURL(repository, cdnPrefix, relativeFilePath) {
+  if (!repository.startsWith("https://github.com/")) {
+    throw new Error("url must start with https://github.com/");
+  }
+  repository = repository.trim().replace(/\/?$/, "/").trim();
+  relativeFilePath = relativeFilePath.trim().replace(/^\/|\/?$/g, "").trim();
+  cdnPrefix = cdnPrefix.trim().replace(/^\/?|\/?$/g, "").trim();
+  return repository.replace("github.com", cdnPrefix) + relativeFilePath;
+}
+function getGithubReleaseCdnGroup() {
+  return [
+    { cdnPrefix: "gh.gh2233.ml", maintainer: "@X.I.U/XIU2" },
+    { cdnPrefix: "ghproxy.com", maintainer: "gh-proxy" },
+    { cdnPrefix: "gh.ddlc.top", maintainer: "@mtr-static-official" },
+    { cdnPrefix: "ghdl.feizhuqwq.cf", maintainer: "feizhuqwq.com" },
+    { cdnPrefix: "slink.ltd", maintainer: "\u77E5\u4E86\u5C0F\u7AD9" },
+    { cdnPrefix: "git.xfj0.cn", maintainer: "anonymous1" },
+    { cdnPrefix: "gh.con.sh", maintainer: "anonymous2" },
+    { cdnPrefix: "ghps.cc", maintainer: "anonymous3" },
+    { cdnPrefix: "cors.isteed.cc/github.com", maintainer: "Lufs's" },
+    { cdnPrefix: "hub.gitmirror.com", maintainer: "GitMirror" },
+    { cdnPrefix: "js.xxooo.ml", maintainer: "\u996D\u592A\u786C" },
+    { cdnPrefix: "download.njuu.cf", maintainer: "LibraryCloud-njuu" },
+    { cdnPrefix: "download.yzuu.cf", maintainer: "LibraryCloud-yzuu" },
+    { cdnPrefix: "download.nuaa.cf", maintainer: "LibraryCloud-nuaa" }
+  ];
+}
+function restartApp() {
+  import_electron.app.relaunch();
+  import_electron.app.quit();
+}
+function waitAppReady(duration = 1e3) {
+  return new Promise((resolve, reject) => {
+    const timeout = setTimeout(() => {
+      reject(new Error("app is not ready"));
+    }, duration);
+    import_electron.app.whenReady().then(() => {
+      clearTimeout(timeout);
+      resolve(null);
+    });
+  });
+}
+async function unzipFile(gzipPath, targetFilePath) {
+  if (!(0, import_node_fs.existsSync)(gzipPath)) {
+    throw new Error(`path to zipped file not exist: ${gzipPath}`);
+  }
+  return new Promise((resolve, reject) => {
+    const gunzip = (0, import_node_zlib.createGunzip)();
+    const input = (0, import_node_fs.createReadStream)(gzipPath);
+    const output = (0, import_node_fs.createWriteStream)(targetFilePath);
+    input.pipe(gunzip).pipe(output).on("finish", () => {
+      (0, import_node_fs.rmSync)(gzipPath);
+      resolve(null);
+    }).on("error", (err) => {
+      (0, import_node_fs.rmSync)(gzipPath);
+      output.destroy(err);
+      reject(err);
+    });
+  });
+}
+async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
+  if (!(0, import_node_fs.existsSync)(filePath)) {
+    throw new Error(`path to be zipped not exist: ${filePath}`);
+  }
+  return new Promise((resolve, reject) => {
+    const gzip = (0, import_node_zlib.createGzip)();
+    const input = (0, import_node_fs.createReadStream)(filePath);
+    const output = (0, import_node_fs.createWriteStream)(targetFilePath);
+    input.pipe(gzip).pipe(output).on("finish", () => resolve(null)).on("error", (err) => reject(err));
+  });
+}
+function handleUnexpectedErrors(callback) {
+  const listener = (err) => {
+    const e = err instanceof Error ? err : new Error(typeof err === "string" ? err : JSON.stringify(err));
+    callback(e);
+  };
+  process.on("uncaughtException", listener);
+  process.on("unhandledRejection", listener);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getEntryVersion,
+  getGithubReleaseCdnGroup,
+  getProductAsarPath,
+  getProductVersion,
+  handleUnexpectedErrors,
+  parseGithubCdnURL,
+  requireNative,
+  restartApp,
+  unzipFile,
+  waitAppReady,
+  zipFile
+});

package/dist/utils.mjs

@@ -0,0 +1,26 @@
+import {
+  getEntryVersion,
+  getGithubReleaseCdnGroup,
+  getProductAsarPath,
+  getProductVersion,
+  handleUnexpectedErrors,
+  parseGithubCdnURL,
+  requireNative,
+  restartApp,
+  unzipFile,
+  waitAppReady,
+  zipFile
+} from "./chunk-CRBEZBU5.mjs";
+export {
+  getEntryVersion,
+  getGithubReleaseCdnGroup,
+  getProductAsarPath,
+  getProductVersion,
+  handleUnexpectedErrors,
+  parseGithubCdnURL,
+  requireNative,
+  restartApp,
+  unzipFile,
+  waitAppReady,
+  zipFile
+};

package/dist/vite.d.mts

@@ -47,6 +47,11 @@ type Options = {
          * @default `release/${productName}.asar`
          */
         asarOutputPath?: string;
+        /**
+         * Path to gzipped asar file
+         * @default `release/${productName}-${version}.asar.gz`
+         */
+        gzipPath?: string;
         /**
          * Path to electron build output
          * @default `dist-electron`

package/dist/vite.d.ts

@@ -47,6 +47,11 @@ type Options = {
          * @default `release/${productName}.asar`
          */
         asarOutputPath?: string;
+        /**
+         * Path to gzipped asar file
+         * @default `release/${productName}-${version}.asar.gz`
+         */
+        gzipPath?: string;
         /**
          * Path to electron build output
          * @default `dist-electron`