electron-incremental-update 3.0.0-beta.4 → 3.0.0-beta.6

package/dist/vite.d.mts

@@ -1,50 +1,24 @@
-import { SpawnOptions } from "node:child_process";
-import { BuildEnvironmentOptions, InlineConfig, LibraryOptions, PluginOption, UserConfig, UserConfigFn, build } from "vite";
+import { Plugin, UserConfig } from "vite";
+import { MultiEnvElectronOptions } from "vite-plugin-electron/multi-env";
+import { RolldownOrRollupOptions } from "vite-plugin-electron";
 
-//#region src/vite/bytecode/utils.d.ts
-/**
-* Obfuscate string
-* @param code source code
-* @param sourcemap whether to generate sourcemap
-* @param offset custom offset
-*/
-declare function convertLiteral(code: string, sourcemap?: boolean, offset?: number): {
-  code: string;
-  map?: any;
-};
-//#endregion
-//#region node_modules/@subframe7536/type-utils/index.d.ts
+//#region src/utils/type.d.ts
 type Promisable<T> = T | Promise<T>;
-type AnyFunction<Return = any> = (...args: any[]) => Return;
-//#endregion
-//#region src/vite/electron/core.d.ts
-interface ElectronOptions {
-  /**
-  * Shortcut of `build.lib.entry`
-  */
-  entry?: LibraryOptions["entry"];
-  vite?: InlineConfig;
-  /**
-  * Triggered when Vite is built every time -- `vite serve` command only.
-  *
-  * If this `onstart` is passed, Electron App will not start automatically.
-  * However, you can start Electroo App via `startup` function.
-  */
-  onstart?: (args: {
-    /**
-    * Electron App startup function.
-    * It will mount the Electron App child-process to `process.electronApp`.
-    * - argv: electron startup arguments (default `['.', '--no-sandbox']`)
-    * - options: options for `child_process.spawn`
-    * - customElectronPkg: custom electron package name (default: `'electron'`)
-    */
-    startup: (argv?: string[], options?: SpawnOptions, customElectronPkg?: string) => Promise<void>; /** Reload Electron-Renderer */
-    reload: () => void;
-  }) => void | Promise<void>;
-}
+type AnyFunction = (...args: any[]) => any;
 //#endregion
-//#region src/vite/electron/utils.d.ts
-type RolldownOptions = Exclude<BuildEnvironmentOptions["rolldownOptions"], undefined>;
+//#region src/vite/startup.d.ts
+/**
+* Filter error messages from stdout/stderr during startup
+* @param args - Startup arguments
+* @param filter - Filter function to determine which messages to show
+*/
+declare function filterErrorMessageStartup(filter: (msg: string) => boolean): Promise<void>;
+/**
+* Fix Windows character encoding by setting code page to UTF-8
+* @param fn - Function to wrap with encoding fix
+* @returns Wrapped function with Windows encoding fix
+*/
+declare function fixWinCharEncoding<T extends AnyFunction>(fn: T): T;
 //#endregion
 //#region src/utils/version.d.ts
 /**
@@ -75,49 +49,69 @@ type UpdateJSON = UpdateInfo & {
 };
 //#endregion
 //#region src/vite/bytecode/index.d.ts
+/** Options for bytecode compilation */
 interface BytecodeOptions {
-  enable: boolean;
+  /**
+  * Enable bytecode compilation
+  * @default true
+  */
+  enable?: boolean;
   /**
   * Enable in preload script. Remember to set `sandbox: false` when creating window
   */
   preload?: boolean;
   /**
-  * Custom electron binary path
+  * Custom electron binary path for bytecode generation
   */
   electronPath?: string;
   /**
   * Before transformed code compile function. If return `Falsy` value, it will be ignored
-  * @param code transformed code
-  * @param id file path
+  * @param code - Transformed code
+  * @param id - File path
+  * @returns Transformed code or falsy to ignore
   */
   beforeCompile?: (code: string, id: string) => Promisable<string | null | undefined | void>;
 }
 //#endregion
-//#region src/vite/key.d.ts
+//#region src/vite/utils/key.d.ts
+/**
+* Distinguished name for certificate generation
+*/
 interface DistinguishedName {
+  /** Country name (2-letter code) */
   countryName?: string;
+  /** State or province name */
   stateOrProvinceName?: string;
+  /** Locality/city name */
   localityName?: string;
+  /** Organization name */
   organizationName?: string;
+  /** Organizational unit name */
   organizationalUnitName?: string;
+  /** Common name */
   commonName?: string;
+  /** Serial number */
   serialNumber?: string;
+  /** Title */
   title?: string;
+  /** Description */
   description?: string;
+  /** Business category */
   businessCategory?: string;
+  /** Email address */
   emailAddress?: string;
 }
 //#endregion
-//#region src/vite/option.d.ts
+//#region src/vite/types.d.ts
 interface CommonBuildOption {
   /**
   * Shortcut of `build.rolldownOptions.input`
   */
-  files: NonNullable<ElectronOptions["entry"]>;
+  files: NonNullable<MultiEnvElectronOptions["input"]>;
   /**
   * Override vite options
   */
-  vite?: ElectronOptions["vite"] & {
+  options?: MultiEnvElectronOptions["options"] & {
     build?: {
       outDir: never;
       sourcemap: never;
@@ -131,21 +125,6 @@ interface CommonBuildOption {
   };
 }
 interface ElectronWithUpdaterOptions {
-  /**
-  * Whether is in build mode
-  * ```ts
-  * export default defineConfig(({ command }) => {
-  *   const isBuild = command === 'build'
-  * })
-  * ```
-  */
-  isBuild: boolean;
-  /**
-  * Project root directory. Can be an absolute path, or a path relative from
-  * the location of the config file itself.
-  * @default process.cwd()
-  */
-  root?: string;
   /**
   * Whether to generate sourcemap
   * @default !isBuild || !!process.env.VSCODE_DEBUG
@@ -165,9 +144,15 @@ interface ElectronWithUpdaterOptions {
   */
   bytecode?: boolean | BytecodeOptions;
   /**
-  * Use `NotBundle()` plugin in main
+  * Faster dev startup by externalize all node modules in entry and main.
+  *
+  * Only works in development (`isBuild === false`).
   * @default true
   */
+  notBundle?: boolean | RolldownOrRollupOptions["external"];
+  /**
+  * @deprecated use `notBundle` instead
+  */
   useNotBundle?: boolean;
   /**
   * Whether to generate version json
@@ -175,12 +160,21 @@ interface ElectronWithUpdaterOptions {
   */
   buildVersionJson?: boolean;
   /**
+  * Generate and serve a local update package during dev startup.
+  *
+  * This is useful for testing update checks, simulated download progress,
+  * and restart/install behavior without publishing a remote release.
+  *
+  * @default false
+  */
+  localDevUpdate?: boolean | LocalDevUpdateOptions;
+  /**
   * Addtional `external` option in `build.rolldownOptions`,
   *
-  * If is in dev and `entry.postBuild` is not setup,
+  * If equals `true`,
   * external `dependencies` in `package.json` by default
   */
-  external?: (string | RegExp)[];
+  external?: (string | RegExp)[] | boolean;
   /**
   * Options for entry (app.asar)
   *
@@ -250,7 +244,7 @@ interface ElectronWithUpdaterOptions {
     * @param options options for `child_process.spawn`
     * @param customElectronPkg custom electron package name (default: 'electron')
     */
-    onstart?: ElectronOptions["onstart"];
+    onstart?: MultiEnvElectronOptions["onstart"];
   } & CommonBuildOption;
   /**
   * Preload process options
@@ -263,29 +257,37 @@ interface ElectronWithUpdaterOptions {
   */
   updater?: UpdaterOptions;
 }
-interface GeneratorOverrideFunctions {
+interface LocalDevUpdateOptions {
   /**
-  * Custom signature generate function
-  * @param buffer file buffer
-  * @param privateKey private key
-  * @param cert certificate string, **EOL must be `\n`**
-  * @param version current version
+  * Package file used for local dev update name/version.
+  *
+  * This is useful when the Electron app package is not the project root
+  * package, such as a playground or example app.
+  *
+  * @default project package.json
   */
-  generateSignature?: (buffer: Buffer, privateKey: string, cert: string, version: string) => Promisable<string>;
+  packageJsonPath?: string;
   /**
-  * Custom generate update json function
-  * @param existingJson The existing JSON object.
-  * @param buffer file buffer
-  * @param signature generated signature
-  * @param version current version
-  * @param minVersion The minimum version
+  * Directory that contains local update resources.
+  *
+  * The generated version file is written under `{baseDir}/{versionPath}` and
+  * update archives are written as `{baseDir}/{name}-{version}.asar.gz`.
+  *
+  * @default 'release/local-update'
   */
-  generateUpdateJson?: (existingJson: UpdateJSON, signature: string, version: string, minVersion: string) => Promisable<UpdateJSON>;
+  baseDir?: string;
   /**
-  * Custom generate zip file buffer
-  * @param buffer source buffer
+  * Local read chunk size for simulated download progress.
+  *
+  * @default LocalDevProvider default
   */
-  generateGzipFile?: (buffer: Buffer) => Promisable<Buffer>;
+  chunkSize?: number;
+  /**
+  * Delay between simulated progress chunks in milliseconds.
+  *
+  * @default LocalDevProvider default
+  */
+  chunkDelay?: number;
 }
 interface UpdaterOptions {
   /**
@@ -309,7 +311,7 @@ interface UpdaterOptions {
     entryOutDir?: string;
     /**
     * Path to version info output, content is {@link UpdateJSON}
-    * @default `version.json`
+    * @default `release/version.json`
     */
     versionPath?: string;
     /**
@@ -375,80 +377,45 @@ interface UpdaterOptions {
   };
   overrideGenerator?: GeneratorOverrideFunctions;
 }
+interface GeneratorOverrideFunctions {
+  /**
+  * Custom signature generate function
+  * @param buffer file buffer
+  * @param privateKey private key
+  * @param cert certificate string, **EOL must be `\n`**
+  * @param version current version
+  */
+  generateSignature?: (buffer: Buffer, privateKey: string, cert: string, version: string) => Promisable<string>;
+  /**
+  * Custom generate update json function
+  * @param existingJson The existing JSON object.
+  * @param signature generated signature
+  * @param version current version
+  * @param minVersion The minimum version
+  */
+  generateUpdateJson?: (existingJson: UpdateJSON, signature: string, version: string, minVersion: string) => Promisable<UpdateJSON>;
+  /**
+  * Custom generate zip file buffer
+  * @param buffer source buffer
+  */
+  generateGzipFile?: (buffer: Buffer) => Promisable<Buffer>;
+}
 //#endregion
 //#region src/vite/core.d.ts
-interface ElectronSimpleOptions {
-  main: ElectronOptions;
-  preload?: Omit<ElectronOptions, "entry"> & {
-    /**
-    * Shortcut of `build.rolldownOptions.input`.
-    *
-    * Preload scripts may contain Web assets, so use the `build.rolldownOptions.input` instead `build.lib.entry`.
-    */
-    input: RolldownOptions["input"];
-  };
-}
-type StartupFn = NonNullable<NonNullable<ElectronSimpleOptions["main"]>["onstart"]>;
-/**
-* Startup function for debug
-* @see {@link https://github.com/electron-vite/electron-vite-vue/blob/main/vite.config.ts electron-vite-vue template}
-* @example
-* import { debugStartup, buildElectronPluginOptions } from 'electron-incremental-update/vite'
-* const options = buildElectronPluginOptions({
-*   // ...
-*   main: {
-*     // ...
-*     startup: debugStartup
-*   },
-* })
-*/
-declare const debugStartup: StartupFn;
-/**
-* Startup function to filter unwanted error message
-* @see {@link https://github.com/electron/electron/issues/46903#issuecomment-2848483520 reference}
-* @example
-* import { filterErrorMessageStartup, buildElectronPluginOptions } from 'electron-incremental-update/vite'
-* const options = buildElectronPluginOptions({
-*   // ...
-*   main: {
-*     // ...
-*     startup: args => filterErrorMessageStartup(
-*       args,
-*       // ignore error message when function returns false
-*       msg => !/"code":-32601/.test(msg)
-*     )
-*   },
-* })
-*/
-declare function filterErrorMessageStartup(args: Parameters<StartupFn>[0], filter: (msg: string) => boolean): Promise<void>;
 /**
-* Startup function util to fix Windows terminal charset
-* @example
-* import { debugStartup, fixWinCharEncoding, buildElectronPluginOptions } from 'electron-incremental-update/vite'
-* const options = buildElectronPluginOptions({
-*   // ...
-*   main: {
-*     // ...
-*     startup: fixWinCharEncoding(debugStartup)
-*   },
-* })
-*/
-declare function fixWinCharEncoding<T extends AnyFunction>(fn: T): T;
-/**
-* Base on `./electron/simple`
+* Base on `vite-plugin-electron/multi-env`
 * - integrate with updater
 * - no `renderer` config
 * - remove old output file
 * - externalize dependencies
 * - auto restart when entry file changes
-* - other configs in {@link https://github.com/electron-vite/electron-vite-vue/blob/main/vite.config.ts electron-vite-vue template}
 *
-* You can override all the vite configs, except output directories (use `options.updater.paths.electronDistPath` instead)
+* You can override all the environment configs, except output directories (use `options.updater.paths.electronDistPath` instead)
 *
 * @example
 * ```ts
 * import { defineConfig } from 'vite'
-* import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
+* import { electronWithUpdater } from 'electron-incremental-update/vite'
 *
 * export default defineConfig(async ({ command }) => {
 *   const isBuild = command === 'build'
@@ -458,8 +425,6 @@ declare function fixWinCharEncoding<T extends AnyFunction>(fn: T): T;
 *         isBuild,
 *         main: {
 *           files: ['./electron/main/index.ts', './electron/main/worker.ts'],
-*           // see https://github.com/electron-vite/electron-vite-vue/blob/85ed267c4851bf59f32888d766c0071661d4b94c/vite.config.ts#L22-L28
-*           onstart: debugStartup,
 *         },
 *         preload: {
 *           files: './electron/preload/index.ts',
@@ -469,26 +434,18 @@ declare function fixWinCharEncoding<T extends AnyFunction>(fn: T): T;
 *         }
 *       }),
 *     ],
-*     server: process.env.VSCODE_DEBUG && (() => {
-*       const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
-*       return {
-*         host: url.hostname,
-*         port: +url.port,
-*       }
-*     })(),
 *   }
 * })
 * ```
 */
-declare function electronWithUpdater(options: ElectronWithUpdaterOptions): Promise<PluginOption[] | undefined>;
+declare function electronWithUpdater(options: ElectronWithUpdaterOptions): Promise<Plugin[] | undefined>;
 //#endregion
 //#region src/vite/define.d.ts
-type MakeOptional<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
-interface ElectronViteHelperOptions extends MakeOptional<ElectronWithUpdaterOptions, "isBuild"> {
+interface ElectronViteHelperOptions extends ElectronWithUpdaterOptions {
   /**
   * Config for renderer process
   */
-  renderer?: Omit<UserConfig, "root">;
+  renderer?: UserConfig;
 }
 /**
 * Vite config helper
@@ -500,8 +457,6 @@ interface ElectronViteHelperOptions extends MakeOptional<ElectronWithUpdaterOpti
 * export default defineElectronConfig({
 *   main: {
 *     files: ['./electron/main/index.ts', './electron/main/worker.ts'],
-*     // see https://github.com/electron-vite/electron-vite-vue/blob/85ed267c4851bf59f32888d766c0071661d4b94c/vite.config.ts#L22-L28
-*     onstart: debugStartup,
 *   },
 *   preload: {
 *     files: './electron/preload/index.ts',
@@ -521,6 +476,6 @@ interface ElectronViteHelperOptions extends MakeOptional<ElectronWithUpdaterOpti
 * })
 * ```
 */
-declare function defineElectronConfig(options: ElectronViteHelperOptions): UserConfigFn;
+declare function defineElectronConfig(options: ElectronViteHelperOptions): UserConfig;
 //#endregion
-export { type ElectronViteHelperOptions, type ElectronWithUpdaterOptions, convertLiteral, debugStartup, electronWithUpdater as default, electronWithUpdater, defineElectronConfig, filterErrorMessageStartup, fixWinCharEncoding };
+export { type ElectronViteHelperOptions, type ElectronWithUpdaterOptions, type LocalDevUpdateOptions, electronWithUpdater as default, electronWithUpdater, defineElectronConfig, filterErrorMessageStartup, fixWinCharEncoding };