electron-incremental-update 2.0.0-beta.1 → 2.0.0-beta.10

package/dist/utils.cjs

@@ -1,177 +1,122 @@
-"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 key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+'use strict';
 
-// src/utils/index.ts
-var utils_exports = {};
-__export(utils_exports, {
-  decrypt: () => decrypt,
-  disableHWAccForWin7: () => disableHWAccForWin7,
-  encrypt: () => encrypt,
-  getAppVersion: () => getAppVersion,
-  getEntryVersion: () => getEntryVersion,
-  getPathFromAppNameAsar: () => getPathFromAppNameAsar,
-  getPathFromEntryAsar: () => getPathFromEntryAsar,
-  getPathFromPreload: () => getPathFromPreload,
-  getPathFromPublic: () => getPathFromPublic,
-  handleUnexpectedErrors: () => handleUnexpectedErrors,
-  hashString: () => hashString,
-  isDev: () => isDev,
-  isLinux: () => isLinux,
-  isLowerVersionDefault: () => isLowerVersionDefault,
-  isMac: () => isMac,
-  isUpdateJSON: () => isUpdateJSON,
-  isWin: () => isWin,
-  loadPage: () => loadPage,
-  parseVersion: () => parseVersion,
-  requireNative: () => requireNative,
-  restartApp: () => restartApp,
-  setAppUserModelId: () => setAppUserModelId,
-  setPortableAppDataPath: () => setPortableAppDataPath,
-  signature: () => signature,
-  singleInstance: () => singleInstance,
-  unzipFile: () => unzipFile,
-  verifySignatureDefault: () => verifySignatureDefault,
-  waitAppReady: () => waitAppReady,
-  zipFile: () => zipFile
-});
-module.exports = __toCommonJS(utils_exports);
+var fs = require('fs');
+var path = require('path');
+var electron = require('electron');
+var zlib = require('zlib');
+var crypto = require('crypto');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
-// src/utils/electron.ts
-var import_node_fs = require("fs");
-var import_node_path = require("path");
-var import_electron = require("electron");
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var path__default = /*#__PURE__*/_interopDefault(path);
+var zlib__default = /*#__PURE__*/_interopDefault(zlib);
+var crypto__default = /*#__PURE__*/_interopDefault(crypto);
+
+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__;
 var isWin = process.platform === "win32";
 var isMac = process.platform === "darwin";
 var isLinux = process.platform === "linux";
