electron-incremental-update 0.7.10 → 0.8.1

package/dist/index.d.mts

@@ -12,7 +12,7 @@ declare class VerifyFailedError extends Error {
     constructor(signature: string, cert: string);
 }
 declare class DownloadError extends Error {
-    constructor();
+    constructor(msg: string);
 }
 declare class IncrementalUpdater implements Updater {
     private info?;
@@ -111,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
@@ -190,6 +190,7 @@ interface UpdaterOption {
     downloadConfig?: UpdaterDownloadConfig;
 }
 
+type Promisable<T> = T | Promise<T>;
 type AppOption = {
     /**
      * path of electron output dist when in development
@@ -201,31 +202,39 @@ 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
+         *
+         * @param oldAsarPath old asar path
+         * @param updateTempAsarPath new asar path, end with .tmp
+         */
+        beforeDoUpdate?: (oldAsarPath: string, updateTempAsarPath: string) => Promisable<void>;
+        /**
+         * hooks before start up
+         */
+        beforeStart?: (productAsarPath: string) => Promisable<void>;
+        /**
+         * hooks on start up error
+         */
+        onStartError?: (err: unknown) => void;
+    };
 };
 type StartupWithUpdater = (updater: Updater) => void;
 type SetUpdater = {
     /**
      * set updater option or create function
      */
-    setUpdater: (updater: (() => Updater | Promise<Updater>) | UpdaterOption) => void;
+    setUpdater: (updater: (() => Promisable<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 })

package/dist/index.d.ts

@@ -12,7 +12,7 @@ declare class VerifyFailedError extends Error {
     constructor(signature: string, cert: string);
 }
 declare class DownloadError extends Error {
-    constructor();
+    constructor(msg: string);
 }
 declare class IncrementalUpdater implements Updater {
     private info?;
@@ -111,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
@@ -190,6 +190,7 @@ interface UpdaterOption {
     downloadConfig?: UpdaterDownloadConfig;
 }
 
+type Promisable<T> = T | Promise<T>;
 type AppOption = {
     /**
      * path of electron output dist when in development
@@ -201,31 +202,39 @@ 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
+         *
+         * @param oldAsarPath old asar path
+         * @param updateTempAsarPath new asar path, end with .tmp
+         */
+        beforeDoUpdate?: (oldAsarPath: string, updateTempAsarPath: string) => Promisable<void>;
+        /**
+         * hooks before start up
+         */
+        beforeStart?: (productAsarPath: string) => Promisable<void>;
+        /**
+         * hooks on start up error
+         */
+        onStartError?: (err: unknown) => void;
+    };
 };
 type StartupWithUpdater = (updater: Updater) => void;
 type SetUpdater = {
     /**
      * set updater option or create function
      */
-    setUpdater: (updater: (() => Updater | Promise<Updater>) | UpdaterOption) => void;
+    setUpdater: (updater: (() => Promisable<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 })

package/dist/index.js

@@ -241,8 +241,8 @@ var VerifyFailedError = class extends Error {
   }
 };
 var DownloadError = class extends Error {
-  constructor() {
-    super("download update error");
+  constructor(msg) {
+    super(`download update error, ${msg}`);
   }
 };
 var IncrementalUpdater = class {
@@ -334,7 +334,7 @@ var IncrementalUpdater = class {
       this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
       return ret;
     } catch (e) {
-      throw new DownloadError();
+      throw new DownloadError(e.toString());
     }
   }
   async checkUpdate(data) {
@@ -383,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) {
@@ -401,22 +401,28 @@ function initApp(appOptions) {
   const {
     electronDevDistPath = "dist-electron",
     mainPath = "main/index.js",
-    onStart,
-    onStartError
+    hooks
   } = appOptions || {};
+  const {
+    beforeDoUpdate,
+    beforeStart,
+    onStartError
+  } = 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`)) {
-        (0, import_node_fs3.renameSync)(`${asarPath}.tmp`, asarPath);
+      const updateAsarPath = `${asarPath}.tmp`;
+      if ((0, import_node_fs3.existsSync)(updateAsarPath)) {
+        await beforeDoUpdate?.(asarPath, updateAsarPath);
+        (0, import_node_fs3.renameSync)(updateAsarPath, asarPath);
       }
       const mainDir = import_electron3.app.isPackaged ? asarPath : electronDevDistPath;
       const entry = (0, import_node_path2.resolve)(__dirname, mainDir, mainPath);
-      onStart?.(entry);
+      await beforeStart?.(entry);
       require(entry)(updater);
     } catch (error) {
       handleError(`failed to start app, ${error}`);
@@ -429,9 +435,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");
       }

package/dist/index.mjs

@@ -135,8 +135,8 @@ var VerifyFailedError = class extends Error {
   }
 };
 var DownloadError = class extends Error {
-  constructor() {
-    super("download update error");
+  constructor(msg) {
+    super(`download update error, ${msg}`);
   }
 };
 var IncrementalUpdater = class {
@@ -228,7 +228,7 @@ var IncrementalUpdater = class {
       this.logger?.info(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
       return ret;
     } catch (e) {
-      throw new DownloadError();
+      throw new DownloadError(e.toString());
     }
   }
   async checkUpdate(data) {
@@ -277,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) {
@@ -295,22 +295,28 @@ function initApp(appOptions) {
   const {
     electronDevDistPath = "dist-electron",
     mainPath = "main/index.js",
-    onStart,
-    onStartError
+    hooks
   } = appOptions || {};
+  const {
+    beforeDoUpdate,
+    beforeStart,
+    onStartError
+  } = 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`)) {
-        renameSync(`${asarPath}.tmp`, asarPath);
+      const updateAsarPath = `${asarPath}.tmp`;
+      if (existsSync2(updateAsarPath)) {
+        await beforeDoUpdate?.(asarPath, updateAsarPath);
+        renameSync(updateAsarPath, asarPath);
       }
       const mainDir = app.isPackaged ? asarPath : electronDevDistPath;
       const entry = resolve(__dirname, mainDir, mainPath);
-      onStart?.(entry);
+      await beforeStart?.(entry);
       __require(entry)(updater);
     } catch (error) {
       handleError(`failed to start app, ${error}`);
@@ -323,9 +329,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");
       }

package/package.json

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