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

package/dist/index.d.ts

@@ -1,12 +1,13 @@
-import { EventEmitter } from 'node:stream';
-import { U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.js';
-import { D as DownloadingInfo, U as URLHandler, I as IProvider } from './types-CPq1MrYZ.js';
+import { EventEmitter } from 'node:events';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.js';
+import { D as DownloadingInfo, I as IProvider, U as URLHandler } from './types-DxhNaNgR.js';
 import '@subframe7536/type-utils';
 
 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;
@@ -60,9 +61,7 @@ declare class Updater extends EventEmitter<{
 }> {
     private CERT;
     private info?;
-    private options;
     private asarPath;
-    private gzipPath;
     private tmpFilePath;
     private provider;
     /**
@@ -70,18 +69,13 @@ declare class Updater extends EventEmitter<{
      */
     logger?: Logger;
     /**
-     * URL handler hook
-     *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDNs}
-     * @param url source url
-     * @param isDownloadAsar whether is download asar
+     * whether to receive beta update
      */
-    handleURL?: URLHandler;
+    receiveBeta?: boolean;
     /**
-     * whether receive beta version
+     * whether force update in DEV
      */
-    get receiveBeta(): boolean;
-    set receiveBeta(receiveBeta: boolean);
+    forceUpdate?: boolean;
     /**
      * initialize incremental updater
      * @param provider update provider
@@ -122,11 +116,22 @@ declare class Updater extends EventEmitter<{
      * @param data existing `asar.gz` buffer
      * @param sig signature
      */
-    download(data: Uint8Array, sig: string): Promise<boolean>;
+    download(data: Uint8Array | Buffer, sig: string): Promise<boolean>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
+    /**
+     * setup provider URL handler
+     *
+     * @example
+     * updater.setURLHandler((url, isDownloadingAsar) => {
+     *   if (isDownloadingAsar) {
+     *     return url.replace('https://raw.githubusercontent.com', 'https://cdn.jsdelivr.net/gh')
+     *   }
+     * })
+     */
+    setURLHandler(handler: URLHandler): void;
 }
 
 type Promisable<T> = T | Promise<T>;
@@ -138,7 +143,7 @@ type Promisable<T> = T | Promise<T>;
  * @param logger logger
  * @default install(); logger.info(`update success!`)
  */
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger: Logger) => Promisable<void>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
     /**
      * update provider
@@ -157,13 +162,13 @@ interface AppOption {
      * @param mainFilePath main file path of `${app.name}.asar`
      * @param logger logger
      */
-    beforeStart?: (mainFilePath: string, logger: Logger) => Promisable<void>;
+    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;
+    onStartError?: (err: unknown, logger?: Logger) => void;
 }
 /**
  * utils for startuping with updater

package/dist/index.js

@@ -1,29 +1,16 @@
-import {
-  __require,
-  getAppVersion,
-  getEntryVersion,
-  getPathFromAppNameAsar,
-  isDev,
-  isUpdateJSON,
-  restartApp,
-  unzipFile
-} from "./chunk-BG22XZAB.js";
-
-// src/entry.ts
-import { join } from "node:path";
-import { existsSync as existsSync2, renameSync } from "node:fs";
-import { app as app2 } from "electron";
-
-// src/updater/core.ts
-import { existsSync, rmSync, writeFileSync } from "node:fs";
-import { EventEmitter } from "node:stream";
-import { app } from "electron";
+import { isDev, getPathFromAppNameAsar, getEntryVersion, getAppVersion, restartApp } from './chunk-PNYRQYFC.js';
+import { isUpdateJSON, __require } from './chunk-BVFQWBLK.js';
+import { join } from 'node:path';
+import { existsSync, rmSync, renameSync } from 'node:fs';
+import { app } from 'electron';
+import { EventEmitter } from 'node:events';
 
 // src/updater/types.ts
 var ErrorInfo = {
   download: "Download failed",
   validate: "Validate failed",
-  param: "Missing params"
+  param: "Missing params",
+  network: "Network error"
 };
 var UpdaterError = class extends Error {
   code;
@@ -37,9 +24,7 @@ var UpdaterError = class extends Error {
 var Updater = class extends EventEmitter {
   CERT = __EIU_SIGNATURE_CERT__;
   info;
-  options;
   asarPath;
-  gzipPath;
   tmpFilePath;
   provider;
   /**
@@ -47,22 +32,13 @@ var Updater = class extends EventEmitter {
    */
   logger;
   /**
-   * URL handler hook
-   *
-   * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDNs}
-   * @param url source url
-   * @param isDownloadAsar whether is download asar
+   * whether to receive beta update
    */
-  handleURL;
+  receiveBeta;
   /**
-   * whether receive beta version
+   * whether force update in DEV
    */
-  get receiveBeta() {
-    return !!this.options.receiveBeta;
-  }
-  set receiveBeta(receiveBeta) {
-    this.options.receiveBeta = receiveBeta;
-  }
+  forceUpdate;
   /**
    * initialize incremental updater
    * @param provider update provider
@@ -71,7 +47,7 @@ var Updater = class extends EventEmitter {
   constructor(provider, option = {}) {
     super();
     this.provider = provider;
-    this.options = option;
+    this.receiveBeta = option.receiveBeta;
     if (option.SIGNATURE_CERT) {
       this.CERT = option.SIGNATURE_CERT;
     }
@@ -88,7 +64,6 @@ var Updater = class extends EventEmitter {
       this.logger.info("no logger set, enable dev-only logger");
     }
     this.asarPath = getPathFromAppNameAsar();
-    this.gzipPath = `${this.asarPath}.gz`;
     this.tmpFilePath = `${this.asarPath}.tmp`;
   }
   async fetch(format, data) {
@@ -96,10 +71,6 @@ var Updater = class extends EventEmitter {
       this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
       rmSync(this.tmpFilePath);
     }
-    if (existsSync(this.gzipPath)) {
-      this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
-      rmSync(this.gzipPath);
-    }
     if (typeof data === "object") {
       if (format === "json" && isUpdateJSON(data) || format === "buffer" && Buffer.isBuffer(data)) {
         return data;
@@ -114,7 +85,7 @@ var Updater = class extends EventEmitter {
       this.logger?.debug(`download ${format} success${format === "buffer" ? `, file size: ${result.length}` : ""}`);
       return result;
     } catch (e) {
-      this.err(`download ${format} failed`, "download", `download ${format} failed: ${e}`);
+      this.err(`fetch ${format} failed`, "network", `download ${format} failed: ${e}`);
     }
   }
   /**
@@ -129,11 +100,11 @@ var Updater = class extends EventEmitter {
     const emitUnavailable = (msg) => {
       this.logger?.info(msg);
       this.emit("update-unavailable", msg);
+      return false;
     };
     const _data = await this.fetch("json", data);
     if (!_data) {
-      emitUnavailable("failed to get update info");
-      return false;
+      return emitUnavailable("failed to get update info");
     }
     let { signature, size, version, minimumVersion, beta } = _data;
     if (this.receiveBeta) {
@@ -143,21 +114,18 @@ var Updater = class extends EventEmitter {
       size = beta.size;
     }
     this.logger?.debug(`checked update, version: ${version}, size: ${size}, signature: ${signature}`);
-    if (isDev) {
-      emitUnavailable("in dev mode, skip check update");
-      return false;
+    if (isDev && !this.forceUpdate && !data) {
+      return emitUnavailable("skip check update in dev mode, to force update, set `updater.forceUpdate` to true or call checkUpdate with UpdateJSON");
     }
     const isLowerVersion = this.provider.isLowerVersion;
     const entryVersion = getEntryVersion();
     const appVersion = getAppVersion();
     if (isLowerVersion(entryVersion, minimumVersion)) {
-      emitUnavailable(`entry version (${entryVersion}) < minimumVersion (${minimumVersion})`);
-      return false;
+      return emitUnavailable(`entry version (${entryVersion}) < minimumVersion (${minimumVersion})`);
     }
     this.logger?.info(`check update: current version is ${appVersion}, new version is ${version}`);
     if (!isLowerVersion(appVersion, version)) {
-      emitUnavailable(`current version (${appVersion}) < new version (${version})`);
-      return false;
+      return emitUnavailable(`current version (${appVersion}) < new version (${version})`);
     }
     this.logger?.info(`update available: ${version}`);
     this.info = { signature, minimumVersion, version, size };
@@ -165,11 +133,11 @@ var Updater = class extends EventEmitter {
     return true;
   }
   async download(data, sig) {
-    if (!this.info) {
-      this.err("download failed", "param", "no update info, call `checkUpdate` first");
+    const _sig = sig ?? this.info?.signature;
+    if (!_sig) {
+      this.err("download failed", "param", "no update signature, please call `checkUpdate` first");
       return false;
     }
-    const _sig = sig ?? this.info.signature;
     const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
     if (!buffer) {
       this.err("download failed", "param", "no update asar file buffer");
@@ -178,21 +146,19 @@ var Updater = class extends EventEmitter {
     this.logger?.debug("verify start");
     const _ver = await this.provider.verifySignaure(buffer, _sig, this.CERT);
     if (!_ver) {
-      this.err("verify failed", "validate", "invalid signature / certificate pair");
+      this.err("download failed", "validate", "invalid signature / certificate pair");
       return false;
     }
     this.logger?.debug("verify success");
     try {
-      this.logger?.debug(`write to ${this.gzipPath}`);
-      writeFileSync(this.gzipPath, buffer);
       this.logger?.debug(`extract to ${this.tmpFilePath}`);
-      await unzipFile(this.gzipPath, this.tmpFilePath);
+      await this.provider.unzipFile(buffer, this.tmpFilePath);
       this.logger?.info(`download success, version: ${_ver}`);
       this.info = void 0;
       this.emit("update-downloaded");
       return true;
     } catch (error) {
-      this.err("unwrap asar failed", "download", `fail to unwrap asar file, ${error}`);
+      this.err("download failed", "download", `fail to unwrap asar file, ${error}`);
       return false;
     }
   }
@@ -203,6 +169,19 @@ var Updater = class extends EventEmitter {
     this.logger?.info("quit and install");
     restartApp();
   }
+  /**
+   * setup provider URL handler
+   *
+   * @example
+   * updater.setURLHandler((url, isDownloadingAsar) => {
+   *   if (isDownloadingAsar) {
+   *     return url.replace('https://raw.githubusercontent.com', 'https://cdn.jsdelivr.net/gh')
+   *   }
+   * })
+   */
+  setURLHandler(handler) {
+    this.provider.urlHandler = handler;
+  }
 };
 
 // src/entry.ts
@@ -211,7 +190,7 @@ function startupWithUpdater(fn) {
 }
 var defaultOnInstall = (install, _, __, logger) => {
   install();
-  logger.info(`update success!`);
+  logger?.info(`update success!`);
 };
 async function initApp(appOptions) {
   const {
@@ -227,31 +206,34 @@ async function initApp(appOptions) {
   } else {
     updaterInstance = await updater();
   }
-  const logger = updaterInstance.logger || console;
+  let logger = updaterInstance.logger;
+  if (isDev && !logger) {
+    logger = {
+      info: (...args) => console.log("[EIU-INFO ]", ...args),
+      debug: (...args) => console.log("[EIU-DEBUG]", ...args),
+      warn: (...args) => console.log("[EIU-WARN ]", ...args),
+      error: (...args) => console.error("[EIU-ERROR]", ...args)
+    };
+  }
   try {
     const appNameAsarPath = getPathFromAppNameAsar();
     const tempAsarPath = `${appNameAsarPath}.tmp`;
-    if (existsSync2(tempAsarPath)) {
-      logger.info(`installing new asar: ${tempAsarPath}`);
+    if (existsSync(tempAsarPath)) {
+      logger?.info(`installing new asar: ${tempAsarPath}`);
       await onInstall(() => renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
     }
     const mainFilePath = join(
-      isDev ? join(app2.getAppPath(), __EIU_MAIN_DEV_DIR__) : appNameAsarPath,
+      isDev ? join(app.getAppPath(), __EIU_MAIN_DEV_DIR__) : appNameAsarPath,
       "main",
       __EIU_MAIN_FILE__
     );
     await beforeStart?.(mainFilePath, logger);
     __require(mainFilePath)(updaterInstance);
   } catch (error) {
-    logger.error("startup error", error);
+    logger?.error("startup error", error);
     onStartError?.(error, logger);
-    app2.quit();
+    app.quit();
   }
 }
-export {
-  ErrorInfo,
-  Updater,
-  UpdaterError,
-  initApp,
-  startupWithUpdater
-};
+
+export { ErrorInfo, Updater, UpdaterError, initApp, startupWithUpdater };

package/dist/provider.cjs

@@ -1,58 +1,11 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+'use strict';
 
-// src/provider/index.ts
-var provider_exports = {};
-__export(provider_exports, {
-  GitHubProvider: () => GitHubProvider,
-  downloadAsarBufferDefault: () => downloadAsarBufferDefault,
-  downloadUpdateJSONDefault: () => downloadUpdateJSONDefault
-});
-module.exports = __toCommonJS(provider_exports);
+var electron = require('electron');
+var crypto = require('crypto');
+var fs = require('fs');
+var zlib = require('zlib');
 
-// src/utils/electron.ts
-var import_node_fs = require("fs");
-var import_node_path = require("path");
-var import_electron = require("electron");
-var isDev = __EIU_IS_DEV__;
-var isWin = process.platform === "win32";
-var isMac = process.platform === "darwin";
-var isLinux = process.platform === "linux";
-function waitAppReady(timeout = 1e3) {
-  return import_electron.app.isReady() ? Promise.resolve() : new Promise((resolve, reject) => {
-    const _ = setTimeout(() => {
-      reject(new Error("app is not ready"));
-    }, timeout);
-    import_electron.app.whenReady().then(() => {
-      clearTimeout(_);
-      resolve();
-    });
-  });
-}
-
-// src/utils/zip.ts
-var import_node_fs2 = require("fs");
-var import_node_zlib = require("zlib");
-
-// src/utils/unzip.ts
-var import_node_fs3 = require("fs");
-var import_node_zlib2 = require("zlib");
+// src/provider/download.ts
 
 // src/utils/version.ts
 function parseVersion(version) {
@@ -78,7 +31,7 @@ function parseVersion(version) {
   }
   return ret;
 }
-function isLowerVersionDefault(oldVer, newVer) {
+function defaultIsLowerVersion(oldVer, newVer) {
   const oldV = parseVersion(oldVer);
   const newV = parseVersion(newVer);
   function compareStrings(str1, str2) {
@@ -103,42 +56,11 @@ function isUpdateJSON(json) {
   return is(json) && is(json?.beta);
 }
 
-// src/utils/crypto/decrypt.ts
-var import_node_crypto2 = require("crypto");
-
-// src/utils/crypto/utils.ts
-var import_node_crypto = require("crypto");
-function hashString(data, length) {
-  const hash = (0, import_node_crypto.createHash)("SHA256").update(data).digest("binary");
-  return Buffer.from(hash).subarray(0, length);
-}
-
-// src/utils/crypto/decrypt.ts
-function decrypt(encryptedText, key, iv) {
-  const decipher = (0, import_node_crypto2.createDecipheriv)("aes-256-cbc", key, iv);
-  let decrypted = decipher.update(encryptedText, "base64url", "utf8");
-  decrypted += decipher.final("utf8");
-  return decrypted;
-}
-function verifySignatureDefault(buffer, signature, cert) {
-  try {
-    const [sig, version] = decrypt(signature, hashString(cert, 32), hashString(buffer, 16)).split("%");
-    const result = (0, import_node_crypto2.createVerify)("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : void 0;
-  } catch {
-    return void 0;
-  }
-}
-
-// src/utils/crypto/encrypt.ts
-var import_node_crypto3 = require("crypto");
-
 // src/provider/download.ts
-var import_electron2 = require("electron");
-async function downlaodFn(url, headers, onResponse) {
-  await waitAppReady();
+async function downloadFn(url, headers, onResponse) {
+  await electron.app.whenReady();
   return new Promise((resolve, reject) => {
-    const request = import_electron2.net.request({ url, method: "GET", redirect: "follow" });
+    const request = electron.net.request({ url, method: "GET", redirect: "follow" });
     Object.keys(headers).forEach((key) => request.setHeader(key, headers[key]));
     request.on("response", (resp) => {
       resp.on("aborted", () => reject(new Error("aborted")));
@@ -149,8 +71,8 @@ async function downlaodFn(url, headers, onResponse) {
     request.end();
   });
 }
-async function downloadUpdateJSONDefault(url, headers) {
-  return await downlaodFn(url, headers, (resp, resolve, reject) => {
+async function defaultDownloadUpdateJSON(url, headers) {
+  return await downloadFn(url, headers, (resp, resolve, reject) => {
     let data = "";
     resp.on("data", (chunk) => data += chunk);
     resp.on("end", () => {
@@ -167,10 +89,10 @@ async function downloadUpdateJSONDefault(url, headers) {
     });
   });
 }
-async function downloadAsarBufferDefault(url, headers, total, onDownloading) {
+async function defaultDownloadAsar(url, headers, total, onDownloading) {
   let transferred = 0;
   let time = Date.now();
-  return await downlaodFn(url, headers, (resp, resolve) => {
+  return await downloadFn(url, headers, (resp, resolve) => {
     let data = [];
     resp.on("data", (chunk) => {
       transferred += chunk.length;
@@ -188,49 +110,93 @@ async function downloadAsarBufferDefault(url, headers, total, onDownloading) {
     resp.on("end", () => resolve(Buffer.concat(data)));
   });
 }
+function hashBuffer(data, length) {
+  const hash = crypto.createHash("SHA256").update(data).digest("binary");
+  return Buffer.from(hash).subarray(0, length);
+}
+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) {
+  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;
+  } catch {
+    return void 0;
+  }
+}
+async function defaultUnzipFile(buffer, targetFilePath) {
+  return new Promise((resolve, reject) => {
+    zlib.brotliDecompress(buffer, (err, buffer2) => {
+      if (err) {
+        reject(err);
+      }
+      fs.writeFileSync(targetFilePath, buffer2);
+      resolve();
+    });
+  });
+}
+
+// src/provider/base.ts
+var BaseProvider = class {
+  name = "BaseProvider";
+  isLowerVersion = defaultIsLowerVersion;
+  verifySignaure = defaultVerify;
+  unzipFile = defaultUnzipFile;
+};
 
 // src/provider/github.ts
-var GitHubProvider = class {
+var GitHubProvider = class extends BaseProvider {
   ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
   name = "GithubProvider";
   urlHandler;
   url;
   extraHeaders;
+  /**
+   * Update Provider for Github repo
+   * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
+   * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+   *
+   * you can setup `urlHandler` in {@link GitHubProviderOptions} or `Updater` to modify url before request
+   * @param options provider options
+   */
   constructor(options) {
-    this.url = new URL(options.url);
+    super();
     this.extraHeaders = options.extraHeaders;
     this.urlHandler = options.urlHandler;
-    if (this.url.host !== "github.com") {
+    if (!options.url.startsWith("https://github.com")) {
       throw new Error(`${this.name}: invalid github url: ${options.url}`);
     }
-    if (!this.url.pathname.endsWith("/")) {
-      this.url.pathname += "/";
+    this.url = options.url;
+    if (!this.url.endsWith("/")) {
+      this.url += "/";
     }
   }
-  parseURL(isDownloadAsar, path) {
-    const url = this.url.href + path;
-    return this.urlHandler ? this.urlHandler(url, isDownloadAsar) : url;
+  async parseURL(isDownloadAsar, extraPath) {
+    const _url = new URL(this.url);
+    _url.hostname = isDownloadAsar ? "github.com" : "raw.githubusercontent.com";
+    _url.pathname += extraPath;
+    return (await this.urlHandler?.(_url, isDownloadAsar) || _url).toString();
   }
-  isLowerVersion = isLowerVersionDefault;
-  verifySignaure = verifySignatureDefault;
   async downloadJSON(versionPath) {
-    return await downloadUpdateJSONDefault(
-      this.parseURL(false, `HEAD/${versionPath}`),
+    return await defaultDownloadUpdateJSON(
+      await this.parseURL(false, `HEAD/${versionPath}`),
       { userAgent: this.ua, accept: "application/json", ...this.extraHeaders }
     );
   }
   async downloadAsar(name, { version, size }, onDownloading) {
-    return await downloadAsarBufferDefault(
-      this.parseURL(true, `releases/download/v${version}/${name}-${version}.asar.gz`),
+    return await defaultDownloadAsar(
+      await this.parseURL(true, `releases/download/v${version}/${name}-${version}.asar.gz`),
       { userAgent: this.ua, accept: "application/octet-stream", ...this.extraHeaders },
       size,
       onDownloading
     );
   }
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  GitHubProvider,
-  downloadAsarBufferDefault,
-  downloadUpdateJSONDefault
-});
+
+exports.BaseProvider = BaseProvider;
+exports.GitHubProvider = GitHubProvider;
+exports.defaultDownloadAsar = defaultDownloadAsar;
+exports.defaultDownloadUpdateJSON = defaultDownloadUpdateJSON;