electron-incremental-update 2.0.0-beta.8 → 2.0.0

package/dist/vite.d.ts

@@ -5,7 +5,7 @@ import { BuildOptions } from 'esbuild';
 export { isCI } from 'ci-info';
 
 /**
- * update info json
+ * Update info json
  */
 type UpdateInfo = {
     signature: string;
@@ -23,6 +23,7 @@ interface PKG {
     name: string;
     version: string;
     main: string;
+    type: 'commonjs' | 'module';
 }
 interface DistinguishedName {
     countryName?: string;
@@ -39,27 +40,26 @@ interface DistinguishedName {
 }
 interface BuildEntryOption {
     /**
-     * whether to minify
+     * Override to minify on entry
      * @default isBuild
      */
     minify?: boolean;
     /**
-     * whether to generate sourcemap
-     * @default isBuild
+     * Override to generate sourcemap on entry
      */
     sourcemap?: boolean;
     /**
-     * path to app entry output file
+     * Path to app entry output file
      * @default 'dist-entry'
      */
     entryOutputDirPath?: string;
     /**
-     * path to app entry file
+     * Path to app entry file
      * @default 'electron/entry.ts'
      */
     appEntryPath?: string;
     /**
-     * esbuild path map of native modules in entry directory
+     * Esbuild path map of native modules in entry directory
      *
      * @default {}
      * @example
@@ -67,7 +67,7 @@ interface BuildEntryOption {
      */
     nativeModuleEntryMap?: Record<string, string>;
     /**
-     * custom options for esbuild
+     * Custom options for esbuild
      * ```ts
      * // default options
      * const options = {
@@ -86,34 +86,32 @@ interface BuildEntryOption {
      *   loader: {
      *     '.node': 'empty',
      *   },
-     *   define: {
-     *     __SIGNATURE_CERT__: JSON.stringify(cert),
-     *   },
+     *   define,
      * }
      * ```
      */
     overrideEsbuildOptions?: BuildOptions;
     /**
-     * resolve extra files on startup, such as `.node`
+     * Resolve extra files on startup, such as `.node`
      * @remark won't trigger will reload
      */
     postBuild?: (args: {
         /**
-         * get path from `entryOutputDirPath`
+         * Get path from `entryOutputDirPath`
          */
         getPathFromEntryOutputDir: (...paths: string[]) => string;
         /**
-         * check exist and copy file to `entryOutputDirPath`
+         * Check exist and copy file to `entryOutputDirPath`
          *
-         * if `to` absent, set to `basename(from)`
+         * If `to` absent, set to `basename(from)`
          *
-         * if `skipIfExist` absent, skip copy if `to` exist
+         * If `skipIfExist` absent, skip copy if `to` exist
          */
         copyToEntryOutputDir: (options: {
             from: string;
             to?: string;
             /**
-             * skip copy if `to` exist
+             * Skip copy if `to` exist
              * @default true
              */
             skipIfExist?: boolean;
@@ -122,15 +120,15 @@ interface BuildEntryOption {
 }
 interface GeneratorOverrideFunctions {
     /**
-     * custom signature generate function
+     * 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) => string | Promise<string>;
+    generateSignature?: (buffer: Buffer, privateKey: string, cert: string, version: string) => Promisable<string>;
     /**
-     * custom generate version json function
+     * Custom generate version json function
      * @param existingJson The existing JSON object.
      * @param buffer file buffer
      * @param signature generated signature
@@ -138,25 +136,25 @@ interface GeneratorOverrideFunctions {
      * @param minVersion The minimum version
      * @returns The updated version json
      */
-    generateVersionJson?: (existingJson: UpdateJSON, signature: string, version: string, minVersion: string) => UpdateJSON | Promise<UpdateJSON>;
+    generateVersionJson?: (existingJson: UpdateJSON, signature: string, version: string, minVersion: string) => Promisable<UpdateJSON>;
     /**
-     * custom generate zip file buffer
+     * Custom generate zip file buffer
      * @param buffer source buffer
      */
-    generateGzipFile?: (buffer: Buffer) => Promise<Buffer>;
+    generateGzipFile?: (buffer: Buffer) => Promisable<Buffer>;
 }
 interface ElectronUpdaterOptions {
     /**
-     * mini version of entry
+     * Minimum version of entry
      * @default '0.0.0'
      */
     minimumVersion?: string;
     /**
-     * config for entry (app.asar)
+     * Options for entry (app.asar)
      */
     entry?: BuildEntryOption;
     /**
-     * paths config
+     * Options for paths
      */
     paths?: {
         /**
@@ -190,40 +188,40 @@ interface ElectronUpdaterOptions {
      */
     keys?: {
         /**
-         * path to the pem file that contains private key
-         * if not ended with .pem, it will be appended
+         * 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`**
+         * **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
-         * if not ended with .pem, it will be appended
+         * 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`**
+         * **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;
         /**
          * X509 certificate info
          *
-         * only generate simple **self-signed** certificate **without extensions**
+         * Only generate simple **self-signed** certificate **without extensions**
          */
         certInfo?: {
             /**
-             * the subject of the certificate
+             * The subject of the certificate
              *
              * @default { commonName: `${app.name}`, organizationName: `org.${app.name}` }
              */
             subject?: DistinguishedName;
             /**
-             * expire days of the certificate
+             * Expire days of the certificate
              *
              * @default 3650
              */
@@ -236,15 +234,15 @@ interface ElectronUpdaterOptions {
 interface BytecodeOptions {
     enable: boolean;
     /**
-     * Remember to set `sandbox: false` when creating window
+     * Enable in preload script. Remember to set `sandbox: false` when creating window
      */
     preload?: boolean;
     /**
-     * before transformed code compile callback, if return `null` or `undefined`, it will be ignored
+     * Before transformed code compile function. If return `Falsy` value, it will be ignored
      * @param code transformed code
      * @param id file path
      */
-    beforeCompile?: (code: string, id: string) => Promisable<string | null | undefined>;
+    beforeCompile?: (code: string, id: string) => Promisable<string | null | undefined | void>;
 }
 
 type MakeRequired<T, K extends keyof T> = Exclude<T, undefined> & {
@@ -284,7 +282,7 @@ type ExcludeOutputDirOptions = {
 };
 interface ElectronWithUpdaterOptions {
     /**
-     * whether is in build mode
+     * Whether is in build mode
      * ```ts
      * export default defineConfig(({ command }) => {
      *   const isBuild = command === 'build'
@@ -293,113 +291,79 @@ interface ElectronWithUpdaterOptions {
      */
     isBuild: boolean;
     /**
-     * manually setup package.json, read name, version and main
+     * Manually setup package.json, read name, version and main,
+     * use `local-pkg` of `loadPackageJSON()` to load package.json by default
      * ```ts
      * import pkg from './package.json'
      * ```
      */
     pkg?: PKG;
     /**
-     * whether to generate sourcemap
+     * Whether to generate sourcemap
      * @default !isBuild
      */
     sourcemap?: boolean;
     /**
-     * whether to minify the code
+     * Whether to minify the code
      * @default isBuild
      */
     minify?: boolean;
     /**
-     * whether to generate bytecode
+     * Whether to generate bytecode
      *
-     * **only support commonjs**
+     * **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
+     * 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
+     * Use `NotBundle()` plugin in main
      * @default true
      */
     useNotBundle?: boolean;
     /**
-     * whether to generate version json
+     * Whether to generate version json
      * @default isCI
      */
     buildVersionJson?: boolean;
     /**
      * Whether to log parsed options
      *
-     * to show certificate and private keys, set `logParsedOptions: { showKeys: true }`
+     * To show certificate and private keys, set `logParsedOptions: { showKeys: true }`
      */
     logParsedOptions?: boolean | {
         showKeys: boolean;
     };
     /**
-     * main process options
+     * Main process options
      *
-     * to change output directories, use `options.updater.paths.electronDistPath` instead
+     * To change output directories, use `options.updater.paths.electronDistPath` instead
      */
     main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'> & ExcludeOutputDirOptions;
     /**
-     * preload process options
+     * Preload process options
      *
-     * to change output directories, use `options.updater.paths.electronDistPath` instead
+     * To change output directories, use `options.updater.paths.electronDistPath` instead
      */
     preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'> & ExcludeOutputDirOptions;
     /**
-     * updater options
+     * Updater options
      */
     updater?: ElectronUpdaterOptions;
 }
 /**
- * build options for `vite-plugin-electron/simple`
+ * Base on `vite-plugin-electron/simple`
  * - integrate with updater
- * - only contains `main` and `preload` configs
- * - remove old electron files
+ * - 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}
- * - no `vite-plugin-electron-renderer` config
  *
- * you can override all the vite configs, except output directories (use `options.updater.paths.electronDistPath` instead)
+ * You can override all the vite configs, except output directories (use `options.updater.paths.electronDistPath` instead)
  *
  * @example
- * import { defineConfig } from 'vite'
- * import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
- * import pkg from './package.json'
- *
- * export default defineConfig(async ({ command }) => {
- *   const isBuild = command === 'build'
- *   return {
- *     plugins: [
- *       electronWithUpdater({
- *         pkg,
- *         isBuild,
- *         logParsedOptions: true,
- *         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
- *         }
- *       }),
- *     ],
- *     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>;
 
-export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater };
+export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater as default, electronWithUpdater };