electron-incremental-update 2.4.3 → 3.0.0-beta.3

package/dist/vite.d.mts

@@ -0,0 +1,521 @@
+import { SpawnOptions } from "node:child_process";
+import { BuildEnvironmentOptions, InlineConfig, LibraryOptions, PluginOption, UserConfig, UserConfigFn, build } from "vite";
+
+//#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
+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`.
+    * @param argv default value `['.', '--no-sandbox']`
+    * @param options options for `child_process.spawn`
+    * @param customElectronPkg custom electron package name (default: 'electron')
+    */
+    startup: (argv?: string[], options?: SpawnOptions, customElectronPkg?: string) => Promise<void>; /** Reload Electron-Renderer */
+    reload: () => void;
+  }) => void | Promise<void>;
+}
+//#endregion
+//#region src/vite/electron/utils.d.ts
+type RolldownOptions = Exclude<BuildEnvironmentOptions["rolldownOptions"], undefined>;
+//#endregion
+//#region src/utils/version.d.ts
+/**
+* Update info json
+*/
+interface UpdateInfo {
+  /**
+  * Update Asar signature
+  */
+  signature: string;
+  /**
+  * Minimum version
+  */
+  minimumVersion: string;
+  /**
+  * Target version
+  */
+  version: string;
+}
+/**
+* {@link UpdateInfo} with beta
+*/
+type UpdateJSON = UpdateInfo & {
+  /**
+  * Beta update info
+  */
+  beta: UpdateInfo;
+};
+//#endregion
+//#region src/vite/bytecode/index.d.ts
+interface BytecodeOptions {
+  enable: boolean;
+  /**
+  * Enable in preload script. Remember to set `sandbox: false` when creating window
+  */
+  preload?: boolean;
+  /**
+  * Custom electron binary path
+  */
+  electronPath?: string;
+  /**
+  * 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 | void>;
+}
+//#endregion
+//#region src/vite/key.d.ts
+interface DistinguishedName {
+  countryName?: string;
+  stateOrProvinceName?: string;
+  localityName?: string;
+  organizationName?: string;
+  organizationalUnitName?: string;
+  commonName?: string;
+  serialNumber?: string;
+  title?: string;
+  description?: string;
+  businessCategory?: string;
+  emailAddress?: string;
+}
+//#endregion
+//#region src/vite/option.d.ts
+interface CommonBuildOption {
+  /**
+  * Shortcut of `build.rolldownOptions.input`
+  */
+  files: NonNullable<ElectronOptions["entry"]>;
+  /**
+  * Override vite options
+  */
+  vite?: ElectronOptions["vite"] & {
+    build?: {
+      outDir: never;
+      sourcemap: never;
+      minify: never;
+      rolldownOptions?: {
+        output?: {
+          dir: never;
+        };
+      };
+    };
+  };
+}
+interface ElectronWithUpdaterOptions {
+  /**
+  * Whether is in build mode
+  * ```ts
+  * export default defineConfig(({ command }) => {
+  *   const isBuild = command === 'build'
+  * })
+  * ```
+  */
+  isBuild: boolean;
+  /**
+  * 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
+  */
+  useNotBundle?: boolean;
+  /**
+  * Whether to generate version json
+  * @default isCI
+  */
+  buildVersionJson?: boolean;
+  /**
+  * `external` option in `build.rolldownOptions`,
+  * default is node built-in modules or native modules.
+  *
+  * If is in dev and `entry.postBuild` is not setup, will also
+  * external `dependencies` in `package.json`
+  */
+  external?: NonNullable<NonNullable<InlineConfig["build"]>["rolldownOptions"]>["external"];
+  /**
+  * Options for entry (app.asar)
+  *
+  * To change output directories, use `options.updater.paths.electronDistPath` instead
+  */
+  entry: {
+    /**
+    * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+    * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+    * to manually handle the native module files.
+    *
+    * If you are using `electron-buidler`, don't forget to append `'!node_modules/**'` in
+    * electron-build config's `files` array
+    */
+    postBuild?: (args: {
+      /**
+      * Whether is in build mode
+      */
+      isBuild: boolean;
+      /**
+      * Get path from `entryOutputDirPath`
+      */
+      getPathFromEntryOutputDir: (...paths: string[]) => string;
+      /**
+      * Check exist and copy file to `entryOutputDirPath`
+      *
+      * If `to` absent, set to `basename(from)`
+      *
+      * If `skipIfExist` absent, skip copy if `to` exist
+      */
+      copyToEntryOutputDir: (options: {
+        from: string;
+        to?: string;
+        /**
+        * Skip copy if `to` exist
+        * @default true
+        */
+        skipIfExist?: boolean;
+      }) => void;
+      /**
+      * Copy specified modules to entry output dir, just like `external` option in rolldown
+      */
+      copyModules: (options: {
+        /**
+        * External Modules
+        */
+        modules: string[];
+        /**
+        * Skip copy if `to` exist
+        * @default true
+        */
+        skipIfExist?: boolean;
+      }) => void;
+    }) => Promisable<void>;
+  } & CommonBuildOption;
+  /**
+  * Main process options
+  *
+  * To change output directories, use `options.updater.paths.electronDistPath` instead
+  */
+  main: {
+    /**
+    * 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"];
+  } & CommonBuildOption;
+  /**
+  * Preload process options
+  *
+  * To change output directories, use `options.updater.paths.electronDistPath` instead
+  */
+  preload?: CommonBuildOption;
+  /**
+  * Updater options
+  */
+  updater?: UpdaterOptions;
+}
+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 buffer file buffer
+  * @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>;
+}
+interface UpdaterOptions {
+  /**
+  * Minimum version of entry
+  * @default '0.0.0'
+  */
+  minimumVersion?: string;
+  /**
+  * Options for paths
+  */
+  paths?: {
+    /**
+    * Path to asar file
+    * @default `release/${app.name}.asar`
+    */
+    asarOutputPath?: string;
+    /**
+    * Path to app entry output file
+    * @default 'dist-entry'
+    */
+    entryOutDir?: string;
+    /**
+    * Path to version info output, content is {@link UpdateJSON}
+    * @default `version.json`
+    */
+    versionPath?: string;
+    /**
+    * Path to gzipped asar file
+    * @default `release/${app.name}-${version}.asar.gz`
+    */
+    gzipPath?: string;
+    /**
+    * Path to electron build output
+    * @default `dist-electron`
+    */
+    electronDistPath?: string;
+    /**
+    * Path to renderer build output
+    * @default `dist`
+    */
+    rendererDistPath?: string;
+  };
+  /**
+  * signature config
+  */
+  keys?: {
+    /**
+    * 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
+    * 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
+    * @default 2048
+    */
+    keyLength?: number;
+    /**
+    * X509 certificate info
+    *
+    * Only generate simple **self-signed** certificate **without extensions**
+    */
+    certInfo?: {
+      /**
+      * The subject of the certificate
+      *
+      * @default { commonName: `${app.name}`, organizationName: `org.${app.name}` }
+      */
+      subject?: DistinguishedName;
+      /**
+      * Expire days of the certificate
+      *
+      * @default 3650
+      */
+      days?: number;
+    };
+  };
+  overrideGenerator?: GeneratorOverrideFunctions;
+}
+//#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`
+* - 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)
+*
+* @example
+* ```ts
+* import { defineConfig } from 'vite'
+* import { debugStartup, electronWithUpdater } from 'electron-incremental-update/vite'
+*
+* export default defineConfig(async ({ command }) => {
+*   const isBuild = command === 'build'
+*   return {
+*     plugins: [
+*       electronWithUpdater({
+*         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',
+*         },
+*         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>;
+//#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"> {
+  /**
+  * 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;
+//#endregion
+export { type ElectronViteHelperOptions, type ElectronWithUpdaterOptions, convertLiteral, debugStartup, electronWithUpdater as default, electronWithUpdater, defineElectronConfig, filterErrorMessageStartup, fixWinCharEncoding };