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

package/dist/vite.js

@@ -5,6 +5,7 @@ import ElectronSimple from 'vite-plugin-electron/simple';
 import { startup } from 'vite-plugin-electron';
 import { notBundle } from 'vite-plugin-electron/plugin';
 import { getPackageInfoSync, loadPackageJSON } from 'local-pkg';
+import { isCI } from 'ci-info';
 import Asar from '@electron/asar';
 import { build } from 'esbuild';
 import { spawn } from 'node:child_process';
@@ -41,21 +42,19 @@ function parseVersion(version) {
   return ret;
 }
 function isUpdateJSON(json) {
-  const is = (j) => !!(j && j.minimumVersion && j.signature && j.size && j.version);
+  const is = (j) => !!(j && j.minimumVersion && j.signature && j.version);
   return is(json) && is(json?.beta);
 }
-function defaultVersionJsonGenerator(existingJson, buffer, signature, version, minimumVersion) {
+function defaultVersionJsonGenerator(existingJson, signature, version, minimumVersion) {
   existingJson.beta = {
     version,
     minimumVersion,
-    signature,
-    size: buffer.length
+    signature
   };
   if (!parseVersion(version).stage) {
     existingJson.version = version;
     existingJson.minimumVersion = minimumVersion;
     existingJson.signature = signature;
-    existingJson.size = buffer.length;
   }
   return existingJson;
 }
@@ -159,6 +158,17 @@ function obfuscateString(input) {
   return `(${decodeFn})([${hexArray.join(",")}],${offset})`;
 }
 
+// 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/build.ts
 async function buildAsar({
   version,
@@ -171,10 +181,12 @@ 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);
+  log.info(`build update asar to '${gzipPath}' [${readableSize(buf.length)}]`, { timestamp: true });
+  return buf;
 }
 async function buildVersion({
-  gzipPath,
   versionPath,
   privateKey,
   cert,
@@ -182,17 +194,15 @@ async function buildVersion({
   minimumVersion,
   generateSignature,
   generateVersionJson
-}) {
+}, asarBuffer) {
   let _json = {
     beta: {
       minimumVersion: version,
       signature: "",
-      size: 0,
       version
     },
     minimumVersion: version,
     signature: "",
-    size: 0,
     version
   };
   if (existsSync(versionPath)) {
@@ -201,18 +211,18 @@ 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, sig, version, minimumVersion);
   if (!isUpdateJSON(_json)) {
     throw new Error("invalid version info");
   }
   writeFileSync(versionPath, JSON.stringify(_json, null, 2));
+  log.info(`build version info to '${versionPath}'`, { timestamp: true });
 }
 async function buildEntry({
   sourcemap,
@@ -274,20 +284,20 @@ async function buildEntry({
       { timestamp: true }
     );
   }
-  bytecodeLog.info(`${filePaths.length} bundles compiled into bytecode`, { timestamp: true });
+  bytecodeLog.info(`${filePaths.length} file${filePaths.length > 1 ? "s" : ""} compiled into bytecode`, { timestamp: true });
 }
 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 +338,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 +383,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 +397,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 +423,6 @@ function parseOptions(pkg, sourcemap = false, minify = false, options = {}) {
   const buildVersionOption = {
     version: pkg.version,
     minimumVersion,
-    gzipPath,
     privateKey,
     cert,
     versionPath,
@@ -553,9 +567,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 }
         );
       });
@@ -603,6 +616,7 @@ async function electronWithUpdater(options) {
     preload: _preload,
     sourcemap = !isBuild,
     minify = isBuild,
+    buildVersionJson = isCI,
     updater,
     bytecode,
     useNotBundle = true,
@@ -641,7 +655,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,10 +735,10 @@ 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);
-                log.info(`build version info to '${buildVersionOption.versionPath}'`, { timestamp: true });
+                const buffer = await buildAsar(buildAsarOption);
+                if (buildVersionJson) {
+                  await buildVersion(buildVersionOption, buffer);
+                }
               }
             }
           ],

package/dist/{unzip-JjYLjJkH.d.cts → 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.ts → 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.5",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",
@@ -60,6 +60,7 @@
     "@babel/core": "^7.24.7",
     "@babel/plugin-transform-arrow-functions": "^7.24.7",
     "@subframe7536/type-utils": "^0.1.6",
+    "ci-info": "^4.0.0",
     "local-pkg": "^0.5.0",
     "selfsigned": "^2.4.1",
     "vite-plugin-electron": "^0.28.7"

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 };