electron-incremental-update 0.2.0 → 0.2.1

package/dist/index.cjs

@@ -33,7 +33,7 @@ __export(src_exports, {
   createUpdater: () => createUpdater,
   getAppAsarPath: () => getAppAsarPath,
   getAppVersion: () => getAppVersion,
-  getElectronVersion: () => getElectronVersion,
+  getEntryVersion: () => getEntryVersion,
   getReleaseCdnLink: () => getReleaseCdnLink,
   initApp: () => initApp,
   requireNative: () => requireNative
@@ -50,7 +50,7 @@ var import_node_fs2 = require("fs");
 var import_promises = require("fs/promises");
 var import_electron2 = require("electron");
 
-// src/updater/download.ts
+// src/updater/defaultFunctions.ts
 var import_node_buffer = require("buffer");
 var import_node_https = __toESM(require("https"), 1);
 function downloadJSONDefault(url, updater, headers) {
@@ -96,6 +96,28 @@ function downloadBufferDefault(url, updater, headers) {
     });
   });
 }
+function compareVersionDefault(oldVersion, newVersion) {
+  if (!oldVersion || !newVersion) {
+    throw new TypeError("invalid version");
+  }
+  const parseVersion = (version) => {
+    const [versionNumber, stage] = version.split("-");
+    const [major, minor, patch] = versionNumber.split(".").map(Number);
+    if (isNaN(major) || isNaN(minor) || isNaN(patch)) {
+      throw new TypeError("invalid version");
+    }
+    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;
+  }
+  if (oldV.stage < newV.stage || !newV.stage && oldV.stage) {
+    return true;
+  }
+  return false;
+}
 
 // src/updater/utils.ts
 var import_node_fs = require("fs");
@@ -104,11 +126,11 @@ var import_electron = require("electron");
 function getAppAsarPath(name) {
   return import_electron.app.isPackaged ? (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${name}.asar`) : "dev";
 }
-function getElectronVersion() {
+function getEntryVersion() {
   return import_electron.app.getVersion();
 }
 function getAppVersion(name) {
-  return import_electron.app.isPackaged ? (0, import_node_fs.readFileSync)((0, import_node_path.join)(getAppAsarPath(name), "version"), "utf-8").trim() : getElectronVersion();
+  return import_electron.app.isPackaged ? (0, import_node_fs.readFileSync)((0, import_node_path.join)(getAppAsarPath(name), "version"), "utf-8").trim() : getEntryVersion();
 }
 function requireNative(packageName) {
   const path = import_electron.app.isPackaged ? (0, import_node_path.join)(import_electron.app.getAppPath(), "node_modules", packageName) : packageName;
@@ -149,10 +171,15 @@ function createUpdater({
   productName,
   releaseAsarURL: _release,
   updateJsonURL: _update,
-  downloadConfig
+  debug = false,
+  downloadConfig,
+  compareVersion
 }) {
   const updater = new import_node_events.EventEmitter();
   const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
+  function log(...args) {
+    debug && console.log(...args);
+  }
   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";
     const headers = {
@@ -160,6 +187,7 @@ function createUpdater({
       UserAgent: ua,
       ...extraHeader
     };
+    log("[updater] headers", headers);
     const downloadFn = format === "json" ? downloadJSON ?? downloadJSONDefault : downloadBuffer ?? downloadBufferDefault;
     return await downloadFn(url, updater, headers);
   }
@@ -173,25 +201,32 @@ 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);
       input.pipe(gunzip).pipe(output).on("finish", async () => {
         await (0, import_promises.rm)(gzipFilePath);
+        log("[updater] finish");
         resolve2(outputFilePath);
       }).on("error", async (err) => {
         await (0, import_promises.rm)(gzipFilePath);
+        log("[updater] 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 needUpdate(version) {
-    const parseVersion = (version2) => {
-      const [major, minor, patch] = version2.split(".");
-      return ~~major * 100 + ~~minor * 10 + ~~patch;
-    };
-    return import_electron2.app.isPackaged && parseVersion(import_electron2.app.getVersion()) < parseVersion(version);
+    if (!version || !import_electron2.app.isPackaged) {
+      return false;
+    }
+    const currentVersion = getEntryVersion();
+    log("[updater] currentVersion", currentVersion);
+    log("[updater] newVersion", version);
+    const _compare = compareVersion ?? compareVersionDefault;
+    return _compare(currentVersion, version);
   }
   async function checkUpdate(option) {
     let {
@@ -199,15 +234,19 @@ function createUpdater({
       releaseAsarURL = _release
     } = option || {};
     if (!updateJsonURL || !releaseAsarURL) {
+      log("[updater] no updateJsonURL or releaseAsarURL, use repository");
       if (!repository) {
         throw new Error("updateJsonURL or releaseAsarURL are not set");
       }
       updateJsonURL = `${repository.replace("github.com", "raw.githubusercontent.com")}/version.json`;
       releaseAsarURL = `${repository}/releases/download/latest/${productName}.asar.gz`;
     }
+    log("[updater] updateJsonURL", updateJsonURL);
+    log("[updater] releaseAsarURL", releaseAsarURL);
     const gzipPath = `../${productName}.asar.gz`;
     const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
     if ((0, import_node_fs2.existsSync)(tmpFile)) {
+      log("[updater] remove tmp file", tmpFile);
       await (0, import_promises.rm)(tmpFile);
     }
     const json = await download(updateJsonURL, "json");
@@ -219,15 +258,19 @@ function createUpdater({
       version,
       size
     } = json;
+    log("[updater] UpdateJSON", json);
     if (!needUpdate(version)) {
       return "unavailable";
     }
     updater.emit("downloadStart", size);
     const buffer = await download(releaseAsarURL, "buffer");
+    log("[updater] start verify");
     if (!verify(buffer, 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);
     await extractFile(gzipPath);
     return "success";
   }
@@ -266,7 +309,7 @@ function initApp(productName, updater, option) {
   createUpdater,
   getAppAsarPath,
   getAppVersion,
-  getElectronVersion,
+  getEntryVersion,
   getReleaseCdnLink,
   initApp,
   requireNative

package/dist/index.d.ts

@@ -72,6 +72,8 @@ interface UpdaterOption extends BaseOption {
      * `repository` will be used to determine the url
      */
     repository?: string;
+    debug?: boolean;
+    compareVersion?: (oldVersion: string, newVersion: string) => boolean;
     downloadConfig?: {
         /**
          * download user agent
@@ -107,11 +109,11 @@ interface UpdaterOption extends BaseOption {
  */
 declare function getAppAsarPath(name: string): string;
 /**
- * get the version of electron
+ * get the version of entry (app.asar)
  */
-declare function getElectronVersion(): string;
+declare function getEntryVersion(): string;
 /**
- * get the version of application
+ * get the version of application (name.asar)
  * @param name - The name of the application
  */
 declare function getAppVersion(name: string): string;
@@ -128,7 +130,7 @@ declare function getReleaseCdnLink(url: string): {
     maintainer: string;
 }[];
 
-declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, downloadConfig, }: UpdaterOption): Updater;
+declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, debug, downloadConfig, compareVersion, }: UpdaterOption): Updater;
 
 interface AppOption {
     /**
@@ -187,4 +189,4 @@ declare function initApp(productName: string, updater: Updater | Omit<UpdaterOpt
     productName?: string;
 }, option?: AppOption): any;
 
-export { BaseOption, CheckResultType, UpdateJSON, Updater, UpdaterOption, createUpdater, getAppAsarPath, getAppVersion, getElectronVersion, getReleaseCdnLink, initApp, requireNative };
+export { BaseOption, CheckResultType, UpdateJSON, Updater, UpdaterOption, createUpdater, getAppAsarPath, getAppVersion, getEntryVersion, getReleaseCdnLink, initApp, requireNative };

package/dist/index.mjs

@@ -14,7 +14,7 @@ import { createReadStream, createWriteStream, existsSync } from "node:fs";
 import { rm, writeFile } from "node:fs/promises";
 import { app as app2 } from "electron";
 
-// src/updater/download.ts
+// src/updater/defaultFunctions.ts
 import { Buffer } from "node:buffer";
 import https from "node:https";
 function downloadJSONDefault(url, updater, headers) {
@@ -60,6 +60,28 @@ function downloadBufferDefault(url, updater, headers) {
     });
   });
 }
+function compareVersionDefault(oldVersion, newVersion) {
+  if (!oldVersion || !newVersion) {
+    throw new TypeError("invalid version");
+  }
+  const parseVersion = (version) => {
+    const [versionNumber, stage] = version.split("-");
+    const [major, minor, patch] = versionNumber.split(".").map(Number);
+    if (isNaN(major) || isNaN(minor) || isNaN(patch)) {
+      throw new TypeError("invalid version");
+    }
+    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;
+  }
+  if (oldV.stage < newV.stage || !newV.stage && oldV.stage) {
+    return true;
+  }
+  return false;
+}
 
 // src/updater/utils.ts
 import { readFileSync } from "node:fs";
@@ -68,11 +90,11 @@ import { app } from "electron";
 function getAppAsarPath(name) {
   return app.isPackaged ? join(dirname(app.getAppPath()), `${name}.asar`) : "dev";
 }
-function getElectronVersion() {
+function getEntryVersion() {
   return app.getVersion();
 }
 function getAppVersion(name) {
-  return app.isPackaged ? readFileSync(join(getAppAsarPath(name), "version"), "utf-8").trim() : getElectronVersion();
+  return app.isPackaged ? readFileSync(join(getAppAsarPath(name), "version"), "utf-8").trim() : getEntryVersion();
 }
 function requireNative(packageName) {
   const path = app.isPackaged ? join(app.getAppPath(), "node_modules", packageName) : packageName;
@@ -113,10 +135,15 @@ function createUpdater({
   productName,
   releaseAsarURL: _release,
   updateJsonURL: _update,
-  downloadConfig
+  debug = false,
+  downloadConfig,
+  compareVersion
 }) {
   const updater = new EventEmitter();
   const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
+  function log(...args) {
+    debug && console.log(...args);
+  }
   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";
     const headers = {
@@ -124,6 +151,7 @@ function createUpdater({
       UserAgent: ua,
       ...extraHeader
     };
+    log("[updater] headers", headers);
     const downloadFn = format === "json" ? downloadJSON ?? downloadJSONDefault : downloadBuffer ?? downloadBufferDefault;
     return await downloadFn(url, updater, headers);
   }
@@ -137,25 +165,32 @@ function createUpdater({
       const input = createReadStream(gzipFilePath);
       const outputFilePath = gzipFilePath.replace(".tmp.gz", ".asar");
       const output = createWriteStream(outputFilePath);
+      log("[updater] outputFilePath", outputFilePath);
       input.pipe(gunzip).pipe(output).on("finish", async () => {
         await rm(gzipFilePath);
+        log("[updater] finish");
         resolve2(outputFilePath);
       }).on("error", async (err) => {
         await rm(gzipFilePath);
+        log("[updater] 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 needUpdate(version) {
-    const parseVersion = (version2) => {
-      const [major, minor, patch] = version2.split(".");
-      return ~~major * 100 + ~~minor * 10 + ~~patch;
-    };
-    return app2.isPackaged && parseVersion(app2.getVersion()) < parseVersion(version);
+    if (!version || !app2.isPackaged) {
+      return false;
+    }
+    const currentVersion = getEntryVersion();
+    log("[updater] currentVersion", currentVersion);
+    log("[updater] newVersion", version);
+    const _compare = compareVersion ?? compareVersionDefault;
+    return _compare(currentVersion, version);
   }
   async function checkUpdate(option) {
     let {
@@ -163,15 +198,19 @@ function createUpdater({
       releaseAsarURL = _release
     } = option || {};
     if (!updateJsonURL || !releaseAsarURL) {
+      log("[updater] no updateJsonURL or releaseAsarURL, use repository");
       if (!repository) {
         throw new Error("updateJsonURL or releaseAsarURL are not set");
       }
       updateJsonURL = `${repository.replace("github.com", "raw.githubusercontent.com")}/version.json`;
       releaseAsarURL = `${repository}/releases/download/latest/${productName}.asar.gz`;
     }
+    log("[updater] updateJsonURL", updateJsonURL);
+    log("[updater] releaseAsarURL", releaseAsarURL);
     const gzipPath = `../${productName}.asar.gz`;
     const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
     if (existsSync(tmpFile)) {
+      log("[updater] remove tmp file", tmpFile);
       await rm(tmpFile);
     }
     const json = await download(updateJsonURL, "json");
@@ -183,15 +222,19 @@ function createUpdater({
       version,
       size
     } = json;
+    log("[updater] UpdateJSON", json);
     if (!needUpdate(version)) {
       return "unavailable";
     }
     updater.emit("downloadStart", size);
     const buffer = await download(releaseAsarURL, "buffer");
+    log("[updater] start verify");
     if (!verify(buffer, signature)) {
       throw new Error("file broken, invalid signature!");
     }
+    log("[updater] write file", gzipPath);
     await writeFile(gzipPath, buffer);
+    log("[updater] extract file", gzipPath);
     await extractFile(gzipPath);
     return "success";
   }
@@ -229,7 +272,7 @@ export {
   createUpdater,
   getAppAsarPath,
   getAppVersion,
-  getElectronVersion,
+  getEntryVersion,
   getReleaseCdnLink,
   initApp,
   requireNative

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "electron-incremental-update",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup",
-    "release": "tsup && bumpp"
+    "release": "pnpm test && pnpm run build && bumpp && npm publish",
+    "test": "vitest --run"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "repository": "https://github.com/subframe7536/electron-incremental-update",
   "type": "module",
@@ -52,13 +57,10 @@
     "fs-jetpack": "^5.1.0",
     "tsup": "^6.7.0",
     "typescript": "^5.1.3",
-    "vite": "^4.3.9"
+    "vite": "^4.3.9",
+    "vitest": "^0.32.2"
   },
   "dependencies": {
     "ci-info": "^3.8.0"
-  },
-  "peerDependencies": {
-    "@electron/asar": "*",
-    "asar": "*"
   }
 }