electron-incremental-update 0.2.2 → 0.3.0

package/dist/index.cjs

@@ -37,7 +37,8 @@ __export(src_exports, {
   getGithubReleaseCdnGroup: () => getGithubReleaseCdnGroup,
   initApp: () => initApp,
   parseGithubCdnURL: () => parseGithubCdnURL,
-  requireNative: () => requireNative
+  requireNative: () => requireNative,
+  restartApp: () => restartApp
 });
 module.exports = __toCommonJS(src_exports);
 var import_node_path2 = require("path");
@@ -62,7 +63,6 @@ function downloadJSONDefault(url, updater, headers) {
       res.headers = headers;
       res.on("data", (chunk) => data += chunk);
       res.on("end", () => {
-        updater.emit("downloadEnd", true);
         const json = JSON.parse(data);
         if ("signature" in json && "version" in json && "size" in json) {
           resolve2(json);
@@ -71,8 +71,6 @@ function downloadJSONDefault(url, updater, headers) {
         }
       });
     }).on("error", (e) => {
-      e && updater.emit("donwnloadError", e);
-      updater.emit("downloadEnd", false);
       reject(e);
     });
   });
@@ -87,12 +85,9 @@ function downloadBufferDefault(url, updater, headers) {
         data.push(chunk);
       });
       res.on("end", () => {
-        updater.emit("downloadEnd", true);
         resolve2(import_node_buffer.Buffer.concat(data));
       });
     }).on("error", (e) => {
-      e && updater.emit("donwnloadError", e);
-      updater.emit("downloadEnd", false);
       reject(e);
     });
   });
@@ -164,6 +159,10 @@ function getGithubReleaseCdnGroup() {
     { cdnPrefix: "download.nuaa.cf", maintainer: "LibraryCloud-nuaa" }
   ];
 }
+function restartApp() {
+  import_electron.app.relaunch();
+  import_electron.app.quit();
+}
 
 // src/updater/index.ts
 function createUpdater({
@@ -177,9 +176,12 @@ function createUpdater({
   compareVersion
 }) {
   const updater = new import_node_events.EventEmitter();
+  let signature = "";
+  const gzipPath = `../${productName}.asar.gz`;
+  const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
   const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
-  function log(...args) {
-    debug && console.log(...args);
+  function log(msg) {
+    debug && updater.emit("debug", msg);
   }
   async function download(url, format) {
     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";
@@ -188,7 +190,7 @@ function createUpdater({
       UserAgent: ua,
       ...extraHeader
     };
-    log("[updater] headers", headers);
+    log(`headers: ${headers}`);
     const downloadFn = format === "json" ? downloadJSON ?? downloadJSONDefault : downloadBuffer ?? downloadBufferDefault;
     return await downloadFn(url, updater, headers);
   }
@@ -202,89 +204,105 @@ function createUpdater({
       const input = (0, import_node_fs2.createReadStream)(gzipFilePath);
       const outputFilePath = gzipFilePath.replace(".tmp.gz", ".asar");
       const output = (0, import_node_fs2.createWriteStream)(outputFilePath);
-      log("[updater] outputFilePath", outputFilePath);
+      log(`outputFilePath: ${outputFilePath}`);
       input.pipe(gunzip).pipe(output).on("finish", async () => {
         await (0, import_promises.rm)(gzipFilePath);
-        log("[updater] finish");
+        log("finish");
         resolve2(outputFilePath);
       }).on("error", async (err) => {
         await (0, import_promises.rm)(gzipFilePath);
-        log("[updater] error", err);
+        log(`error: ${err}`);
         output.destroy(err);
         reject(err);
       });
     });
   }
-  function verify(buffer, signature) {
-    log("[updater] signature", signature);
-    return (0, import_node_crypto.createVerify)("RSA-SHA256").update(buffer).verify(SIGNATURE_PUB, signature, "base64");
+  function verify(buffer, signature2) {
+    log(`signature: ${signature2}`);
+    return (0, import_node_crypto.createVerify)("RSA-SHA256").update(buffer).verify(SIGNATURE_PUB, signature2, "base64");
   }
   function needUpdate(version) {
     if (!version || !import_electron2.app.isPackaged) {
       return false;
     }
     const currentVersion = getEntryVersion();
-    log("[updater] currentVersion", currentVersion);
-    log("[updater] newVersion", version);
+    log(`currentVersion: ${currentVersion}`);
+    log(`newVersion: ${version}`);
     const _compare = compareVersion ?? compareVersionDefault;
     return _compare(currentVersion, version);
   }
-  async function checkUpdate(option) {
-    let {
-      updateJsonURL = _update,
-      releaseAsarURL = _release
-    } = option || {};
-    if (!updateJsonURL || !releaseAsarURL) {
-      log("[updater] no updateJsonURL or releaseAsarURL, use repository");
+  async function checkUpdate(url) {
+    url ??= _update;
+    if (!url) {
+      log("no updateJsonURL, use repository");
       if (!repository) {
-        throw new Error("updateJsonURL or releaseAsarURL are not set");
+        throw new Error("updateJsonURL or repository are not set");
       }
-      updateJsonURL = `${repository.replace("github.com", "raw.githubusercontent.com")}/version.json`;
-      releaseAsarURL = `${repository}/releases/download/latest/${productName}.asar.gz`;
+      url = `${repository.replace("github.com", "raw.githubusercontent.com")}/version.json`;
     }
-    log("[updater] updateJsonURL", updateJsonURL);
-    log("[updater] releaseAsarURL", releaseAsarURL);
-    const gzipPath = `../${productName}.asar.gz`;
-    const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
+    log(`updateJsonURL: ${url}`);
     if ((0, import_node_fs2.existsSync)(tmpFile)) {
-      log("[updater] remove tmp file", tmpFile);
+      log(`remove tmp file: ${tmpFile}`);
       await (0, import_promises.rm)(tmpFile);
     }
-    const json = await download(updateJsonURL, "json");
-    if (!json) {
-      throw new Error("fetch update json failed");
-    }
+    const json = await download(url, "json");
     const {
-      signature,
+      signature: _sig,
       version,
       size
     } = json;
-    log("[updater] UpdateJSON", json);
+    log(`UpdateJSON: ${JSON.stringify(json, null, 2)}`);
     if (!needUpdate(version)) {
-      return "unavailable";
+      return false;
+    } else {
+      signature = _sig;
+      return { size, version };
     }
-    updater.emit("downloadStart", size);
-    const buffer = await download(releaseAsarURL, "buffer");
-    log("[updater] start verify");
-    if (!verify(buffer, signature)) {
+  }
+  async function downloadUpdate(src) {
+    if (typeof src !== "object") {
+      let _url = src ?? _release;
+      if (!_url) {
+        log("no releaseAsarURL, use repository");
+        if (!repository) {
+          throw new Error("releaseAsarURL or repository are not set");
+        }
+        _url = `${repository}/releases/download/latest/${productName}.asar.gz`;
+      }
+      log(`releaseAsarURL: ${_url}`);
+      src = await download(_url, "buffer");
+    }
+    log("start verify");
+    if (!verify(src, signature)) {
       throw new Error("file broken, invalid signature!");
     }
-    log("[updater] write file", gzipPath);
-    await (0, import_promises.writeFile)(gzipPath, buffer);
-    log("[updater] extract file", gzipPath);
+    log(`write file: ${gzipPath}`);
+    await (0, import_promises.writeFile)(gzipPath, src);
+    log(`extract file: ${gzipPath}`);
     await extractFile(gzipPath);
-    return "success";
+    updater.emit("downloaded");
   }
-  const onCheck = async (option) => {
+  const onCheck = async (url) => {
     try {
-      const result = await checkUpdate(option);
+      const result = await checkUpdate(url);
       updater.emit("checkResult", result);
     } catch (error) {
-      updater.emit("checkResult", "fail", error);
+      log(error);
+      updater.emit("checkResult", error);
     }
   };
   updater.on("check", onCheck);
   updater.checkUpdate = onCheck;
+  const onDownload = async (src) => {
+    try {
+      await downloadUpdate(src);
+    } catch (error) {
+      log(error);
+      updater.emit("donwnloadError", error);
+    }
+  };
+  updater.on("download", onDownload);
+  updater.downloadUpdate = onDownload;
   return updater;
 }
 
@@ -314,5 +332,6 @@ function initApp(productName, updater, option) {
   getGithubReleaseCdnGroup,
   initApp,
   parseGithubCdnURL,
-  requireNative
+  requireNative,
+  restartApp
 });

package/dist/index.d.ts

@@ -1,13 +1,14 @@
 import { Buffer } from 'node:buffer';
 
-type CheckResultType = 'success' | 'fail' | 'unavailable';
+type CheckResultType = Error | false | Omit<UpdateJSON, 'signature'>;
 type UpdateEvents = {
     check: null;
-    checkResult: [data: CheckResultType, err?: unknown];
-    downloadStart: [size: number];
+    checkResult: [data: CheckResultType];
+    download: null;
     downloading: [current: number];
-    downloadEnd: [success: boolean];
+    downloaded: null;
     donwnloadError: [error: unknown];
+    debug: [msg: string | Error];
 };
 type UpdateJSON = {
     signature: string;
@@ -37,7 +38,13 @@ interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event
     once<E extends Event>(eventName: E, listener: (...args: MaybeArray<T[E]>) => void): this;
     emit<E extends Event>(eventName: E, ...args: MaybeArray<T[E]>): boolean;
     off<E extends Event>(eventName: E, listener: (...args: MaybeArray<T[E]>) => void): this;
-    checkUpdate(options?: BaseOption): Promise<void>;
+    /**
+     * - `undefined`: errror
+     * - `false`: unavailable
+     * - `{size: number, version: string}`: success
+     */
+    checkUpdate(url?: BaseOption['updateJsonURL']): Promise<void>;
+    downloadUpdate(url?: BaseOption['releaseAsarURL'] | Buffer): Promise<void>;
 }
 type Updater = TypedUpdater<UpdateEvents>;
 interface UpdaterOption extends BaseOption {
@@ -133,6 +140,7 @@ declare function getGithubReleaseCdnGroup(): {
     cdnPrefix: string;
     maintainer: string;
 }[];
+declare function restartApp(): void;
 
 declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, debug, downloadConfig, compareVersion, }: UpdaterOption): Updater;
 
@@ -193,4 +201,4 @@ declare function initApp(productName: string, updater: Updater | Omit<UpdaterOpt
     productName?: string;
 }, option?: AppOption): any;
 
-export { BaseOption, CheckResultType, UpdateJSON, Updater, UpdaterOption, createUpdater, getAppAsarPath, getAppVersion, getEntryVersion, getGithubReleaseCdnGroup, initApp, parseGithubCdnURL, requireNative };
+export { BaseOption, CheckResultType, UpdateJSON, Updater, UpdaterOption, createUpdater, getAppAsarPath, getAppVersion, getEntryVersion, getGithubReleaseCdnGroup, initApp, parseGithubCdnURL, requireNative, restartApp };

package/dist/index.mjs

@@ -25,7 +25,6 @@ function downloadJSONDefault(url, updater, headers) {
       res.headers = headers;
       res.on("data", (chunk) => data += chunk);
       res.on("end", () => {
-        updater.emit("downloadEnd", true);
         const json = JSON.parse(data);
         if ("signature" in json && "version" in json && "size" in json) {
           resolve2(json);
@@ -34,8 +33,6 @@ function downloadJSONDefault(url, updater, headers) {
         }
       });
     }).on("error", (e) => {
-      e && updater.emit("donwnloadError", e);
-      updater.emit("downloadEnd", false);
       reject(e);
     });
   });
@@ -50,12 +47,9 @@ function downloadBufferDefault(url, updater, headers) {
         data.push(chunk);
       });
       res.on("end", () => {
-        updater.emit("downloadEnd", true);
         resolve2(Buffer.concat(data));
       });
     }).on("error", (e) => {
-      e && updater.emit("donwnloadError", e);
-      updater.emit("downloadEnd", false);
       reject(e);
     });
   });
@@ -127,6 +121,10 @@ function getGithubReleaseCdnGroup() {
     { cdnPrefix: "download.nuaa.cf", maintainer: "LibraryCloud-nuaa" }
   ];
 }
+function restartApp() {
+  app.relaunch();
+  app.quit();
+}
 
 // src/updater/index.ts
 function createUpdater({
@@ -140,9 +138,12 @@ function createUpdater({
   compareVersion
 }) {
   const updater = new EventEmitter();
+  let signature = "";
+  const gzipPath = `../${productName}.asar.gz`;
+  const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
   const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
-  function log(...args) {
-    debug && console.log(...args);
+  function log(msg) {
+    debug && updater.emit("debug", msg);
   }
   async function download(url, format) {
     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";
@@ -151,7 +152,7 @@ function createUpdater({
       UserAgent: ua,
       ...extraHeader
     };
-    log("[updater] headers", headers);
+    log(`headers: ${headers}`);
     const downloadFn = format === "json" ? downloadJSON ?? downloadJSONDefault : downloadBuffer ?? downloadBufferDefault;
     return await downloadFn(url, updater, headers);
   }
@@ -165,89 +166,105 @@ function createUpdater({
       const input = createReadStream(gzipFilePath);
       const outputFilePath = gzipFilePath.replace(".tmp.gz", ".asar");
       const output = createWriteStream(outputFilePath);
-      log("[updater] outputFilePath", outputFilePath);
+      log(`outputFilePath: ${outputFilePath}`);
       input.pipe(gunzip).pipe(output).on("finish", async () => {
         await rm(gzipFilePath);
-        log("[updater] finish");
+        log("finish");
         resolve2(outputFilePath);
       }).on("error", async (err) => {
         await rm(gzipFilePath);
-        log("[updater] error", err);
+        log(`error: ${err}`);
         output.destroy(err);
         reject(err);
       });
     });
   }
-  function verify(buffer, signature) {
-    log("[updater] signature", signature);
-    return createVerify("RSA-SHA256").update(buffer).verify(SIGNATURE_PUB, signature, "base64");
+  function verify(buffer, signature2) {
+    log(`signature: ${signature2}`);
+    return createVerify("RSA-SHA256").update(buffer).verify(SIGNATURE_PUB, signature2, "base64");
   }
   function needUpdate(version) {
     if (!version || !app2.isPackaged) {
       return false;
     }
     const currentVersion = getEntryVersion();
-    log("[updater] currentVersion", currentVersion);
-    log("[updater] newVersion", version);
+    log(`currentVersion: ${currentVersion}`);
+    log(`newVersion: ${version}`);
     const _compare = compareVersion ?? compareVersionDefault;
     return _compare(currentVersion, version);
   }
-  async function checkUpdate(option) {
-    let {
-      updateJsonURL = _update,
-      releaseAsarURL = _release
-    } = option || {};
-    if (!updateJsonURL || !releaseAsarURL) {
-      log("[updater] no updateJsonURL or releaseAsarURL, use repository");
+  async function checkUpdate(url) {
+    url ??= _update;
+    if (!url) {
+      log("no updateJsonURL, use repository");
       if (!repository) {
-        throw new Error("updateJsonURL or releaseAsarURL are not set");
+        throw new Error("updateJsonURL or repository are not set");
       }
-      updateJsonURL = `${repository.replace("github.com", "raw.githubusercontent.com")}/version.json`;
-      releaseAsarURL = `${repository}/releases/download/latest/${productName}.asar.gz`;
+      url = `${repository.replace("github.com", "raw.githubusercontent.com")}/version.json`;
     }
-    log("[updater] updateJsonURL", updateJsonURL);
-    log("[updater] releaseAsarURL", releaseAsarURL);
-    const gzipPath = `../${productName}.asar.gz`;
-    const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
+    log(`updateJsonURL: ${url}`);
     if (existsSync(tmpFile)) {
-      log("[updater] remove tmp file", tmpFile);
+      log(`remove tmp file: ${tmpFile}`);
       await rm(tmpFile);
     }
-    const json = await download(updateJsonURL, "json");
-    if (!json) {
-      throw new Error("fetch update json failed");
-    }
+    const json = await download(url, "json");
     const {
-      signature,
+      signature: _sig,
       version,
       size
     } = json;
-    log("[updater] UpdateJSON", json);
+    log(`UpdateJSON: ${JSON.stringify(json, null, 2)}`);
     if (!needUpdate(version)) {
-      return "unavailable";
+      return false;
+    } else {
+      signature = _sig;
+      return { size, version };
     }
-    updater.emit("downloadStart", size);
-    const buffer = await download(releaseAsarURL, "buffer");
-    log("[updater] start verify");
-    if (!verify(buffer, signature)) {
+  }
+  async function downloadUpdate(src) {
+    if (typeof src !== "object") {
+      let _url = src ?? _release;
+      if (!_url) {
+        log("no releaseAsarURL, use repository");
+        if (!repository) {
+          throw new Error("releaseAsarURL or repository are not set");
+        }
+        _url = `${repository}/releases/download/latest/${productName}.asar.gz`;
+      }
+      log(`releaseAsarURL: ${_url}`);
+      src = await download(_url, "buffer");
+    }
+    log("start verify");
+    if (!verify(src, signature)) {
       throw new Error("file broken, invalid signature!");
     }
-    log("[updater] write file", gzipPath);
-    await writeFile(gzipPath, buffer);
-    log("[updater] extract file", gzipPath);
+    log(`write file: ${gzipPath}`);
+    await writeFile(gzipPath, src);
+    log(`extract file: ${gzipPath}`);
     await extractFile(gzipPath);
-    return "success";
+    updater.emit("downloaded");
   }
-  const onCheck = async (option) => {
+  const onCheck = async (url) => {
     try {
-      const result = await checkUpdate(option);
+      const result = await checkUpdate(url);
       updater.emit("checkResult", result);
     } catch (error) {
-      updater.emit("checkResult", "fail", error);
+      log(error);
+      updater.emit("checkResult", error);
     }
   };
   updater.on("check", onCheck);
   updater.checkUpdate = onCheck;
+  const onDownload = async (src) => {
+    try {
+      await downloadUpdate(src);
+    } catch (error) {
+      log(error);
+      updater.emit("donwnloadError", error);
+    }
+  };
+  updater.on("download", onDownload);
+  updater.downloadUpdate = onDownload;
   return updater;
 }
 
@@ -276,5 +293,6 @@ export {
   getGithubReleaseCdnGroup,
   initApp,
   parseGithubCdnURL,
-  requireNative
+  requireNative,
+  restartApp
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-incremental-update",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup",