electron-incremental-update 1.1.0 → 1.2.0

package/dist/chunk-RQCTJY4L.js

@@ -0,0 +1,236 @@
+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');
+});
+
+// src/utils/electron.ts
+import { existsSync, mkdirSync, readFileSync } from "node:fs";
+import { basename, dirname, join } from "node:path";
+import { release } from "node:os";
+import { app } from "electron";
+var is = {
+  dev: !app.isPackaged,
+  win: process.platform === "win32",
+  mac: process.platform === "darwin",
+  linux: process.platform === "linux"
+};
+function getPathFromAppNameAsar(...path) {
+  return is.dev ? "DEV.asar" : join(dirname(app.getAppPath()), `${app.name}.asar`, ...path);
+}
+function getVersions() {
+  const platform = is.win ? "Windows" : is.mac ? "MacOS" : process.platform.toUpperCase();
+  return {
+    appVersion: is.dev ? app.getVersion() : readFileSync(getPathFromAppNameAsar("version"), "utf-8"),
+    entryVersion: app.getVersion(),
+    electronVersion: process.versions.electron,
+    nodeVersion: process.versions.node,
+    systemVersion: `${platform} ${release()}`
+  };
+}
+function loadNativeModuleFromEntry(devEntryDirPath = "../../dist-entry", entryDirPath = join(app.getAppPath(), basename(devEntryDirPath))) {
+  const path = is.dev ? devEntryDirPath : entryDirPath;
+  return (moduleName) => {
+    try {
+      return __require(join(path, moduleName));
+    } catch (error) {
+      console.error("fail to load module", error);
+    }
+  };
+}
+function restartApp() {
+  app.relaunch();
+  app.quit();
+}
+function setAppUserModelId(id) {
+  app.setAppUserModelId(is.dev ? process.execPath : id ?? `org.${app.name}`);
+}
+function disableHWAccForWin7() {
+  if (release().startsWith("6.1")) {
+    app.disableHardwareAcceleration();
+  }
+}
+function singleInstance(window) {
+  const result = app.requestSingleInstanceLock();
+  result ? app.on("second-instance", () => {
+    if (window) {
+      window.show();
+      if (window.isMinimized()) {
+        window.restore();
+      }
+      window.focus();
+    }
+  }) : app.quit();
+  return result;
+}
+function setPortableAppDataPath(dirName = "data") {
+  const portablePath = join(dirname(app.getPath("exe")), dirName);
+  if (!existsSync(portablePath)) {
+    mkdirSync(portablePath);
+  }
+  app.setPath("appData", portablePath);
+}
+function waitAppReady(timeout = 1e3) {
+  return app.isReady() ? Promise.resolve() : new Promise((resolve, reject) => {
+    const _ = setTimeout(() => {
+      reject(new Error("app is not ready"));
+    }, timeout);
+    app.whenReady().then(() => {
+      clearTimeout(_);
+      resolve();
+    });
+  });
+}
+function getPaths(entryDirName = "dist-entry") {
+  const root = join(__dirname, "..");
+  const mainDirPath = join(root, "main");
+  const preloadDirPath = join(root, "preload");
+  const rendererDirPath = join(root, "renderer");
+  const devServerURL = process.env.VITE_DEV_SERVER_URL;
+  const indexHTMLPath = join(rendererDirPath, "index.html");
+  const publicDirPath = devServerURL ? join(root, "../public") : rendererDirPath;
+  return {
+    /**
+     * @example
+     * ```ts
+     * devServerURL && win.loadURL(devServerURL)
+     * ```
+     */
+    devServerURL,
+    /**
+     * @example
+     * ```ts
+     * win.loadFile(indexHTMLPath)
+     * ```
+     */
+    indexHTMLPath,
+    /**
+     * get path inside entry asar
+     * @param paths joined path
+     */
+    getPathFromEntryAsar(...paths) {
+      return join(app.getAppPath(), entryDirName, ...paths);
+    },
+    /**
+     * get path inside `${electron.app.name}.asar/main`
+     * @param paths joined path
+     */
+    getPathFromMain(...paths) {
+      return join(mainDirPath, ...paths);
+    },
+    /**
+     * get path inside `${electron.app.name}.asar/preload`
+     * @param paths joined path
+     */
+    getPathFromPreload(...paths) {
+      return join(preloadDirPath, ...paths);
+    },
+    /**
+     * get path inside public dir
+     * @param paths joined path
+     */
+    getPathFromPublic(...paths) {
+      return join(publicDirPath, ...paths);
+    }
+  };
+}
+
+// src/utils/zip.ts
+import { existsSync as existsSync2, readFileSync as readFileSync2, rmSync, writeFileSync } from "node:fs";
+import { brotliCompress, brotliDecompress } from "node:zlib";
+async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
+  if (!existsSync2(gzipPath)) {
+    throw new Error(`path to zipped file not exist: ${gzipPath}`);
+  }
+  const compressedBuffer = readFileSync2(gzipPath);
+  return new Promise((resolve, reject) => {
+    brotliDecompress(compressedBuffer, (err, buffer) => {
+      rmSync(gzipPath);
+      if (err) {
+        reject(err);
+      }
+      writeFileSync(targetFilePath, buffer);
+      resolve(null);
+    });
+  });
+}
+async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
+  if (!existsSync2(filePath)) {
+    throw new Error(`path to be zipped not exist: ${filePath}`);
+  }
+  const buffer = readFileSync2(filePath);
+  return new Promise((resolve, reject) => {
+    brotliCompress(buffer, (err, buffer2) => {
+      if (err) {
+        reject(err);
+      }
+      writeFileSync(targetFilePath, buffer2);
+      resolve(null);
+    });
+  });
+}
+
+// src/utils/pure.ts
+function parseGithubCdnURL(originRepoURL, cdnPrefix, relativeFilePath) {
+  if (!originRepoURL.startsWith("https://github.com/")) {
+    throw new Error("origin url must start with https://github.com/");
+  }
+  originRepoURL = originRepoURL.trim().replace(/\/?$/, "/").trim();
+  relativeFilePath = relativeFilePath.trim().replace(/^\/|\/?$/g, "").trim();
+  cdnPrefix = cdnPrefix.trim().replace(/^\/?|\/?$/g, "").trim();
+  return originRepoURL.replace("github.com", cdnPrefix) + relativeFilePath;
+}
+function handleUnexpectedErrors(callback) {
+  process.on("uncaughtException", callback);
+  process.on("unhandledRejection", callback);
+}
+function parseVersion(version) {
+  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-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);
+}
+
+export {
+  __require,
+  is,
+  getPathFromAppNameAsar,
+  getVersions,
+  loadNativeModuleFromEntry,
+  restartApp,
+  setAppUserModelId,
+  disableHWAccForWin7,
+  singleInstance,
+  setPortableAppDataPath,
+  waitAppReady,
+  getPaths,
+  unzipFile,
+  zipFile,
+  parseGithubCdnURL,
+  handleUnexpectedErrors,
+  parseVersion,
+  isUpdateJSON
+};

