electron-incremental-update 2.4.2 → 3.0.0-beta.2

package/dist/index.cjs

@@ -1,350 +1,278 @@
-'use strict';
+const require_version = require('./version-aPrLuz_-.cjs');
+const require_electron = require('./electron-BFoZUBhU.cjs');
+let electron = require("electron");
+let node_fs = require("node:fs");
+node_fs = require_version.__toESM(node_fs);
+let node_path = require("node:path");
+node_path = require_version.__toESM(node_path);
+let node_events = require("node:events");
 
-var fs2 = require('fs');
-var path2 = require('path');
-var electron = require('electron');
-var events = require('events');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var fs2__default = /*#__PURE__*/_interopDefault(fs2);
-var path2__default = /*#__PURE__*/_interopDefault(path2);
-var electron__default = /*#__PURE__*/_interopDefault(electron);
-
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-var isDev = __EIU_IS_DEV__;
-process.platform === "win32";
-process.platform === "darwin";
-process.platform === "linux";
-function getPathFromAppNameAsar(...paths) {
-  return isDev ? "DEV.asar" : path2__default.default.join(path2__default.default.dirname(electron__default.default.app.getAppPath()), `${electron__default.default.app.name}.asar`, ...paths);
-}
-function getAppVersion() {
-  return isDev ? getEntryVersion() : fs2__default.default.readFileSync(getPathFromAppNameAsar("version"), "utf-8");
-}
-function getEntryVersion() {
-  return electron__default.default.app.getVersion();
-}
-function restartApp() {
-  electron__default.default.app.relaunch();
-  electron__default.default.app.quit();
-}
-
-// src/utils/version.ts
-var is = (j) => !!(j && j.minimumVersion && j.signature && j.version);
-function isUpdateJSON(json) {
-  return is(json) && is(json?.beta);
-}
-
-// src/entry/types.ts
+//#region src/entry/types.ts
 var UpdaterError = class extends Error {
-  code;
-  constructor(code, info) {
-    super(`[${code}] ${info}`);
-    this.code = code;
-  }
+	code;
+	constructor(code, info) {
+		super(`[${code}] ${info}`);
+		this.code = code;
+	}
 };
 
-// src/entry/updater.ts
-var Updater = class extends events.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(
-        electron__default.default.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 && fs2__default.default.existsSync(this.tmpFilePath)) {
-      try {
-        fs2__default.default.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}`);
-      fs2__default.default.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();
-  }
+//#endregion
+//#region src/entry/updater.ts
+var Updater = class extends node_events.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 (require_electron.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" && require_version.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(electron.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 && node_fs.default.existsSync(this.tmpFilePath)) try {
+			node_fs.default.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, info) => {
+			this.logger?.info(`[${code}] ${msg}`);
+			this.logger?.debug("Check update end");
+			this.processing = false;
+			this.emit("update-not-available", code, msg, info);
+			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: require_electron.getAppVersion(),
+			entryVersion: require_electron.getEntryVersion(),
+			...rest
+		};
+		this.logger?.debug(`Checked update, version: ${version}, signature: ${signature}`);
+		if (require_electron.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 = `${require_electron.getPathFromAppNameAsar()}.tmp`;
+			this.logger?.debug(`Install to ${this.tmpFilePath}`);
+			node_fs.default.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");
+		require_electron.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();
+	}
 };
+/**
+* Auto check update, download and install
+*/
 async function autoUpdate(updater) {
-  if (await updater.checkForUpdates() && await updater.downloadUpdate()) {
-    updater.quitAndInstall();
-  }
+	if (await updater.checkForUpdates() && await updater.downloadUpdate()) updater.quitAndInstall();
 }
 
-// src/entry/core.ts
+//#endregion
+//#region src/entry/core.ts
+/**
+* Utils to startup with updater
+* @param fn startup function
+* @example
+* // in electron/main/index.ts
+* export default startupWithUpdater((updater) => {
+*   updater.checkUpdate()
+* })
+*/
 function startupWithUpdater(fn) {
-  return fn;
+	console.log(typeof fn);
+	return fn;
+}
+function runWithDefaultExport(mod, args) {
+	return (mod.default || mod)(args);
 }
-var defaultOnInstall = (install, _, __, logger) => {
-  install();
-  logger?.info(`update success!`);
+const defaultOnInstall = (install, _, __, logger) => {
+	install();
+	logger?.info(`update success!`);
 };
+/**
+* Initialize Electron with updater
+* @example
+* createElectronApp({
+*   updater: {
+*     provider: new GitHubProvider({
+*       username: 'yourname',
+*       repo: 'electron',
+*     }),
+*   },
+*   beforeStart(mainFilePath, logger) {
+*     logger?.debug(mainFilePath)
+*   },
+* })
+*/
 async function createElectronApp(appOptions = {}) {
-  const appNameAsarPath = getPathFromAppNameAsar();
-  const {
-    mainPath = isDev ? path2__default.default.join(electron__default.default.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "main", __EIU_MAIN_FILE__) : path2__default.default.join(path2__default.default.dirname(electron__default.default.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 (fs2__default.default.existsSync(tempAsarPath)) {
-      logger?.info(`Installing new asar from ${tempAsarPath}`);
-      await onInstall(() => fs2__default.default.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);
-    electron__default.default.app.quit();
-  }
+	const appNameAsarPath = require_electron.getPathFromAppNameAsar();
+	const { mainPath = require_electron.isDev ? node_path.default.join(electron.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "main", __EIU_MAIN_FILE__) : node_path.default.join(node_path.default.dirname(electron.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 (node_fs.default.existsSync(tempAsarPath)) {
+			logger?.info(`Installing new asar from ${tempAsarPath}`);
+			await onInstall(() => node_fs.default.renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
+		}
+		await beforeStart?.(mainPath, logger);
+		if (__EIU_IS_ESM__) runWithDefaultExport(await import(`file://${mainPath}`), updaterInstance);
+		else runWithDefaultExport(require(mainPath), updaterInstance);
+	} catch (error) {
+		logger?.error("startup error, exit", error);
+		onStartError?.(error, logger);
+		electron.app.quit();
+	}
 }
-var initApp = createElectronApp;
+/**
+* @deprecated Use {@link createElectronApp} instead
+*/
+const initApp = createElectronApp;
 
+//#endregion
 exports.Updater = Updater;
 exports.UpdaterError = UpdaterError;
 exports.autoUpdate = autoUpdate;
 exports.createElectronApp = createElectronApp;
 exports.initApp = initApp;
-exports.startupWithUpdater = startupWithUpdater;
+exports.startupWithUpdater = startupWithUpdater;