electron-incremental-update 1.0.3 → 1.2.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { U as UpdateInfo, a as UpdateJSON } from './noDep-TvZoKVF8.js';
+import { U as UpdateInfo, a as UpdateJSON } from './pure-GoN_3MEj.js';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -83,19 +83,10 @@ type UpdaterDownloadConfig = {
 };
 interface UpdaterOption {
     /**
-     * public key of signature, which will be auto generated by plugin
-     * @example
-     * ```ts
-     * // just empty here, auto filled by plugin
-     * const SIGNATURE_CERT = ''
-     *
-     * const updater = createUpdater({
-     *   SIGNATURE_CERT,
-     *   ...
-     * })
-     * ```
+     * public key of signature, which will be auto generated by plugin,
+     * generate by `selfsigned` if not set
      */
-    SIGNATURE_CERT: string;
+    SIGNATURE_CERT?: string;
     /**
      * repository url, e.g. `https://github.com/electron/electron`
      *
@@ -126,6 +117,7 @@ interface UpdaterOption {
 }
 
 declare class Updater {
+    private CERT;
     private info?;
     private option;
     private asarPath;
@@ -153,7 +145,7 @@ declare class Updater {
      * initialize incremental updater
      * @param option UpdaterOption
      */
-    constructor(option: UpdaterOption);
+    constructor(option?: UpdaterOption);
     private needUpdate;
     /**
      * this function is used to parse download data.
@@ -200,11 +192,15 @@ declare class Updater {
  * @param option updater option
  * @returns updater
  */
-declare function createUpdater(option: UpdaterOption): Updater;
+declare function createUpdater(option?: UpdaterOption): Updater;
 
 type Promisable<T> = T | Promise<T>;
 type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 type AppOption = {
+    /**
+     * updater options
+     */
+    updater?: (() => Promisable<Updater>) | UpdaterOption;
     /**
      * path of electron output dist when in development
      * @default '../dist-electron'
@@ -252,13 +248,6 @@ type AppOption = {
  * })
  */
 declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>): (updater: Updater) => Promisable<void>;
-type StartupWithUpdater = {
-    /**
-     * starup app
-     * @param updater updater option or create function
-     */
-    startupWithUpdater: (updater: (() => Promisable<Updater>) | UpdaterOption) => void;
-};
 /**
  * initialize app
  * @example
@@ -266,20 +255,22 @@ type StartupWithUpdater = {
  * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
  * import { repository } from '../package.json'
  *
- * const SIGNATURE_CERT = '' // auto generate certificate when start app
  * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
  * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
- * initApp({ onStart: console.log })
+ *
+ * initApp({
  *   // can be updater option or function that return updater
- *   .startupWithUpdater({
- *     SIGNATURE_CERT,
+ *   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): StartupWithUpdater;
+declare function initApp(appOptions?: AppOption): Promise<void>;
 
 export { type AppOption, type CheckResult, type CheckResultError, DownloadError, type DownloadResult, type DownloadResultError, type DownloadingInfo, type Logger, MinimumVersionError, Updater, type UpdaterDownloadConfig, type UpdaterOption, type UpdaterOverrideFunctions, VerifyFailedError, createUpdater, initApp, startupWithUpdater };

package/dist/index.js

@@ -1,149 +1,45 @@
-"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 key2 of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key2) && key2 !== except)
-        __defProp(to, key2, { get: () => from[key2], enumerable: !(desc = __getOwnPropDesc(from, key2)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+import {
+  __require,
+  getPathFromAppNameAsar,
+  getVersions,
+  is,
+  isUpdateJSON,
+  parseVersion,
+  restartApp,
+  unzipFile,
+  waitAppReady
+} from "./chunk-RQCTJY4L.js";
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  DownloadError: () => DownloadError,
-  MinimumVersionError: () => MinimumVersionError,
-  Updater: () => Updater,
-  VerifyFailedError: () => VerifyFailedError,
-  createUpdater: () => createUpdater,
-  initApp: () => initApp,
-  startupWithUpdater: () => startupWithUpdater
-});
-module.exports = __toCommonJS(src_exports);
-var import_node_path2 = require("path");
-var import_node_fs4 = require("fs");
-var import_electron4 = require("electron");
+import { resolve } from "node:path";
+import { existsSync as existsSync2, renameSync } from "node:fs";
+import { app as app2 } from "electron";
 
 // src/updater/core.ts
-var import_node_fs3 = require("fs");
-var import_promises = require("fs/promises");
-var import_electron3 = require("electron");
-
-// src/utils/electron.ts
-var import_node_fs = require("fs");
-var import_node_path = require("path");
-var import_node_os = require("os");
-var import_electron = require("electron");
-var is = {
-  dev: !import_electron.app.isPackaged,
-  win: process.platform === "win32",
-  mac: process.platform === "darwin",
-  linux: process.platform === "linux"
-};
-function getPathFromAppNameAsar(...path) {
-  return is.dev ? "DEV.asar" : (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${import_electron.app.name}.asar`, ...path);
-}
-function getVersions() {
-  const platform = is.win ? "Windows" : is.mac ? "MacOS" : process.platform.toUpperCase();
-  return {
-    appVersion: is.dev ? import_electron.app.getVersion() : (0, import_node_fs.readFileSync)(getPathFromAppNameAsar("version"), "utf-8"),
-    entryVersion: import_electron.app.getVersion(),
-    electronVersion: process.versions.electron,
-    nodeVersion: process.versions.node,
-    systemVersion: `${platform} ${(0, import_node_os.release)()}`
-  };
-}
-function restartApp() {
-  import_electron.app.relaunch();
-  import_electron.app.quit();
-}
-function waitAppReady(timeout = 1e3) {
-  return import_electron.app.isReady() ? Promise.resolve() : new Promise((resolve2, reject) => {
-    const _ = setTimeout(() => {
-      reject(new Error("app is not ready"));
-    }, timeout);
-    import_electron.app.whenReady().then(() => {
-      clearTimeout(_);
-      resolve2();
-    });
-  });
-}
+import { existsSync, rmSync, writeFileSync } from "node:fs";
+import { app } from "electron";
 
-// src/utils/zip.ts
-var import_node_fs2 = require("fs");
-var import_node_zlib = require("zlib");
-async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
-  if (!(0, import_node_fs2.existsSync)(gzipPath)) {
-    throw new Error(`path to zipped file not exist: ${gzipPath}`);
-  }
-  const compressedBuffer = (0, import_node_fs2.readFileSync)(gzipPath);
-  return new Promise((resolve2, reject) => {
-    (0, import_node_zlib.gunzip)(compressedBuffer, (err, buffer) => {
-      (0, import_node_fs2.rmSync)(gzipPath);
-      if (err) {
-        reject(err);
-      }
-      (0, import_node_fs2.writeFileSync)(targetFilePath, buffer);
-      resolve2(null);
-    });
-  });
-}
+// src/crypto/dec.ts
+import { createDecipheriv, createVerify } from "node:crypto";
 
-// src/utils/noDep.ts
-function parseVersion(version) {
-  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-zA-Z0-9\.-]+))?/i;
-  const match = semver.exec(version);
-  if (!match) {
-    throw new TypeError(`invalid version: ${version}`);
-  }
-  const [major, minor, patch] = match.slice(1, 4).map(Number);
-  const ret = {
-    major,
-    minor,
-    patch,
-    stage: "",
-    stageVersion: -1
-  };
-  if (match[4]) {
-    let [stage, _v] = match[4].split(".");
-    ret.stage = stage;
-    ret.stageVersion = Number(_v) || -1;
-  }
-  if (Number.isNaN(major) || Number.isNaN(minor) || Number.isNaN(patch) || Number.isNaN(ret.stageVersion)) {
-    throw new TypeError(`invalid version: ${version}`);
-  }
-  return ret;
-}
-function isUpdateJSON(json) {
-  const is2 = (j) => !!(j && j.minimumVersion && j.signature && j.size && j.version);
-  return is2(json) && is2(json?.beta);
+// src/crypto/utils.ts
+import { createHash } from "node:crypto";
+function hashString(data, length) {
+  const hash = createHash("SHA256").update(data).digest("binary");
+  return Buffer.from(hash).subarray(0, length);
 }
 
-// src/crypto.ts
-var import_node_crypto = require("crypto");
-function decrypt(encryptedText, key2, iv) {
-  const decipher = (0, import_node_crypto.createDecipheriv)("aes-256-cbc", key2, iv);
+// src/crypto/dec.ts
+function decrypt(encryptedText, key, iv) {
+  const decipher = createDecipheriv("aes-256-cbc", key, iv);
   let decrypted = decipher.update(encryptedText, "base64url", "utf8");
   decrypted += decipher.final("utf8");
   return decrypted;
 }
-function key(data, length) {
-  const hash = (0, import_node_crypto.createHash)("SHA256").update(data).digest("binary");
-  return Buffer.from(hash).subarray(0, length);
-}
 var verify = (buffer, signature, cert) => {
   try {
-    const [sig, version] = decrypt(signature, key(cert, 32), key(buffer, 16)).split("%");
-    const result = (0, import_node_crypto.createVerify)("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
+    const [sig, version] = decrypt(signature, hashString(cert, 32), hashString(buffer, 16)).split("%");
+    const result = createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
     return result ? version : false;
   } catch (error) {
     return false;
@@ -176,17 +72,17 @@ var DownloadError = class extends Error {
 };
 
 // src/updater/defaultFunctions/download.ts
-var import_electron2 = require("electron");
+import { net } from "electron";
 var downloadJSONDefault = async (url, headers) => {
   await waitAppReady();
   return new Promise((resolve2, reject) => {
-    const request = import_electron2.net.request({
+    const request = net.request({
       url,
       method: "GET",
       redirect: "follow"
     });
-    Object.keys(headers).forEach((key2) => {
-      request.setHeader(key2, headers[key2]);
+    Object.keys(headers).forEach((key) => {
+      request.setHeader(key, headers[key]);
     });
     request.on("response", (res) => {
       let data = "";
@@ -214,13 +110,13 @@ var downloadBufferDefault = async (url, headers, total, onDownloading) => {
   await waitAppReady();
   let current = 0;
   return new Promise((resolve2, reject) => {
-    const request = import_electron2.net.request({
+    const request = net.request({
       url,
       method: "GET",
       redirect: "follow"
     });
-    Object.keys(headers).forEach((key2) => {
-      request.setHeader(key2, headers[key2]);
+    Object.keys(headers).forEach((key) => {
+      request.setHeader(key, headers[key]);
     });
     request.on("response", (res) => {
       let data = [];
@@ -255,11 +151,11 @@ var compareVersionDefault = (version1, version2) => {
     }
     return str1 < str2;
   }
-  for (let key2 of Object.keys(oldV)) {
-    if (key2 === "stage" && compareStrings(oldV[key2], newV[key2])) {
+  for (let key of Object.keys(oldV)) {
+    if (key === "stage" && compareStrings(oldV[key], newV[key])) {
       return true;
-    } else if (oldV[key2] !== newV[key2]) {
-      return oldV[key2] < newV[key2];
+    } else if (oldV[key] !== newV[key]) {
+      return oldV[key] < newV[key];
     }
   }
   return false;
@@ -267,6 +163,7 @@ var compareVersionDefault = (version1, version2) => {
 
 // src/updater/core.ts
 var Updater = class {
+  CERT = __SIGNATURE_CERT__;
   info;
   option;
   asarPath;
@@ -298,8 +195,11 @@ var Updater = class {
    * initialize incremental updater
    * @param option UpdaterOption
    */
-  constructor(option) {
+  constructor(option = {}) {
     this.option = option;
+    if (option.SIGNATURE_CERT) {
+      this.CERT = option.SIGNATURE_CERT;
+    }
     this.asarPath = getPathFromAppNameAsar();
     this.gzipPath = `${this.asarPath}.gz`;
     this.tmpFilePath = `${this.asarPath}.tmp`;
@@ -314,13 +214,13 @@ var Updater = class {
     return await compare(appVersion, version);
   }
   async parseData(format, data) {
-    if ((0, import_node_fs3.existsSync)(this.tmpFilePath)) {
+    if (existsSync(this.tmpFilePath)) {
       this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
-      await (0, import_promises.rm)(this.tmpFilePath);
+      rmSync(this.tmpFilePath);
     }
-    if ((0, import_node_fs3.existsSync)(this.gzipPath)) {
+    if (existsSync(this.gzipPath)) {
       this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
-      await (0, import_promises.rm)(this.gzipPath);
+      rmSync(this.gzipPath);
     }
     if (!["string", "object", "undefined"].includes(typeof data)) {
       throw new TypeError(`invalid type at format '${format}': ${data}`);
@@ -346,7 +246,7 @@ var Updater = class {
     } : {
       name: "releaseAsarURL",
       url: this.option.releaseAsarURL,
-      repoFallback: `${this.option.repository}/releases/download/v${this.info?.version}/${import_electron3.app.name}-${this.info?.version}.asar.gz`,
+      repoFallback: `${this.option.repository}/releases/download/v${this.info?.version}/${app.name}-${this.info?.version}.asar.gz`,
       fn: this.option.overrideFunctions?.downloadBuffer ?? downloadBufferDefault
     };
     data ??= config.url;
@@ -426,13 +326,13 @@ var Updater = class {
       const buffer = await this.parseData("buffer", data);
       this.logger?.info("verify start");
       const _verify = this.option.overrideFunctions?.verifySignaure ?? verify;
-      const _ver = await _verify(buffer, _sig, this.option.SIGNATURE_CERT);
+      const _ver = await _verify(buffer, _sig, this.CERT);
       if (!_ver) {
-        throw new VerifyFailedError(_sig, this.option.SIGNATURE_CERT);
+        throw new VerifyFailedError(_sig, this.CERT);
       }
       this.logger?.info("verify success");
       this.logger?.info(`write to ${this.gzipPath}`);
-      await (0, import_promises.writeFile)(this.gzipPath, buffer);
+      writeFileSync(this.gzipPath, buffer);
       this.logger?.info(`extract to ${this.tmpFilePath}`);
       await unzipFile(this.gzipPath, this.tmpFilePath);
       this.logger?.info(`download success, version: ${_ver}`);
@@ -465,8 +365,9 @@ var defaultOnInstall = (install, _, __, logger) => {
   install();
   logger?.info(`update success!`);
 };
-function initApp(appOptions) {
+async function initApp(appOptions = {}) {
   const {
+    updater,
     electronDevDistPath = "../dist-electron",
     mainPath = "main/index.js",
     hooks
@@ -476,46 +377,34 @@ function initApp(appOptions) {
     beforeStart,
     onStartError
   } = hooks || {};
-  function handleError(err, logger) {
+  function handleError(err, logger2) {
     console.error(err);
-    onStartError?.(err, logger);
-    import_electron4.app.quit();
+    onStartError?.(err, logger2);
+    app2.quit();
   }
-  async function startup(updater) {
-    const logger = updater.logger;
-    try {
-      const appNameAsarPath = getPathFromAppNameAsar();
-      const tempAsarPath = `${appNameAsarPath}.tmp`;
-      if ((0, import_node_fs4.existsSync)(tempAsarPath)) {
-        logger?.info(`installing new asar: ${tempAsarPath}`);
-        await onInstall(() => (0, import_node_fs4.renameSync)(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
-      }
-      const mainDir = is.dev ? electronDevDistPath : appNameAsarPath;
-      const entry = (0, import_node_path2.resolve)(__dirname, mainDir, mainPath);
-      await beforeStart?.(entry, logger);
-      require(entry)(updater);
-    } catch (error) {
-      handleError(error, logger);
-    }
+  let updaterInstance;
+  if (typeof updater === "object" || !updater) {
+    updaterInstance = createUpdater(updater);
+  } else {
+    updaterInstance = await updater();
   }
-  let timer = setTimeout(() => {
-    handleError("start app timeout, please start app with `initApp(options).startupWithUpdater(options)`");
-  }, 3e3);
-  return {
-    async startupWithUpdater(updater) {
-      clearTimeout(timer);
-      if (typeof updater === "object") {
-        await startup(createUpdater(updater));
-      } else if (typeof updater === "function") {
-        await startup(await updater());
-      } else {
-        handleError("invalid updater option or updater is not a function");
-      }
+  const logger = updaterInstance.logger;
+  try {
+    const appNameAsarPath = getPathFromAppNameAsar();
+    const tempAsarPath = `${appNameAsarPath}.tmp`;
+    if (existsSync2(tempAsarPath)) {
+      logger?.info(`installing new asar: ${tempAsarPath}`);
+      await onInstall(() => renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
     }
-  };
+    const mainDir = is.dev ? electronDevDistPath : appNameAsarPath;
+    const entry = resolve(__dirname, mainDir, mainPath);
+    await beforeStart?.(entry, logger);
+    __require(entry)(updaterInstance);
+  } catch (error) {
+    handleError(error, logger);
+  }
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   DownloadError,
   MinimumVersionError,
   Updater,
@@ -523,4 +412,4 @@ function initApp(appOptions) {
   createUpdater,
   initApp,
   startupWithUpdater
-});
+};