package/dist/index.cjs

@@ -35,7 +35,6 @@ var import_electron4 = require("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
@@ -87,7 +86,7 @@ async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
   }
   const compressedBuffer = (0, import_node_fs2.readFileSync)(gzipPath);
   return new Promise((resolve2, reject) => {
-    (0, import_node_zlib.gunzip)(compressedBuffer, (err, buffer) => {
+    (0, import_node_zlib.brotliDecompress)(compressedBuffer, (err, buffer) => {
       (0, import_node_fs2.rmSync)(gzipPath);
       if (err) {
         reject(err);
@@ -275,6 +274,7 @@ var compareVersionDefault = (version1, version2) => {
 
 // src/updater/core.ts
 var Updater = class {
+  CERT = __SIGNATURE_CERT__;
   info;
   option;
   asarPath;
@@ -306,8 +306,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`;
@@ -324,11 +327,11 @@ var Updater = class {
   async parseData(format, data) {
     if ((0, import_node_fs3.existsSync)(this.tmpFilePath)) {
       this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
-      await (0, import_promises.rm)(this.tmpFilePath);
+      (0, import_node_fs3.rmSync)(this.tmpFilePath);
     }
     if ((0, import_node_fs3.existsSync)(this.gzipPath)) {
       this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
-      await (0, import_promises.rm)(this.gzipPath);
+      (0, import_node_fs3.rmSync)(this.gzipPath);
     }
     if (!["string", "object", "undefined"].includes(typeof data)) {
       throw new TypeError(`invalid type at format '${format}': ${data}`);
@@ -434,13 +437,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);
+      (0, import_node_fs3.writeFileSync)(this.gzipPath, buffer);
       this.logger?.info(`extract to ${this.tmpFilePath}`);
       await unzipFile(this.gzipPath, this.tmpFilePath);
       this.logger?.info(`download success, version: ${_ver}`);
@@ -473,8 +476,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
@@ -484,43 +488,32 @@ function initApp(appOptions) {
     beforeStart,
     onStartError
   } = hooks || {};
-  function handleError(err, logger) {
+  function handleError(err, logger2) {
     console.error(err);
-    onStartError?.(err, logger);
+    onStartError?.(err, logger2);
     import_electron4.app.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 ((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)(updaterInstance);
+  } catch (error) {
+    handleError(error, logger);
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -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.d.ts

@@ -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 };