electron-incremental-update 0.7.4 → 0.7.5

package/README.md

@@ -55,30 +55,27 @@ src
 
 ```ts
 // electron/app.ts
-import { createUpdater, getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
+import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
 import { name, repository } from '../package.json'
 
 const SIGNATURE_CERT = '' // auto generate certificate when start app
 
-// create updater when init, no need to set productName
-initApp({ onStart: console.log }, { productName: name, SIGNATURE_CERT, repository })
-
-// or create updater manually
 const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
-const updater = createUpdater({
-  SIGNATURE_CERT,
-  productName: name,
-  repository,
-  updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
-  releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
-  debug: true,
-})
-initApp().setUpdater(updater)
+initApp({ onStart: console.log })
+  // can be updater option or function that return updater
+  .setUpdater({
+    SIGNATURE_CERT,
+    productName: name,
+    repository,
+    updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
+    releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
+    debug: true,
+  })
 ```
 
 ### usage in main process
 
-To utilize the electron `net` module for requesting update information, the `checkUpdate` and `downloadAndInstall` functions must be called after the app is ready by default.
+To utilize the electron `net` module for requesting update information, the `checkUpdate` and `download` functions must be called after the app is ready by default.
 
 However, you have the option to customize the download function when creating the updater.
 

package/dist/{chunk-L3QO4PD3.mjs → chunk-67MCNA7W.mjs}

@@ -33,22 +33,31 @@ function parseGithubCdnURL(repository, cdnPrefix, relativeFilePath) {
   cdnPrefix = cdnPrefix.trim().replace(/^\/?|\/?$/g, "").trim();
   return repository.replace("github.com", cdnPrefix) + relativeFilePath;
 }
+function getGithubFileCdnGroup() {
+  return [
+    { cdnPrefix: "cdn.jsdelivr.net/gh", source: "jsdelivr" },
+    { cdnPrefix: "fastly.jsdelivr.net/gh", source: "jsdelivr-fastly" },
+    { cdnPrefix: "cdn.statically.io/gh", source: "statically" },
+    { cdnPrefix: "rawcdn.githack.com/gh", source: "githack" },
+    { cdnPrefix: "raw.githack.com/gh", source: "githack-dev" }
+  ];
+}
 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" }
+    { cdnPrefix: "gh.gh2233.ml", source: "@X.I.U/XIU2" },
+    { cdnPrefix: "ghproxy.com", source: "gh-proxy" },
+    { cdnPrefix: "gh.ddlc.top", source: "@mtr-static-official" },
+    { cdnPrefix: "ghdl.feizhuqwq.cf", source: "feizhuqwq.com" },
+    { cdnPrefix: "slink.ltd", source: "\u77E5\u4E86\u5C0F\u7AD9" },
+    { cdnPrefix: "git.xfj0.cn", source: "anonymous1" },
+    { cdnPrefix: "gh.con.sh", source: "anonymous2" },
+    { cdnPrefix: "ghps.cc", source: "anonymous3" },
+    { cdnPrefix: "cors.isteed.cc/github.com", source: "Lufs's" },
+    { cdnPrefix: "hub.gitmirror.com", source: "GitMirror" },
+    { cdnPrefix: "js.xxooo.ml", source: "\u996D\u592A\u786C" },
+    { cdnPrefix: "download.njuu.cf", source: "LibraryCloud-njuu" },
+    { cdnPrefix: "download.yzuu.cf", source: "LibraryCloud-yzuu" },
+    { cdnPrefix: "download.nuaa.cf", source: "LibraryCloud-nuaa" }
   ];
 }
 function restartApp() {
@@ -113,6 +122,7 @@ export {
   getProductVersion,
   requireNative,
   parseGithubCdnURL,
+  getGithubFileCdnGroup,
   getGithubReleaseCdnGroup,
   restartApp,
   waitAppReady,

package/dist/index.d.mts

@@ -163,43 +163,34 @@ type AppOption = {
     onStartError?: (err: unknown) => void;
 };
 type StartupWithUpdater = (updater: Updater) => void;
+type SetUpdater = {
+    /**
+     * set updater option or create function
+     */
+    setUpdater: (updater: (() => Updater | Promise<Updater>) | UpdaterOption) => void;
+};
 /**
  * create updater manually
  * @example
  * ```ts
- * import { createUpdater, getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
+ * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
  * import { name, repository } from '../package.json'
  *
- * const SIGNATURE_CERT = '' // auto generate
+ * const SIGNATURE_CERT = '' // auto generate certificate when start app
  *
  * const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
- * const updater = createUpdater({
- *   SIGNATURE_CERT,
- *   productName: name,
- *   repository,
- *   updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
- *   releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
- *   debug: true,
- * })
- * initApp().setUpdater(updater)
- * ```
- */
-declare function initApp(appOptions: AppOption): {
-    setUpdater: (updater: Updater) => void;
-};
-/**
- * create updater when init, no need to set productName
- *
- * @example
- * ```ts
- * import { initApp } from 'electron-incremental-update'
- * import { name, repository } from '../package.json'
- *
- * const SIGNATURE_CERT = '' // auto generate
- *
- * initApp({ onStart: console.log }, { productName: name, SIGNATURE_CERT, repository })
+ * initApp({ onStart: console.log })
+ *   // can be updater option or function that return updater
+ *   .setUpdater({
+ *     SIGNATURE_CERT,
+ *     productName: name,
+ *     repository,
+ *     updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
+ *     releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
+ *     debug: true,
+ *   })
  * ```
  */
-declare function initApp(appOptions: AppOption, updaterOptions: UpdaterOption): undefined;
+declare function initApp(appOptions?: AppOption): SetUpdater;
 
 export { AppOption, FunctionCompareVersion, FunctionVerifySignature, StartupWithUpdater, UpdateJSON, Updater, UpdaterOption, createUpdater, initApp };

package/dist/index.d.ts

@@ -163,43 +163,34 @@ type AppOption = {
     onStartError?: (err: unknown) => void;
 };
 type StartupWithUpdater = (updater: Updater) => void;
+type SetUpdater = {
+    /**
+     * set updater option or create function
+     */
+    setUpdater: (updater: (() => Updater | Promise<Updater>) | UpdaterOption) => void;
+};
 /**
  * create updater manually
  * @example
  * ```ts
- * import { createUpdater, getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
+ * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
  * import { name, repository } from '../package.json'
  *
- * const SIGNATURE_CERT = '' // auto generate
+ * const SIGNATURE_CERT = '' // auto generate certificate when start app
  *
  * const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
- * const updater = createUpdater({
- *   SIGNATURE_CERT,
- *   productName: name,
- *   repository,
- *   updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
- *   releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
- *   debug: true,
- * })
- * initApp().setUpdater(updater)
- * ```
- */
-declare function initApp(appOptions: AppOption): {
-    setUpdater: (updater: Updater) => void;
-};
-/**
- * create updater when init, no need to set productName
- *
- * @example
- * ```ts
- * import { initApp } from 'electron-incremental-update'
- * import { name, repository } from '../package.json'
- *
- * const SIGNATURE_CERT = '' // auto generate
- *
- * initApp({ onStart: console.log }, { productName: name, SIGNATURE_CERT, repository })
+ * initApp({ onStart: console.log })
+ *   // can be updater option or function that return updater
+ *   .setUpdater({
+ *     SIGNATURE_CERT,
+ *     productName: name,
+ *     repository,
+ *     updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
+ *     releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
+ *     debug: true,
+ *   })
  * ```
  */
-declare function initApp(appOptions: AppOption, updaterOptions: UpdaterOption): undefined;
+declare function initApp(appOptions?: AppOption): SetUpdater;
 
 export { AppOption, FunctionCompareVersion, FunctionVerifySignature, StartupWithUpdater, UpdateJSON, Updater, UpdaterOption, createUpdater, initApp };

package/dist/index.js

@@ -334,12 +334,17 @@ function createUpdater(updaterOptions) {
 }
 
 // src/index.ts
-function initApp({
-  electronDevDistPath = "dist-electron",
-  mainPath = "main/index.js",
-  onStart,
-  onStartError
-}, updaterOptions) {
+function initApp(appOptions) {
+  const {
+    electronDevDistPath = "dist-electron",
+    mainPath = "main/index.js",
+    onStart,
+    onStartError
+  } = appOptions || {};
+  function handleError(msg) {
+    onStartError?.(new Error(msg));
+    import_electron4.app.quit();
+  }
   function startup(updater) {
     try {
       const asarPath = getProductAsarPath(updater.productName);
@@ -351,30 +356,24 @@ function initApp({
       onStart?.(entry);
       require(entry)(updater);
     } catch (error) {
-      if (onStartError) {
-        onStartError(error);
-      } else {
-        console.error("fail to start app,", error);
-        import_electron4.app.quit();
-        process.exit(1);
-      }
+      handleError(`failed to start app, ${error}`);
     }
   }
-  if (updaterOptions) {
-    startup(createUpdater(updaterOptions));
-  } else {
-    let timer = setTimeout(() => {
-      console.error("start app timeout, please call .setUpdater() to set updater and start");
-      import_electron4.app.quit();
-      process.exit(1);
-    }, 3e3);
-    return {
-      setUpdater(updater) {
-        clearTimeout(timer);
-        startup(updater);
+  let timer = setTimeout(() => {
+    handleError("start app timeout, please call .setUpdater() to set updater and start");
+  }, 3e3);
+  return {
+    async setUpdater(updater) {
+      clearTimeout(timer);
+      if (typeof updater === "object") {
+        startup(createUpdater(updater));
+      } else if (typeof updater === "function") {
+        startup(await updater());
+      } else {
+        handleError("invalid updater option or updater is not a function");
       }
-    };
-  }
+    }
+  };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -7,7 +7,7 @@ import {
   getProductAsarPath,
   unzipFile,
   waitAppReady
-} from "./chunk-L3QO4PD3.mjs";
+} from "./chunk-67MCNA7W.mjs";
 
 // src/index.ts
 import { resolve } from "node:path";
@@ -258,12 +258,17 @@ function createUpdater(updaterOptions) {
 }
 
 // src/index.ts
-function initApp({
-  electronDevDistPath = "dist-electron",
-  mainPath = "main/index.js",
-  onStart,
-  onStartError
-}, updaterOptions) {
+function initApp(appOptions) {
+  const {
+    electronDevDistPath = "dist-electron",
+    mainPath = "main/index.js",
+    onStart,
+    onStartError
+  } = appOptions || {};
+  function handleError(msg) {
+    onStartError?.(new Error(msg));
+    app2.quit();
+  }
   function startup(updater) {
     try {
       const asarPath = getProductAsarPath(updater.productName);
@@ -275,30 +280,24 @@ function initApp({
       onStart?.(entry);
       __require(entry)(updater);
     } catch (error) {
-      if (onStartError) {
-        onStartError(error);
-      } else {
-        console.error("fail to start app,", error);
-        app2.quit();
-        process.exit(1);
-      }
+      handleError(`failed to start app, ${error}`);
     }
   }
-  if (updaterOptions) {
-    startup(createUpdater(updaterOptions));
-  } else {
-    let timer = setTimeout(() => {
-      console.error("start app timeout, please call .setUpdater() to set updater and start");
-      app2.quit();
-      process.exit(1);
-    }, 3e3);
-    return {
-      setUpdater(updater) {
-        clearTimeout(timer);
-        startup(updater);
+  let timer = setTimeout(() => {
+    handleError("start app timeout, please call .setUpdater() to set updater and start");
+  }, 3e3);
+  return {
+    async setUpdater(updater) {
+      clearTimeout(timer);
+      if (typeof updater === "object") {
+        startup(createUpdater(updater));
+      } else if (typeof updater === "function") {
+        startup(await updater());
+      } else {
+        handleError("invalid updater option or updater is not a function");
       }
-    };
-  }
+    }
+  };
 }
 export {
   createUpdater,

package/dist/utils.d.mts

@@ -21,12 +21,19 @@ 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 file CDN prefix for accelerating the speed of downloading release
+ */
+declare function getGithubFileCdnGroup(): {
+    cdnPrefix: string;
+    source: string;
+}[];
 /**
  * get group of github release CDN prefix for accelerating the speed of downloading release
  */
 declare function getGithubReleaseCdnGroup(): {
     cdnPrefix: string;
-    maintainer: string;
+    source: string;
 }[];
 declare function restartApp(): void;
 declare function waitAppReady(duration?: number): Promise<unknown>;
@@ -34,4 +41,4 @@ declare function unzipFile(gzipPath: string, targetFilePath: string): Promise<un
 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 };
+export { getEntryVersion, getGithubFileCdnGroup, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, requireNative, restartApp, unzipFile, waitAppReady, zipFile };

package/dist/utils.d.ts

@@ -21,12 +21,19 @@ 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 file CDN prefix for accelerating the speed of downloading release
+ */
+declare function getGithubFileCdnGroup(): {
+    cdnPrefix: string;
+    source: string;
+}[];
 /**
  * get group of github release CDN prefix for accelerating the speed of downloading release
  */
 declare function getGithubReleaseCdnGroup(): {
     cdnPrefix: string;
-    maintainer: string;
+    source: string;
 }[];
 declare function restartApp(): void;
 declare function waitAppReady(duration?: number): Promise<unknown>;
@@ -34,4 +41,4 @@ declare function unzipFile(gzipPath: string, targetFilePath: string): Promise<un
 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 };
+export { getEntryVersion, getGithubFileCdnGroup, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, handleUnexpectedErrors, parseGithubCdnURL, requireNative, restartApp, unzipFile, waitAppReady, zipFile };

package/dist/utils.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var utils_exports = {};
 __export(utils_exports, {
   getEntryVersion: () => getEntryVersion,
+  getGithubFileCdnGroup: () => getGithubFileCdnGroup,
   getGithubReleaseCdnGroup: () => getGithubReleaseCdnGroup,
   getProductAsarPath: () => getProductAsarPath,
   getProductVersion: () => getProductVersion,
@@ -59,22 +60,31 @@ function parseGithubCdnURL(repository, cdnPrefix, relativeFilePath) {
   cdnPrefix = cdnPrefix.trim().replace(/^\/?|\/?$/g, "").trim();
   return repository.replace("github.com", cdnPrefix) + relativeFilePath;
 }
+function getGithubFileCdnGroup() {
+  return [
+    { cdnPrefix: "cdn.jsdelivr.net/gh", source: "jsdelivr" },
+    { cdnPrefix: "fastly.jsdelivr.net/gh", source: "jsdelivr-fastly" },
+    { cdnPrefix: "cdn.statically.io/gh", source: "statically" },
+    { cdnPrefix: "rawcdn.githack.com/gh", source: "githack" },
+    { cdnPrefix: "raw.githack.com/gh", source: "githack-dev" }
+  ];
+}
 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" }
+    { cdnPrefix: "gh.gh2233.ml", source: "@X.I.U/XIU2" },
+    { cdnPrefix: "ghproxy.com", source: "gh-proxy" },
+    { cdnPrefix: "gh.ddlc.top", source: "@mtr-static-official" },
+    { cdnPrefix: "ghdl.feizhuqwq.cf", source: "feizhuqwq.com" },
+    { cdnPrefix: "slink.ltd", source: "\u77E5\u4E86\u5C0F\u7AD9" },
+    { cdnPrefix: "git.xfj0.cn", source: "anonymous1" },
+    { cdnPrefix: "gh.con.sh", source: "anonymous2" },
+    { cdnPrefix: "ghps.cc", source: "anonymous3" },
+    { cdnPrefix: "cors.isteed.cc/github.com", source: "Lufs's" },
+    { cdnPrefix: "hub.gitmirror.com", source: "GitMirror" },
+    { cdnPrefix: "js.xxooo.ml", source: "\u996D\u592A\u786C" },
+    { cdnPrefix: "download.njuu.cf", source: "LibraryCloud-njuu" },
+    { cdnPrefix: "download.yzuu.cf", source: "LibraryCloud-yzuu" },
+    { cdnPrefix: "download.nuaa.cf", source: "LibraryCloud-nuaa" }
   ];
 }
 function restartApp() {
@@ -134,6 +144,7 @@ function handleUnexpectedErrors(callback) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getEntryVersion,
+  getGithubFileCdnGroup,
   getGithubReleaseCdnGroup,
   getProductAsarPath,
   getProductVersion,

package/dist/utils.mjs

@@ -1,5 +1,6 @@
 import {
   getEntryVersion,
+  getGithubFileCdnGroup,
   getGithubReleaseCdnGroup,
   getProductAsarPath,
   getProductVersion,
@@ -10,9 +11,10 @@ import {
   unzipFile,
   waitAppReady,
   zipFile
-} from "./chunk-L3QO4PD3.mjs";
+} from "./chunk-67MCNA7W.mjs";
 export {
   getEntryVersion,
+  getGithubFileCdnGroup,
   getGithubReleaseCdnGroup,
   getProductAsarPath,
   getProductVersion,

package/dist/vite.mjs

@@ -3,7 +3,7 @@ import {
 } from "./chunk-Q2K52LOG.mjs";
 import {
   zipFile
-} from "./chunk-L3QO4PD3.mjs";
+} from "./chunk-67MCNA7W.mjs";
 
 // src/vite.ts
 import { createLogger } from "vite";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "author": "subframe7536",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup && node fix-module.js",