electron-incremental-update 2.4.1 → 2.4.3

package/README.md

@@ -857,13 +857,34 @@ export interface ElectronWithUpdaterOptions {
    *
    * To change output directories, use `options.updater.paths.electronDistPath` instead
    */
-  main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'> & ExcludeOutputDirOptions
+  main: {
+    /**
+     * Shortcut of `build.rollupOptions.input`
+     */
+    files: NonNullable<ElectronOptions['entry']>
+    /**
+     * Electron App startup function.
+     *
+     * It will mount the Electron App child-process to `process.electronApp`.
+     * @param argv default value `['.', '--no-sandbox']`
+     * @param options options for `child_process.spawn`
+     * @param customElectronPkg custom electron package name (default: 'electron')
+     */
+    onstart?: ElectronOptions['onstart']
+  } & ViteOverride
   /**
    * Preload process options
    *
    * To change output directories, use `options.updater.paths.electronDistPath` instead
    */
-  preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'> & ExcludeOutputDirOptions
+  preload: {
+    /**
+     * Shortcut of `build.rollupOptions.input`.
+     *
+     * Preload scripts may contain Web assets, so use the `build.rollupOptions.input` instead `build.lib.entry`.
+     */
+    files: NonNullable<ElectronOptions['entry']>
+  } & ViteOverride
   /**
    * Updater options
    */
@@ -997,7 +1018,7 @@ export interface BuildEntryOption {
    */
   appEntryPath?: string
   /**
-   * Esbuild path map of native modules in entry directory
+   * Vite input options of native modules in entry directory
    *
    * @default {}
    * @example

package/dist/provider.cjs

@@ -261,15 +261,6 @@ var BaseGitHubProvider = class extends BaseProvider {
 var ERROR_MSG = "Cannot find UpdateJSON in latest release";
 var GitHubApiProvider = class extends BaseGitHubProvider {
   name = "GithubApiProvider";
-  /**
-   * Update Provider for Github API, you need to upload `version.json` to release as well
-   * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
-   * - download update json and get version and download url
-   * - download update asar from update info
-   *
-   * you can setup `urlHandler` in options to modify url before request
-   * @param options provider options
-   */
   constructor(options) {
     super(options);
   }
@@ -302,15 +293,6 @@ var GitHubApiProvider = class extends BaseGitHubProvider {
 // src/provider/github/atom.ts
 var GitHubAtomProvider = class extends BaseGitHubProvider {
   name = "GithubAtomProvider";
-  /**
-   * Update Provider for Github repo
-   * - check update from `https://github.com/{user}/{repo}/releases.atom`
-   * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
-   * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-   *
-   * you can setup `urlHandler` in options to modify url before request
-   * @param options provider options
-   */
   constructor(options) {
     super(options);
   }
@@ -341,14 +323,6 @@ var GitHubAtomProvider = class extends BaseGitHubProvider {
 // src/provider/github/file.ts
 var GitHubProvider = class extends BaseGitHubProvider {
   name = "GithubProvider";
-  /**
-   * Update Provider for Github repo
-   * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
-   * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-   *
-   * you can setup `urlHandler` in options to modify url before request
-   * @param options provider options
-   */
   constructor(options) {
     super(options);
     if (!options.branch) {

package/dist/provider.d.cts

@@ -71,17 +71,17 @@ declare abstract class BaseGitHubProvider<T extends BaseGitHubProviderOptions =
 interface GitHubApiProviderOptions extends BaseGitHubProviderOptions {
     token?: string;
 }
+/**
+ * Update Provider for Github API, you need to upload `version.json` to release as well
+ * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
+ * - download update json and get version and download url
+ * - download update asar from update info
+ *
+ * you can setup `urlHandler` in options to modify url before request
+ * @param options provider options
+ */
 declare class GitHubApiProvider extends BaseGitHubProvider<GitHubApiProviderOptions> {
     name: string;
-    /**
-     * Update Provider for Github API, you need to upload `version.json` to release as well
-     * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
-     * - download update json and get version and download url
-     * - download update asar from update info
-     *
-     * you can setup `urlHandler` in options to modify url before request
-     * @param options provider options
-     */
     constructor(options: GitHubApiProviderOptions);
     protected getHeaders(accept: string): Record<string, string>;
     /**
@@ -90,17 +90,17 @@ declare class GitHubApiProvider extends BaseGitHubProvider<GitHubApiProviderOpti
     protected getVersionURL(versionPath: string, signal: AbortSignal): Promise<string>;
 }
 
+/**
+ * Update Provider for Github repo
+ * - check update from `https://github.com/{user}/{repo}/releases.atom`
+ * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
+ * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+ *
+ * you can setup `urlHandler` in options to modify url before request
+ * @param options provider options
+ */
 declare class GitHubAtomProvider extends BaseGitHubProvider {
     name: string;
-    /**
-     * Update Provider for Github repo
-     * - check update from `https://github.com/{user}/{repo}/releases.atom`
-     * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
-     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-     *
-     * you can setup `urlHandler` in options to modify url before request
-     * @param options provider options
-     */
     constructor(options: BaseGitHubProviderOptions);
     protected getHeaders(accept: string): Record<string, string>;
     /**
@@ -116,16 +116,16 @@ interface GitHubProviderOptions extends BaseGitHubProviderOptions {
      */
     branch?: string;
 }
+/**
+ * Update Provider for Github repo
+ * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
+ * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+ *
+ * you can setup `urlHandler` in options to modify url before request
+ * @param options provider options
+ */
 declare class GitHubProvider extends BaseGitHubProvider<GitHubProviderOptions> {
     name: string;
-    /**
-     * Update Provider for Github repo
-     * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
-     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-     *
-     * you can setup `urlHandler` in options to modify url before request
-     * @param options provider options
-     */
     constructor(options: GitHubProviderOptions);
     protected getHeaders(accept: string): Record<string, string>;
     protected getVersionURL(versionPath: string): string;

package/dist/provider.d.ts

@@ -71,17 +71,17 @@ declare abstract class BaseGitHubProvider<T extends BaseGitHubProviderOptions =
 interface GitHubApiProviderOptions extends BaseGitHubProviderOptions {
     token?: string;
 }
+/**
+ * Update Provider for Github API, you need to upload `version.json` to release as well
+ * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
+ * - download update json and get version and download url
+ * - download update asar from update info
+ *
+ * you can setup `urlHandler` in options to modify url before request
+ * @param options provider options
+ */
 declare class GitHubApiProvider extends BaseGitHubProvider<GitHubApiProviderOptions> {
     name: string;
-    /**
-     * Update Provider for Github API, you need to upload `version.json` to release as well
-     * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
-     * - download update json and get version and download url
-     * - download update asar from update info
-     *
-     * you can setup `urlHandler` in options to modify url before request
-     * @param options provider options
-     */
     constructor(options: GitHubApiProviderOptions);
     protected getHeaders(accept: string): Record<string, string>;
     /**
@@ -90,17 +90,17 @@ declare class GitHubApiProvider extends BaseGitHubProvider<GitHubApiProviderOpti
     protected getVersionURL(versionPath: string, signal: AbortSignal): Promise<string>;
 }
 
+/**
+ * Update Provider for Github repo
+ * - check update from `https://github.com/{user}/{repo}/releases.atom`
+ * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
+ * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+ *
+ * you can setup `urlHandler` in options to modify url before request
+ * @param options provider options
+ */
 declare class GitHubAtomProvider extends BaseGitHubProvider {
     name: string;
-    /**
-     * Update Provider for Github repo
-     * - check update from `https://github.com/{user}/{repo}/releases.atom`
-     * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
-     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-     *
-     * you can setup `urlHandler` in options to modify url before request
-     * @param options provider options
-     */
     constructor(options: BaseGitHubProviderOptions);
     protected getHeaders(accept: string): Record<string, string>;
     /**
@@ -116,16 +116,16 @@ interface GitHubProviderOptions extends BaseGitHubProviderOptions {
      */
     branch?: string;
 }
+/**
+ * Update Provider for Github repo
+ * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
+ * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+ *
+ * you can setup `urlHandler` in options to modify url before request
+ * @param options provider options
+ */
 declare class GitHubProvider extends BaseGitHubProvider<GitHubProviderOptions> {
     name: string;
-    /**
-     * Update Provider for Github repo
-     * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
-     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-     *
-     * you can setup `urlHandler` in options to modify url before request
-     * @param options provider options
-     */
     constructor(options: GitHubProviderOptions);
     protected getHeaders(accept: string): Record<string, string>;
     protected getVersionURL(versionPath: string): string;

package/dist/provider.js

@@ -73,15 +73,6 @@ var BaseGitHubProvider = class extends BaseProvider {
 var ERROR_MSG = "Cannot find UpdateJSON in latest release";
 var GitHubApiProvider = class extends BaseGitHubProvider {
   name = "GithubApiProvider";
-  /**
-   * Update Provider for Github API, you need to upload `version.json` to release as well
-   * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
-   * - download update json and get version and download url
-   * - download update asar from update info
-   *
-   * you can setup `urlHandler` in options to modify url before request
-   * @param options provider options
-   */
   constructor(options) {
     super(options);
   }
@@ -114,15 +105,6 @@ var GitHubApiProvider = class extends BaseGitHubProvider {
 // src/provider/github/atom.ts
 var GitHubAtomProvider = class extends BaseGitHubProvider {
   name = "GithubAtomProvider";
-  /**
-   * Update Provider for Github repo
-   * - check update from `https://github.com/{user}/{repo}/releases.atom`
-   * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
-   * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-   *
-   * you can setup `urlHandler` in options to modify url before request
-   * @param options provider options
-   */
   constructor(options) {
     super(options);
   }
@@ -153,14 +135,6 @@ var GitHubAtomProvider = class extends BaseGitHubProvider {
 // src/provider/github/file.ts
 var GitHubProvider = class extends BaseGitHubProvider {
   name = "GithubProvider";
-  /**
-   * Update Provider for Github repo
-   * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
-   * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-   *
-   * you can setup `urlHandler` in options to modify url before request
-   * @param options provider options
-   */
   constructor(options) {
     super(options);
     if (!options.branch) {

package/dist/vite.d.ts

@@ -1,7 +1,7 @@
 import { Promisable, AnyFunction } from '@subframe7536/type-utils';
-import { InlineConfig, PluginOption } from 'vite';
-import { ElectronSimpleOptions } from 'vite-plugin-electron/simple.js';
-import { ElectronSimpleOptions as ElectronSimpleOptions$1 } from 'vite-plugin-electron/simple';
+import { InlineConfig, PluginOption, UserConfig, UserConfigFn } from 'vite';
+import { ElectronOptions } from 'vite-plugin-electron';
+import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
 export { isCI } from 'ci-info';
 export { getPackageInfo, getPackageInfoSync, loadPackageJSON, resolveModule } from 'local-pkg';
 
@@ -81,15 +81,11 @@ interface PKG {
     main: string;
     type: 'commonjs' | 'module';
 }
-type MakeRequired<T, K extends keyof T> = NonNullable<T> & {
-    [P in K]-?: T[P];
-};
-type ReplaceKey<T, Key extends keyof T, NewKey extends string> = Omit<T, Key> & {
-    [P in NewKey]: T[Key];
-};
-type MakeRequiredAndReplaceKey<T, K extends keyof T, NewKey extends string> = MakeRequired<ReplaceKey<T, K, NewKey>, NewKey>;
-type ExcludeOutputDirOptions = {
-    vite?: {
+interface ViteOverride {
+    /**
+     * Override vite options
+     */
+    vite?: ElectronOptions['vite'] & {
         build?: {
             outDir: never;
             rollupOptions?: {
@@ -99,7 +95,7 @@ type ExcludeOutputDirOptions = {
             };
         };
     };
-};
+}
 interface ElectronWithUpdaterOptions {
     /**
      * Whether is in build mode
@@ -151,13 +147,34 @@ interface ElectronWithUpdaterOptions {
      *
      * To change output directories, use `options.updater.paths.electronDistPath` instead
      */
-    main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'> & ExcludeOutputDirOptions;
+    main: {
+        /**
+         * Shortcut of `build.rollupOptions.input`
+         */
+        files: NonNullable<ElectronOptions['entry']>;
+        /**
+         * Electron App startup function.
+         *
+         * It will mount the Electron App child-process to `process.electronApp`.
+         * @param argv default value `['.', '--no-sandbox']`
+         * @param options options for `child_process.spawn`
+         * @param customElectronPkg custom electron package name (default: 'electron')
+         */
+        onstart?: ElectronOptions['onstart'];
+    } & ViteOverride;
     /**
      * Preload process options
      *
      * To change output directories, use `options.updater.paths.electronDistPath` instead
      */
-    preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'> & ExcludeOutputDirOptions;
+    preload: {
+        /**
+         * Shortcut of `build.rollupOptions.input`.
+         *
+         * Preload scripts may contain Web assets, so use the `build.rollupOptions.input` instead `build.lib.entry`.
+         */
+        files: NonNullable<ElectronOptions['entry']>;
+    } & ViteOverride;
     /**
      * Updater options
      */
@@ -379,7 +396,7 @@ interface UpdaterOptions {
     overrideGenerator?: GeneratorOverrideFunctions;
 }
 
-type StartupFn = NonNullable<NonNullable<ElectronSimpleOptions$1['main']>['onstart']>;
+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}
@@ -473,4 +490,44 @@ declare function fixWinCharEncoding<T extends AnyFunction>(fn: T): T;
  */
 declare function electronWithUpdater(options: ElectronWithUpdaterOptions): Promise<PluginOption[] | undefined>;
 
-export { type ElectronWithUpdaterOptions, convertLiteral, debugStartup, electronWithUpdater as default, electronWithUpdater, filterErrorMessageStartup, fixWinCharEncoding };
+type MakeOptional<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
+interface ElectronViteHelperOptions extends MakeOptional<ElectronWithUpdaterOptions, 'isBuild'> {
+    /**
+     * Config for renderer process
+     */
+    renderer?: UserConfig;
+}
+/**
+ * Vite config helper
+ * @see {@link electronWithUpdater}
+ * @example
+ * ```ts
+ * import { defineElectronConfig } from 'electron-incremental-update/vite'
+ *
+ * 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',
+ *   },
+ *   updater: {
+ *     // options
+ *   },
+ *   renderer: {
+ *     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 defineElectronConfig(options: ElectronViteHelperOptions): UserConfigFn;
+
+export { type ElectronViteHelperOptions, type ElectronWithUpdaterOptions, convertLiteral, debugStartup, electronWithUpdater as default, defineElectronConfig, electronWithUpdater, filterErrorMessageStartup, fixWinCharEncoding };

package/dist/vite.js

@@ -390,16 +390,16 @@ var CJSShim = `
 import __cjs_url__ from 'node:url';
 import __cjs_path__ from 'node:path';
 import __cjs_mod__ from 'node:module';
-const __filename = __cjs_url__.fileURLToPath(import.meta.url);
-const __dirname = __cjs_path__.dirname(__filename);
-const require = __cjs_mod__.createRequire(import.meta.url);
+var __filename = __cjs_url__.fileURLToPath(import.meta.url);
+var __dirname = __cjs_path__.dirname(__filename);
+var require = __cjs_mod__.createRequire(import.meta.url);
 `;
 var CJSShim_electron_30 = `
 // -- CommonJS Shims --
 import __cjs_mod__ from 'node:module';
-const __filename = import.meta.filename;
-const __dirname = import.meta.dirname;
-const require = __cjs_mod__.createRequire(import.meta.url);
+var __filename = import.meta.filename;
+var __dirname = import.meta.dirname;
+var require = __cjs_mod__.createRequire(import.meta.url);
 `;
 var shim = electronMajorVersion >= 30 ? CJSShim_electron_30 : CJSShim;
 
@@ -854,7 +854,6 @@ async function electronWithUpdater(options) {
     },
     preload: {
       input: _preload.files,
-      onstart: _preload.onstart,
       vite: mergeConfig(
         {
           plugins: [
@@ -931,4 +930,16 @@ async function electronWithUpdater(options) {
   return result;
 }
 
-export { convertLiteral, debugStartup, electronWithUpdater as default, electronWithUpdater, filterErrorMessageStartup, fixWinCharEncoding };
+// src/vite/define.ts
+function defineElectronConfig(options) {
+  return ({ command }) => {
+    options.isBuild ??= command === "build";
+    const electronPlugin = electronWithUpdater(options);
+    const result = options.renderer ?? {};
+    result.plugins ??= [];
+    result.plugins.push(electronPlugin);
+    return result;
+  };
+}
+
+export { convertLiteral, debugStartup, electronWithUpdater as default, defineElectronConfig, electronWithUpdater, filterErrorMessageStartup, fixWinCharEncoding };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "2.4.1",
+  "version": "2.4.3",
   "description": "Electron incremental update tools with Vite plugin, support bytecode protection",
   "author": "subframe7536",
   "license": "MIT",
@@ -59,24 +59,24 @@
     "@electron/asar": "*"
   },
   "dependencies": {
-    "@babel/core": "^7.27.4",
+    "@babel/core": "^7.28.0",
     "@babel/plugin-transform-arrow-functions": "^7.27.1",
     "@babel/plugin-transform-template-literals": "^7.27.1",
     "@subframe7536/type-utils": "^0.2.0",
-    "ci-info": "^4.2.0",
+    "ci-info": "^4.3.0",
     "local-pkg": "^1.1.1",
     "magic-string": "^0.30.17",
-    "selfsigned": "^2.4.1",
+    "selfsigned": "^3.0.1",
     "vite-plugin-electron": "^0.29.0"
   },
   "devDependencies": {
     "@subframe7536/eslint-config": "^1.3.1",
     "@types/babel__core": "^7.20.5",
-    "@types/node": "^22.15.30",
-    "@vitest/eslint-plugin": "^1.2.1",
+    "@types/node": "^22.17.0",
+    "@vitest/eslint-plugin": "^1.3.4",
     "bumpp": "^10.1.1",
     "electron": "36.2.0",
-    "esbuild": "^0.25.4",
+    "esbuild": "^0.25.8",
     "eslint": "^9.28.0",
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
@@ -90,8 +90,7 @@
     },
     "onlyBuiltDependencies": [
       "electron",
-      "esbuild",
-      "unrs-resolver"
+      "esbuild"
     ]
   }
 }