electron-incremental-update 1.1.0 → 1.2.0

package/dist/index.js

@@ -8,7 +8,7 @@ import {
   restartApp,
   unzipFile,
   waitAppReady
-} from "./chunk-CXHA5TF7.js";
+} from "./chunk-RQCTJY4L.js";
 
 // src/index.ts
 import { resolve } from "node:path";
@@ -16,8 +16,7 @@ import { existsSync as existsSync2, renameSync } from "node:fs";
 import { app as app2 } from "electron";
 
 // src/updater/core.ts
-import { existsSync } from "node:fs";
-import { rm, writeFile } from "node:fs/promises";
+import { existsSync, rmSync, writeFileSync } from "node:fs";
 import { app } from "electron";
 
 // src/crypto/dec.ts
@@ -164,6 +163,7 @@ var compareVersionDefault = (version1, version2) => {
 
 // src/updater/core.ts
 var Updater = class {
+  CERT = __SIGNATURE_CERT__;
   info;
   option;
   asarPath;
@@ -195,8 +195,11 @@ var Updater = class {
    * initialize incremental updater
    * @param option UpdaterOption
    */
-  constructor(option) {
+  constructor(option = {}) {
     this.option = option;
+    if (option.SIGNATURE_CERT) {
+      this.CERT = option.SIGNATURE_CERT;
+    }
     this.asarPath = getPathFromAppNameAsar();
     this.gzipPath = `${this.asarPath}.gz`;
     this.tmpFilePath = `${this.asarPath}.tmp`;
@@ -213,11 +216,11 @@ var Updater = class {
   async parseData(format, data) {
     if (existsSync(this.tmpFilePath)) {
       this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
-      await rm(this.tmpFilePath);
+      rmSync(this.tmpFilePath);
     }
     if (existsSync(this.gzipPath)) {
       this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
-      await rm(this.gzipPath);
+      rmSync(this.gzipPath);
     }
     if (!["string", "object", "undefined"].includes(typeof data)) {
       throw new TypeError(`invalid type at format '${format}': ${data}`);
@@ -323,13 +326,13 @@ var Updater = class {
       const buffer = await this.parseData("buffer", data);
       this.logger?.info("verify start");
       const _verify = this.option.overrideFunctions?.verifySignaure ?? verify;
-      const _ver = await _verify(buffer, _sig, this.option.SIGNATURE_CERT);
+      const _ver = await _verify(buffer, _sig, this.CERT);
       if (!_ver) {
-        throw new VerifyFailedError(_sig, this.option.SIGNATURE_CERT);
+        throw new VerifyFailedError(_sig, this.CERT);
       }
       this.logger?.info("verify success");
       this.logger?.info(`write to ${this.gzipPath}`);
-      await writeFile(this.gzipPath, buffer);
+      writeFileSync(this.gzipPath, buffer);
       this.logger?.info(`extract to ${this.tmpFilePath}`);
       await unzipFile(this.gzipPath, this.tmpFilePath);
       this.logger?.info(`download success, version: ${_ver}`);
@@ -362,8 +365,9 @@ var defaultOnInstall = (install, _, __, logger) => {
   install();
   logger?.info(`update success!`);
 };
-function initApp(appOptions) {
+async function initApp(appOptions = {}) {
   const {
+    updater,
     electronDevDistPath = "../dist-electron",
     mainPath = "main/index.js",
     hooks
@@ -373,43 +377,32 @@ function initApp(appOptions) {
     beforeStart,
     onStartError
   } = hooks || {};
-  function handleError(err, logger) {
+  function handleError(err, logger2) {
     console.error(err);
-    onStartError?.(err, logger);
+    onStartError?.(err, logger2);
     app2.quit();
   }
-  async function startup(updater) {
-    const logger = updater.logger;
-    try {
-      const appNameAsarPath = getPathFromAppNameAsar();
-      const tempAsarPath = `${appNameAsarPath}.tmp`;
-      if (existsSync2(tempAsarPath)) {
-        logger?.info(`installing new asar: ${tempAsarPath}`);
-        await onInstall(() => renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
-      }
-      const mainDir = is.dev ? electronDevDistPath : appNameAsarPath;
-      const entry = resolve(__dirname, mainDir, mainPath);
-      await beforeStart?.(entry, logger);
-      __require(entry)(updater);
-    } catch (error) {
-      handleError(error, logger);
-    }
+  let updaterInstance;
+  if (typeof updater === "object" || !updater) {
+    updaterInstance = createUpdater(updater);
+  } else {
+    updaterInstance = await updater();
   }
-  let timer = setTimeout(() => {
-    handleError("start app timeout, please start app with `initApp(options).startupWithUpdater(options)`");
-  }, 3e3);
-  return {
-    async startupWithUpdater(updater) {
-      clearTimeout(timer);
-      if (typeof updater === "object") {
-        await startup(createUpdater(updater));
-      } else if (typeof updater === "function") {
-        await startup(await updater());
-      } else {
-        handleError("invalid updater option or updater is not a function");
-      }
+  const logger = updaterInstance.logger;
+  try {
+    const appNameAsarPath = getPathFromAppNameAsar();
+    const tempAsarPath = `${appNameAsarPath}.tmp`;
+    if (existsSync2(tempAsarPath)) {
+      logger?.info(`installing new asar: ${tempAsarPath}`);
+      await onInstall(() => renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
     }
-  };
+    const mainDir = is.dev ? electronDevDistPath : appNameAsarPath;
+    const entry = resolve(__dirname, mainDir, mainPath);
+    await beforeStart?.(entry, logger);
+    __require(entry)(updaterInstance);
+  } catch (error) {
+    handleError(error, logger);
+  }
 }
 export {
   DownloadError,

package/dist/utils.cjs

@@ -148,14 +148,14 @@ function getPaths(entryDirName = "dist-entry") {
       return (0, import_node_path.join)(import_electron.app.getAppPath(), entryDirName, ...paths);
     },
     /**
-     * get path inside `${app.name}.asar/main`
+     * get path inside `${electron.app.name}.asar/main`
      * @param paths joined path
      */
     getPathFromMain(...paths) {
       return (0, import_node_path.join)(mainDirPath, ...paths);
     },
     /**
-     * get path inside `${app.name}.asar/preload`
+     * get path inside `${electron.app.name}.asar/preload`
      * @param paths joined path
      */
     getPathFromPreload(...paths) {
@@ -180,7 +180,7 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
   }
   const compressedBuffer = (0, import_node_fs2.readFileSync)(gzipPath);
   return new Promise((resolve, reject) => {
-    (0, import_node_zlib.gunzip)(compressedBuffer, (err, buffer) => {
+    (0, import_node_zlib.brotliDecompress)(compressedBuffer, (err, buffer) => {
       (0, import_node_fs2.rmSync)(gzipPath);
       if (err) {
         reject(err);
@@ -196,7 +196,7 @@ async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
   }
   const buffer = (0, import_node_fs2.readFileSync)(filePath);
   return new Promise((resolve, reject) => {
-    (0, import_node_zlib.gzip)(buffer, (err, buffer2) => {
+    (0, import_node_zlib.brotliCompress)(buffer, (err, buffer2) => {
       if (err) {
         reject(err);
       }

package/dist/utils.d.cts

@@ -19,7 +19,7 @@ declare function getPathFromAppNameAsar(...path: string[]): string;
 /**
  * get versions of App, Entry, Electron, Node and System
  *
- * App version is read from `version` file in `${app.name}.asar`
+ * App version is read from `version` file in `${electron.app.name}.asar`
  *
  * Entry version is read from `package.json`
  *
@@ -54,7 +54,7 @@ declare function loadNativeModuleFromEntry(devEntryDirPath?: string, entryDirPat
 declare function restartApp(): void;
 /**
  * fix app use model id, only for Windows
- * @param id app id @default `org.${app.name}`
+ * @param id app id @default `org.${electron.app.name}`
  */
 declare function setAppUserModelId(id?: string): void;
 /**
@@ -104,12 +104,12 @@ declare function getPaths(entryDirName?: string): {
      */
     getPathFromEntryAsar(...paths: string[]): string;
     /**
-     * get path inside `${app.name}.asar/main`
+     * get path inside `${electron.app.name}.asar/main`
      * @param paths joined path
      */
     getPathFromMain(...paths: string[]): string;
     /**
-     * get path inside `${app.name}.asar/preload`
+     * get path inside `${electron.app.name}.asar/preload`
      * @param paths joined path
      */
     getPathFromPreload(...paths: string[]): string;

package/dist/utils.d.ts

@@ -19,7 +19,7 @@ declare function getPathFromAppNameAsar(...path: string[]): string;
 /**
  * get versions of App, Entry, Electron, Node and System
  *
- * App version is read from `version` file in `${app.name}.asar`
+ * App version is read from `version` file in `${electron.app.name}.asar`
  *
  * Entry version is read from `package.json`
  *
@@ -54,7 +54,7 @@ declare function loadNativeModuleFromEntry(devEntryDirPath?: string, entryDirPat
 declare function restartApp(): void;
 /**
  * fix app use model id, only for Windows
- * @param id app id @default `org.${app.name}`
+ * @param id app id @default `org.${electron.app.name}`
  */
 declare function setAppUserModelId(id?: string): void;
 /**
@@ -104,12 +104,12 @@ declare function getPaths(entryDirName?: string): {
      */
     getPathFromEntryAsar(...paths: string[]): string;
     /**
-     * get path inside `${app.name}.asar/main`
+     * get path inside `${electron.app.name}.asar/main`
      * @param paths joined path
      */
     getPathFromMain(...paths: string[]): string;
     /**
-     * get path inside `${app.name}.asar/preload`
+     * get path inside `${electron.app.name}.asar/preload`
      * @param paths joined path
      */
     getPathFromPreload(...paths: string[]): string;

package/dist/utils.js

@@ -16,7 +16,7 @@ import {
   unzipFile,
   waitAppReady,
   zipFile
-} from "./chunk-CXHA5TF7.js";
+} from "./chunk-RQCTJY4L.js";
 export {
   disableHWAccForWin7,
   getPathFromAppNameAsar,

package/dist/vite.d.ts

@@ -1,4 +1,3 @@
-import * as vite from 'vite';
 import { Plugin } from 'vite';
 import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
 import { Promisable } from '@subframe7536/type-utils';
@@ -81,6 +80,9 @@ type BuildEntryOption = {
      *   loader: {
      *     '.node': 'empty',
      *   },
+     *   define: {
+     *     __SIGNATURE_CERT__: JSON.stringify(cert),
+     *   },
      * }
      * ```
      */
@@ -220,6 +222,17 @@ type ElectronUpdaterOptions = {
     };
 };
 
+type BytecodeOptions = {
+    /**
+     * strings that should be transformed
+     */
+    protectedStrings?: string[];
+    /**
+     * Remember to set `sandbox: false` when creating window
+     */
+    enablePreload?: boolean;
+};
+
 type MakeRequired<T, K extends keyof T> = Exclude<T, undefined> & {
     [P in K]-?: T[P];
 };
@@ -254,7 +267,7 @@ type ElectronWithUpdaterOptions = {
      */
     isBuild: boolean;
     /**
-     * manullay setup package.json, read name, version and main
+     * manually setup package.json, read name, version and main
      * ```ts
      * import pkg from './package.json'
      * ```
@@ -262,12 +275,22 @@ type ElectronWithUpdaterOptions = {
     pkg?: PKG;
     /**
      * whether to generate sourcemap
+     * @default !isBuild
      */
     sourcemap?: boolean;
     /**
      * whether to minify the code
+     * @default isBuild
      */
     minify?: boolean;
+    /**
+     * whether to generate bytecode
+     *
+     * **only support commonjs**
+     *
+     * only main process by default, if you want to use in preload script, please use `electronWithUpdater({ bytecode: { enablePreload: true } })` and set `sandbox: false` when creating window
+     */
+    bytecode?: boolean | BytecodeOptions;
     /**
      * use NotBundle() plugin in main
      * @default true
@@ -275,8 +298,12 @@ type ElectronWithUpdaterOptions = {
     useNotBundle?: boolean;
     /**
      * Whether to log parsed options
+     *
+     * to show certificate and private keys, set `logParsedOptions: { showKeys: true }`
      */
-    logParsedOptions?: boolean;
+    logParsedOptions?: boolean | {
+        showKeys: boolean;
+    };
     /**
      * main options
      */
@@ -290,7 +317,6 @@ type ElectronWithUpdaterOptions = {
      */
     updater?: ElectronUpdaterOptions;
 };
-declare const log: vite.Logger;
 /**
  * build options for `vite-plugin-electron/simple`
  * - integrate with updater
@@ -341,6 +367,6 @@ declare const log: vite.Logger;
  *   }
  * })
  */
-declare function electronWithUpdater(options: ElectronWithUpdaterOptions): (Plugin<any> | Promise<Plugin<any>[]> | undefined)[] | null;
+declare function electronWithUpdater(options: ElectronWithUpdaterOptions): Promise<(Plugin<any> | Promise<Plugin<any>[]> | undefined)[] | null>;
 
-export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater, log };
+export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater };