electron-incremental-update 0.1.1 → 0.1.2

package/README.md

@@ -47,7 +47,7 @@ const SIGNATURE_PUB = '' // auto generate RSA public key when start app
 
 const updater = createUpdater({
   SIGNATURE_PUB,
-  githubRepository: repository,
+  repository,
   productName: name,
 })
 initApp(name, updater)

package/dist/index.cjs

@@ -91,14 +91,20 @@ var import_node_https = __toESM(require("https"), 1);
 var import_electron2 = require("electron");
 function createUpdater({
   SIGNATURE_PUB,
-  githubRepository,
+  repository,
   productName,
-  releaseCdnPrefix: _release,
-  updateJsonURL: _update
+  releaseAsarURL: _release,
+  updateJsonURL: _update,
+  userAgent,
+  extraHeader
 }) {
   const updater = new import_node_events.EventEmitter();
   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";
+    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 commonHeader = {
+      UserAgent: ua,
+      ...extraHeader
+    };
     return await new Promise((resolve2, reject) => {
       import_node_https.default.get(url, (res) => {
         if (format === "json") {
@@ -106,7 +112,7 @@ function createUpdater({
           res.setEncoding("utf8");
           res.headers = {
             Accept: "application/json",
-            UserAgent: ua
+            ...commonHeader
           };
           res.on("data", (chunk) => data += chunk);
           res.on("end", () => {
@@ -116,7 +122,7 @@ function createUpdater({
           let data = [];
           res.headers = {
             Accept: "application/octet-stream",
-            UserAgent: ua
+            ...commonHeader
           };
           res.on("data", (chunk) => {
             updater.emit("downloading", chunk.length);
@@ -164,17 +170,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 +193,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

@@ -8,9 +8,19 @@ type UpdateEvents = {
     donwnloadError: [error: unknown];
 };
 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 +30,52 @@ 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;
+    /**
+     * 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>;
 }
-declare function createUpdater({ SIGNATURE_PUB, githubRepository, productName, releaseCdnPrefix: _release, updateJsonURL: _update, }: Options): Updater;
+declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, userAgent, extraHeader, }: Options): Updater;
 
 declare function getAppAsarPath(name: string): string;
 declare function getElectronVersion(): string;

package/dist/index.mjs

@@ -55,14 +55,20 @@ import https from "node:https";
 import { app as app2 } from "electron";
 function createUpdater({
   SIGNATURE_PUB,
-  githubRepository,
+  repository,
   productName,
-  releaseCdnPrefix: _release,
-  updateJsonURL: _update
+  releaseAsarURL: _release,
+  updateJsonURL: _update,
+  userAgent,
+  extraHeader
 }) {
   const updater = new EventEmitter();
   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";
+    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 commonHeader = {
+      UserAgent: ua,
+      ...extraHeader
+    };
     return await new Promise((resolve2, reject) => {
       https.get(url, (res) => {
         if (format === "json") {
@@ -70,7 +76,7 @@ function createUpdater({
           res.setEncoding("utf8");
           res.headers = {
             Accept: "application/json",
-            UserAgent: ua
+            ...commonHeader
           };
           res.on("data", (chunk) => data += chunk);
           res.on("end", () => {
@@ -80,7 +86,7 @@ function createUpdater({
           let data = [];
           res.headers = {
             Accept: "application/octet-stream",
-            UserAgent: ua
+            ...commonHeader
           };
           res.on("data", (chunk) => {
             updater.emit("downloading", chunk.length);
@@ -128,17 +134,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 +157,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

@@ -47,6 +47,11 @@ type Options = {
          * @default `dist`
          */
         rendererDistPath?: string;
+        /**
+         * Path to version info output
+         * @default `version.json`
+         */
+        versionPath?: string;
     };
     keys?: {
         /**

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.2",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup",