electron-incremental-update 2.4.3 → 3.0.0-beta.3

package/dist/index.js

@@ -1,309 +0,0 @@
-import { isDev, getEntryVersion, getAppVersion, getPathFromAppNameAsar, restartApp } from './chunk-IVHNGRZY.js';
-import { isUpdateJSON, __require } from './chunk-AAAM44NW.js';
-import fs from 'fs';
-import path from 'path';
-import electron2 from 'electron';
-import { EventEmitter } from 'events';
-
-// src/entry/types.ts
-var UpdaterError = class extends Error {
-  code;
-  constructor(code, info) {
-    super(`[${code}] ${info}`);
-    this.code = code;
-  }
-};
-
-// src/entry/updater.ts
-var Updater = class extends EventEmitter {
-  CERT;
-  controller;
-  info;
-  tmpFilePath;
-  processing = false;
-  provider;
-  /**
-   * Updater logger
-   */
-  logger;
-  /**
-   * Whether to receive beta update
-   */
-  receiveBeta;
-  /**
-   * Whether force update in DEV
-   */
-  forceUpdate;
-  /**
-   * Initialize incremental updater
-   * @param options UpdaterOption
-   */
-  constructor(options = {}) {
-    super();
-    this.provider = options.provider;
-    this.receiveBeta = options.receiveBeta;
-    this.CERT = options.SIGNATURE_CERT || __EIU_SIGNATURE_CERT__;
-    this.logger = options.logger;
-    this.controller = new AbortController();
-    if (isDev && !this.logger) {
-      this.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)
-      };
-      this.logger.info("No logger set, enable dev-only logger");
-    }
-    if (!this.provider) {
-      this.logger?.debug("WARN: No update provider");
-    }
-  }
-  async fetch(format, data) {
-    if (typeof data === "object") {
-      if (format === "json" && isUpdateJSON(data) || format === "buffer" && Buffer.isBuffer(data)) {
-        return data;
-      } else {
-        this.err("Invalid type", "ERR_PARAM", `Invalid type at format '${format}': ${JSON.stringify(data)}`);
-        return;
-      }
-    }
-    this.logger?.debug(`Download from \`${this.provider.name}\``);
-    try {
-      const result = format === "json" ? await this.provider.downloadJSON(
-        electron2.app.name,
-        __EIU_VERSION_PATH__,
-        this.controller.signal
-      ) : await this.provider.downloadAsar(
-        this.info,
-        this.controller.signal,
-        (info) => this.emit("download-progress", info)
-      );
-      this.logger?.debug(`Download ${format} success${format === "buffer" ? `, file size: ${result.length}` : ""}`);
-      return result;
-    } catch (e) {
-      this.err(`Fetch ${format} failed`, "ERR_NETWORK", e instanceof Error ? e.message : e.toString());
-    }
-  }
-  cleanup() {
-    if (this.tmpFilePath && fs.existsSync(this.tmpFilePath)) {
-      try {
-        fs.unlinkSync(this.tmpFilePath);
-        this.tmpFilePath = void 0;
-        this.logger?.debug("Cleaned up temporary update file");
-      } catch (error) {
-        this.logger?.warn(`Failed to clean up temporary update file: ${error}`);
-      }
-    }
-  }
-  /**
-   * Handle error message and emit error event
-   */
-  err(msg, code, errorInfo) {
-    const err = new UpdaterError(code, errorInfo);
-    this.logger?.error(`[${code}] ${msg}`, err);
-    this.cleanup();
-    this.emit("error", err);
-  }
-  async checkForUpdates(data) {
-    const emitUnavailable = (msg, code, info2) => {
-      this.logger?.info(`[${code}] ${msg}`);
-      this.logger?.debug("Check update end");
-      this.processing = false;
-      this.emit("update-not-available", code, msg, info2);
-      return false;
-    };
-    if (this.processing) {
-      this.logger?.info("Updater is already processing, skip check update");
-      return false;
-    }
-    this.processing = true;
-    this.logger?.debug("Check update start");
-    if (!data && !this.provider) {
-      const msg = "No update json or provider";
-      this.err("Check update failed", "ERR_PARAM", msg);
-      return emitUnavailable(
-        msg,
-        "UNAVAILABLE_ERROR"
-      );
-    }
-    const _data = await this.fetch("json", data);
-    if (!_data) {
-      return emitUnavailable(
-        "Failed to get update info",
-        "UNAVAILABLE_ERROR"
-      );
-    }
-    const { signature, version, minimumVersion, url, ...rest } = this.receiveBeta ? _data.beta : _data;
-    const info = { signature, minimumVersion, version, url };
-    const extraVersionInfo = {
-      signature,
-      minimumVersion,
-      version,
-      appVersion: getAppVersion(),
-      entryVersion: getEntryVersion(),
-      ...rest
-    };
-    this.logger?.debug(`Checked update, version: ${version}, signature: ${signature}`);
-    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",
-        "UNAVAILABLE_DEV"
-      );
-    }
-    const isLowerVersion = this.provider.isLowerVersion;
-    try {
-      if (isLowerVersion(extraVersionInfo.entryVersion, minimumVersion)) {
-        return emitUnavailable(
-          `Entry Version (${extraVersionInfo.entryVersion}) < MinimumVersion (${minimumVersion})`,
-          "UNAVAILABLE_VERSION",
-          extraVersionInfo
-        );
-      }
-      this.logger?.info(`Current version is ${extraVersionInfo.appVersion}, new version is ${version}`);
-      if (!isLowerVersion(extraVersionInfo.appVersion, version)) {
-        return emitUnavailable(
-          `Current version (${extraVersionInfo.appVersion}) > New version (${version})`,
-          "UNAVAILABLE_VERSION",
-          extraVersionInfo
-        );
-      }
-      this.logger?.info(`Update available: ${version}`);
-      this.info = info;
-      this.processing = false;
-      this.logger?.debug("Check update end");
-      this.emit("update-available", extraVersionInfo);
-      return true;
-    } catch {
-      const msg = "Fail to parse version string";
-      this.err(
-        "Check update failed",
-        "ERR_VALIDATE",
-        msg
-      );
-      return emitUnavailable(msg, "UNAVAILABLE_ERROR", extraVersionInfo);
-    }
-  }
-  async downloadUpdate(data, info) {
-    const emitError = (code, errorInfo) => {
-      this.err(`Download update failed`, code, errorInfo);
-      this.logger?.debug("Download update end");
-      this.processing = false;
-      return false;
-    };
-    if (this.processing) {
-      this.logger?.info("Updater is already processing, skip download update");
-      return false;
-    }
-    this.processing = true;
-    this.logger?.debug("Download update start");
-    const _sig = info?.signature ?? this.info?.signature;
-    const _version = info?.version ?? this.info?.version;
-    if (!_sig || !_version) {
-      return emitError(
-        "ERR_PARAM",
-        "No update signature, please call `checkUpdate` first or manually setup params"
-      );
-    }
-    if (!data && !this.provider) {
-      return emitError(
-        "ERR_PARAM",
-        "No update asar buffer and provider"
-      );
-    }
-    const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
-    if (!buffer) {
-      return emitError(
-        "ERR_PARAM",
-        "No update asar file buffer"
-      );
-    }
-    this.logger?.debug("Validation start");
-    if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
-      return emitError(
-        "ERR_VALIDATE",
-        "Invalid update asar file"
-      );
-    }
-    this.logger?.debug("Validation end");
-    try {
-      this.tmpFilePath = `${getPathFromAppNameAsar()}.tmp`;
-      this.logger?.debug(`Install to ${this.tmpFilePath}`);
-      fs.writeFileSync(this.tmpFilePath, await this.provider.unzipFile(buffer));
-      this.logger?.info(`Download success, version: ${_version}`);
-      this.info = void 0;
-      this.emit("update-downloaded");
-      this.processing = false;
-      this.logger?.debug("Download update end");
-      return true;
-    } catch (error) {
-      this.cleanup();
-      return emitError(
-        "ERR_DOWNLOAD",
-        `Failed to write update file: ${error instanceof Error ? error.message : error}`
-      );
-    }
-  }
-  /**
-   * quit App and install
-   */
-  quitAndInstall() {
-    this.logger?.info("Quit and install");
-    restartApp();
-  }
-  cancel() {
-    if (this.controller.signal.aborted) {
-      return;
-    }
-    this.controller.abort();
-    this.cleanup();
-    this.logger?.info("Cancel update");
-    this.emit("update-cancelled");
-    this.controller = new AbortController();
-  }
-};
-async function autoUpdate(updater) {
-  if (await updater.checkForUpdates() && await updater.downloadUpdate()) {
-    updater.quitAndInstall();
-  }
-}
-
-// src/entry/core.ts
-function startupWithUpdater(fn) {
-  return fn;
-}
-var defaultOnInstall = (install, _, __, logger) => {
-  install();
-  logger?.info(`update success!`);
-};
-async function createElectronApp(appOptions = {}) {
-  const appNameAsarPath = getPathFromAppNameAsar();
-  const {
-    mainPath = isDev ? path.join(electron2.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "main", __EIU_MAIN_FILE__) : path.join(path.dirname(electron2.app.getAppPath()), __EIU_ASAR_BASE_NAME__, "main", __EIU_MAIN_FILE__),
-    updater,
-    onInstall = defaultOnInstall,
-    beforeStart,
-    onStartError
-  } = appOptions;
-  const updaterInstance = typeof updater === "object" || !updater ? new Updater(updater) : await updater();
-  const logger = updaterInstance.logger;
-  try {
-    const tempAsarPath = `${appNameAsarPath}.tmp`;
-    if (fs.existsSync(tempAsarPath)) {
-      logger?.info(`Installing new asar from ${tempAsarPath}`);
-      await onInstall(() => fs.renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
-    }
-    await beforeStart?.(mainPath, logger);
-    if (__EIU_IS_ESM__) {
-      (await import(`file://${mainPath}`)).default(updaterInstance);
-    } else {
-      __require(mainPath)(updaterInstance);
-    }
-  } catch (error) {
-    logger?.error("startup error, exit", error);
-    onStartError?.(error, logger);
-    electron2.app.quit();
-  }
-}
-var initApp = createElectronApp;
-
-export { Updater, UpdaterError, autoUpdate, createElectronApp, initApp, startupWithUpdater };

package/dist/provider.d.ts

@@ -1,134 +0,0 @@
-import { c as defaultVerifySignature, l as defaultUnzipFile } from './zip-CnSv_Njj.js';
-export { j as defaultDownloadAsar, f as defaultDownloadText, i as defaultDownloadUpdateJSON, e as downloadUtil, g as getHeader, r as resolveJson } from './zip-CnSv_Njj.js';
-import { I as IProvider, d as defaultIsLowerVersion, b as UpdateJSONWithURL, e as UpdateInfoWithURL, D as DownloadingInfo, f as URLHandler } from './types-CU7GyVez.js';
-import { Promisable } from '@subframe7536/type-utils';
-import 'electron';
-import 'node:url';
-
-declare abstract class BaseProvider implements IProvider {
-    name: string;
-    /**
-     * @inheritdoc
-     */
-    isLowerVersion: typeof defaultIsLowerVersion;
-    /**
-     * @inheritdoc
-     */
-    verifySignaure: typeof defaultVerifySignature;
-    /**
-     * @inheritdoc
-     */
-    unzipFile: typeof defaultUnzipFile;
-    /**
-     * @inheritdoc
-     */
-    abstract downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<UpdateJSONWithURL>;
-    /**
-     * @inheritdoc
-     */
-    abstract downloadAsar(info: UpdateInfoWithURL, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
-}
-
-interface BaseGitHubProviderOptions {
-    /**
-     * Github user name
-     */
-    user: string;
-    /**
-     * Github repo name
-     */
-    repo: string;
-    /**
-     * Extra headers
-     */
-    extraHeaders?: Record<string, string>;
-    /**
-     * Custom url handler ({@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 some public CDN links})
-     * @example
-     * (url) => {
-     *   url.hostname = 'mirror.ghproxy.com'
-     *   url.pathname = 'https://github.com' + url.pathname
-     *   return url
-     * }
-     */
-    urlHandler?: URLHandler;
-}
-declare abstract class BaseGitHubProvider<T extends BaseGitHubProviderOptions = BaseGitHubProviderOptions> extends BaseProvider {
-    protected options: T;
-    constructor(options: T);
-    get urlHandler(): URLHandler | undefined;
-    set urlHandler(handler: URLHandler);
-    protected parseURL(extraPath: string): Promise<string>;
-    protected abstract getHeaders(accept: string): Record<string, string>;
-    protected abstract getVersionURL(versionPath: string, signal: AbortSignal): Promisable<string>;
-    downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<UpdateJSONWithURL>;
-    /**
-     * @inheritdoc
-     */
-    downloadAsar(info: UpdateInfoWithURL, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
-}
-
-interface GitHubApiProviderOptions extends BaseGitHubProviderOptions {
-    token?: string;
-}
-/**
- * Update Provider for Github API, you need to upload `version.json` to release as well
- * - check update from `https://api.github.com/repos/{user}/{repo}/releases?per_page=1`
- * - download update json and get version and download url
- * - download update asar from update info
- *
- * you can setup `urlHandler` in options to modify url before request
- * @param options provider options
- */
-declare class GitHubApiProvider extends BaseGitHubProvider<GitHubApiProviderOptions> {
-    name: string;
-    constructor(options: GitHubApiProviderOptions);
-    protected getHeaders(accept: string): Record<string, string>;
-    /**
-     * @inheritdoc
-     */
-    protected getVersionURL(versionPath: string, signal: AbortSignal): Promise<string>;
-}
-
-/**
- * Update Provider for Github repo
- * - check update from `https://github.com/{user}/{repo}/releases.atom`
- * - download update json from `https://github.com/{user}/{repo}/releases/download/v{version}/{versionPath}`
- * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
- *
- * you can setup `urlHandler` in options to modify url before request
- * @param options provider options
- */
-declare class GitHubAtomProvider extends BaseGitHubProvider {
-    name: string;
-    constructor(options: BaseGitHubProviderOptions);
-    protected getHeaders(accept: string): Record<string, string>;
-    /**
-     * @inheritdoc
-     */
-    protected getVersionURL(versionPath: string, signal: AbortSignal): Promise<string>;
-}
-
-interface GitHubProviderOptions extends BaseGitHubProviderOptions {
-    /**
-     * Github branch name that fetch version
-     * @default 'HEAD'
-     */
-    branch?: string;
-}
-/**
- * Update Provider for Github repo
- * - download update json from `https://github.com/{user}/{repo}/raw/HEAD/{versionPath}`
- * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
- *
- * you can setup `urlHandler` in options to modify url before request
- * @param options provider options
- */
-declare class GitHubProvider extends BaseGitHubProvider<GitHubProviderOptions> {
-    name: string;
-    constructor(options: GitHubProviderOptions);
-    protected getHeaders(accept: string): Record<string, string>;
-    protected getVersionURL(versionPath: string): string;
-}
-
-export { BaseGitHubProvider, type BaseGitHubProviderOptions, BaseProvider, DownloadingInfo, GitHubApiProvider, type GitHubApiProviderOptions, GitHubAtomProvider, GitHubProvider, type GitHubProviderOptions, IProvider, URLHandler, UpdateInfoWithURL, UpdateJSONWithURL };

package/dist/provider.js

@@ -1,152 +0,0 @@
-import { defaultVerifySignature, defaultUnzipFile, defaultDownloadUpdateJSON, defaultDownloadAsar, defaultDownloadText, resolveJson } from './chunk-PD4EV4MM.js';
-export { defaultDownloadAsar, defaultDownloadText, defaultDownloadUpdateJSON, downloadUtil, getHeader, resolveJson } from './chunk-PD4EV4MM.js';
-import { defaultIsLowerVersion } from './chunk-AAAM44NW.js';
-import { URL } from 'url';
-
-// src/provider/base.ts
-var BaseProvider = class {
-  name = "BaseProvider";
-  /**
-   * @inheritdoc
-   */
-  isLowerVersion = defaultIsLowerVersion;
-  /**
-   * @inheritdoc
-   */
-  verifySignaure = defaultVerifySignature;
-  /**
-   * @inheritdoc
-   */
-  unzipFile = defaultUnzipFile;
-};
-var BaseGitHubProvider = class extends BaseProvider {
-  constructor(options) {
-    super();
-    this.options = options;
-  }
-  get urlHandler() {
-    return this.options.urlHandler;
-  }
-  set urlHandler(handler) {
-    this.options.urlHandler = handler;
-  }
-  async parseURL(extraPath) {
-    const url = new URL(
-      `/${this.options.user}/${this.options.repo}/${extraPath}`,
-      "https://github.com"
-    );
-    return (await this.urlHandler?.(url) || url).toString();
-  }
-  async downloadJSON(name, versionPath, signal) {
-    const { beta, version, ...info } = await defaultDownloadUpdateJSON(
-      await this.parseURL(await this.getVersionURL(versionPath, signal)),
-      this.getHeaders("json"),
-      signal
-    );
-    const getURL = (ver) => this.parseURL(
-      `releases/download/v${ver}/${name}-${ver}.asar.gz`
-    );
-    return {
-      ...info,
-      version,
-      url: await getURL(version),
-      beta: {
-        ...beta,
-        url: await getURL(beta.version)
-      }
-    };
-  }
-  /**
-   * @inheritdoc
-   */
-  async downloadAsar(info, signal, onDownloading) {
-    return await defaultDownloadAsar(
-      info.url,
-      this.getHeaders("octet-stream"),
-      signal,
-      onDownloading
-    );
-  }
-};
-
-// src/provider/github/api.ts
-var ERROR_MSG = "Cannot find UpdateJSON in latest release";
-var GitHubApiProvider = class extends BaseGitHubProvider {
-  name = "GithubApiProvider";
-  constructor(options) {
-    super(options);
-  }
-  getHeaders(accept) {
-    return {
-      Accept: `application/${accept}`,
-      ...this.options.token ? { Authorization: `token ${this.options.token}` } : {},
-      ...this.options.extraHeaders
-    };
-  }
-  /**
-   * @inheritdoc
-   */
-  async getVersionURL(versionPath, signal) {
-    const basename = versionPath.slice(versionPath.lastIndexOf("/") + 1);
-    const data = await defaultDownloadText(
-      await this.parseURL(`https://api.github.com/repos/${this.options.user}/${this.options.repo}/releases?per_page=1`),
-      this.getHeaders("vnd.github.v3+json"),
-      signal,
-      resolveJson
-    );
-    const versionAssets = data[0]?.assets.find((asset) => asset.name === basename);
-    if (!versionAssets) {
-      throw new Error(`${ERROR_MSG}, ${"message" in data ? data.message : "please check the release assets"}`);
-    }
-    return versionAssets.browser_download_url;
-  }
-};
-
-// src/provider/github/atom.ts
-var GitHubAtomProvider = class extends BaseGitHubProvider {
-  name = "GithubAtomProvider";
-  constructor(options) {
-    super(options);
-  }
-  getHeaders(accept) {
-    return { Accept: `application/${accept}`, ...this.options.extraHeaders };
-  }
-  /**
-   * @inheritdoc
-   */
-  async getVersionURL(versionPath, signal) {
-    const tag = await defaultDownloadText(
-      await this.parseURL(`releases.atom`),
-      this.getHeaders("xml"),
-      signal,
-      (data, resolve, reject) => {
-        const result = data.match(/<entry>\s*<id>([^<]*\/)?([^/<]+)<\/id>/)?.[2];
-        if (result) {
-          resolve(result);
-        } else {
-          reject("No tag matched");
-        }
-      }
-    );
-    return `releases/download/v${tag}/${versionPath}`;
-  }
-};
-
-// src/provider/github/file.ts
-var GitHubProvider = class extends BaseGitHubProvider {
-  name = "GithubProvider";
-  constructor(options) {
-    super(options);
-    if (!options.branch) {
-      this.options.branch = "HEAD";
-    }
-  }
-  getHeaders(accept) {
-    return { Accept: `application/${accept}`, ...this.options.extraHeaders };
-  }
-  getVersionURL(versionPath) {
-    return `raw/${this.options.branch}/${versionPath}`;
-  }
-};
-
-export { BaseGitHubProvider, BaseProvider, GitHubApiProvider, GitHubAtomProvider, GitHubProvider };