-function getPathFromAppNameAsar(...path) {
-  return isDev ? "DEV.asar" : (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${import_electron.app.name}.asar`, ...path);
+function getPathFromAppNameAsar(...paths) {
+  return isDev ? "DEV.asar" : path__default.default.join(path__default.default.dirname(electron.app.getAppPath()), `${electron.app.name}.asar`, ...paths);
 }
 function getAppVersion() {
-  return isDev ? getEntryVersion() : (0, import_node_fs.readFileSync)(getPathFromAppNameAsar("version"), "utf-8");
+  return isDev ? getEntryVersion() : fs__default.default.readFileSync(getPathFromAppNameAsar("version"), "utf-8");
 }
 function getEntryVersion() {
-  return import_electron.app.getVersion();
+  return electron.app.getVersion();
 }
 function requireNative(moduleName) {
-  return require((0, import_node_path.join)(import_electron.app.getAppPath(), __EIU_ENTRY_DIST_PATH__, moduleName));
+  return __require(path__default.default.join(electron.app.getAppPath(), __EIU_ENTRY_DIST_PATH__, moduleName));
 }
 function restartApp() {
-  import_electron.app.relaunch();
-  import_electron.app.quit();
+  electron.app.relaunch();
+  electron.app.quit();
 }
 function setAppUserModelId(id) {
-  isWin && import_electron.app.setAppUserModelId(id ?? `org.${import_electron.app.name}`);
+  if (isWin) {
+    electron.app.setAppUserModelId(id ?? `org.${electron.app.name}`);
+  }
 }
 function disableHWAccForWin7() {
-  if (require("os").release().startsWith("6.1")) {
-    import_electron.app.disableHardwareAcceleration();
+  if (__require("os").release().startsWith("6.1")) {
+    electron.app.disableHardwareAcceleration();
   }
 }
 function singleInstance(window) {
-  const result = import_electron.app.requestSingleInstanceLock();
-  result ? import_electron.app.on("second-instance", () => {
-    if (window) {
-      window.show();
-      if (window.isMinimized()) {
-        window.restore();
+  const result = electron.app.requestSingleInstanceLock();
+  if (result) {
+    electron.app.on("second-instance", () => {
+      if (window) {
+        window.show();
+        if (window.isMinimized()) {
+          window.restore();
+        }
+        window.focus();
       }
-      window.focus();
-    }
-  }) : import_electron.app.quit();
+    });
+  } else {
+    electron.app.quit();
+  }
   return result;
 }
 function setPortableAppDataPath(dirName = "data") {
-  const portablePath = (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getPath("exe")), dirName);
-  if (!(0, import_node_fs.existsSync)(portablePath)) {
-    (0, import_node_fs.mkdirSync)(portablePath);
+  const portablePath = path__default.default.join(path__default.default.dirname(electron.app.getPath("exe")), dirName);
+  if (!fs__default.default.existsSync(portablePath)) {
+    fs__default.default.mkdirSync(portablePath);
   }
-  import_electron.app.setPath("appData", portablePath);
-}
-function waitAppReady(timeout = 1e3) {
-  return import_electron.app.isReady() ? Promise.resolve() : new Promise((resolve, reject) => {
-    const _ = setTimeout(() => {
-      reject(new Error("app is not ready"));
-    }, timeout);
-    import_electron.app.whenReady().then(() => {
-      clearTimeout(_);
-      resolve();
-    });
-  });
+  electron.app.setPath("appData", portablePath);
 }
 function loadPage(win, htmlFilePath = "index.html") {
-  isDev ? win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath) : win.loadFile(getPathFromAppNameAsar("renderer", htmlFilePath));
+  if (isDev) {
+    win.loadURL(process.env.VITE_DEV_SERVER_URL + htmlFilePath);
+  } else {
+    win.loadFile(getPathFromAppNameAsar("renderer", htmlFilePath));
+  }
 }
 function getPathFromPreload(...paths) {
-  return isDev ? (0, import_node_path.join)(import_electron.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "preload", ...paths) : getPathFromAppNameAsar("preload", ...paths);
+  return isDev ? path__default.default.join(electron.app.getAppPath(), __EIU_ELECTRON_DIST_PATH__, "preload", ...paths) : getPathFromAppNameAsar("preload", ...paths);
 }
 function getPathFromPublic(...paths) {
-  return isDev ? (0, import_node_path.join)(import_electron.app.getAppPath(), "public", ...paths) : getPathFromAppNameAsar("renderer", ...paths);
+  return isDev ? path__default.default.join(electron.app.getAppPath(), "public", ...paths) : getPathFromAppNameAsar("renderer", ...paths);
 }
 function getPathFromEntryAsar(...paths) {
-  return (0, import_node_path.join)(import_electron.app.getAppPath(), __EIU_ENTRY_DIST_PATH__, ...paths);
+  return path__default.default.join(electron.app.getAppPath(), __EIU_ENTRY_DIST_PATH__, ...paths);
 }
-
-// src/utils/zip.ts
-var import_node_fs2 = require("fs");
-var import_node_zlib = require("zlib");
-async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
-  if (!(0, import_node_fs2.existsSync)(filePath)) {
-    throw new Error(`path to be zipped not exist: ${filePath}`);
-  }
-  const buffer = (0, import_node_fs2.readFileSync)(filePath);
+function handleUnexpectedErrors(callback) {
+  process.on("uncaughtException", callback);
+  process.on("unhandledRejection", callback);
+}
+async function defaultZipFile(buffer) {
   return new Promise((resolve, reject) => {
-    (0, import_node_zlib.brotliCompress)(buffer, (err, buffer2) => {
+    zlib__default.default.brotliCompress(buffer, (err, buffer2) => {
       if (err) {
         reject(err);
+      } else {
+        resolve(buffer2);
       }
-      (0, import_node_fs2.writeFileSync)(targetFilePath, buffer2);
-      resolve(null);
     });
   });
 }
-
-// src/utils/unzip.ts
-var import_node_fs3 = require("fs");
-var import_node_zlib2 = require("zlib");
-async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
-  if (!(0, import_node_fs3.existsSync)(gzipPath)) {
-    throw new Error(`path to zipped file not exist: ${gzipPath}`);
-  }
-  const compressedBuffer = (0, import_node_fs3.readFileSync)(gzipPath);
+async function defaultUnzipFile(buffer) {
   return new Promise((resolve, reject) => {
-    (0, import_node_zlib2.brotliDecompress)(compressedBuffer, (err, buffer) => {
-      (0, import_node_fs3.rmSync)(gzipPath);
+    zlib__default.default.brotliDecompress(buffer, (err, buffer2) => {
       if (err) {
         reject(err);
+      } else {
+        resolve(buffer2);
       }
-      (0, import_node_fs3.writeFileSync)(targetFilePath, buffer);
-      resolve(null);
     });
   });
 }
 
 // src/utils/version.ts
-function handleUnexpectedErrors(callback) {
-  process.on("uncaughtException", callback);
-  process.on("unhandledRejection", callback);
-}
 function parseVersion(version) {
   const match = /^(\d+)\.(\d+)\.(\d+)(?:-([a-z0-9.-]+))?/i.exec(version);
   if (!match) {
@@ -195,7 +140,7 @@ function parseVersion(version) {
   }
   return ret;
 }
-function isLowerVersionDefault(oldVer, newVer) {
+function defaultIsLowerVersion(oldVer, newVer) {
   const oldV = parseVersion(oldVer);
   const newV = parseVersion(newVer);
   function compareStrings(str1, str2) {
@@ -216,78 +161,76 @@ function isLowerVersionDefault(oldVer, newVer) {
   return false;
 }
 function isUpdateJSON(json) {
-  const is = (j) => !!(j && j.minimumVersion && j.signature && j.size && j.version);
+  const is = (j) => !!(j && j.minimumVersion && j.signature && j.version);
   return is(json) && is(json?.beta);
 }
-
-// src/utils/crypto/decrypt.ts
-var import_node_crypto2 = require("crypto");
-
-// src/utils/crypto/utils.ts
-var import_node_crypto = require("crypto");
-function hashString(data, length) {
-  const hash = (0, import_node_crypto.createHash)("SHA256").update(data).digest("binary");
+function defaultVersionJsonGenerator(existingJson, signature, version, minimumVersion) {
+  existingJson.beta = {
+    version,
+    minimumVersion,
+    signature
+  };
+  if (!parseVersion(version).stage) {
+    existingJson.version = version;
+    existingJson.minimumVersion = minimumVersion;
+    existingJson.signature = signature;
+  }
+  return existingJson;
+}
+function hashBuffer(data, length) {
+  const hash = crypto__default.default.createHash("SHA256").update(data).digest("binary");
   return Buffer.from(hash).subarray(0, length);
 }
-
-// src/utils/crypto/decrypt.ts
-function decrypt(encryptedText, key, iv) {
-  const decipher = (0, import_node_crypto2.createDecipheriv)("aes-256-cbc", key, iv);
-  let decrypted = decipher.update(encryptedText, "base64url", "utf8");
-  decrypted += decipher.final("utf8");
-  return decrypted;
+function aesEncrypt(plainText, key, iv) {
+  const cipher = crypto__default.default.createCipheriv("aes-256-cbc", key, iv);
+  return cipher.update(plainText, "utf8", "base64url") + cipher.final("base64url");
+}
+function defaultSignature(buffer, privateKey, cert, version) {
+  const sig = crypto__default.default.createSign("RSA-SHA256").update(buffer).sign(crypto__default.default.createPrivateKey(privateKey), "base64");
+  return aesEncrypt(`${sig}%${version}`, hashBuffer(cert, 32), hashBuffer(buffer, 16));
+}
+function aesDecrypt(encryptedText, key, iv) {
+  const decipher = crypto__default.default.createDecipheriv("aes-256-cbc", key, iv);
+  return decipher.update(encryptedText, "base64url", "utf8") + decipher.final("utf8");
 }
-function verifySignatureDefault(buffer, signature2, cert) {
+function defaultVerifySignature(buffer, version, signature, cert) {
   try {
-    const [sig, version] = decrypt(signature2, hashString(cert, 32), hashString(buffer, 16)).split("%");
-    const result = (0, import_node_crypto2.createVerify)("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : void 0;
-  } catch (error) {
-    return void 0;
+    const [sig, ver] = aesDecrypt(signature, hashBuffer(cert, 32), hashBuffer(buffer, 16)).split("%");
+    if (ver !== version) {
+      return false;
+    }
+    return crypto__default.default.createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
+  } catch {
+    return false;
   }
 }
 
-// src/utils/crypto/encrypt.ts
-var import_node_crypto3 = require("crypto");
-function encrypt(plainText, key, iv) {
-  const cipher = (0, import_node_crypto3.createCipheriv)("aes-256-cbc", key, iv);
-  let encrypted = cipher.update(plainText, "utf8", "base64url");
-  encrypted += cipher.final("base64url");
-  return encrypted;
-}
-function signature(buffer, privateKey, cert, version) {
-  const sig = (0, import_node_crypto3.createSign)("RSA-SHA256").update(buffer).sign((0, import_node_crypto3.createPrivateKey)(privateKey), "base64");
-  return encrypt(`${sig}%${version}`, hashString(cert, 32), hashString(buffer, 16));
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  decrypt,
-  disableHWAccForWin7,
-  encrypt,
-  getAppVersion,
-  getEntryVersion,
-  getPathFromAppNameAsar,
-  getPathFromEntryAsar,
-  getPathFromPreload,
-  getPathFromPublic,
-  handleUnexpectedErrors,
-  hashString,
-  isDev,
-  isLinux,
-  isLowerVersionDefault,
-  isMac,
-  isUpdateJSON,
-  isWin,
-  loadPage,
-  parseVersion,
-  requireNative,
-  restartApp,
-  setAppUserModelId,
-  setPortableAppDataPath,
-  signature,
-  singleInstance,
-  unzipFile,
-  verifySignatureDefault,
-  waitAppReady,
-  zipFile
-});
+exports.aesDecrypt = aesDecrypt;
+exports.aesEncrypt = aesEncrypt;
+exports.defaultIsLowerVersion = defaultIsLowerVersion;
+exports.defaultSignature = defaultSignature;
+exports.defaultUnzipFile = defaultUnzipFile;
+exports.defaultVerifySignature = defaultVerifySignature;
+exports.defaultVersionJsonGenerator = defaultVersionJsonGenerator;
+exports.defaultZipFile = defaultZipFile;
+exports.disableHWAccForWin7 = disableHWAccForWin7;
+exports.getAppVersion = getAppVersion;
+exports.getEntryVersion = getEntryVersion;
+exports.getPathFromAppNameAsar = getPathFromAppNameAsar;
+exports.getPathFromEntryAsar = getPathFromEntryAsar;
+exports.getPathFromPreload = getPathFromPreload;
+exports.getPathFromPublic = getPathFromPublic;
+exports.handleUnexpectedErrors = handleUnexpectedErrors;
+exports.hashBuffer = hashBuffer;
+exports.isDev = isDev;
+exports.isLinux = isLinux;
+exports.isMac = isMac;
+exports.isUpdateJSON = isUpdateJSON;
+exports.isWin = isWin;
+exports.loadPage = loadPage;
+exports.parseVersion = parseVersion;
+exports.requireNative = requireNative;
+exports.restartApp = restartApp;
+exports.setAppUserModelId = setAppUserModelId;
+exports.setPortableAppDataPath = setPortableAppDataPath;
+exports.singleInstance = singleInstance;

package/dist/utils.d.cts

@@ -1,31 +1,33 @@
 import { BrowserWindow } from 'electron';
-export { a as UpdateInfo, U as UpdateJSON, V as Version, h as handleUnexpectedErrors, i as isLowerVersionDefault, b as isUpdateJSON, p as parseVersion } from './version-CffZWDhZ.cjs';
-export { d as decrypt, v as verifySignatureDefault } from './decrypt-BNBcodiO.cjs';
+export { e as aesDecrypt, b as aesEncrypt, c as defaultSignature, a as defaultUnzipFile, f as defaultVerifySignature, d as defaultZipFile, h as hashBuffer } from './zip-rm9ED9nU.cjs';
+export { U as UpdateInfo, a as UpdateJSON, V as Version, d as defaultIsLowerVersion, b as defaultVersionJsonGenerator, i as isUpdateJSON, p as parseVersion } from './version-C4tF_trh.cjs';
 
 /**
- * compile time dev check
+ * Compile time dev check
  */
 declare const isDev: boolean;
 declare const isWin: boolean;
 declare const isMac: boolean;
 declare const isLinux: boolean;
 /**
- * get the absolute path of `${electron.app.name}.asar` (not `app.asar`)
+ * Get the absolute path of `${electron.app.name}.asar` (not `app.asar`)
  *
- * if is in dev, **always** return `'DEV.asar'`
+ * If is in dev, **always** return `'DEV.asar'`
  */
-declare function getPathFromAppNameAsar(...path: string[]): string;
+declare function getPathFromAppNameAsar(...paths: string[]): string;
 /**
- * get app version, if is in dev, return `getEntryVersion()`
+ * Get app version, if is in dev, return `getEntryVersion()`
  */
 declare function getAppVersion(): string;
 /**
- * get entry version
+ * Get entry version
  */
 declare function getEntryVersion(): string;
 /**
- * use `require` to load native module from entry
+ * Use `require` to load native module from entry asar
  * @param moduleName file name in entry
+ * @example
+ * requireNative<typeof import('../native/db')>('db')
  */
 declare function requireNative<T = any>(moduleName: string): T;
 /**
@@ -33,49 +35,52 @@ declare function requireNative<T = any>(moduleName: string): T;
  */
 declare function restartApp(): void;
 /**
- * fix app use model id, only for Windows
+ * Fix app use model id, only for Windows
  * @param id app id, default is `org.${electron.app.name}`
  */
 declare function setAppUserModelId(id?: string): void;
 /**
- * disable hardware acceleration for Windows 7
+ * Disable hardware acceleration for Windows 7
  */
 declare function disableHWAccForWin7(): void;
 /**
- * keep single electron instance and auto restore window on `second-instance` event
+ * Keep single electron instance and auto restore window on `second-instance` event
  * @param window brwoser window to show
  * @returns `false` if the app is running
  */
 declare function singleInstance(window?: BrowserWindow): boolean;
 /**
- * set `AppData` dir to the dir of .exe file
+ * Set `AppData` dir to the dir of .exe file
  *
- * useful for portable Windows app
+ * Useful for portable Windows app
  * @param dirName dir name, default to `data`
  */
 declare function setPortableAppDataPath(dirName?: string): void;
 /**
- * ensure app is ready.
- * @param timeout wait timeout, @default 1000
- */
-declare function waitAppReady(timeout?: number): Promise<void>;
-/**
- * load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
+ * Load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
  * @param win window
  * @param htmlFilePath html file path, default is `index.html`
  */
 declare function loadPage(win: BrowserWindow, htmlFilePath?: string): void;
+/**
+ * Get joined path from preload dir
+ * @param paths rest paths
+ */
 declare function getPathFromPreload(...paths: string[]): string;
+/**
+ * Get joined path from publich dir
+ * @param paths rest paths
+ */
 declare function getPathFromPublic(...paths: string[]): string;
+/**
+ * Get joined path from entry asar
+ * @param paths rest paths
+ */
 declare function getPathFromEntryAsar(...paths: string[]): string;
+/**
+ * Handle all unhandled error
+ * @param callback callback function
+ */
+declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
 
-declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
-
-declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
-
-declare function encrypt(plainText: string, key: Buffer, iv: Buffer): string;
-declare function signature(buffer: Buffer, privateKey: string, cert: string, version: string): string;
-
-declare function hashString(data: string | Buffer, length: number): Buffer;
-
-export { disableHWAccForWin7, encrypt, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, hashString, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, signature, singleInstance, unzipFile, waitAppReady, zipFile };
+export { disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };

package/dist/utils.d.ts

@@ -1,31 +1,33 @@
 import { BrowserWindow } from 'electron';
-export { a as UpdateInfo, U as UpdateJSON, V as Version, h as handleUnexpectedErrors, i as isLowerVersionDefault, b as isUpdateJSON, p as parseVersion } from './version-CffZWDhZ.js';
-export { d as decrypt, v as verifySignatureDefault } from './decrypt-BNBcodiO.js';
+export { e as aesDecrypt, b as aesEncrypt, c as defaultSignature, a as defaultUnzipFile, f as defaultVerifySignature, d as defaultZipFile, h as hashBuffer } from './zip-rm9ED9nU.js';
+export { U as UpdateInfo, a as UpdateJSON, V as Version, d as defaultIsLowerVersion, b as defaultVersionJsonGenerator, i as isUpdateJSON, p as parseVersion } from './version-C4tF_trh.js';
 
 /**
- * compile time dev check
+ * Compile time dev check
  */
 declare const isDev: boolean;
 declare const isWin: boolean;
 declare const isMac: boolean;
 declare const isLinux: boolean;
 /**
- * get the absolute path of `${electron.app.name}.asar` (not `app.asar`)
+ * Get the absolute path of `${electron.app.name}.asar` (not `app.asar`)
  *
- * if is in dev, **always** return `'DEV.asar'`
+ * If is in dev, **always** return `'DEV.asar'`
  */
-declare function getPathFromAppNameAsar(...path: string[]): string;
+declare function getPathFromAppNameAsar(...paths: string[]): string;
 /**
- * get app version, if is in dev, return `getEntryVersion()`
+ * Get app version, if is in dev, return `getEntryVersion()`
  */
 declare function getAppVersion(): string;
 /**
- * get entry version
+ * Get entry version
  */
 declare function getEntryVersion(): string;
 /**
- * use `require` to load native module from entry
+ * Use `require` to load native module from entry asar
  * @param moduleName file name in entry
+ * @example
+ * requireNative<typeof import('../native/db')>('db')
  */
 declare function requireNative<T = any>(moduleName: string): T;
 /**
@@ -33,49 +35,52 @@ declare function requireNative<T = any>(moduleName: string): T;
  */
 declare function restartApp(): void;
 /**
- * fix app use model id, only for Windows
+ * Fix app use model id, only for Windows
  * @param id app id, default is `org.${electron.app.name}`
  */
 declare function setAppUserModelId(id?: string): void;
 /**
- * disable hardware acceleration for Windows 7
+ * Disable hardware acceleration for Windows 7
  */
 declare function disableHWAccForWin7(): void;
 /**
- * keep single electron instance and auto restore window on `second-instance` event
+ * Keep single electron instance and auto restore window on `second-instance` event
  * @param window brwoser window to show
  * @returns `false` if the app is running
  */
 declare function singleInstance(window?: BrowserWindow): boolean;
 /**
- * set `AppData` dir to the dir of .exe file
+ * Set `AppData` dir to the dir of .exe file
  *
- * useful for portable Windows app
+ * Useful for portable Windows app
  * @param dirName dir name, default to `data`
  */
 declare function setPortableAppDataPath(dirName?: string): void;
 /**
- * ensure app is ready.
- * @param timeout wait timeout, @default 1000
- */
-declare function waitAppReady(timeout?: number): Promise<void>;
-/**
- * load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
+ * Load `process.env.VITE_DEV_SERVER_URL` when dev, else load html file
  * @param win window
  * @param htmlFilePath html file path, default is `index.html`
  */
 declare function loadPage(win: BrowserWindow, htmlFilePath?: string): void;
+/**
+ * Get joined path from preload dir
+ * @param paths rest paths
+ */
 declare function getPathFromPreload(...paths: string[]): string;
+/**
+ * Get joined path from publich dir
+ * @param paths rest paths
+ */
 declare function getPathFromPublic(...paths: string[]): string;
+/**
+ * Get joined path from entry asar
+ * @param paths rest paths
+ */
 declare function getPathFromEntryAsar(...paths: string[]): string;
+/**
+ * Handle all unhandled error
+ * @param callback callback function
+ */
+declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
 
-declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
-
-declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
-
-declare function encrypt(plainText: string, key: Buffer, iv: Buffer): string;
-declare function signature(buffer: Buffer, privateKey: string, cert: string, version: string): string;
-
-declare function hashString(data: string | Buffer, length: number): Buffer;
-
-export { disableHWAccForWin7, encrypt, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, hashString, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, signature, singleInstance, unzipFile, waitAppReady, zipFile };
+export { disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };