electron-incremental-update 0.7.9 → 0.8.0

package/dist/index.d.mts

@@ -11,6 +11,9 @@ declare class VerifyFailedError extends Error {
     cert: string;
     constructor(signature: string, cert: string);
 }
+declare class DownloadError extends Error {
+    constructor(msg: string);
+}
 declare class IncrementalUpdater implements Updater {
     private info?;
     private option;
@@ -36,11 +39,13 @@ declare class IncrementalUpdater implements Updater {
  */
 declare function createUpdater(option: UpdaterOption): IncrementalUpdater;
 
+type CheckResultError = MinimumVersionError | DownloadError | TypeError | Error;
+type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
 type CheckResultType = {
     size: number;
     version: string;
-} | undefined | Error | MinimumVersionError | TypeError;
-type DownloadResult = true | Error | VerifyFailedError | TypeError;
+} | undefined | CheckResultError;
+type DownloadResult = true | DownloadResultError;
 type DownloadingInfo = {
     /**
      * downloaded percent, 0% - 100%
@@ -69,8 +74,8 @@ interface Updater {
      * @param data update json url or object
      * @returns
      * - `{size: number, version: string}`: available
-     * - `false`: unavailable
-     * - `Error`: fail ({@link MinimumVersionError} or other)
+     * - `undefined`: unavailable
+     * - `CheckResultError`: fail
      */
     checkUpdate: (data?: string | UpdateJSON) => Promise<CheckResultType>;
     /**
@@ -81,7 +86,7 @@ interface Updater {
      * @param sig signature
      * @returns
      * - `true`: success
-     * - `Error`: fail ({@link VerifyFailedError} or other)
+     * - `DownloadResultError`: fail
      */
     download: (data?: string | Buffer, sig?: string) => Promise<DownloadResult>;
     /**
@@ -106,7 +111,7 @@ type UpdaterOverrideFunctions = {
      * @param cert certificate
      * @returns if signature is valid, returns the version or `true` , otherwise returns `false`
      */
-    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | boolean | Promise<string | boolean>;
+    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | false | Promise<string | false>;
     /**
      * custom download JSON function
      * @param url download url
@@ -196,14 +201,20 @@ type AppOption = {
      * @default 'main/index.js'
      */
     mainPath?: string;
-    /**
-     * hooks for start up
-     */
-    onStart?: (productAsarPath: string) => void;
-    /**
-     * hooks for start up error
-     */
-    onStartError?: (err: unknown) => void;
+    hooks?: {
+        /**
+         * hooks before replace the old asar is replaced by the new asar
+         */
+        beforeDoUpdate?: (updateTempAsarPath: string) => void | Promise<void>;
+        /**
+         * hooks on start up
+         */
+        onStart?: (productAsarPath: string) => void;
+        /**
+         * hooks on start up error
+         */
+        onStartError?: (err: unknown) => void;
+    };
 };
 type StartupWithUpdater = (updater: Updater) => void;
 type SetUpdater = {
@@ -213,14 +224,13 @@ type SetUpdater = {
     setUpdater: (updater: (() => Updater | Promise<Updater>) | UpdaterOption) => void;
 };
 /**
- * create updater manually
+ * initialize app
  * @example
  * ```ts
  * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
  * import { name, repository } from '../package.json'
  *
  * const SIGNATURE_CERT = '' // auto generate certificate when start app
- *
  * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
  * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
  * initApp({ onStart: console.log })
@@ -237,4 +247,4 @@ type SetUpdater = {
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, IncrementalUpdater, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };
+export { AppOption, DownloadError, IncrementalUpdater, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };

package/dist/index.d.ts

@@ -11,6 +11,9 @@ declare class VerifyFailedError extends Error {
     cert: string;
     constructor(signature: string, cert: string);
 }
+declare class DownloadError extends Error {
+    constructor(msg: string);
+}
 declare class IncrementalUpdater implements Updater {
     private info?;
     private option;
@@ -36,11 +39,13 @@ declare class IncrementalUpdater implements Updater {
  */
 declare function createUpdater(option: UpdaterOption): IncrementalUpdater;
 
+type CheckResultError = MinimumVersionError | DownloadError | TypeError | Error;
+type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
 type CheckResultType = {
     size: number;
     version: string;
-} | undefined | Error | MinimumVersionError | TypeError;
-type DownloadResult = true | Error | VerifyFailedError | TypeError;
+} | undefined | CheckResultError;
+type DownloadResult = true | DownloadResultError;
 type DownloadingInfo = {
     /**
      * downloaded percent, 0% - 100%
@@ -69,8 +74,8 @@ interface Updater {
      * @param data update json url or object
      * @returns
      * - `{size: number, version: string}`: available
-     * - `false`: unavailable
-     * - `Error`: fail ({@link MinimumVersionError} or other)
+     * - `undefined`: unavailable
+     * - `CheckResultError`: fail
      */
     checkUpdate: (data?: string | UpdateJSON) => Promise<CheckResultType>;
     /**
@@ -81,7 +86,7 @@ interface Updater {
      * @param sig signature
      * @returns
      * - `true`: success
-     * - `Error`: fail ({@link VerifyFailedError} or other)
+     * - `DownloadResultError`: fail
      */
     download: (data?: string | Buffer, sig?: string) => Promise<DownloadResult>;
     /**
@@ -106,7 +111,7 @@ type UpdaterOverrideFunctions = {
      * @param cert certificate
      * @returns if signature is valid, returns the version or `true` , otherwise returns `false`
      */
-    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | boolean | Promise<string | boolean>;
+    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | false | Promise<string | false>;
     /**
      * custom download JSON function
      * @param url download url
@@ -196,14 +201,20 @@ type AppOption = {
      * @default 'main/index.js'
      */
     mainPath?: string;
-    /**
-     * hooks for start up
-     */
-    onStart?: (productAsarPath: string) => void;
-    /**
-     * hooks for start up error
-     */
-    onStartError?: (err: unknown) => void;
+    hooks?: {
+        /**
+         * hooks before replace the old asar is replaced by the new asar
+         */
+        beforeDoUpdate?: (updateTempAsarPath: string) => void | Promise<void>;
+        /**
+         * hooks on start up
+         */
+        onStart?: (productAsarPath: string) => void;
+        /**
+         * hooks on start up error
+         */
+        onStartError?: (err: unknown) => void;
+    };
 };
 type StartupWithUpdater = (updater: Updater) => void;
 type SetUpdater = {
@@ -213,14 +224,13 @@ type SetUpdater = {
     setUpdater: (updater: (() => Updater | Promise<Updater>) | UpdaterOption) => void;
 };
 /**
- * create updater manually
+ * initialize app
  * @example
  * ```ts
  * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
  * import { name, repository } from '../package.json'
  *
  * const SIGNATURE_CERT = '' // auto generate certificate when start app
- *
  * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
  * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
  * initApp({ onStart: console.log })
@@ -237,4 +247,4 @@ type SetUpdater = {
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, IncrementalUpdater, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };
+export { AppOption, DownloadError, IncrementalUpdater, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  DownloadError: () => DownloadError,
   IncrementalUpdater: () => IncrementalUpdater,
   MinimumVersionError: () => MinimumVersionError,
   VerifyFailedError: () => VerifyFailedError,
@@ -239,6 +240,11 @@ var VerifyFailedError = class extends Error {
     this.cert = cert;
   }
 };
+var DownloadError = class extends Error {
+  constructor(msg) {
+    super(`download update error, ${msg}`);
+  }
+};
 var IncrementalUpdater = class {
   info;
   option;
@@ -323,9 +329,13 @@ var IncrementalUpdater = class {
       data = config.repoFallback;
     }
     this.logger?.info(`download ${format} from ${data}`);
-    const ret = format === "json" ? await config.fn(data, headers) : await config.fn(data, headers, this.info.size, this.onDownloading);
-    this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
-    return ret;
+    try {
+      const ret = format === "json" ? await config.fn(data, headers) : await config.fn(data, headers, this.info.size, this.onDownloading);
+      this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
+      return ret;
+    } catch (e) {
+      throw new DownloadError(e.toString());
+    }
   }
   async checkUpdate(data) {
     try {
@@ -373,7 +383,7 @@ var IncrementalUpdater = class {
       await (0, import_promises.writeFile)(this.gzipPath, buffer);
       this.logger?.info(`extract to ${this.tmpFilePath}`);
       await unzipFile(this.gzipPath, this.tmpFilePath);
-      this.logger?.info(`download success${typeof _ver === "string" ? `, version: ${_ver}` : ""}`);
+      this.logger?.info(`download success, version: ${_ver}`);
       this.info = void 0;
       return true;
     } catch (error) {
@@ -391,17 +401,22 @@ function initApp(appOptions) {
   const {
     electronDevDistPath = "dist-electron",
     mainPath = "main/index.js",
+    hooks
+  } = appOptions || {};
+  const {
+    beforeDoUpdate,
     onStart,
     onStartError
-  } = appOptions || {};
+  } = hooks || {};
   function handleError(msg) {
     onStartError?.(new Error(msg));
     import_electron3.app.quit();
   }
-  function startup(updater) {
+  async function startup(updater) {
     try {
       const asarPath = getProductAsarPath(updater.productName);
       if ((0, import_node_fs3.existsSync)(`${asarPath}.tmp`)) {
+        await beforeDoUpdate?.(asarPath);
         (0, import_node_fs3.renameSync)(`${asarPath}.tmp`, asarPath);
       }
       const mainDir = import_electron3.app.isPackaged ? asarPath : electronDevDistPath;
@@ -419,9 +434,9 @@ function initApp(appOptions) {
     async setUpdater(updater) {
       clearTimeout(timer);
       if (typeof updater === "object") {
-        startup(createUpdater(updater));
+        await startup(createUpdater(updater));
       } else if (typeof updater === "function") {
-        startup(await updater());
+        await startup(await updater());
       } else {
         handleError("invalid updater option or updater is not a function");
       }
@@ -430,6 +445,7 @@ function initApp(appOptions) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DownloadError,
   IncrementalUpdater,
   MinimumVersionError,
   VerifyFailedError,

package/dist/index.mjs

@@ -134,6 +134,11 @@ var VerifyFailedError = class extends Error {
     this.cert = cert;
   }
 };
+var DownloadError = class extends Error {
+  constructor(msg) {
+    super(`download update error, ${msg}`);
+  }
+};
 var IncrementalUpdater = class {
   info;
   option;
@@ -218,9 +223,13 @@ var IncrementalUpdater = class {
       data = config.repoFallback;
     }
     this.logger?.info(`download ${format} from ${data}`);
-    const ret = format === "json" ? await config.fn(data, headers) : await config.fn(data, headers, this.info.size, this.onDownloading);
-    this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
-    return ret;
+    try {
+      const ret = format === "json" ? await config.fn(data, headers) : await config.fn(data, headers, this.info.size, this.onDownloading);
+      this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
+      return ret;
+    } catch (e) {
+      throw new DownloadError(e.toString());
+    }
   }
   async checkUpdate(data) {
     try {
@@ -268,7 +277,7 @@ var IncrementalUpdater = class {
       await writeFile(this.gzipPath, buffer);
       this.logger?.info(`extract to ${this.tmpFilePath}`);
       await unzipFile(this.gzipPath, this.tmpFilePath);
-      this.logger?.info(`download success${typeof _ver === "string" ? `, version: ${_ver}` : ""}`);
+      this.logger?.info(`download success, version: ${_ver}`);
       this.info = void 0;
       return true;
     } catch (error) {
@@ -286,17 +295,22 @@ function initApp(appOptions) {
   const {
     electronDevDistPath = "dist-electron",
     mainPath = "main/index.js",
+    hooks
+  } = appOptions || {};
+  const {
+    beforeDoUpdate,
     onStart,
     onStartError
-  } = appOptions || {};
+  } = hooks || {};
   function handleError(msg) {
     onStartError?.(new Error(msg));
     app.quit();
   }
-  function startup(updater) {
+  async function startup(updater) {
     try {
       const asarPath = getProductAsarPath(updater.productName);
       if (existsSync2(`${asarPath}.tmp`)) {
+        await beforeDoUpdate?.(asarPath);
         renameSync(`${asarPath}.tmp`, asarPath);
       }
       const mainDir = app.isPackaged ? asarPath : electronDevDistPath;
@@ -314,9 +328,9 @@ function initApp(appOptions) {
     async setUpdater(updater) {
       clearTimeout(timer);
       if (typeof updater === "object") {
-        startup(createUpdater(updater));
+        await startup(createUpdater(updater));
       } else if (typeof updater === "function") {
-        startup(await updater());
+        await startup(await updater());
       } else {
         handleError("invalid updater option or updater is not a function");
       }
@@ -324,6 +338,7 @@ function initApp(appOptions) {
   };
 }
 export {
+  DownloadError,
   IncrementalUpdater,
   MinimumVersionError,
   VerifyFailedError,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "author": "subframe7536",
-  "version": "0.7.9",
+  "version": "0.8.0",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup && node fix-module.js",
@@ -58,4 +58,4 @@
     "ci-info": "^3.8.0",
     "selfsigned": "^2.1.1"
   }
-}
+}