electron-incremental-update 0.9.1 → 1.0.0

package/dist/utils.d.mts

@@ -1,4 +1,6 @@
-declare const DEFAULT_APP_NAME = "product";
+import { BrowserWindow } from 'electron';
+export { U as UpdateInfo, a as UpdateJSON, V as Version, h as handleUnexpectedErrors, i as isUpdateJSON, p as parseGithubCdnURL, b as parseVersion } from './noDep-TvZoKVF8.mjs';
+
 type Is = {
     dev: boolean;
     win: boolean;
@@ -9,83 +11,118 @@ type Is = {
  * get app info
  */
 declare const is: Is;
-declare function getLocale(): string | undefined;
 /**
- * get the application asar absolute path (not `app.asar`),
+ * get the absolute path of `${app.name}.asar` (not `app.asar`)
+ *
  * if is in dev, return `'DEV.asar'`
- * @param name The name of the application
+ * @todo change a better function name or merge into {@link getPaths}
  */
-declare function getProductAsarPath(name?: string): string;
+declare function getPathFromAppNameAsar(...path: string[]): string;
 /**
- * get the version of Electron runtime
+ * get versions of App, Entry, Electron, Node and System
+ *
+ * App version is read from `version` file in `${app.name}.asar`
+ *
+ * Entry version is read from `package.json`
+ *
+ * SystemVersion: `${platform} ${os.release()}`
  */
-declare function getElectronVersion(): string;
+declare function getVersions(): {
+    appVersion: string;
+    entryVersion: string;
+    electronVersion: string;
+    nodeVersion: string;
+    systemVersion: string;
+};
 /**
- * get the version of application (name.asar)
- *
- * if is dev, return {@link getElectronVersion}
- * @param name - The name of the application
+ * load native module from entry
+ * @param moduleName file name in entry
  */
-declare function getAppVersion(name?: string): string;
-declare class NoSuchNativeModuleError extends Error {
-    moduleName: string;
-    constructor(moduleName: string);
-}
-declare function isNoSuchNativeModuleError(e: unknown): e is NoSuchNativeModuleError;
+type RequireNative = <T = any>(moduleName: string) => T;
 /**
- * require native package, if not found, return {@link NoSuchNativeModuleError}
- * @param packageName native package name
+ * load module from entry, **only for main and preload**
+ * @remark use `require`, only support **CommonJS**
+ * @param devEntryDirPath entry directory path when dev, default `../../dist-entry`
+ * @param entryDirPath entry directory path when not dev, default `join(app.getAppPath(), basename(devEntryDirPath))`
+ * @example
+ * const requireNative = loadNativeModuleFromEntry()
+ * const db = requireNative<typeof import('../native/db')>('db')
+ * db.test()
  */
-declare function requireNative<T = any>(packageName: string): T | NoSuchNativeModuleError;
+declare function loadNativeModuleFromEntry(devEntryDirPath?: string, entryDirPath?: string): RequireNative;
 /**
  * Restarts the Electron app.
  */
 declare function restartApp(): void;
 /**
  * fix app use model id, only for Windows
- * @param id app id
+ * @param id app id @default `org.${app.name}`
  */
-declare function setAppUserModelId(id: string): void;
+declare function setAppUserModelId(id?: string): void;
 /**
  * disable hardware acceleration for Windows 7
  */
 declare function disableHWAccForWin7(): void;
 /**
- * keep single electron instance
+ * 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(): void;
+declare function singleInstance(window?: BrowserWindow): boolean;
 /**
- * set AppData dir for portable Windows app
+ * set `AppData` dir to the dir of .exe file
+ *
+ * useful for portable Windows app
+ * @param dirName dir name, default to `data`
  */
-declare function setPortableAppDataPath(dirName?: string, create?: boolean): void;
+declare function setPortableAppDataPath(dirName?: string): void;
 /**
  * ensure app is ready.
  * @param timeout wait timeout, @default 1000
  */
 declare function waitAppReady(timeout?: number): Promise<void>;
-
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
+/**
+ * get paths, **only for main and preload**
+ * @param entryDirName entry dir name, default to `dist-entry`
+ */
+declare function getPaths(entryDirName?: string): {
+    /**
+     * @example
+     * ```ts
+     * devServerURL && win.loadURL(devServerURL)
+     * ```
+     */
+    devServerURL: string | undefined;
+    /**
+     * @example
+     * ```ts
+     * win.loadFile(indexHTMLPath)
+     * ```
+     */
+    indexHTMLPath: string;
+    /**
+     * get path inside entry asar
+     * @param paths joined path
+     */
+    getPathFromEntryAsar(...paths: string[]): string;
+    /**
+     * get path inside `${app.name}.asar/main`
+     * @param paths joined path
+     */
+    getPathFromMain(...paths: string[]): string;
+    /**
+     * get path inside `${app.name}.asar/preload`
+     * @param paths joined path
+     */
+    getPathFromPreload(...paths: string[]): string;
+    /**
+     * get path inside public dir
+     * @param paths joined path
+     */
+    getPathFromPublic(...paths: string[]): string;
+};
 
 declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
 declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
 
-/**
- * parse Github CDN URL for accelerating the speed of downloading
- *
- * {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 some public CDN links}
- */
-declare function parseGithubCdnURL(originRepoURL: string, cdnPrefix: string, relativeFilePath: string): string;
-/**
- * handle all unhandled error
- * @param callback callback function
- */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
-
-export { DEFAULT_APP_NAME, NoSuchNativeModuleError, type Version, disableHWAccForWin7, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, is, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance, unzipFile, waitAppReady, zipFile };
+export { disableHWAccForWin7, getPathFromAppNameAsar, getPaths, getVersions, is, loadNativeModuleFromEntry, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance, unzipFile, waitAppReady, zipFile };

package/dist/utils.d.ts

@@ -1,4 +1,6 @@
-declare const DEFAULT_APP_NAME = "product";
+import { BrowserWindow } from 'electron';
+export { U as UpdateInfo, a as UpdateJSON, V as Version, h as handleUnexpectedErrors, i as isUpdateJSON, p as parseGithubCdnURL, b as parseVersion } from './noDep-TvZoKVF8.js';
+
 type Is = {
     dev: boolean;
     win: boolean;
@@ -9,83 +11,118 @@ type Is = {
  * get app info
  */
 declare const is: Is;
-declare function getLocale(): string | undefined;
 /**
- * get the application asar absolute path (not `app.asar`),
+ * get the absolute path of `${app.name}.asar` (not `app.asar`)
+ *
  * if is in dev, return `'DEV.asar'`
- * @param name The name of the application
+ * @todo change a better function name or merge into {@link getPaths}
  */
-declare function getProductAsarPath(name?: string): string;
+declare function getPathFromAppNameAsar(...path: string[]): string;
 /**
- * get the version of Electron runtime
+ * get versions of App, Entry, Electron, Node and System
+ *
+ * App version is read from `version` file in `${app.name}.asar`
+ *
+ * Entry version is read from `package.json`
+ *
+ * SystemVersion: `${platform} ${os.release()}`
  */
-declare function getElectronVersion(): string;
+declare function getVersions(): {
+    appVersion: string;
+    entryVersion: string;
+    electronVersion: string;
+    nodeVersion: string;
+    systemVersion: string;
+};
 /**
- * get the version of application (name.asar)
- *
- * if is dev, return {@link getElectronVersion}
- * @param name - The name of the application
+ * load native module from entry
+ * @param moduleName file name in entry
  */
-declare function getAppVersion(name?: string): string;
-declare class NoSuchNativeModuleError extends Error {
-    moduleName: string;
-    constructor(moduleName: string);
-}
-declare function isNoSuchNativeModuleError(e: unknown): e is NoSuchNativeModuleError;
+type RequireNative = <T = any>(moduleName: string) => T;
 /**
- * require native package, if not found, return {@link NoSuchNativeModuleError}
- * @param packageName native package name
+ * load module from entry, **only for main and preload**
+ * @remark use `require`, only support **CommonJS**
+ * @param devEntryDirPath entry directory path when dev, default `../../dist-entry`
+ * @param entryDirPath entry directory path when not dev, default `join(app.getAppPath(), basename(devEntryDirPath))`
+ * @example
+ * const requireNative = loadNativeModuleFromEntry()
+ * const db = requireNative<typeof import('../native/db')>('db')
+ * db.test()
  */
-declare function requireNative<T = any>(packageName: string): T | NoSuchNativeModuleError;
+declare function loadNativeModuleFromEntry(devEntryDirPath?: string, entryDirPath?: string): RequireNative;
 /**
  * Restarts the Electron app.
  */
 declare function restartApp(): void;
 /**
  * fix app use model id, only for Windows
- * @param id app id
+ * @param id app id @default `org.${app.name}`
  */
-declare function setAppUserModelId(id: string): void;
+declare function setAppUserModelId(id?: string): void;
 /**
  * disable hardware acceleration for Windows 7
  */
 declare function disableHWAccForWin7(): void;
 /**
- * keep single electron instance
+ * 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(): void;
+declare function singleInstance(window?: BrowserWindow): boolean;
 /**
- * set AppData dir for portable Windows app
+ * set `AppData` dir to the dir of .exe file
+ *
+ * useful for portable Windows app
+ * @param dirName dir name, default to `data`
  */
-declare function setPortableAppDataPath(dirName?: string, create?: boolean): void;
+declare function setPortableAppDataPath(dirName?: string): void;
 /**
  * ensure app is ready.
  * @param timeout wait timeout, @default 1000
  */
 declare function waitAppReady(timeout?: number): Promise<void>;
-
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
+/**
+ * get paths, **only for main and preload**
+ * @param entryDirName entry dir name, default to `dist-entry`
+ */
+declare function getPaths(entryDirName?: string): {
+    /**
+     * @example
+     * ```ts
+     * devServerURL && win.loadURL(devServerURL)
+     * ```
+     */
+    devServerURL: string | undefined;
+    /**
+     * @example
+     * ```ts
+     * win.loadFile(indexHTMLPath)
+     * ```
+     */
+    indexHTMLPath: string;
+    /**
+     * get path inside entry asar
+     * @param paths joined path
+     */
+    getPathFromEntryAsar(...paths: string[]): string;
+    /**
+     * get path inside `${app.name}.asar/main`
+     * @param paths joined path
+     */
+    getPathFromMain(...paths: string[]): string;
+    /**
+     * get path inside `${app.name}.asar/preload`
+     * @param paths joined path
+     */
+    getPathFromPreload(...paths: string[]): string;
+    /**
+     * get path inside public dir
+     * @param paths joined path
+     */
+    getPathFromPublic(...paths: string[]): string;
+};
 
 declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
 declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
 
-/**
- * parse Github CDN URL for accelerating the speed of downloading
- *
- * {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 some public CDN links}
- */
-declare function parseGithubCdnURL(originRepoURL: string, cdnPrefix: string, relativeFilePath: string): string;
-/**
- * handle all unhandled error
- * @param callback callback function
- */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
-
-export { DEFAULT_APP_NAME, NoSuchNativeModuleError, type Version, disableHWAccForWin7, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, is, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance, unzipFile, waitAppReady, zipFile };
+export { disableHWAccForWin7, getPathFromAppNameAsar, getPaths, getVersions, is, loadNativeModuleFromEntry, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance, unzipFile, waitAppReady, zipFile };

package/dist/utils.js

@@ -20,19 +20,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/utils/index.ts
 var utils_exports = {};
 __export(utils_exports, {
-  DEFAULT_APP_NAME: () => DEFAULT_APP_NAME,
-  NoSuchNativeModuleError: () => NoSuchNativeModuleError,
   disableHWAccForWin7: () => disableHWAccForWin7,
-  getAppVersion: () => getAppVersion,
-  getElectronVersion: () => getElectronVersion,
-  getLocale: () => getLocale,
-  getProductAsarPath: () => getProductAsarPath,
+  getPathFromAppNameAsar: () => getPathFromAppNameAsar,
+  getPaths: () => getPaths,
+  getVersions: () => getVersions,
   handleUnexpectedErrors: () => handleUnexpectedErrors,
   is: () => is,
-  isNoSuchNativeModuleError: () => isNoSuchNativeModuleError,
+  isUpdateJSON: () => isUpdateJSON,
+  loadNativeModuleFromEntry: () => loadNativeModuleFromEntry,
   parseGithubCdnURL: () => parseGithubCdnURL,
   parseVersion: () => parseVersion,
-  requireNative: () => requireNative,
   restartApp: () => restartApp,
   setAppUserModelId: () => setAppUserModelId,
   setPortableAppDataPath: () => setPortableAppDataPath,
@@ -43,79 +40,71 @@ __export(utils_exports, {
 });
 module.exports = __toCommonJS(utils_exports);
 
-// src/utils/core.ts
+// 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 DEFAULT_APP_NAME = "product";
 var is = {
   dev: !import_electron.app.isPackaged,
   win: process.platform === "win32",
   mac: process.platform === "darwin",
   linux: process.platform === "linux"
 };
-function getLocale() {
-  return import_electron.app.isReady() ? import_electron.app.getLocale() : void 0;
+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 getProductAsarPath(name = DEFAULT_APP_NAME) {
-  return !import_electron.app.isPackaged ? (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getAppPath()), `${name}.asar`) : "DEV.asar";
-}
-function getElectronVersion() {
-  return import_electron.app.getVersion();
-}
-function getAppVersion(name = DEFAULT_APP_NAME) {
-  return import_electron.app.isPackaged ? (0, import_node_fs.readFileSync)((0, import_node_path.join)(getProductAsarPath(name), "version"), "utf-8") : getElectronVersion();
+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)()}`
+  };
 }
-var NoSuchNativeModuleError = class extends Error {
-  moduleName;
-  constructor(moduleName) {
-    super(`no such native module: ${moduleName}`);
-    this.moduleName = moduleName;
-  }
-};
-function isNoSuchNativeModuleError(e) {
-  return e instanceof NoSuchNativeModuleError;
-}
-function requireNative(packageName) {
-  const path = import_electron.app.isPackaged ? (0, import_node_path.join)(import_electron.app.getAppPath(), "node_modules", packageName) : packageName;
-  try {
-    return require(path);
-  } catch (error) {
-    return new NoSuchNativeModuleError(packageName);
-  }
+function loadNativeModuleFromEntry(devEntryDirPath = "../../dist-entry", entryDirPath = (0, import_node_path.join)(import_electron.app.getAppPath(), (0, import_node_path.basename)(devEntryDirPath))) {
+  const path = is.dev ? devEntryDirPath : entryDirPath;
+  return (moduleName) => {
+    try {
+      return require((0, import_node_path.join)(path, moduleName));
+    } catch (error) {
+      console.error("fail to load module", error);
+    }
+  };
 }
 function restartApp() {
   import_electron.app.relaunch();
   import_electron.app.quit();
 }
 function setAppUserModelId(id) {
-  is.win && import_electron.app.setAppUserModelId(is.dev ? process.execPath : id);
+  import_electron.app.setAppUserModelId(is.dev ? process.execPath : id ?? `org.${import_electron.app.name}`);
 }
 function disableHWAccForWin7() {
   if ((0, import_node_os.release)().startsWith("6.1")) {
     import_electron.app.disableHardwareAcceleration();
   }
 }
-function singleInstance() {
-  if (!import_electron.app.requestSingleInstanceLock()) {
-    import_electron.app.quit();
-    process.exit(0);
-  }
+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();
+      }
+      window.focus();
+    }
+  }) : import_electron.app.quit();
+  return result;
 }
-function setPortableAppDataPath(dirName = "data", create) {
-  if (!is.win) {
-    return;
-  }
+function setPortableAppDataPath(dirName = "data") {
   const portablePath = (0, import_node_path.join)((0, import_node_path.dirname)(import_electron.app.getPath("exe")), dirName);
-  let exists = (0, import_node_fs.existsSync)(portablePath);
-  if (create && !exists) {
+  if (!(0, import_node_fs.existsSync)(portablePath)) {
     (0, import_node_fs.mkdirSync)(portablePath);
-    exists = true;
-  }
-  if (exists) {
-    import_electron.app.setPath("appData", portablePath);
   }
+  import_electron.app.setPath("appData", portablePath);
 }
 function waitAppReady(timeout = 1e3) {
   return import_electron.app.isReady() ? Promise.resolve() : new Promise((resolve, reject) => {
@@ -128,31 +117,58 @@ function waitAppReady(timeout = 1e3) {
     });
   });
 }
-
-// src/utils/version.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
+function getPaths(entryDirName = "dist-entry") {
+  const root = (0, import_node_path.join)(__dirname, "..");
+  const mainDirPath = (0, import_node_path.join)(root, "main");
+  const preloadDirPath = (0, import_node_path.join)(root, "preload");
+  const rendererDirPath = (0, import_node_path.join)(root, "renderer");
+  const devServerURL = process.env.VITE_DEV_SERVER_URL;
+  const indexHTMLPath = (0, import_node_path.join)(rendererDirPath, "index.html");
+  const publicDirPath = devServerURL ? (0, import_node_path.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 (0, import_node_path.join)(import_electron.app.getAppPath(), entryDirName, ...paths);
+    },
+    /**
+     * get path inside `${app.name}.asar/main`
+     * @param paths joined path
+     */
+    getPathFromMain(...paths) {
+      return (0, import_node_path.join)(mainDirPath, ...paths);
+    },
+    /**
+     * get path inside `${app.name}.asar/preload`
+     * @param paths joined path
+     */
+    getPathFromPreload(...paths) {
+      return (0, import_node_path.join)(preloadDirPath, ...paths);
+    },
+    /**
+     * get path inside public dir
+     * @param paths joined path
+     */
+    getPathFromPublic(...paths) {
+      return (0, import_node_path.join)(publicDirPath, ...paths);
+    }
   };
-  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;
 }
 
 // src/utils/zip.ts
@@ -190,7 +206,7 @@ async function zipFile(filePath, targetFilePath = `${filePath}.gz`) {
   });
 }
 
-// src/utils/utils.ts
+// src/utils/noDep.ts
 function parseGithubCdnURL(originRepoURL, cdnPrefix, relativeFilePath) {
   if (!originRepoURL.startsWith("https://github.com/")) {
     throw new Error("origin url must start with https://github.com/");
@@ -204,21 +220,46 @@ function handleUnexpectedErrors(callback) {
   process.on("uncaughtException", callback);
   process.on("unhandledRejection", callback);
 }
+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);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  DEFAULT_APP_NAME,
-  NoSuchNativeModuleError,
   disableHWAccForWin7,
-  getAppVersion,
-  getElectronVersion,
-  getLocale,
-  getProductAsarPath,
+  getPathFromAppNameAsar,
+  getPaths,
+  getVersions,
   handleUnexpectedErrors,
   is,
-  isNoSuchNativeModuleError,
+  isUpdateJSON,
+  loadNativeModuleFromEntry,
   parseGithubCdnURL,
   parseVersion,
-  requireNative,
   restartApp,
   setAppUserModelId,
   setPortableAppDataPath,