electron-incremental-update 0.9.0 → 1.0.0

package/dist/noDep-TvZoKVF8.d.mts

@@ -0,0 +1,31 @@
+/**
+ * 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;
+interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+    stage: string;
+    stageVersion: number;
+}
+declare function parseVersion(version: string): Version;
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+
+export { type UpdateInfo as U, type Version as V, type UpdateJSON as a, parseVersion as b, handleUnexpectedErrors as h, isUpdateJSON as i, parseGithubCdnURL as p };

package/dist/noDep-TvZoKVF8.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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;
+interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+    stage: string;
+    stageVersion: number;
+}
+declare function parseVersion(version: string): Version;
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+    size: number;
+};
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+
+export { type UpdateInfo as U, type Version as V, type UpdateJSON as a, parseVersion as b, handleUnexpectedErrors as h, isUpdateJSON as i, parseGithubCdnURL as p };

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,75 +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
- */
-declare function getProductAsarPath(name?: string): string;
-/**
- * get the version of Electron runtime
+ * @todo change a better function name or merge into {@link getPaths}
  */
-declare function getElectronVersion(): string;
+declare function getPathFromAppNameAsar(...path: string[]): string;
 /**
- * get the version of application (name.asar)
+ * 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`
  *
- * if is dev, return {@link getElectronVersion}
- * @param name - The name of the application
+ * SystemVersion: `${platform} ${os.release()}`
  */
-declare function getAppVersion(name?: string): string;
-declare class NoSuchNativeModuleError extends Error {
-    moduleName: string;
-    constructor(moduleName: string);
-}
-declare function isNoSuchNativeModuleError(e: unknown): e is NoSuchNativeModuleError;
+declare function getVersions(): {
+    appVersion: string;
+    entryVersion: string;
+    electronVersion: string;
+    nodeVersion: string;
+    systemVersion: string;
+};
 /**
- * require native package, if not found, return {@link NoSuchNativeModuleError}
- * @param packageName native package name
+ * load native module from entry
+ * @param moduleName file name in entry
  */
-declare function requireNative<T = any>(packageName: string): T | NoSuchNativeModuleError;
-
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
-
-declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
-declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
-
+type RequireNative = <T = any>(moduleName: string) => T;
 /**
- * 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}
+ * 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 parseGithubCdnURL(originRepoURL: string, cdnPrefix: string, relativeFilePath: string): string;
+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;
+/**
+ * disable hardware acceleration for Windows 7
  */
-declare function setAppUserModelId(id: string): void;
+declare function disableHWAccForWin7(): void;
 /**
- * set AppData dir for portable Windows app
+ * 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 setPortableAppDataPath(dirName?: string, create?: boolean): void;
+declare function singleInstance(window?: BrowserWindow): boolean;
+/**
+ * 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): void;
 /**
  * ensure app is ready.
  * @param timeout wait timeout, @default 1000
  */
 declare function waitAppReady(timeout?: number): Promise<void>;
 /**
- * handle all unhandled error
- * @param callback callback function
+ * get paths, **only for main and preload**
+ * @param entryDirName entry dir name, default to `dist-entry`
  */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
+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>;
 
-export { DEFAULT_APP_NAME, NoSuchNativeModuleError, type Version, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, is, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, 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,75 +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
- */
-declare function getProductAsarPath(name?: string): string;
-/**
- * get the version of Electron runtime
+ * @todo change a better function name or merge into {@link getPaths}
  */
-declare function getElectronVersion(): string;
+declare function getPathFromAppNameAsar(...path: string[]): string;
 /**
- * get the version of application (name.asar)
+ * 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`
  *
- * if is dev, return {@link getElectronVersion}
- * @param name - The name of the application
+ * SystemVersion: `${platform} ${os.release()}`
  */
-declare function getAppVersion(name?: string): string;
-declare class NoSuchNativeModuleError extends Error {
-    moduleName: string;
-    constructor(moduleName: string);
-}
-declare function isNoSuchNativeModuleError(e: unknown): e is NoSuchNativeModuleError;
+declare function getVersions(): {
+    appVersion: string;
+    entryVersion: string;
+    electronVersion: string;
+    nodeVersion: string;
+    systemVersion: string;
+};
 /**
- * require native package, if not found, return {@link NoSuchNativeModuleError}
- * @param packageName native package name
+ * load native module from entry
+ * @param moduleName file name in entry
  */
-declare function requireNative<T = any>(packageName: string): T | NoSuchNativeModuleError;
-
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
-
-declare function unzipFile(gzipPath: string, targetFilePath?: string): Promise<unknown>;
-declare function zipFile(filePath: string, targetFilePath?: string): Promise<unknown>;
-
+type RequireNative = <T = any>(moduleName: string) => T;
 /**
- * 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}
+ * 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 parseGithubCdnURL(originRepoURL: string, cdnPrefix: string, relativeFilePath: string): string;
+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;
+/**
+ * disable hardware acceleration for Windows 7
  */
-declare function setAppUserModelId(id: string): void;
+declare function disableHWAccForWin7(): void;
 /**
- * set AppData dir for portable Windows app
+ * 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 setPortableAppDataPath(dirName?: string, create?: boolean): void;
+declare function singleInstance(window?: BrowserWindow): boolean;
+/**
+ * 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): void;
 /**
  * ensure app is ready.
  * @param timeout wait timeout, @default 1000
  */
 declare function waitAppReady(timeout?: number): Promise<void>;
 /**
- * handle all unhandled error
- * @param callback callback function
+ * get paths, **only for main and preload**
+ * @param entryDirName entry dir name, default to `dist-entry`
  */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
+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>;
 
-export { DEFAULT_APP_NAME, NoSuchNativeModuleError, type Version, getAppVersion, getElectronVersion, getLocale, getProductAsarPath, handleUnexpectedErrors, is, isNoSuchNativeModuleError, parseGithubCdnURL, parseVersion, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, unzipFile, waitAppReady, zipFile };
+export { disableHWAccForWin7, getPathFromAppNameAsar, getPaths, getVersions, is, loadNativeModuleFromEntry, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance, unzipFile, waitAppReady, zipFile };