electron-incremental-update 1.0.3 → 1.2.0

package/dist/vite.d.ts

@@ -1,9 +1,17 @@
-import * as vite from 'vite';
 import { Plugin } from 'vite';
 import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
 import { Promisable } from '@subframe7536/type-utils';
 import { BuildOptions } from 'esbuild';
-import { a as UpdateJSON } from './noDep-TvZoKVF8.js';
+
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
 
 type PKG = {
     name: string;
@@ -72,6 +80,9 @@ type BuildEntryOption = {
      *   loader: {
      *     '.node': 'empty',
      *   },
+     *   define: {
+     *     __SIGNATURE_CERT__: JSON.stringify(cert),
+     *   },
      * }
      * ```
      */
@@ -86,13 +97,13 @@ type BuildEntryOption = {
          */
         getPathFromEntryOutputDir: (...paths: string[]) => string;
         /**
-         * copy file to `entryOutputDirPath`
+         * check exist and copy file to `entryOutputDirPath`
          *
          * if `to` absent, set to `basename(from)`
          *
          * if `skipIfExist` absent, skip copy if `to` exist
          */
-        existsAndCopyToEntryOutputDir: (options: {
+        copyToEntryOutputDir: (options: {
             from: string;
             to?: string;
             /**
@@ -211,6 +222,17 @@ type ElectronUpdaterOptions = {
     };
 };
 
+type BytecodeOptions = {
+    /**
+     * strings that should be transformed
+     */
+    protectedStrings?: string[];
+    /**
+     * Remember to set `sandbox: false` when creating window
+     */
+    enablePreload?: boolean;
+};
+
 type MakeRequired<T, K extends keyof T> = Exclude<T, undefined> & {
     [P in K]-?: T[P];
 };
@@ -245,24 +267,30 @@ type ElectronWithUpdaterOptions = {
      */
     isBuild: boolean;
     /**
-     * name, version and main in `package.json`
+     * manually setup package.json, read name, version and main
      * ```ts
      * import pkg from './package.json'
      * ```
      */
-    pkg: PKG;
+    pkg?: PKG;
     /**
-     * main options
+     * whether to generate sourcemap
+     * @default !isBuild
      */
-    main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'>;
+    sourcemap?: boolean;
     /**
-     * preload options
+     * whether to minify the code
+     * @default isBuild
      */
-    preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'>;
+    minify?: boolean;
     /**
-     * updater options
+     * 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
      */
-    updater?: ElectronUpdaterOptions;
+    bytecode?: boolean | BytecodeOptions;
     /**
      * use NotBundle() plugin in main
      * @default true
@@ -270,10 +298,25 @@ type ElectronWithUpdaterOptions = {
     useNotBundle?: boolean;
     /**
      * Whether to log parsed options
+     *
+     * to show certificate and private keys, set `logParsedOptions: { showKeys: true }`
+     */
+    logParsedOptions?: boolean | {
+        showKeys: boolean;
+    };
+    /**
+     * main options
      */
-    logParsedOptions?: boolean;
+    main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'>;
+    /**
+     * preload options
+     */
+    preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'>;
+    /**
+     * updater options
+     */
+    updater?: ElectronUpdaterOptions;
 };
-declare const log: vite.Logger;
 /**
  * build options for `vite-plugin-electron/simple`
  * - integrate with updater
@@ -324,6 +367,6 @@ declare const log: vite.Logger;
  *   }
  * })
  */
-declare function electronWithUpdater(options: ElectronWithUpdaterOptions): (Plugin<any> | Promise<Plugin<any>[]> | undefined)[];
+declare function electronWithUpdater(options: ElectronWithUpdaterOptions): Promise<(Plugin<any> | Promise<Plugin<any>[]> | undefined)[] | null>;
 
-export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater, log };
+export { type ElectronWithUpdaterOptions, debugStartup, electronWithUpdater };