electron-incremental-update 0.1.5 → 0.1.6

package/README.md

@@ -50,6 +50,8 @@ src
 
 ### setup app
 
+more example see comment on `initApp()`
+
 ```ts
 // electron/app.ts
 import { createUpdater, initApp } from 'electron-incremental-update'
@@ -143,55 +145,31 @@ db.close()
 ### setup vite.config.ts
 
 ```ts
-import { rmSync } from 'node:fs'
-import { defineConfig } from 'vite'
-import electron from 'vite-plugin-electron'
-import updater from 'electron-incremental-update/vite'
-import pkg from './package.json'
-
-// https://vitejs.dev/config/
-
 export default defineConfig(({ command }) => {
-  rmSync('dist-electron', { recursive: true, force: true })
 
-  const isServe = command === 'serve'
   const isBuild = command === 'build'
-  const sourcemap = isServe || !!process.env.VSCODE_DEBUG
+  // ...
 
   return {
     plugins: [
       electron([
+        // main
         {
-          // Main-Process entry file of the Electron App.
-          entry: ['electron/main/index.ts'],
-          onstart(options) {
-            if (process.env.VSCODE_DEBUG) {
-              console.log(/* For `.vscode/.debug.script.mjs` */'[startup] Electron App')
-            } else {
-              options.startup()
-            }
-          },
+          // ...
+        },
+        // preload
+        {
+          // ...
           vite: {
             plugins: [
-              updater({ // options see below
+              updater({ // !make sure the plugin run pack asar after all build finish
                 productName: pkg.name,
                 version: pkg.version,
                 isBuild,
               }),
             ],
-            build: {
-              sourcemap,
-              minify: false,
-              outDir: 'dist-electron/main',
-              rollupOptions: {
-                external: Object.keys('dependencies' in pkg ? pkg.dependencies : {}),
-                treeshake: true,
-              },
-            },
-          },
-        },
-        {
-          // ...preload
+            // ...
+          }
         },
       ]),
       // ... other plugins
@@ -201,7 +179,7 @@ export default defineConfig(({ command }) => {
 })
 ```
 
-#### option
+#### plugin options
 
 ```ts
 type Options = {

package/dist/index.cjs

@@ -34,7 +34,7 @@ __export(src_exports, {
   getAppAsarPath: () => getAppAsarPath,
   getAppVersion: () => getAppVersion,
   getElectronVersion: () => getElectronVersion,
-  getReleaseDnsPrefix: () => getReleaseDnsPrefix,
+  getReleaseCdnLink: () => getReleaseCdnLink,
   initApp: () => initApp,
   requireNative: () => requireNative
 });
@@ -114,24 +114,31 @@ function requireNative(packageName) {
   const path = import_electron.app.isPackaged ? (0, import_node_path.join)(import_electron.app.getAppPath(), "node_modules", packageName) : packageName;
   return require(path);
 }
-function getReleaseDnsPrefix() {
-  const hub = "https://github.com";
+function getReleaseCdnLink(url) {
+  const hub = "https://github.com/";
+  if (!url.startsWith(hub)) {
+    throw new Error("URL must start with 'https://github.com/'");
+  }
+  if (url.endsWith("/")) {
+    url = url.slice(0, -1);
+  }
+  const _url = url.replace(hub, "");
   return [
-    { urlPrefix: `https://gh.gh2233.ml/${hub}`, maintainer: "@X.I.U/XIU2" },
-    { urlPrefix: `https://ghproxy.com/${hub}`, maintainer: "gh-proxy" },
-    { urlPrefix: `https://gh.ddlc.top/${hub}`, maintainer: "@mtr-static-official" },
-    { urlPrefix: `https://ghdl.feizhuqwq.cf/${hub}`, maintainer: "feizhuqwq.com" },
-    { urlPrefix: `https://slink.ltd/${hub}`, maintainer: "\u77E5\u4E86\u5C0F\u7AD9" },
-    { urlPrefix: `https://git.xfj0.cn/${hub}`, maintainer: "anonymous1" },
-    { urlPrefix: `https://gh.con.sh/${hub}`, maintainer: "anonymous2" },
-    { urlPrefix: `https://ghps.cc/${hub}`, maintainer: "anonymous3" },
-    { urlPrefix: "https://cors.isteed.cc/github.com", maintainer: "Lufs's" },
-    { urlPrefix: `https://hub.gitmirror.com/${hub}`, maintainer: "GitMirror" },
-    { urlPrefix: `https://js.xxooo.ml/${hub}`, maintainer: "\u996D\u592A\u786C" },
-    { urlPrefix: `https://proxy.freecdn.ml/?url=${hub}`, maintainer: "anonymous4" },
-    { urlPrefix: "https://download.njuu.cf", maintainer: "LibraryCloud-njuu" },
-    { urlPrefix: "https://download.yzuu.cf", maintainer: "LibraryCloud-yzuu" },
-    { urlPrefix: "https://download.nuaa.cf", maintainer: "LibraryCloud-nuaa" }
+    { urlPrefix: `https://gh.gh2233.ml/${url}`, maintainer: "@X.I.U/XIU2" },
+    { urlPrefix: `https://ghproxy.com/${url}`, maintainer: "gh-proxy" },
+    { urlPrefix: `https://gh.ddlc.top/${url}`, maintainer: "@mtr-static-official" },
+    { urlPrefix: `https://ghdl.feizhuqwq.cf/${url}`, maintainer: "feizhuqwq.com" },
+    { urlPrefix: `https://slink.ltd/${url}`, maintainer: "\u77E5\u4E86\u5C0F\u7AD9" },
+    { urlPrefix: `https://git.xfj0.cn/${url}`, maintainer: "anonymous1" },
+    { urlPrefix: `https://gh.con.sh/${url}`, maintainer: "anonymous2" },
+    { urlPrefix: `https://ghps.cc/${url}`, maintainer: "anonymous3" },
+    { urlPrefix: `https://cors.isteed.cc/github.com/${_url}`, maintainer: "Lufs's" },
+    { urlPrefix: `https://hub.gitmirror.com/${url}`, maintainer: "GitMirror" },
+    { urlPrefix: `https://js.xxooo.ml/${url}`, maintainer: "\u996D\u592A\u786C" },
+    { urlPrefix: `https://proxy.freecdn.ml/?url=${url}`, maintainer: "anonymous4" },
+    { urlPrefix: `https://download.njuu.cf/${_url}`, maintainer: "LibraryCloud-njuu" },
+    { urlPrefix: `https://download.yzuu.cf/${_url}`, maintainer: "LibraryCloud-yzuu" },
+    { urlPrefix: `https://download.nuaa.cf/${_url}`, maintainer: "LibraryCloud-nuaa" }
   ];
 }
 
@@ -245,7 +252,14 @@ function initApp(productName, updater, option) {
   } = option ?? {};
   const mainDir = import_electron3.app.isPackaged ? `../${productName}.asar` : electronDistPath;
   const entry = (0, import_node_path2.resolve)(__dirname, mainDir, mainPath);
-  return require(entry)(updater);
+  let _updater;
+  if ("SIGNATURE_PUB" in updater) {
+    const _option = updater.productName ? updater : { ...updater, productName };
+    _updater = createUpdater(_option);
+  } else {
+    _updater = updater;
+  }
+  return require(entry)(_updater);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -253,7 +267,7 @@ function initApp(productName, updater, option) {
   getAppAsarPath,
   getAppVersion,
   getElectronVersion,
-  getReleaseDnsPrefix,
+  getReleaseCdnLink,
   initApp,
   requireNative
 });

package/dist/index.d.ts

@@ -15,7 +15,7 @@ type UpdateJSON = {
     size: number;
 };
 type MaybeArray<T> = T extends undefined | null | never ? [] : T extends any[] ? T['length'] extends 1 ? [data: T[0]] : T : [data: T];
-interface UpdateOption {
+interface BaseOption {
     /**
      * URL of version info json
      * @default `${repository.replace('github.com', 'raw.githubusercontent.com')}/version.json`
@@ -37,10 +37,10 @@ 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?: UpdateOption): Promise<void>;
+    checkUpdate(options?: BaseOption): Promise<void>;
 }
 type Updater = TypedUpdater<UpdateEvents>;
-interface Options extends UpdateOption {
+interface UpdaterOption extends BaseOption {
     /**
      * public key of signature
      *
@@ -101,18 +101,36 @@ interface Options extends UpdateOption {
     };
 }
 
+/**
+ * get the application asar absolute path
+ * @param name The name of the application
+ */
 declare function getAppAsarPath(name: string): string;
+/**
+ * get the version of electron
+ */
 declare function getElectronVersion(): string;
+/**
+ * get the version of application
+ * @param name - The name of the application
+ */
 declare function getAppVersion(name: string): string;
+/**
+ * require native package from app.asar
+ * @param packageName native package name
+ */
 declare function requireNative<T = any>(packageName: string): T;
-declare function getReleaseDnsPrefix(): {
+/**
+ * get group of parsed github release CDN links for accelerating the speed of downloading release
+ */
+declare function getReleaseCdnLink(url: string): {
     urlPrefix: string;
     maintainer: string;
 }[];
 
-declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, downloadConfig, }: Options): Updater;
+declare function createUpdater({ SIGNATURE_PUB, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, downloadConfig, }: UpdaterOption): Updater;
 
-interface PathConfig {
+interface AppOption {
     /**
      * path of electron output dist
      * @default 'dist-electron'
@@ -127,10 +145,46 @@ interface PathConfig {
 /**
  * Initialize application
  * @param productName name of your application
- * @param updater updater
- * @param option options for entry, will be used to generate electron main path, default: `dist-electron/main/index.js`
+ * @param updater updater instance or updater options
+ * @param option options for entry, will be used to generate electron main path, default target path: `dist-electron/main/index.js`
  * @returns a function to init your application with a updater
- */
-declare function initApp(productName: string, updater: Updater, option?: PathConfig): any;
+ *
+ * @example
+ * **manual** generate updater
+ * ```ts
+ * import { initApp } from 'electron-incremental-updater'
+ * import { name, repository } from '../package.json'
+ *
+ * const SIGNATURE_PUB = '' // auto generate RSA public key when start app
+ * const updater = createUpdater({
+ *   SIGNATURE_PUB,
+ *   productName: name,
+ *   repository,
+ * })
+ * initApp(name, updater)
+ * ```
+ * @example
+ * **auto** generate updater and set update URL
+ *
+ * ```ts
+ * import { getReleaseDnsPrefix, initApp } from 'electron-incremental-update'
+ * import { name, repository } from '../package.json'
+ *
+ * const SIGNATURE_PUB = '' // auto generate RSA public key when start app
+ *
+ * const { urlPrefix } = getReleaseCdnPrefix()[0]
+ * initApp(name, {
+ *   SIGNATURE_PUB,
+ *   repository,
+ *   updateJsonURL: `https://cdn.jsdelivr.net/gh/${repository.replace('https://github.com', '')}/version.json`,
+ *   releaseAsarURL: `${urlPrefix}/download/latest/${name}.asar.gz`,
+ * }, {
+ *  // options for main entry
+ * })
+ * ```
+*/
+declare function initApp(productName: string, updater: Updater | Omit<UpdaterOption, 'productName'> & {
+    productName?: string;
+}, option?: AppOption): any;
 
-export { CheckResultType, Options, UpdateJSON, UpdateOption, Updater, createUpdater, getAppAsarPath, getAppVersion, getElectronVersion, getReleaseDnsPrefix, initApp, requireNative };
+export { BaseOption, CheckResultType, UpdateJSON, Updater, UpdaterOption, createUpdater, getAppAsarPath, getAppVersion, getElectronVersion, getReleaseCdnLink, initApp, requireNative };

package/dist/index.mjs

@@ -78,24 +78,31 @@ function requireNative(packageName) {
   const path = app.isPackaged ? join(app.getAppPath(), "node_modules", packageName) : packageName;
   return __require(path);
 }
-function getReleaseDnsPrefix() {
-  const hub = "https://github.com";
+function getReleaseCdnLink(url) {
+  const hub = "https://github.com/";
+  if (!url.startsWith(hub)) {
+    throw new Error("URL must start with 'https://github.com/'");
+  }
+  if (url.endsWith("/")) {
+    url = url.slice(0, -1);
+  }
+  const _url = url.replace(hub, "");
   return [
-    { urlPrefix: `https://gh.gh2233.ml/${hub}`, maintainer: "@X.I.U/XIU2" },
-    { urlPrefix: `https://ghproxy.com/${hub}`, maintainer: "gh-proxy" },
-    { urlPrefix: `https://gh.ddlc.top/${hub}`, maintainer: "@mtr-static-official" },
-    { urlPrefix: `https://ghdl.feizhuqwq.cf/${hub}`, maintainer: "feizhuqwq.com" },
-    { urlPrefix: `https://slink.ltd/${hub}`, maintainer: "\u77E5\u4E86\u5C0F\u7AD9" },
-    { urlPrefix: `https://git.xfj0.cn/${hub}`, maintainer: "anonymous1" },
-    { urlPrefix: `https://gh.con.sh/${hub}`, maintainer: "anonymous2" },
-    { urlPrefix: `https://ghps.cc/${hub}`, maintainer: "anonymous3" },
-    { urlPrefix: "https://cors.isteed.cc/github.com", maintainer: "Lufs's" },
-    { urlPrefix: `https://hub.gitmirror.com/${hub}`, maintainer: "GitMirror" },
-    { urlPrefix: `https://js.xxooo.ml/${hub}`, maintainer: "\u996D\u592A\u786C" },
-    { urlPrefix: `https://proxy.freecdn.ml/?url=${hub}`, maintainer: "anonymous4" },
-    { urlPrefix: "https://download.njuu.cf", maintainer: "LibraryCloud-njuu" },
-    { urlPrefix: "https://download.yzuu.cf", maintainer: "LibraryCloud-yzuu" },
-    { urlPrefix: "https://download.nuaa.cf", maintainer: "LibraryCloud-nuaa" }
+    { urlPrefix: `https://gh.gh2233.ml/${url}`, maintainer: "@X.I.U/XIU2" },
+    { urlPrefix: `https://ghproxy.com/${url}`, maintainer: "gh-proxy" },
+    { urlPrefix: `https://gh.ddlc.top/${url}`, maintainer: "@mtr-static-official" },
+    { urlPrefix: `https://ghdl.feizhuqwq.cf/${url}`, maintainer: "feizhuqwq.com" },
+    { urlPrefix: `https://slink.ltd/${url}`, maintainer: "\u77E5\u4E86\u5C0F\u7AD9" },
+    { urlPrefix: `https://git.xfj0.cn/${url}`, maintainer: "anonymous1" },
+    { urlPrefix: `https://gh.con.sh/${url}`, maintainer: "anonymous2" },
+    { urlPrefix: `https://ghps.cc/${url}`, maintainer: "anonymous3" },
+    { urlPrefix: `https://cors.isteed.cc/github.com/${_url}`, maintainer: "Lufs's" },
+    { urlPrefix: `https://hub.gitmirror.com/${url}`, maintainer: "GitMirror" },
+    { urlPrefix: `https://js.xxooo.ml/${url}`, maintainer: "\u996D\u592A\u786C" },
+    { urlPrefix: `https://proxy.freecdn.ml/?url=${url}`, maintainer: "anonymous4" },
+    { urlPrefix: `https://download.njuu.cf/${_url}`, maintainer: "LibraryCloud-njuu" },
+    { urlPrefix: `https://download.yzuu.cf/${_url}`, maintainer: "LibraryCloud-yzuu" },
+    { urlPrefix: `https://download.nuaa.cf/${_url}`, maintainer: "LibraryCloud-nuaa" }
   ];
 }
 
@@ -209,14 +216,21 @@ function initApp(productName, updater, option) {
   } = option ?? {};
   const mainDir = app3.isPackaged ? `../${productName}.asar` : electronDistPath;
   const entry = resolve(__dirname, mainDir, mainPath);
-  return __require(entry)(updater);
+  let _updater;
+  if ("SIGNATURE_PUB" in updater) {
+    const _option = updater.productName ? updater : { ...updater, productName };
+    _updater = createUpdater(_option);
+  } else {
+    _updater = updater;
+  }
+  return __require(entry)(_updater);
 }
 export {
   createUpdater,
   getAppAsarPath,
   getAppVersion,
   getElectronVersion,
-  getReleaseDnsPrefix,
+  getReleaseCdnLink,
   initApp,
   requireNative
 };

package/package.json

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