electron-incremental-update 0.1.1 → 0.1.3

package/README.md

@@ -1,25 +1,37 @@
 ## electron incremental updater
 
-inspired by Obsidian's update strategy, using RSA + Signature to sign the update asar and replace the old one when verified
+provider a vite plugin and useful functions to generate updater and split entry file and real app
+
+### principle
+
+using two asar, `app.asar` and `main.asar` (if "main" is your app's name)
+
+the `app.asar` is used to load `main.asar` and initialize the updater
+
+using RSA + Signature to sign the new `main.asar` downloaded from remote and replace the old one when verified
+
+- inspired by Obsidian's update strategy
+
+### notice
 
 develop with [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron), and may be effect in other electron vite frameworks
 
-### install
+## install
 
-#### npm
+### npm
 ```bash
 npm install electron-incremental-update
 ```
-#### yarn
+### yarn
 ```bash
 yarn add electron-incremental-update
 ```
-#### pnpm
+### pnpm
 ```bash
 pnpm add electron-incremental-update
 ```
 
-### usage
+## usage
 
 base on [electron-vite-vue](https://github.com/electron-vite/electron-vite-vue)
 
@@ -36,7 +48,7 @@ src
 └── ...
 ```
 
-#### setup app
+### setup app
 
 ```ts
 // electron/app.ts
@@ -47,13 +59,13 @@ const SIGNATURE_PUB = '' // auto generate RSA public key when start app
 
 const updater = createUpdater({
   SIGNATURE_PUB,
-  githubRepository: repository,
+  repository,
   productName: name,
 })
 initApp(name, updater)
 ```
 
-#### setup main
+### setup main
 
 ```ts
 // electron/main/index.ts
@@ -103,7 +115,7 @@ export default function (updater: Updater) {
 }
 ```
 
-#### use native modules
+### use native modules
 
 ```ts
 // db.ts
@@ -128,7 +140,7 @@ console.log(r)
 db.close()
 ```
 
-#### setup vite.config.ts
+### setup vite.config.ts
 
 ```ts
 import { rmSync } from 'node:fs'
@@ -189,7 +201,7 @@ export default defineConfig(({ command }) => {
 })
 ```
 
-##### option
+#### option
 
 ```ts
 type Options = {
@@ -213,6 +225,9 @@ type Options = {
    * Whether to minify
    */
   minify?: boolean
+  /**
+   * path config
+   */
   paths?: {
     /**
      * Path to app entry file
@@ -225,7 +240,7 @@ type Options = {
      */
     entryOutputPath?: string
     /**
-     * Path to app entry file
+     * Path to asar file
      * @default `release/${ProductName}.asar`
      */
     asarOutputPath?: string
@@ -239,7 +254,15 @@ type Options = {
      * @default `dist`
      */
     rendererDistPath?: string
+    /**
+     * Path to version info output
+     * @default `version.json`
+     */
+    versionPath?: string
   }
+  /**
+   * signature config
+   */
   keys?: {
     /**
      * Path to the pem file that contains private key
@@ -262,7 +285,7 @@ type Options = {
 }
 ```
 
-#### electron-builder config
+### electron-builder config
 
 ```js
 const { name } = require('./package.json')

package/dist/index.cjs

@@ -89,49 +89,68 @@ var import_node_fs2 = require("fs");
 var import_promises = require("fs/promises");
 var import_node_https = __toESM(require("https"), 1);
 var import_electron2 = require("electron");
+function downloadJSONDefault(url, updater, headers) {
+  return new Promise((resolve2, reject) => {
+    import_node_https.default.get(url, (res) => {
+      let data = "";
+      res.setEncoding("utf8");
+      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);
+        } else {
+          throw new Error("invalid update json");
+        }
+      });
+    }).on("error", (e) => {
+      e && updater.emit("donwnloadError", e);
+      updater.emit("downloadEnd", false);
+      reject(e);
+    });
+  });
+}
+function downloadBufferDefault(url, updater, headers) {
+  return new Promise((resolve2, reject) => {
+    import_node_https.default.get(url, (res) => {
+      let data = [];
+      res.headers = headers;
+      res.on("data", (chunk) => {
+        updater.emit("downloading", chunk.length);
+        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);
+    });
+  });
+}
 function createUpdater({
   SIGNATURE_PUB,
-  githubRepository,
+  repository,
   productName,
-  releaseCdnPrefix: _release,
-  updateJsonURL: _update
+  releaseAsarURL: _release,
+  updateJsonURL: _update,
+  downloadConfig
 }) {
   const updater = new import_node_events.EventEmitter();
+  const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
   async function download(url, format) {
-    const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
-    return await new Promise((resolve2, reject) => {
-      import_node_https.default.get(url, (res) => {
-        if (format === "json") {
-          let data = "";
-          res.setEncoding("utf8");
-          res.headers = {
-            Accept: "application/json",
-            UserAgent: ua
-          };
-          res.on("data", (chunk) => data += chunk);
-          res.on("end", () => {
-            resolve2(JSON.parse(data));
-          });
-        } else if (format === "buffer") {
-          let data = [];
-          res.headers = {
-            Accept: "application/octet-stream",
-            UserAgent: ua
-          };
-          res.on("data", (chunk) => {
-            updater.emit("downloading", chunk.length);
-            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);
-        reject(e);
-      });
-    });
+    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
+    };
+    const downloadFn = format === "json" ? downloadJSON ?? downloadJSONDefault : downloadBuffer ?? downloadBufferDefault;
+    return await downloadFn(url, updater, headers);
   }
   async function extractFile(gzipFilePath) {
     if (!gzipFilePath.endsWith(".asar.gz") || !(0, import_node_fs2.existsSync)(gzipFilePath)) {
@@ -164,17 +183,21 @@ function createUpdater({
     return import_electron2.app.isPackaged && parseVersion(import_electron2.app.getVersion()) < parseVersion(version);
   }
   async function checkUpdate(option) {
-    const { releaseCdnPrefix, updateJsonURL } = option || {};
+    let {
+      updateJsonURL = _update,
+      releaseAsarURL = _release
+    } = option || {};
+    if ((!updateJsonURL || !releaseAsarURL) && !repository) {
+      throw new Error("updateJsonURL or releaseAsarURL are not set");
+    }
+    updateJsonURL ??= `${repository}/version.json`;
+    releaseAsarURL ??= `${repository}/releases/download/latest/${productName}.asar.gz`;
     const gzipPath = `../${productName}.asar.gz`;
     const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
-    const base = githubRepository.replace("https://github.com", "");
-    const updateJSONUrl = updateJsonURL ?? _update ?? `https://cdn.jsdelivr.net/gh/${base}/version.json`;
-    const prefix = releaseCdnPrefix ?? _release;
-    const downloadUrl = `${prefix ? `${prefix}/${base}` : githubRepository}/releases/download/latest/${productName}.asar.gz`;
     if ((0, import_node_fs2.existsSync)(tmpFile)) {
       await (0, import_promises.rm)(tmpFile);
     }
-    const json = await download(updateJSONUrl, "json");
+    const json = await download(updateJsonURL, "json");
     if (!json) {
       throw new Error("fetch update json failed");
     }
@@ -183,12 +206,11 @@ function createUpdater({
       version,
       size
     } = json;
-    console.log(version, size, signature);
     if (!needUpdate(version)) {
       return "unavailable";
     }
     updater.emit("downloadStart", size);
-    const buffer = await download(downloadUrl, "buffer");
+    const buffer = await download(releaseAsarURL, "buffer");
     if (!verify(buffer, signature)) {
       throw new Error("file broken, invalid signature!");
     }

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Buffer } from 'node:buffer';
+
 type CheckResultType = 'success' | 'fail' | 'unavailable';
 type UpdateEvents = {
     check: null;
@@ -7,10 +9,25 @@ type UpdateEvents = {
     downloadEnd: [success: boolean];
     donwnloadError: [error: unknown];
 };
+type UpdateJSON = {
+    signature: string;
+    version: string;
+    size: number;
+};
 type MaybeArray<T> = T extends undefined | null | never ? [] : T extends any[] ? T['length'] extends 1 ? [data: T[0]] : T : [data: T];
-interface CheckUpdateOption {
+interface UpdateOption {
+    /**
+     * URL of version info json
+     * @default `${repository}/version.json`
+     * @throws if `updateJsonURL` and `repository` are all not set
+     */
     updateJsonURL?: string;
-    releaseCdnPrefix?: string;
+    /**
+     * URL of release asar.gz
+     * @default `${repository}/releases/download/latest/${productName}.asar.gz`
+     * @throws if `releaseAsarURL` and `repository` are all not set
+     */
+    releaseAsarURL?: string;
 }
 interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event extends Exclude<keyof T, number> = Exclude<keyof T, number>> {
     removeAllListeners<E extends Event>(event?: E): this;
@@ -20,15 +37,70 @@ 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?: CheckUpdateOption): Promise<void>;
+    checkUpdate(options?: UpdateOption): Promise<void>;
 }
 type Updater = TypedUpdater<UpdateEvents>;
-interface Options extends CheckUpdateOption {
+interface Options extends UpdateOption {
+    /**
+     * public key of signature
+     *
+     * it will be auto generated by plugin
+     * @example
+     * ```ts
+     * // auto filled by plugin
+     * const SIGNATURE_PUB = ''
+     *
+     * const updater = createUpdater({
+     *   SIGNATURE_PUB,
+     *   ...
+     * })
+     * ```
+     */
     SIGNATURE_PUB: string;
+    /**
+     * product name
+     *
+     * you can use the `name` in `package.json`
+     */
     productName: string;
-    githubRepository: string;
+    /**
+     * repository url, e.g. `https://github.com/electron/electron`
+     *
+     * you can use the `repository` in `package.json`
+     *
+     * if `updateJsonURL` or `releaseAsarURL` are absent,
+     * `repository` will be used to determine the url
+     */
+    repository?: string;
+    downloadConfig?: {
+        /**
+         * download user agent
+       * @default 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36'
+        */
+        userAgent?: string;
+        /**
+        * extra download header, `accept` and `user-agent` is set by default
+       */
+        extraHeader?: Record<string, string>;
+        /**
+         * download JSON function
+         * @param url download url
+         * @param updater updater, emit events
+         * @param header download header
+         * @returns `UpdateJSON`
+         */
+        downloadJSON?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
+        /**
+         * download buffer function
+         * @param url download url
+         * @param updater updater, emit events
+         * @param header download header
+         * @returns `Buffer`
+         */
+        downloadBuffer?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
+    };
 }
-declare function createUpdater({ SIGNATURE_PUB, githubRepository, productName, releaseCdnPrefix: _release, updateJsonURL: _update, }: Options): Updater;
+declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, downloadConfig, }: Options): Updater;
 
 declare function getAppAsarPath(name: string): string;
 declare function getElectronVersion(): string;

package/dist/index.mjs

@@ -53,49 +53,68 @@ import { createReadStream, createWriteStream, existsSync } from "node:fs";
 import { rm, writeFile } from "node:fs/promises";
 import https from "node:https";
 import { app as app2 } from "electron";
+function downloadJSONDefault(url, updater, headers) {
+  return new Promise((resolve2, reject) => {
+    https.get(url, (res) => {
+      let data = "";
+      res.setEncoding("utf8");
+      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);
+        } else {
+          throw new Error("invalid update json");
+        }
+      });
+    }).on("error", (e) => {
+      e && updater.emit("donwnloadError", e);
+      updater.emit("downloadEnd", false);
+      reject(e);
+    });
+  });
+}
+function downloadBufferDefault(url, updater, headers) {
+  return new Promise((resolve2, reject) => {
+    https.get(url, (res) => {
+      let data = [];
+      res.headers = headers;
+      res.on("data", (chunk) => {
+        updater.emit("downloading", chunk.length);
+        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);
+    });
+  });
+}
 function createUpdater({
   SIGNATURE_PUB,
-  githubRepository,
+  repository,
   productName,
-  releaseCdnPrefix: _release,
-  updateJsonURL: _update
+  releaseAsarURL: _release,
+  updateJsonURL: _update,
+  downloadConfig
 }) {
   const updater = new EventEmitter();
+  const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
   async function download(url, format) {
-    const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
-    return await new Promise((resolve2, reject) => {
-      https.get(url, (res) => {
-        if (format === "json") {
-          let data = "";
-          res.setEncoding("utf8");
-          res.headers = {
-            Accept: "application/json",
-            UserAgent: ua
-          };
-          res.on("data", (chunk) => data += chunk);
-          res.on("end", () => {
-            resolve2(JSON.parse(data));
-          });
-        } else if (format === "buffer") {
-          let data = [];
-          res.headers = {
-            Accept: "application/octet-stream",
-            UserAgent: ua
-          };
-          res.on("data", (chunk) => {
-            updater.emit("downloading", chunk.length);
-            data.push(chunk);
-          });
-          res.on("end", () => {
-            updater.emit("downloadEnd", true);
-            resolve2(Buffer.concat(data));
-          });
-        }
-      }).on("error", (e) => {
-        e && updater.emit("donwnloadError", e);
-        reject(e);
-      });
-    });
+    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
+    };
+    const downloadFn = format === "json" ? downloadJSON ?? downloadJSONDefault : downloadBuffer ?? downloadBufferDefault;
+    return await downloadFn(url, updater, headers);
   }
   async function extractFile(gzipFilePath) {
     if (!gzipFilePath.endsWith(".asar.gz") || !existsSync(gzipFilePath)) {
@@ -128,17 +147,21 @@ function createUpdater({
     return app2.isPackaged && parseVersion(app2.getVersion()) < parseVersion(version);
   }
   async function checkUpdate(option) {
-    const { releaseCdnPrefix, updateJsonURL } = option || {};
+    let {
+      updateJsonURL = _update,
+      releaseAsarURL = _release
+    } = option || {};
+    if ((!updateJsonURL || !releaseAsarURL) && !repository) {
+      throw new Error("updateJsonURL or releaseAsarURL are not set");
+    }
+    updateJsonURL ??= `${repository}/version.json`;
+    releaseAsarURL ??= `${repository}/releases/download/latest/${productName}.asar.gz`;
     const gzipPath = `../${productName}.asar.gz`;
     const tmpFile = gzipPath.replace(".asar.gz", ".tmp.gz");
-    const base = githubRepository.replace("https://github.com", "");
-    const updateJSONUrl = updateJsonURL ?? _update ?? `https://cdn.jsdelivr.net/gh/${base}/version.json`;
-    const prefix = releaseCdnPrefix ?? _release;
-    const downloadUrl = `${prefix ? `${prefix}/${base}` : githubRepository}/releases/download/latest/${productName}.asar.gz`;
     if (existsSync(tmpFile)) {
       await rm(tmpFile);
     }
-    const json = await download(updateJSONUrl, "json");
+    const json = await download(updateJsonURL, "json");
     if (!json) {
       throw new Error("fetch update json failed");
     }
@@ -147,12 +170,11 @@ function createUpdater({
       version,
       size
     } = json;
-    console.log(version, size, signature);
     if (!needUpdate(version)) {
       return "unavailable";
     }
     updater.emit("downloadStart", size);
-    const buffer = await download(downloadUrl, "buffer");
+    const buffer = await download(releaseAsarURL, "buffer");
     if (!verify(buffer, signature)) {
       throw new Error("file broken, invalid signature!");
     }

package/dist/vite.cjs

@@ -140,7 +140,8 @@ async function buildAsar({
   asarOutputPath,
   privateKeyPath,
   electronDistPath,
-  rendererDistPath
+  rendererDistPath,
+  versionPath
 }) {
   await (0, import_promises2.rename)(rendererDistPath, `${electronDistPath}/renderer`);
   await (0, import_promises2.writeFile)(`${electronDistPath}/version`, version);
@@ -151,7 +152,7 @@ async function buildAsar({
   await gzipFile(asarOutputPath);
   const buffer = await (0, import_promises2.readFile)(`${asarOutputPath}.gz`);
   const signature = generateSignature(buffer, await (0, import_promises2.readFile)(privateKeyPath, "utf-8"));
-  await (0, import_promises2.writeFile)("version.json", JSON.stringify({
+  await (0, import_promises2.writeFile)(versionPath, JSON.stringify({
     signature,
     version,
     size: buffer.length
@@ -166,7 +167,8 @@ function parseOptions(options) {
     entryOutputPath = "app.js",
     asarOutputPath = `release/${productName}.asar`,
     electronDistPath = "dist-electron",
-    rendererDistPath = "dist"
+    rendererDistPath = "dist",
+    versionPath = "version.json"
   } = paths;
   const {
     privateKeyPath = "public/private.pem",
@@ -175,11 +177,11 @@ function parseOptions(options) {
   } = keys;
   const buildAsarOption = {
     version,
-    productName,
     asarOutputPath,
     privateKeyPath,
     electronDistPath,
-    rendererDistPath
+    rendererDistPath,
+    versionPath
   };
   const buildEntryOption = {
     privateKeyPath,

package/dist/vite.d.ts

@@ -8,19 +8,22 @@ type Options = {
     /**
      * the name of you application
      *
-     * you can set as 'name' in package.json
+     * you can set as 'name' in `package.json`
     */
     productName: string;
     /**
      * the version of you application
      *
-     * you can set as 'version' in package.json
+     * you can set as 'version' in `package.json`
      */
     version: string;
     /**
-     * Whether to minify
+     * Whether to minify entry file
      */
     minify?: boolean;
+    /**
+     * paths config
+     */
     paths?: {
         /**
          * Path to app entry file
@@ -33,7 +36,7 @@ type Options = {
          */
         entryOutputPath?: string;
         /**
-         * Path to app entry file
+         * Path to asar file
          * @default `release/${ProductName}.asar`
          */
         asarOutputPath?: string;
@@ -47,7 +50,15 @@ type Options = {
          * @default `dist`
          */
         rendererDistPath?: string;
+        /**
+         * Path to version info output
+         * @default `version.json`
+         */
+        versionPath?: string;
     };
+    /**
+     * signature config
+     */
     keys?: {
         /**
          * Path to the pem file that contains private key

package/dist/vite.mjs

@@ -108,7 +108,8 @@ async function buildAsar({
   asarOutputPath,
   privateKeyPath,
   electronDistPath,
-  rendererDistPath
+  rendererDistPath,
+  versionPath
 }) {
   await rename(rendererDistPath, `${electronDistPath}/renderer`);
   await writeFile2(`${electronDistPath}/version`, version);
@@ -119,7 +120,7 @@ async function buildAsar({
   await gzipFile(asarOutputPath);
   const buffer = await readFile2(`${asarOutputPath}.gz`);
   const signature = generateSignature(buffer, await readFile2(privateKeyPath, "utf-8"));
-  await writeFile2("version.json", JSON.stringify({
+  await writeFile2(versionPath, JSON.stringify({
     signature,
     version,
     size: buffer.length
@@ -134,7 +135,8 @@ function parseOptions(options) {
     entryOutputPath = "app.js",
     asarOutputPath = `release/${productName}.asar`,
     electronDistPath = "dist-electron",
-    rendererDistPath = "dist"
+    rendererDistPath = "dist",
+    versionPath = "version.json"
   } = paths;
   const {
     privateKeyPath = "public/private.pem",
@@ -143,11 +145,11 @@ function parseOptions(options) {
   } = keys;
   const buildAsarOption = {
     version,
-    productName,
     asarOutputPath,
     privateKeyPath,
     electronDistPath,
-    rendererDistPath
+    rendererDistPath,
+    versionPath
   };
   const buildEntryOption = {
     privateKeyPath,

package/package.json

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