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

package/dist/utils.d.cts

@@ -1,126 +1,86 @@
 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 './pure-GoN_3MEj.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';
 
 /**
- * app info
+ * Compile time dev check
  */
-declare const is: {
-    readonly dev: boolean;
-    readonly win: boolean;
-    readonly mac: boolean;
-    readonly linux: boolean;
-};
+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, return `'DEV.asar'`
+ * If is in dev, **always** return `'DEV.asar'`
  */
-declare function getPathFromAppNameAsar(...path: string[]): string;
+declare function getPathFromAppNameAsar(...paths: string[]): string;
 /**
- * get versions of App, Entry, Electron, Node and System
- *
- * App version is read from `version` file in `${electron.app.name}.asar`
- *
- * Entry version is read from `package.json`
- *
- * SystemVersion: `${platform} ${os.release()}`
+ * Get app version, if is in dev, return `getEntryVersion()`
  */
-declare function getVersions(): {
-    appVersion: string;
-    entryVersion: string;
-    electronVersion: string;
-    nodeVersion: string;
-    systemVersion: string;
-};
+declare function getAppVersion(): string;
 /**
- * load native module from entry
- * @param moduleName file name in entry
+ * Get entry version
  */
-type RequireNative = <T = any>(moduleName: string) => T;
+declare function getEntryVersion(): string;
 /**
- * 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))`
+ * Use `require` to load native module from entry asar
+ * @param moduleName file name in entry
  * @example
- * const requireNative = loadNativeModuleFromEntry()
- * const db = requireNative<typeof import('../native/db')>('db')
- * db.test()
+ * requireNative<typeof import('../native/db')>('db')
  */
-declare function loadNativeModuleFromEntry(devEntryDirPath?: string, entryDirPath?: string): RequireNative;
+declare function requireNative<T = any>(moduleName: string): T;
 /**
  * Restarts the Electron app.
  */
 declare function restartApp(): void;
 /**
- * fix app use model id, only for Windows
- * @param id app id @default `org.${electron.app.name}`
+ * 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
+ * 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 waitAppReady(timeout?: number): Promise<void>;
+declare function loadPage(win: BrowserWindow, htmlFilePath?: string): void;
 /**
- * get paths, **only for main and preload**
- * @param entryDirName entry dir name, default to `dist-entry`
+ * Get joined path from preload dir
+ * @param paths rest paths
  */
-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 `${electron.app.name}.asar/main`
-     * @param paths joined path
-     */
-    getPathFromMain(...paths: string[]): string;
-    /**
-     * get path inside `${electron.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>;
+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;
 
-export { disableHWAccForWin7, getPathFromAppNameAsar, getPaths, getVersions, is, loadNativeModuleFromEntry, restartApp, setAppUserModelId, setPortableAppDataPath, 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,126 +1,86 @@
 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 './pure-GoN_3MEj.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';
 
 /**
- * app info
+ * Compile time dev check
  */
-declare const is: {
-    readonly dev: boolean;
-    readonly win: boolean;
-    readonly mac: boolean;
-    readonly linux: boolean;
-};
+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, return `'DEV.asar'`
+ * If is in dev, **always** return `'DEV.asar'`
  */
-declare function getPathFromAppNameAsar(...path: string[]): string;
+declare function getPathFromAppNameAsar(...paths: string[]): string;
 /**
- * get versions of App, Entry, Electron, Node and System
- *
- * App version is read from `version` file in `${electron.app.name}.asar`
- *
- * Entry version is read from `package.json`
- *
- * SystemVersion: `${platform} ${os.release()}`
+ * Get app version, if is in dev, return `getEntryVersion()`
  */
-declare function getVersions(): {
-    appVersion: string;
-    entryVersion: string;
-    electronVersion: string;
-    nodeVersion: string;
-    systemVersion: string;
-};
+declare function getAppVersion(): string;
 /**
- * load native module from entry
- * @param moduleName file name in entry
+ * Get entry version
  */
-type RequireNative = <T = any>(moduleName: string) => T;
+declare function getEntryVersion(): string;
 /**
- * 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))`
+ * Use `require` to load native module from entry asar
+ * @param moduleName file name in entry
  * @example
- * const requireNative = loadNativeModuleFromEntry()
- * const db = requireNative<typeof import('../native/db')>('db')
- * db.test()
+ * requireNative<typeof import('../native/db')>('db')
  */
-declare function loadNativeModuleFromEntry(devEntryDirPath?: string, entryDirPath?: string): RequireNative;
+declare function requireNative<T = any>(moduleName: string): T;
 /**
  * Restarts the Electron app.
  */
 declare function restartApp(): void;
 /**
- * fix app use model id, only for Windows
- * @param id app id @default `org.${electron.app.name}`
+ * 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
+ * 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 waitAppReady(timeout?: number): Promise<void>;
+declare function loadPage(win: BrowserWindow, htmlFilePath?: string): void;
 /**
- * get paths, **only for main and preload**
- * @param entryDirName entry dir name, default to `dist-entry`
+ * Get joined path from preload dir
+ * @param paths rest paths
  */
-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 `${electron.app.name}.asar/main`
-     * @param paths joined path
-     */
-    getPathFromMain(...paths: string[]): string;
-    /**
-     * get path inside `${electron.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>;
+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;
 
-export { disableHWAccForWin7, getPathFromAppNameAsar, getPaths, getVersions, is, loadNativeModuleFromEntry, restartApp, setAppUserModelId, setPortableAppDataPath, 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.js

@@ -1,38 +1,3 @@
-import {
-  disableHWAccForWin7,
-  getPathFromAppNameAsar,
-  getPaths,
-  getVersions,
-  handleUnexpectedErrors,
-  is,
-  isUpdateJSON,
-  loadNativeModuleFromEntry,
-  parseGithubCdnURL,
-  parseVersion,
-  restartApp,
-  setAppUserModelId,
-  setPortableAppDataPath,
-  singleInstance,
-  unzipFile,
-  waitAppReady,
-  zipFile
-} from "./chunk-SBPTSLG7.js";
-export {
-  disableHWAccForWin7,
-  getPathFromAppNameAsar,
-  getPaths,
-  getVersions,
-  handleUnexpectedErrors,
-  is,
-  isUpdateJSON,
-  loadNativeModuleFromEntry,
-  parseGithubCdnURL,
-  parseVersion,
-  restartApp,
-  setAppUserModelId,
-  setPortableAppDataPath,
-  singleInstance,
-  unzipFile,
-  waitAppReady,
-  zipFile
-};
+export { disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance } from './chunk-4MH6ZXCY.js';
+export { aesDecrypt, aesEncrypt, defaultSignature, defaultUnzipFile, defaultVerifySignature, defaultZipFile, hashBuffer } from './chunk-KZSYEXLO.js';
+export { defaultIsLowerVersion, defaultVersionJsonGenerator, isUpdateJSON, parseVersion } from './chunk-72ZAJ7AF.js';

package/dist/version-C4tF_trh.d.cts

@@ -0,0 +1,62 @@
+interface Version {
+    /**
+     * `2` of `2.1.0-beta.10`
+     */
+    major: number;
+    /**
+     * `1` of `2.1.0-beta.10`
+     */
+    minor: number;
+    /**
+     * `0` of `2.1.0-beta.10`
+     */
+    patch: number;
+    /**
+     * `beta` of `2.1.0-beta.10`
+     */
+    stage: string;
+    /**
+     * `10` of `2.1.0-beta.10`
+     */
+    stageVersion: number;
+}
+/**
+ * Parse version string to {@link Version}, like `0.2.0-beta.1`
+ * @param version version string
+ */
+declare function parseVersion(version: string): Version;
+/**
+ * Default function to check the old version is less than new version
+ * @param oldVer old version string
+ * @param newVer new version string
+ */
+declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
+/**
+ * Update info json
+ */
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+};
+/**
+ * {@link UpdateInfo} with beta
+ */
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+/**
+ * Check is `UpdateJSON`
+ * @param json any variable
+ */
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+/**
+ * Default function to generate `UpdateJSON`
+ * @param existingJson exising update json
+ * @param signature sigature
+ * @param version target version
+ * @param minimumVersion minimum version
+ */
+declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
+
+export { type UpdateInfo as U, type Version as V, type UpdateJSON as a, defaultVersionJsonGenerator as b, defaultIsLowerVersion as d, isUpdateJSON as i, parseVersion as p };

package/dist/version-C4tF_trh.d.ts

@@ -0,0 +1,62 @@
+interface Version {
+    /**
+     * `2` of `2.1.0-beta.10`
+     */
+    major: number;
+    /**
+     * `1` of `2.1.0-beta.10`
+     */
+    minor: number;
+    /**
+     * `0` of `2.1.0-beta.10`
+     */
+    patch: number;
+    /**
+     * `beta` of `2.1.0-beta.10`
+     */
+    stage: string;
+    /**
+     * `10` of `2.1.0-beta.10`
+     */
+    stageVersion: number;
+}
+/**
+ * Parse version string to {@link Version}, like `0.2.0-beta.1`
+ * @param version version string
+ */
+declare function parseVersion(version: string): Version;
+/**
+ * Default function to check the old version is less than new version
+ * @param oldVer old version string
+ * @param newVer new version string
+ */
+declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
+/**
+ * Update info json
+ */
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+};
+/**
+ * {@link UpdateInfo} with beta
+ */
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+/**
+ * Check is `UpdateJSON`
+ * @param json any variable
+ */
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+/**
+ * Default function to generate `UpdateJSON`
+ * @param existingJson exising update json
+ * @param signature sigature
+ * @param version target version
+ * @param minimumVersion minimum version
+ */
+declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
+
+export { type UpdateInfo as U, type Version as V, type UpdateJSON as a, defaultVersionJsonGenerator as b, defaultIsLowerVersion as d, isUpdateJSON as i, parseVersion as p };