electron-incremental-update 2.0.0-beta.3 → 2.0.0-beta.4

package/dist/vite.d.ts

@@ -0,0 +1,397 @@
+import { PluginOption } from 'vite';
+import { ElectronSimpleOptions } from 'vite-plugin-electron/simple';
+import { Promisable } from '@subframe7536/type-utils';
+import { BuildOptions } from 'esbuild';
+
+/**
+ * update info json
+ */
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+/**
+ * {@link UpdateInfo} with beta
+ */
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+
+interface PKG {
+    name: string;
+    version: string;
+    main: string;
+}
+interface DistinguishedName {
+    countryName?: string;
+    stateOrProvinceName?: string;
+    localityName?: string;
+    organizationName?: string;
+    organizationalUnitName?: string;
+    commonName?: string;
+    serialNumber?: string;
+    title?: string;
+    description?: string;
+    businessCategory?: string;
+    emailAddress?: string;
+}
+interface 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',
+     *   },
+     *   define: {
+     *     __SIGNATURE_CERT__: JSON.stringify(cert),
+     *   },
+     * }
+     * ```
+     */
+    overrideEsbuildOptions?: BuildOptions;
+    /**
+     * resolve extra files on startup, such as `.node`
+     * @remark won't trigger will reload
+     */
+    postBuild?: (args: {
+        /**
+         * 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;
+    }) => Promisable<void>;
+}
+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) => string | Promise<string>;
+    /**
+     * custom generate version 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
+     * @returns The updated version json
+     */
+    generateVersionJson?: (existingJson: UpdateJSON, buffer: Buffer, signature: string, version: string, minVersion: string) => UpdateJSON | Promise<UpdateJSON>;
+    /**
+     * custom generate zip file buffer
+     * @param buffer source buffer
+     */
+    generateGzipFile?: (buffer: Buffer) => Promise<Buffer>;
+}
+interface ElectronUpdaterOptions {
+    /**
+     * mini version of entry
+     * @default '0.0.0'
+     */
+    minimumVersion?: string;
+    /**
+     * config for entry (app.asar)
+     */
+    entry?: BuildEntryOption;
+    /**
+     * paths config
+     */
+    paths?: {
+        /**
+         * Path to asar file
+         * @default `release/${app.name}.asar`
+         */
+        asarOutputPath?: 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;
+}
+
+interface 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];
+};
+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 ExcludeOutputDirOptions = {
+    vite?: {
+        build?: {
+            outDir: never;
+            rollupOptions?: {
+                output?: {
+                    dir: never;
+                };
+            };
+        };
+    };
+};
+interface ElectronWithUpdaterOptions {
+    /**
+     * whether is in build mode
+     * ```ts
+     * export default defineConfig(({ command }) => {
+     *   const isBuild = command === 'build'
+     * })
+     * ```
+     */
+    isBuild: boolean;
+    /**
+     * manually setup package.json, read name, version and main
+     * ```ts
+     * import pkg from './package.json'
+     * ```
+     */
+    pkg?: PKG;
+    /**
+     * 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 log parsed options
+     *
+     * to show certificate and private keys, set `logParsedOptions: { showKeys: true }`
+     */
+    logParsedOptions?: boolean | {
+        showKeys: boolean;
+    };
+    /**
+     * main process options
+     *
+     * to change output directories, use `options.updater.paths.electronDistPath` instead
+     */
+    main: MakeRequiredAndReplaceKey<ElectronSimpleOptions['main'], 'entry', 'files'> & ExcludeOutputDirOptions;
+    /**
+     * preload process options
+     *
+     * to change output directories, use `options.updater.paths.electronDistPath` instead
+     */
+    preload: MakeRequiredAndReplaceKey<Exclude<ElectronSimpleOptions['preload'], undefined>, 'input', 'files'> & ExcludeOutputDirOptions;
+    /**
+     * updater options
+     */
+    updater?: ElectronUpdaterOptions;
+}
+/**
+ * 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 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 };

package/dist/vite.js

@@ -171,10 +171,11 @@ async function buildAsar({
   renameSync(rendererDistPath, join(electronDistPath, "renderer"));
   writeFileSync(join(electronDistPath, "version"), version);
   await Asar.createPackage(electronDistPath, asarOutputPath);
-  await generateGzipFile(readFileSync(asarOutputPath), gzipPath);
+  const buf = await generateGzipFile(readFileSync(asarOutputPath));
+  writeFileSync(gzipPath, buf);
+  return buf;
 }
 async function buildVersion({
-  gzipPath,
   versionPath,
   privateKey,
   cert,
@@ -182,7 +183,7 @@ async function buildVersion({
   minimumVersion,
   generateSignature,
   generateVersionJson
-}) {
+}, asarBuffer) {
   let _json = {
     beta: {
       minimumVersion: version,
@@ -201,14 +202,13 @@ async function buildVersion({
       if (isUpdateJSON(oldVersionJson)) {
         _json = oldVersionJson;
       } else {
-        log.warn("old version json is invalid, ignore it");
+        log.warn("old version json is invalid, ignore it", { timestamp: true });
       }
     } catch {
     }
   }
-  const buffer = readFileSync(gzipPath);
-  const sig = await generateSignature(buffer, privateKey, cert, version);
-  _json = await generateVersionJson(_json, buffer, sig, version, minimumVersion);
+  const sig = await generateSignature(asarBuffer, privateKey, cert, version);
+  _json = await generateVersionJson(_json, asarBuffer, sig, version, minimumVersion);
   if (!isUpdateJSON(_json)) {
     throw new Error("invalid version info");
   }
@@ -280,14 +280,14 @@ function getCert(code) {
   const cert = code.match(/-----BEGIN CERTIFICATE-----[\s\S]*-----END CERTIFICATE-----\\n/)?.[0];
   return cert ? [cert] : [];
 }
-async function defaultZipFile(buffer, targetFilePath) {
+async function defaultZipFile(buffer) {
   return new Promise((resolve2, reject) => {
     brotliCompress(buffer, (err, buffer2) => {
       if (err) {
         reject(err);
+      } else {
+        resolve2(buffer2);
       }
-      writeFileSync(targetFilePath, buffer2);
-      resolve2();
     });
   });
 }
@@ -328,15 +328,21 @@ function parseKeys({
   days
 }) {
   const keysDir = dirname(privateKeyPath);
+  let privateKey = process.env.UPDATER_PK;
+  let cert = process.env.UPDATER_CERT;
+  if (privateKey && cert) {
+    log.info("use UPDATER_PK and UPDATER_CERT from environment variables", { timestamp: true });
+    return { privateKey, cert };
+  }
   if (!existsSync(keysDir)) {
     mkdirSync(keysDir);
   }
   if (!existsSync(privateKeyPath) || !existsSync(certPath)) {
-    log.warn("no key pair found, generate new key pair");
+    log.info("no key pair found, generate new key pair", { timestamp: true });
     generateKeyPair(keyLength, parseSubjects(subject), days, privateKeyPath, certPath);
   }
-  const privateKey = process.env.UPDATER_PK || readFileSync(privateKeyPath, "utf-8");
-  const cert = process.env.UPDATER_CERT || readFileSync(certPath, "utf-8");
+  privateKey = readFileSync(privateKeyPath, "utf-8");
+  cert = readFileSync(certPath, "utf-8");
   return { privateKey, cert };
 }
 function parseSubjects(subject) {
@@ -367,7 +373,13 @@ function parseOptions(pkg, sourcemap = false, minify = false, options = {}) {
       privateKeyPath = "keys/private.pem",
       certPath = "keys/cert.pem",
       keyLength = 2048,
-      certInfo = {}
+      certInfo: {
+        subject = {
+          commonName: pkg.name,
+          organizationName: `org.${pkg.name}`
+        },
+        days = 3650
+      } = {}
     } = {},
     overrideGenerator: {
       generateGzipFile = defaultZipFile,
@@ -375,13 +387,6 @@ function parseOptions(pkg, sourcemap = false, minify = false, options = {}) {
       generateVersionJson = defaultVersionJsonGenerator
     } = {}
   } = options;
-  let {
-    subject = {
-      commonName: pkg.name,
-      organizationName: `org.${pkg.name}`
-    },
-    days = 3650
-  } = certInfo;
   const buildAsarOption = {
     version: pkg.version,
     asarOutputPath,
@@ -408,7 +413,6 @@ function parseOptions(pkg, sourcemap = false, minify = false, options = {}) {
   const buildVersionOption = {
     version: pkg.version,
     minimumVersion,
-    gzipPath,
     privateKey,
     cert,
     versionPath,
@@ -417,6 +421,19 @@ function parseOptions(pkg, sourcemap = false, minify = false, options = {}) {
   };
   return { buildAsarOption, buildEntryOption, buildVersionOption, postBuild, cert };
 }
+
+// src/build-plugins/utils.ts
+function readableSize(size) {
+  const units = ["B", "KB", "MB", "GB"];
+  let i = 0;
+  while (size >= 1024 && i < units.length - 1) {
+    size /= 1024;
+    i++;
+  }
+  return `${size.toFixed(2)} ${units[i]}`;
+}
+
+// src/build-plugins/bytecode/index.ts
 function bytecodePlugin(isBuild, env, options = {}) {
   if (!isBuild) {
     return null;
@@ -553,9 +570,8 @@ ${bytecodeLoaderBlock}`) : _code;
     closeBundle() {
       const outDir = `${normalizePath(path2.relative(config.root, path2.resolve(config.root, config.build.outDir)))}/`;
       bytecodeFiles.forEach((file) => {
-        const kbs = file.size / 1e3;
         bytecodeLog.info(
-          `${outDir}${file.name} => ${kbs.toFixed(2)} kB`,
+          `${outDir}${file.name} => ${readableSize(file.size)}`,
           { timestamp: true }
         );
       });
@@ -641,7 +657,7 @@ async function electronWithUpdater(options) {
     __EIU_MAIN_DEV_DIR__: JSON.stringify(buildAsarOption.electronDistPath),
     __EIU_MAIN_FILE__: JSON.stringify(getMainFilePath(_main.files)),
     __EIU_SIGNATURE_CERT__: JSON.stringify(cert),
-    __EUI_VERSION_PATH__: JSON.stringify(parseVersionPath(buildVersionOption.versionPath))
+    __EIU_VERSION_PATH__: JSON.stringify(parseVersionPath(buildVersionOption.versionPath))
   };
   const _buildEntry = async () => {
     await buildEntry(
@@ -721,9 +737,9 @@ async function electronWithUpdater(options) {
               async closeBundle() {
                 await _buildEntry();
                 await _postBuild();
-                await buildAsar(buildAsarOption);
-                log.info(`build asar to '${buildAsarOption.asarOutputPath}'`, { timestamp: true });
-                await buildVersion(buildVersionOption);
+                const buffer = await buildAsar(buildAsarOption);
+                log.info(`build update asar to '${buildAsarOption.gzipPath}' => ${readableSize(buffer.length)}`, { timestamp: true });
+                await buildVersion(buildVersionOption, buffer);
                 log.info(`build version info to '${buildVersionOption.versionPath}'`, { timestamp: true });
               }
             }

package/dist/{unzip-JjYLjJkH.d.ts → zip-WRrEMkgp.d.cts}

@@ -4,6 +4,7 @@ declare function defaultSignature(buffer: Buffer, privateKey: string, cert: stri
 declare function aesDecrypt(encryptedText: string, key: Buffer, iv: Buffer): string;
 declare function defaultVerify(buffer: Buffer, signature: string, cert: string): string | undefined;
 
-declare function defaultUnzipFile(buffer: Buffer, targetFilePath: string): Promise<void>;
+declare function defaultZipFile(buffer: Buffer): Promise<Buffer>;
+declare function defaultUnzipFile(buffer: Buffer): Promise<Buffer>;
 
-export { aesEncrypt as a, defaultSignature as b, aesDecrypt as c, defaultUnzipFile as d, defaultVerify as e, hashBuffer as h };
+export { defaultUnzipFile as a, aesEncrypt as b, defaultSignature as c, defaultZipFile as d, aesDecrypt as e, defaultVerify as f, hashBuffer as h };

package/dist/{unzip-JjYLjJkH.d.cts → zip-WRrEMkgp.d.ts}

@@ -4,6 +4,7 @@ declare function defaultSignature(buffer: Buffer, privateKey: string, cert: stri
 declare function aesDecrypt(encryptedText: string, key: Buffer, iv: Buffer): string;
 declare function defaultVerify(buffer: Buffer, signature: string, cert: string): string | undefined;
 
-declare function defaultUnzipFile(buffer: Buffer, targetFilePath: string): Promise<void>;
+declare function defaultZipFile(buffer: Buffer): Promise<Buffer>;
+declare function defaultUnzipFile(buffer: Buffer): Promise<Buffer>;
 
-export { aesEncrypt as a, defaultSignature as b, aesDecrypt as c, defaultUnzipFile as d, defaultVerify as e, hashBuffer as h };
+export { defaultUnzipFile as a, aesEncrypt as b, defaultSignature as c, defaultZipFile as d, aesDecrypt as e, defaultVerify as f, hashBuffer as h };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.4",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",
@@ -78,4 +78,4 @@
     "vite-plugin-electron": "^0.28.7",
     "vitest": "^2.0.3"
   }
-}
+}

package/dist/version-CemSHimT.d.cts

@@ -1,33 +0,0 @@
-/**
- * handle all unhandled error
- * @param callback callback function
- */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
-declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
-/**
- * update info json
- */
-type UpdateInfo = {
-    signature: string;
-    minimumVersion: string;
-    version: string;
-    size: number;
-};
-/**
- * {@link UpdateInfo} with beta
- */
-type UpdateJSON = UpdateInfo & {
-    beta: UpdateInfo;
-};
-declare function isUpdateJSON(json: any): json is UpdateJSON;
-declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, buffer: Buffer, signature: string, version: string, minimumVersion: string): UpdateJSON;
-
-export { type UpdateJSON as U, type Version as V, type UpdateInfo as a, defaultVersionJsonGenerator as b, defaultIsLowerVersion as d, handleUnexpectedErrors as h, isUpdateJSON as i, parseVersion as p };

package/dist/version-CemSHimT.d.ts

@@ -1,33 +0,0 @@
-/**
- * handle all unhandled error
- * @param callback callback function
- */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
-declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
-/**
- * update info json
- */
-type UpdateInfo = {
-    signature: string;
-    minimumVersion: string;
-    version: string;
-    size: number;
-};
-/**
- * {@link UpdateInfo} with beta
- */
-type UpdateJSON = UpdateInfo & {
-    beta: UpdateInfo;
-};
-declare function isUpdateJSON(json: any): json is UpdateJSON;
-declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, buffer: Buffer, signature: string, version: string, minimumVersion: string): UpdateJSON;
-
-export { type UpdateJSON as U, type Version as V, type UpdateInfo as a, defaultVersionJsonGenerator as b, defaultIsLowerVersion as d, handleUnexpectedErrors as h, isUpdateJSON as i, parseVersion as p };