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

package/dist/{chunk-JSYIRKTR.js → chunk-N77WQ5WB.js}

@@ -40,14 +40,16 @@ function aesDecrypt(encryptedText, key, iv) {
   const decipher = createDecipheriv("aes-256-cbc", key, iv);
   return decipher.update(encryptedText, "base64url", "utf8") + decipher.final("utf8");
 }
-function defaultVerify(buffer, signature, cert) {
+function defaultVerifySignature(buffer, version, signature, cert) {
   try {
-    const [sig, version] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
-    const result = createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : void 0;
+    const [sig, ver] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
+    if (ver !== version) {
+      return false;
+    }
+    return createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
   } catch {
-    return void 0;
+    return false;
   }
 }
 
-export { aesDecrypt, aesEncrypt, defaultSignature, defaultUnzipFile, defaultVerify, defaultZipFile, hashBuffer };
+export { aesDecrypt, aesEncrypt, defaultSignature, defaultUnzipFile, defaultVerifySignature, defaultZipFile, hashBuffer };

package/dist/index.cjs

@@ -153,10 +153,11 @@ var Updater = class extends events.EventEmitter {
     this.emit("update-available", this.info);
     return true;
   }
-  async downloadUpdate(data, sig) {
-    const _sig = sig ?? this.info?.signature;
-    if (!_sig) {
-      this.err("download failed", "param", "no update signature, please call `checkUpdate` first");
+  async downloadUpdate(data, info) {
+    const _sig = info?.signature ?? this.info?.signature;
+    const _version = info?.version ?? this.info?.version;
+    if (!_sig || !_version) {
+      this.err("download failed", "param", "no update signature, please call `checkUpdate` first or manually setup params");
       return false;
     }
     const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
@@ -165,8 +166,7 @@ var Updater = class extends events.EventEmitter {
       return false;
     }
     this.logger?.debug("verify start");
-    const _ver = await this.provider.verifySignaure(buffer, _sig, this.CERT);
-    if (!_ver) {
+    if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
       this.err("download failed", "validate", "invalid signature / certificate pair");
       return false;
     }
@@ -175,7 +175,7 @@ var Updater = class extends events.EventEmitter {
       const tmpFilePath = getPathFromAppNameAsar() + ".tmp";
       this.logger?.debug(`install to ${tmpFilePath}`);
       fs.writeFileSync(tmpFilePath, await this.provider.unzipFile(buffer));
-      this.logger?.info(`download success, version: ${_ver}`);
+      this.logger?.info(`download success, version: ${_version}`);
       this.info = void 0;
       this.emit("update-downloaded");
       return true;

package/dist/index.js

@@ -123,10 +123,11 @@ var Updater = class extends EventEmitter {
     this.emit("update-available", this.info);
     return true;
   }
-  async downloadUpdate(data, sig) {
-    const _sig = sig ?? this.info?.signature;
-    if (!_sig) {
-      this.err("download failed", "param", "no update signature, please call `checkUpdate` first");
+  async downloadUpdate(data, info) {
+    const _sig = info?.signature ?? this.info?.signature;
+    const _version = info?.version ?? this.info?.version;
+    if (!_sig || !_version) {
+      this.err("download failed", "param", "no update signature, please call `checkUpdate` first or manually setup params");
       return false;
     }
     const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
@@ -135,8 +136,7 @@ var Updater = class extends EventEmitter {
       return false;
     }
     this.logger?.debug("verify start");
-    const _ver = await this.provider.verifySignaure(buffer, _sig, this.CERT);
-    if (!_ver) {
+    if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
       this.err("download failed", "validate", "invalid signature / certificate pair");
       return false;
     }
@@ -145,7 +145,7 @@ var Updater = class extends EventEmitter {
       const tmpFilePath = getPathFromAppNameAsar() + ".tmp";
       this.logger?.debug(`install to ${tmpFilePath}`);
       writeFileSync(tmpFilePath, await this.provider.unzipFile(buffer));
-      this.logger?.info(`download success, version: ${_ver}`);
+      this.logger?.info(`download success, version: ${_version}`);
       this.info = void 0;
       this.emit("update-downloaded");
       return true;

package/dist/provider.cjs

@@ -104,14 +104,15 @@ async function defaultDownloadAsar(url, headers, onDownloading) {
     const total = getHeader(resp.headers, "content-length") || -1;
     let data = [];
     resp.on("data", (chunk) => {
-      transferred += chunk.length;
+      const delta = chunk.length;
+      transferred += delta;
       const current = Date.now();
       onDownloading?.({
         percent: +(transferred / total).toFixed(2) * 100,
         total,
         transferred,
-        delta: chunk.length,
-        bps: chunk.length / ((current - time) * 1e3)
+        delta,
+        bps: delta / ((current - time) * 1e3)
       });
       time = current;
       data.push(chunk);
@@ -127,13 +128,15 @@ function aesDecrypt(encryptedText, key, iv) {
   const decipher = crypto.createDecipheriv("aes-256-cbc", key, iv);
   return decipher.update(encryptedText, "base64url", "utf8") + decipher.final("utf8");
 }
-function defaultVerify(buffer, signature, cert) {
+function defaultVerifySignature(buffer, version, signature, cert) {
   try {
-    const [sig, version] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
-    const result = crypto.createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : void 0;
+    const [sig, ver] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
+    if (ver !== version) {
+      return false;
+    }
+    return crypto.createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
   } catch {
-    return void 0;
+    return false;
   }
 }
 async function defaultUnzipFile(buffer) {
@@ -152,7 +155,7 @@ async function defaultUnzipFile(buffer) {
 var BaseProvider = class {
   name = "BaseProvider";
   isLowerVersion = defaultIsLowerVersion;
-  verifySignaure = defaultVerify;
+  verifySignaure = defaultVerifySignature;
   unzipFile = defaultUnzipFile;
 };
 
@@ -187,7 +190,7 @@ var GitHubProvider = class extends BaseProvider {
   }
   async downloadJSON(versionPath) {
     return await defaultDownloadUpdateJSON(
-      await this.parseURL(false, `HEAD/${versionPath}`),
+      await this.parseURL(false, `${this.options.branch ?? "HEAD"}/${versionPath}`),
       { accept: "application/json", ...this.options.extraHeaders }
     );
   }

package/dist/provider.js

@@ -1,4 +1,4 @@
-import { defaultVerify, defaultUnzipFile } from './chunk-JSYIRKTR.js';
+import { defaultVerifySignature, defaultUnzipFile } from './chunk-N77WQ5WB.js';
 import { defaultIsLowerVersion, isUpdateJSON } from './chunk-72ZAJ7AF.js';
 import { URL } from 'node:url';
 import { app, net } from 'electron';
@@ -50,14 +50,15 @@ async function defaultDownloadAsar(url, headers, onDownloading) {
     const total = getHeader(resp.headers, "content-length") || -1;
     let data = [];
     resp.on("data", (chunk) => {
-      transferred += chunk.length;
+      const delta = chunk.length;
+      transferred += delta;
       const current = Date.now();
       onDownloading?.({
         percent: +(transferred / total).toFixed(2) * 100,
         total,
         transferred,
-        delta: chunk.length,
-        bps: chunk.length / ((current - time) * 1e3)
+        delta,
+        bps: delta / ((current - time) * 1e3)
       });
       time = current;
       data.push(chunk);
@@ -70,7 +71,7 @@ async function defaultDownloadAsar(url, headers, onDownloading) {
 var BaseProvider = class {
   name = "BaseProvider";
   isLowerVersion = defaultIsLowerVersion;
-  verifySignaure = defaultVerify;
+  verifySignaure = defaultVerifySignature;
   unzipFile = defaultUnzipFile;
 };
 
@@ -105,7 +106,7 @@ var GitHubProvider = class extends BaseProvider {
   }
   async downloadJSON(versionPath) {
     return await defaultDownloadUpdateJSON(
-      await this.parseURL(false, `HEAD/${versionPath}`),
+      await this.parseURL(false, `${this.options.branch ?? "HEAD"}/${versionPath}`),
       { accept: "application/json", ...this.options.extraHeaders }
     );
   }

package/dist/utils.cjs

@@ -5,6 +5,7 @@ var path = require('path');
 var electron = require('electron');
 var zlib = require('zlib');
 var crypto = require('crypto');
+var ciInfo = require('ci-info');
 
 var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
   get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
@@ -186,13 +187,15 @@ function aesDecrypt(encryptedText, key, iv) {
   const decipher = crypto.createDecipheriv("aes-256-cbc", key, iv);
   return decipher.update(encryptedText, "base64url", "utf8") + decipher.final("utf8");
 }
-function defaultVerify(buffer, signature, cert) {
+function defaultVerifySignature(buffer, version, signature, cert) {
   try {
-    const [sig, version] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
-    const result = crypto.createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : void 0;
+    const [sig, ver] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
+    if (ver !== version) {
+      return false;
+    }
+    return crypto.createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
   } catch {
-    return void 0;
+    return false;
   }
 }
 
@@ -203,13 +206,17 @@ async function autoUpdate(updater) {
   }
 }
 
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () { return ciInfo.isCI; }
+});
 exports.aesDecrypt = aesDecrypt;
 exports.aesEncrypt = aesEncrypt;
 exports.autoUpdate = autoUpdate;
 exports.defaultIsLowerVersion = defaultIsLowerVersion;
 exports.defaultSignature = defaultSignature;
 exports.defaultUnzipFile = defaultUnzipFile;
-exports.defaultVerify = defaultVerify;
+exports.defaultVerifySignature = defaultVerifySignature;
 exports.defaultVersionJsonGenerator = defaultVersionJsonGenerator;
 exports.defaultZipFile = defaultZipFile;
 exports.disableHWAccForWin7 = disableHWAccForWin7;

package/dist/utils.js

@@ -1,6 +1,7 @@
 export { disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance } from './chunk-DFNDKSE6.js';
-export { aesDecrypt, aesEncrypt, defaultSignature, defaultUnzipFile, defaultVerify, defaultZipFile, hashBuffer } from './chunk-JSYIRKTR.js';
+export { aesDecrypt, aesEncrypt, defaultSignature, defaultUnzipFile, defaultVerifySignature, defaultZipFile, hashBuffer } from './chunk-N77WQ5WB.js';
 export { defaultIsLowerVersion, defaultVersionJsonGenerator, isUpdateJSON, parseVersion } from './chunk-72ZAJ7AF.js';
+export { isCI } from 'ci-info';
 
 // src/utils/updater.ts
 async function autoUpdate(updater) {

package/dist/vite.js

@@ -280,7 +280,7 @@ async function buildEntry({
       `${isEntry ? bytecodeModuleLoaderCode : useStrict}${isEntry ? "" : "module.exports = "}require("./${fileName}c")`
     );
     bytecodeLog.info(
-      `${filePath} => ${(buffer.byteLength / 1e3).toFixed(2)} kB`,
+      `${filePath} [${(buffer.byteLength / 1e3).toFixed(2)} kB]`,
       { timestamp: true }
     );
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0-beta.6",
   "description": "electron incremental update tools, powered by vite",
   "author": "subframe7536",
   "license": "MIT",

package/dist/core-CXETH_bb.d.ts

@@ -1,134 +0,0 @@
-import { EventEmitter } from 'node:events';
-import { a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, I as IProvider, c as URLHandler } from './types-C5P0h_bB.js';
-
-declare const ErrorInfo: {
-    readonly download: "Download failed";
-    readonly validate: "Validate failed";
-    readonly param: "Missing params";
-    readonly network: "Network error";
-};
-declare class UpdaterError extends Error {
-    code: keyof typeof ErrorInfo;
-    constructor(msg: keyof typeof ErrorInfo, info: string);
-}
-type CheckResult<T extends UpdateJSON> = {
-    success: true;
-    data: Omit<T, 'beta'>;
-} | {
-    success: false;
-    /**
-     * minimal version that can update
-     */
-    data: string;
-} | {
-    success: false;
-    data: UpdaterError;
-};
-type DownloadResult = {
-    success: true;
-} | {
-    success: false;
-    data: UpdaterError;
-};
-interface Logger {
-    info: (msg: string) => void;
-    debug: (msg: string) => void;
-    warn: (msg: string) => void;
-    error: (msg: string, e?: unknown) => void;
-}
-interface UpdaterOption {
-    /**
-     * public key of signature, which will be auto generated by plugin,
-     * generate by `selfsigned` if not set
-     */
-    SIGNATURE_CERT?: string;
-    /**
-     * whether to receive beta update
-     */
-    receiveBeta?: boolean;
-    logger?: Logger;
-}
-
-declare class Updater extends EventEmitter<{
-    'checking': any;
-    'update-available': [data: UpdateInfo];
-    'update-unavailable': [reason: string];
-    'error': [error: UpdaterError];
-    'download-progress': [info: DownloadingInfo];
-    'update-downloaded': any;
-}> {
-    private CERT;
-    private info?;
-    private provider;
-    /**
-     * updater logger
-     */
-    logger?: Logger;
-    /**
-     * whether to receive beta update
-     */
-    receiveBeta?: boolean;
-    /**
-     * whether force update in DEV
-     */
-    forceUpdate?: boolean;
-    /**
-     * initialize incremental updater
-     * @param provider update provider
-     * @param option UpdaterOption
-     */
-    constructor(provider: IProvider, option?: UpdaterOption);
-    /**
-     * this function is used to parse download data.
-     * - if format is `'json'`
-     *   - if data is `UpdateJSON`, return it
-     *   - if data is string or absent, download URL data and return it
-     * - if format is `'buffer'`
-     *   - if data is `Buffer`, return it
-     *   - if data is string or absent, download URL data and return it
-     * @param format 'json' or 'buffer'
-     * @param data download URL or update json or buffer
-     */
-    private fetch;
-    /**
-     * handle error message and emit error event
-     */
-    private err;
-    /**
-     * check update info using default options
-     */
-    checkUpdate(): Promise<boolean>;
-    /**
-     * check update info using existing update json
-     * @param data existing update json
-     */
-    checkUpdate(data: UpdateJSON): Promise<boolean>;
-    /**
-     * download update using default options
-     */
-    downloadUpdate(): Promise<boolean>;
-    /**
-     * download update using existing `asar.gz` buffer and signature
-     * @param data existing `asar.gz` buffer
-     * @param sig signature
-     */
-    downloadUpdate(data: Uint8Array | Buffer, sig: string): Promise<boolean>;
-    /**
-     * quit App and install
-     */
-    quitAndInstall(): void;
-    /**
-     * setup provider URL handler
-     *
-     * @example
-     * updater.setURLHandler((url, isDownloadingAsar) => {
-     *   if (isDownloadingAsar) {
-     *     url.hostname = 'https://cdn.jsdelivr.net/gh'
-     *     return url
-     *   }
-     * })
-     */
-    setURLHandler(handler: URLHandler): void;
-}
-
-export { type CheckResult as C, type DownloadResult as D, ErrorInfo as E, type Logger as L, Updater as U, type UpdaterOption as a, UpdaterError as b };

package/dist/core-DmU2Vk_S.d.cts

@@ -1,134 +0,0 @@
-import { EventEmitter } from 'node:events';
-import { a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, I as IProvider, c as URLHandler } from './types-C5P0h_bB.cjs';
-
-declare const ErrorInfo: {
-    readonly download: "Download failed";
-    readonly validate: "Validate failed";
-    readonly param: "Missing params";
-    readonly network: "Network error";
-};
-declare class UpdaterError extends Error {
-    code: keyof typeof ErrorInfo;
-    constructor(msg: keyof typeof ErrorInfo, info: string);
-}
-type CheckResult<T extends UpdateJSON> = {
-    success: true;
-    data: Omit<T, 'beta'>;
-} | {
-    success: false;
-    /**
-     * minimal version that can update
-     */
-    data: string;
-} | {
-    success: false;
-    data: UpdaterError;
-};
-type DownloadResult = {
-    success: true;
-} | {
-    success: false;
-    data: UpdaterError;
-};
-interface Logger {
-    info: (msg: string) => void;
-    debug: (msg: string) => void;
-    warn: (msg: string) => void;
-    error: (msg: string, e?: unknown) => void;
-}
-interface UpdaterOption {
-    /**
-     * public key of signature, which will be auto generated by plugin,
-     * generate by `selfsigned` if not set
-     */
-    SIGNATURE_CERT?: string;
-    /**
-     * whether to receive beta update
-     */
-    receiveBeta?: boolean;
-    logger?: Logger;
-}
-
-declare class Updater extends EventEmitter<{
-    'checking': any;
-    'update-available': [data: UpdateInfo];
-    'update-unavailable': [reason: string];
-    'error': [error: UpdaterError];
-    'download-progress': [info: DownloadingInfo];
-    'update-downloaded': any;
-}> {
-    private CERT;
-    private info?;
-    private provider;
-    /**
-     * updater logger
-     */
-    logger?: Logger;
-    /**
-     * whether to receive beta update
-     */
-    receiveBeta?: boolean;
-    /**
-     * whether force update in DEV
-     */
-    forceUpdate?: boolean;
-    /**
-     * initialize incremental updater
-     * @param provider update provider
-     * @param option UpdaterOption
-     */
-    constructor(provider: IProvider, option?: UpdaterOption);
-    /**
-     * this function is used to parse download data.
-     * - if format is `'json'`
-     *   - if data is `UpdateJSON`, return it
-     *   - if data is string or absent, download URL data and return it
-     * - if format is `'buffer'`
-     *   - if data is `Buffer`, return it
-     *   - if data is string or absent, download URL data and return it
-     * @param format 'json' or 'buffer'
-     * @param data download URL or update json or buffer
-     */
-    private fetch;
-    /**
-     * handle error message and emit error event
-     */
-    private err;
-    /**
-     * check update info using default options
-     */
-    checkUpdate(): Promise<boolean>;
-    /**
-     * check update info using existing update json
-     * @param data existing update json
-     */
-    checkUpdate(data: UpdateJSON): Promise<boolean>;
-    /**
-     * download update using default options
-     */
-    downloadUpdate(): Promise<boolean>;
-    /**
-     * download update using existing `asar.gz` buffer and signature
-     * @param data existing `asar.gz` buffer
-     * @param sig signature
-     */
-    downloadUpdate(data: Uint8Array | Buffer, sig: string): Promise<boolean>;
-    /**
-     * quit App and install
-     */
-    quitAndInstall(): void;
-    /**
-     * setup provider URL handler
-     *
-     * @example
-     * updater.setURLHandler((url, isDownloadingAsar) => {
-     *   if (isDownloadingAsar) {
-     *     url.hostname = 'https://cdn.jsdelivr.net/gh'
-     *     return url
-     *   }
-     * })
-     */
-    setURLHandler(handler: URLHandler): void;
-}
-
-export { type CheckResult as C, type DownloadResult as D, ErrorInfo as E, type Logger as L, Updater as U, type UpdaterOption as a, UpdaterError as b };

package/dist/index.d.cts

@@ -1,78 +0,0 @@
-import { U as Updater, a as UpdaterOption, L as Logger } from './core-DmU2Vk_S.cjs';
-export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-DmU2Vk_S.cjs';
-import { I as IProvider } from './types-C5P0h_bB.cjs';
-import 'node:events';
-import '@subframe7536/type-utils';
-
-type Promisable<T> = T | Promise<T>;
-/**
- * hooks on rename temp asar path to `${app.name}.asar`
- * @param install `() => renameSync(tempAsarPath, appNameAsarPath)`
- * @param tempAsarPath temp(updated) asar path
- * @param appNameAsarPath `${app.name}.asar` path
- * @param logger logger
- * @default install(); logger.info(`update success!`)
- */
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
-interface AppOption {
-    /**
-     * update provider
-     */
-    provider: IProvider;
-    /**
-     * updater options
-     */
-    updater?: (() => Promisable<Updater>) | UpdaterOption;
-    /**
-     * hooks on rename temp asar path to `${app.name}.asar`
-     */
-    onInstall?: OnInstallFunction;
-    /**
-     * hooks before app start up
-     * @param mainFilePath main file path of `${app.name}.asar`
-     * @param logger logger
-     */
-    beforeStart?: (mainFilePath: string, logger?: Logger) => Promisable<void>;
-    /**
-     * hooks on app start up error
-     * @param err installing or startup error
-     * @param logger logger
-     */
-    onStartError?: (err: unknown, logger?: Logger) => void;
-}
-/**
- * utils for startuping with updater
- * @param fn startup function
- * @example
- * // in electron/main/index.ts
- * export default startupWithUpdater((updater) => {
- *   updater.checkUpdate()
- * })
- */
-declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>): (updater: Updater) => Promisable<void>;
-/**
- * initialize app
- * @example
- * ```ts
- * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
- * import { repository } from '../package.json'
- *
- * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
- * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
- *
- * initApp({
- *   // can be updater option or function that return updater
- *   updater: {
- *     SIGNATURE_CERT: 'custom certificate',
- *     repository,
- *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${app.name}.asar.gz`),
- *     receiveBeta: true,
- *   },
- *   onStart: console.log
- * })
- * ```
- */
-declare function initApp(appOptions: AppOption): Promise<void>;
-
-export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };