electron-incremental-update 0.9.1 → 1.0.0

package/dist/utils.mjs

@@ -1,41 +1,35 @@
 import {
-  DEFAULT_APP_NAME,
-  NoSuchNativeModuleError,
   disableHWAccForWin7,
-  getAppVersion,
-  getElectronVersion,
-  getLocale,
-  getProductAsarPath,
-  handleUnexpectedErrors,
+  getPathFromAppNameAsar,
+  getPaths,
+  getVersions,
   is,
-  isNoSuchNativeModuleError,
-  parseGithubCdnURL,
-  requireNative,
+  loadNativeModuleFromEntry,
   restartApp,
   setAppUserModelId,
   setPortableAppDataPath,
   singleInstance,
   waitAppReady
-} from "./chunk-SPZL37O5.mjs";
+} from "./chunk-OUZLSVQC.mjs";
 import {
+  handleUnexpectedErrors,
+  isUpdateJSON,
+  parseGithubCdnURL,
   parseVersion,
   unzipFile,
   zipFile
-} from "./chunk-CMBFI77K.mjs";
+} from "./chunk-GB6VLKJZ.mjs";
 export {
-  DEFAULT_APP_NAME,
-  NoSuchNativeModuleError,
   disableHWAccForWin7,
-  getAppVersion,
-  getElectronVersion,
-  getLocale,
-  getProductAsarPath,
+  getPathFromAppNameAsar,
+  getPaths,
+  getVersions,
   handleUnexpectedErrors,
   is,
-  isNoSuchNativeModuleError,
+  isUpdateJSON,
+  loadNativeModuleFromEntry,
   parseGithubCdnURL,
   parseVersion,
-  requireNative,
   restartApp,
   setAppUserModelId,
   setPortableAppDataPath,

package/dist/vite.d.mts

@@ -1,6 +1,14 @@
 import { Plugin } from 'vite';
-import { U as UpdateJSON } from './updateJson-synsK-Pt.mjs';
+import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
+import { Promisable, Prettify } from '@subframe7536/type-utils';
+import { BuildOptions } from 'esbuild';
+import { a as UpdateJSON } from './noDep-TvZoKVF8.mjs';
 
+type PKG = {
+    name: string;
+    version: string;
+    main: string;
+};
 type DistinguishedName = {
     countryName?: string;
     stateOrProvinceName?: string;
@@ -14,6 +22,85 @@ type DistinguishedName = {
     businessCategory?: string;
     emailAddress?: string;
 };
+type BuildEntryOption = {
+    /**
+     * whether to minify
+     * @default isBuild
+     */
+    minify: boolean;
+    /**
+     * Whether to generate sourcemap
+     * @default isBuild
+     */
+    sourcemap: boolean;
+    /**
+     * path to app entry output file
+     * @default 'dist-entry'
+     */
+    entryOutputDirPath: string;
+    /**
+     * path to app entry file
+     * @default 'electron/entry.ts'
+     */
+    appEntryPath: string;
+    /**
+     * esbuild path map of native modules in entry directory
+     *
+     * @default {}
+     * @example
+     * { db: './electron/native/db.ts' }
+     */
+    nativeModuleEntryMap?: Record<string, string>;
+    /**
+     * custom options for esbuild
+     * ```ts
+     * // default options
+     * const options = {
+     *   entryPoints: {
+     *     entry: appEntryPath,
+     *     ...moduleEntryMap,
+     *   },
+     *   bundle: true,
+     *   platform: 'node',
+     *   outdir: entryOutputDirPath,
+     *   minify,
+     *   sourcemap,
+     *   entryNames: '[dir]/[name]',
+     *   assetNames: '[dir]/[name]',
+     *   external: ['electron', 'original-fs'],
+     *   loader: {
+     *     '.node': 'empty',
+     *   },
+     * }
+     * ```
+     */
+    overrideEsbuildOptions?: BuildOptions;
+    /**
+     * resolve extra files, such as `.node`
+     */
+    postBuild?: (args: {
+        /**
+         * get path from `entryOutputDirPath`
+         */
+        getPathFromEntryOutputDir: (...paths: string[]) => string;
+        /**
+         * copy file to `entryOutputDirPath`
+         *
+         * if `to` absent, set to `basename(from)`
+         *
+         * if `skipIfExist` absent, skip copy if `to` exist
+         */
+        existsAndCopyToEntryOutputDir: (options: {
+            from: string;
+            to?: string;
+            /**
+             * skip copy if `to` exist
+             * @default true
+             */
+            skipIfExist?: boolean;
+        }) => void;
+    }) => Promisable<void>;
+};
 type GeneratorOverrideFunctions = {
     /**
      * custom signature generate function
@@ -34,49 +121,23 @@ type GeneratorOverrideFunctions = {
      */
     generateVersionJson?: (existingJson: UpdateJSON, buffer: Buffer, signature: string, version: string, minVersion: string) => UpdateJSON | Promise<UpdateJSON>;
 };
-type Options = {
-    /**
-     * whether is in build mode
-     */
-    isBuild: boolean;
-    /**
-     * the name of you application
-     *
-     * you can set as 'name' in `package.json`
-     */
-    productName: string;
-    /**
-     * the version of you application
-     *
-     * you can set as 'version' in `package.json`
-     */
-    version: string;
+type ElectronUpdaterOptions = {
     /**
      * mini version of entry
-     * @default version
+     * @default '0.0.0'
      */
     minimumVersion?: string;
     /**
-     * Whether to minify entry file
+     * config for entry (app.asar)
      */
-    minify?: boolean;
+    entry?: Partial<BuildEntryOption>;
     /**
      * paths config
      */
     paths?: {
-        /**
-         * Path to app entry file
-         * @default 'electron/app.ts'
-         */
-        entryPath?: string;
-        /**
-         * Path to app entry output file
-         * @default 'app.js'
-         */
-        entryOutputPath?: string;
         /**
          * Path to asar file
-         * @default `release/${productName}.asar`
+         * @default `release/${app.name}.asar`
          */
         asarOutputPath?: string;
         /**
@@ -86,7 +147,7 @@ type Options = {
         versionPath?: string;
         /**
          * Path to gzipped asar file
-         * @default `release/${productName}-${version}.asar.gz`
+         * @default `release/${app.name}-${version}.asar.gz`
          */
         gzipPath?: string;
         /**
@@ -105,19 +166,23 @@ type Options = {
      */
     keys?: {
         /**
-         * Path to the pem file that contains private key
+         * path to the pem file that contains private key
          * if not ended with .pem, it will be appended
+         *
+         * **if `UPDATER_PK` is set, will read it instead of read from `privateKeyPath`**
          * @default 'keys/private.pem'
          */
         privateKeyPath?: string;
         /**
-         * Path to the pem file that contains public key
+         * path to the pem file that contains public key
          * if not ended with .pem, it will be appended
+         *
+         * **if `UPDATER_CERT` is set, will read it instead of read from `certPath`**
          * @default 'keys/cert.pem'
          */
         certPath?: string;
         /**
-         * Length of the key
+         * length of the key
          * @default 2048
          */
         keyLength?: number;
@@ -130,20 +195,122 @@ type Options = {
             /**
              * the subject of the certificate
              *
-             * @default { commonName: productName, organizationName: `org.${productName}` }
+             * @default { commonName: `${app.name}`, organizationName: `org.${app.name}` }
              */
             subject?: DistinguishedName;
             /**
              * expire days of the certificate
              *
-             * @default 365
+             * @default 3650
              */
             days?: number;
         };
-        overrideFunctions?: GeneratorOverrideFunctions;
+        overrideGenerator?: GeneratorOverrideFunctions;
     };
 };
 
-declare function ElectronUpdater(options: Options): Plugin;
+type MakeRequired<T, K extends keyof T> = Exclude<T, undefined> & {
+    [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>;
+/**
+ * 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 function debugStartup(args: {
+    startup: (argv?: string[]) => Promise<void>;
+    reload: () => void;
+}): void;
+type ElectronWithUpdaterOptions = {
+    /**
+     * whether is in build mode
+     * ```ts
+     * export default defineConfig(({ command }) => {
+     *   const isBuild = command === 'build'
+     * })
+     * ```
+     */
+    isBuild: boolean;
+    /**
+     * name, version and main in `package.json`
+     * ```ts
+     * import pkg from './package.json'
+     * ```
+     */
+    pkg: PKG;
+    /**
+     * main options
+     */
+    main: Prettify<MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'>>;
+    /**
+     * preload options
+     */
+    preload: Prettify<MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'>>;
+    /**
+     * updater options
+     */
+    updater?: ElectronUpdaterOptions;
+    /**
+     * use NotBundle() plugin in main
+     * @default true
+     */
+    useNotBundle?: boolean;
+    /**
+     * Whether to log parsed options
+     */
+    logParsedOptions?: boolean;
+};
+/**
+ * build options for `vite-plugin-electron/simple`
+ * - integrate with updater
+ * - only contains `main` and `preload` configs
+ * - remove old electron files
+ * - 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}
+ * - no `vite-plugin-electron-renderer` config
+ *
+ * you can override all the configs
+ *
+ * **Limitation**: entry file change cannot trigger auto restart
+ *
+ * @example
+ * import { defineConfig } from 'vite'
+ * import electronSimple from 'vite-plugin-electron/simple'
+ * import { buildElectronPluginOptions } from 'electron-incremental-update/vite'
+ * import pkg from './package.json'
+ *
+ * export default defineConfig(({ command }) => {
+ *   const electronOptions = buildElectronPluginOptions({
+ *     isBuild: command === 'build',
+ *     pkg,
+ *     main: {
+ *       files: ['./electron/main/index.ts', './electron/main/worker.ts'],
+ *     },
+ *     preload: {
+ *       files: './electron/preload/index.ts',
+ *     },
+ *   })
+ *   return {
+ *     plugins: [electronSimple(electronOptions)],
+ *     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): (Plugin<any> | Promise<Plugin<any>[]> | undefined)[];
 
-export { ElectronUpdater, type Options };
+export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater };

package/dist/vite.d.ts

@@ -1,6 +1,14 @@
 import { Plugin } from 'vite';
-import { U as UpdateJSON } from './updateJson-synsK-Pt.js';
+import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
+import { Promisable, Prettify } from '@subframe7536/type-utils';
+import { BuildOptions } from 'esbuild';
+import { a as UpdateJSON } from './noDep-TvZoKVF8.js';
 
+type PKG = {
+    name: string;
+    version: string;
+    main: string;
+};
 type DistinguishedName = {
     countryName?: string;
     stateOrProvinceName?: string;
@@ -14,6 +22,85 @@ type DistinguishedName = {
     businessCategory?: string;
     emailAddress?: string;
 };
+type BuildEntryOption = {
+    /**
+     * whether to minify
+     * @default isBuild
+     */
+    minify: boolean;
+    /**
+     * Whether to generate sourcemap
+     * @default isBuild
+     */
+    sourcemap: boolean;
+    /**
+     * path to app entry output file
+     * @default 'dist-entry'
+     */
+    entryOutputDirPath: string;
+    /**
+     * path to app entry file
+     * @default 'electron/entry.ts'
+     */
+    appEntryPath: string;
+    /**
+     * esbuild path map of native modules in entry directory
+     *
+     * @default {}
+     * @example
+     * { db: './electron/native/db.ts' }
+     */
+    nativeModuleEntryMap?: Record<string, string>;
+    /**
+     * custom options for esbuild
+     * ```ts
+     * // default options
+     * const options = {
+     *   entryPoints: {
+     *     entry: appEntryPath,
+     *     ...moduleEntryMap,
+     *   },
+     *   bundle: true,
+     *   platform: 'node',
+     *   outdir: entryOutputDirPath,
+     *   minify,
+     *   sourcemap,
+     *   entryNames: '[dir]/[name]',
+     *   assetNames: '[dir]/[name]',
+     *   external: ['electron', 'original-fs'],
+     *   loader: {
+     *     '.node': 'empty',
+     *   },
+     * }
+     * ```
+     */
+    overrideEsbuildOptions?: BuildOptions;
+    /**
+     * resolve extra files, such as `.node`
+     */
+    postBuild?: (args: {
+        /**
+         * get path from `entryOutputDirPath`
+         */
+        getPathFromEntryOutputDir: (...paths: string[]) => string;
+        /**
+         * copy file to `entryOutputDirPath`
+         *
+         * if `to` absent, set to `basename(from)`
+         *
+         * if `skipIfExist` absent, skip copy if `to` exist
+         */
+        existsAndCopyToEntryOutputDir: (options: {
+            from: string;
+            to?: string;
+            /**
+             * skip copy if `to` exist
+             * @default true
+             */
+            skipIfExist?: boolean;
+        }) => void;
+    }) => Promisable<void>;
+};
 type GeneratorOverrideFunctions = {
     /**
      * custom signature generate function
@@ -34,49 +121,23 @@ type GeneratorOverrideFunctions = {
      */
     generateVersionJson?: (existingJson: UpdateJSON, buffer: Buffer, signature: string, version: string, minVersion: string) => UpdateJSON | Promise<UpdateJSON>;
 };
-type Options = {
-    /**
-     * whether is in build mode
-     */
-    isBuild: boolean;
-    /**
-     * the name of you application
-     *
-     * you can set as 'name' in `package.json`
-     */
-    productName: string;
-    /**
-     * the version of you application
-     *
-     * you can set as 'version' in `package.json`
-     */
-    version: string;
+type ElectronUpdaterOptions = {
     /**
      * mini version of entry
-     * @default version
+     * @default '0.0.0'
      */
     minimumVersion?: string;
     /**
-     * Whether to minify entry file
+     * config for entry (app.asar)
      */
-    minify?: boolean;
+    entry?: Partial<BuildEntryOption>;
     /**
      * paths config
      */
     paths?: {
-        /**
-         * Path to app entry file
-         * @default 'electron/app.ts'
-         */
-        entryPath?: string;
-        /**
-         * Path to app entry output file
-         * @default 'app.js'
-         */
-        entryOutputPath?: string;
         /**
          * Path to asar file
-         * @default `release/${productName}.asar`
+         * @default `release/${app.name}.asar`
          */
         asarOutputPath?: string;
         /**
@@ -86,7 +147,7 @@ type Options = {
         versionPath?: string;
         /**
          * Path to gzipped asar file
-         * @default `release/${productName}-${version}.asar.gz`
+         * @default `release/${app.name}-${version}.asar.gz`
          */
         gzipPath?: string;
         /**
@@ -105,19 +166,23 @@ type Options = {
      */
     keys?: {
         /**
-         * Path to the pem file that contains private key
+         * path to the pem file that contains private key
          * if not ended with .pem, it will be appended
+         *
+         * **if `UPDATER_PK` is set, will read it instead of read from `privateKeyPath`**
          * @default 'keys/private.pem'
          */
         privateKeyPath?: string;
         /**
-         * Path to the pem file that contains public key
+         * path to the pem file that contains public key
          * if not ended with .pem, it will be appended
+         *
+         * **if `UPDATER_CERT` is set, will read it instead of read from `certPath`**
          * @default 'keys/cert.pem'
          */
         certPath?: string;
         /**
-         * Length of the key
+         * length of the key
          * @default 2048
          */
         keyLength?: number;
@@ -130,20 +195,122 @@ type Options = {
             /**
              * the subject of the certificate
              *
-             * @default { commonName: productName, organizationName: `org.${productName}` }
+             * @default { commonName: `${app.name}`, organizationName: `org.${app.name}` }
              */
             subject?: DistinguishedName;
             /**
              * expire days of the certificate
              *
-             * @default 365
+             * @default 3650
              */
             days?: number;
         };
-        overrideFunctions?: GeneratorOverrideFunctions;
+        overrideGenerator?: GeneratorOverrideFunctions;
     };
 };
 
-declare function ElectronUpdater(options: Options): Plugin;
+type MakeRequired<T, K extends keyof T> = Exclude<T, undefined> & {
+    [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>;
+/**
+ * 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 function debugStartup(args: {
+    startup: (argv?: string[]) => Promise<void>;
+    reload: () => void;
+}): void;
+type ElectronWithUpdaterOptions = {
+    /**
+     * whether is in build mode
+     * ```ts
+     * export default defineConfig(({ command }) => {
+     *   const isBuild = command === 'build'
+     * })
+     * ```
+     */
+    isBuild: boolean;
+    /**
+     * name, version and main in `package.json`
+     * ```ts
+     * import pkg from './package.json'
+     * ```
+     */
+    pkg: PKG;
+    /**
+     * main options
+     */
+    main: Prettify<MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'>>;
+    /**
+     * preload options
+     */
+    preload: Prettify<MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'>>;
+    /**
+     * updater options
+     */
+    updater?: ElectronUpdaterOptions;
+    /**
+     * use NotBundle() plugin in main
+     * @default true
+     */
+    useNotBundle?: boolean;
+    /**
+     * Whether to log parsed options
+     */
+    logParsedOptions?: boolean;
+};
+/**
+ * build options for `vite-plugin-electron/simple`
+ * - integrate with updater
+ * - only contains `main` and `preload` configs
+ * - remove old electron files
+ * - 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}
+ * - no `vite-plugin-electron-renderer` config
+ *
+ * you can override all the configs
+ *
+ * **Limitation**: entry file change cannot trigger auto restart
+ *
+ * @example
+ * import { defineConfig } from 'vite'
+ * import electronSimple from 'vite-plugin-electron/simple'
+ * import { buildElectronPluginOptions } from 'electron-incremental-update/vite'
+ * import pkg from './package.json'
+ *
+ * export default defineConfig(({ command }) => {
+ *   const electronOptions = buildElectronPluginOptions({
+ *     isBuild: command === 'build',
+ *     pkg,
+ *     main: {
+ *       files: ['./electron/main/index.ts', './electron/main/worker.ts'],
+ *     },
+ *     preload: {
+ *       files: './electron/preload/index.ts',
+ *     },
+ *   })
+ *   return {
+ *     plugins: [electronSimple(electronOptions)],
+ *     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): (Plugin<any> | Promise<Plugin<any>[]> | undefined)[];
 
-export { ElectronUpdater, type Options };
+export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater };