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

package/dist/index.d.ts

@@ -1,134 +1,9 @@
-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 { U as Updater, a as UpdaterOption, L as Logger } from './core-D6QlpOgp.js';
+export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-D6QlpOgp.js';
+import { I as IProvider } from './types-Bz1VD18z.js';
+import 'node:events';
 import '@subframe7536/type-utils';
 
-declare const ErrorInfo: {
-    readonly download: "Download failed";
-    readonly validate: "Validate failed";
-    readonly param: "Missing params";
-};
-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 options;
-    private asarPath;
-    private gzipPath;
-    private tmpFilePath;
-    private provider;
-    /**
-     * updater logger
-     */
-    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
-     */
-    handleURL?: URLHandler;
-    /**
-     * whether receive beta version
-     */
-    get receiveBeta(): boolean;
-    set receiveBeta(receiveBeta: 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
-     */
-    download(): Promise<boolean>;
-    /**
-     * download update using existing `asar.gz` buffer and signature
-     * @param data existing `asar.gz` buffer
-     * @param sig signature
-     */
-    download(data: Uint8Array, sig: string): Promise<boolean>;
-    /**
-     * quit App and install
-     */
-    quitAndInstall(): void;
-}
-
 type Promisable<T> = T | Promise<T>;
 /**
  * hooks on rename temp asar path to `${app.name}.asar`
@@ -138,7 +13,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 +32,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
@@ -200,4 +75,4 @@ declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>):
  */
 declare function initApp(appOptions: AppOption): Promise<void>;
 
-export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };

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, getEntryVersion, getAppVersion, getPathFromAppNameAsar, restartApp } from './chunk-PNYRQYFC.js';
+import { isUpdateJSON, __require } from './chunk-BVFQWBLK.js';
+import { join } from 'node:path';
+import { writeFileSync, existsSync, 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,32 +24,19 @@ var UpdaterError = class extends Error {
 var Updater = class extends EventEmitter {
   CERT = __EIU_SIGNATURE_CERT__;
   info;
-  options;
-  asarPath;
-  gzipPath;
-  tmpFilePath;
   provider;
   /**
    * updater 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;
+  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 +45,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;
     }
@@ -87,19 +61,8 @@ 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) {
-    if (existsSync(this.tmpFilePath)) {
-      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 +77,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 +92,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,33 +106,30 @@ 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 };
     this.emit("update-available", this.info);
     return true;
   }
-  async download(data, sig) {
-    if (!this.info) {
-      this.err("download failed", "param", "no update info, call `checkUpdate` first");
+  async downloadUpdate(data, sig) {
+    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 +138,20 @@ 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);
+      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.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 +162,20 @@ var Updater = class extends EventEmitter {
     this.logger?.info("quit and install");
     restartApp();
   }
+  /**
+   * setup provider URL handler
+   *
+   * @example
+   * updater.setURLHandler((url, isDownloadingAsar) => {
+   *   if (isDownloadingAsar) {
+   *     url.hostname = 'https://cdn.jsdelivr.net/gh'
+   *     return url
+   *   }
+   * })
+   */
+  setURLHandler(handler) {
+    this.provider.urlHandler = handler;
+  }
 };
 
 // src/entry.ts
@@ -211,7 +184,7 @@ function startupWithUpdater(fn) {
 }
 var defaultOnInstall = (install, _, __, logger) => {
   install();
-  logger.info(`update success!`);
+  logger?.info(`update success!`);
 };
 async function initApp(appOptions) {
   const {
@@ -227,31 +200,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 };