electron-incremental-update 2.0.0-beta.5 → 2.0.0-beta.6

package/dist/index.d.ts

@@ -1,78 +0,0 @@
-import { U as Updater, a as UpdaterOption, L as Logger } from './core-CXETH_bb.js';
-export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-CXETH_bb.js';
-import { I as IProvider } from './types-C5P0h_bB.js';
-import 'node:events';
-import '@subframe7536/type-utils';
-
-type Promisable<T> = T | Promise<T>;
-/**
- * hooks on rename temp asar path to `${app.name}.asar`
- * @param install `() => renameSync(tempAsarPath, appNameAsarPath)`
- * @param tempAsarPath temp(updated) asar path
- * @param appNameAsarPath `${app.name}.asar` path
- * @param logger logger
- * @default install(); logger.info(`update success!`)
- */
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
-interface AppOption {
-    /**
-     * update provider
-     */
-    provider: IProvider;
-    /**
-     * updater options
-     */
-    updater?: (() => Promisable<Updater>) | UpdaterOption;
-    /**
-     * hooks on rename temp asar path to `${app.name}.asar`
-     */
-    onInstall?: OnInstallFunction;
-    /**
-     * hooks before app start up
-     * @param mainFilePath main file path of `${app.name}.asar`
-     * @param logger logger
-     */
-    beforeStart?: (mainFilePath: string, logger?: Logger) => Promisable<void>;
-    /**
-     * hooks on app start up error
-     * @param err installing or startup error
-     * @param logger logger
-     */
-    onStartError?: (err: unknown, logger?: Logger) => void;
-}
-/**
- * utils for startuping with updater
- * @param fn startup function
- * @example
- * // in electron/main/index.ts
- * export default startupWithUpdater((updater) => {
- *   updater.checkUpdate()
- * })
- */
-declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>): (updater: Updater) => Promisable<void>;
-/**
- * initialize app
- * @example
- * ```ts
- * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
- * import { repository } from '../package.json'
- *
- * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
- * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
- *
- * initApp({
- *   // can be updater option or function that return updater
- *   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): Promise<void>;
-
-export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };

package/dist/provider.d.cts

@@ -1,65 +0,0 @@
-import { I as IProvider, d as defaultIsLowerVersion, a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, c as URLHandler, O as OnDownloading } from './types-C5P0h_bB.cjs';
-import { f as defaultVerify, a as defaultUnzipFile } from './zip-WRrEMkgp.cjs';
-import { Arrayable } from '@subframe7536/type-utils';
-
-declare abstract class BaseProvider implements IProvider {
-    name: string;
-    isLowerVersion: typeof defaultIsLowerVersion;
-    verifySignaure: typeof defaultVerify;
-    unzipFile: typeof defaultUnzipFile;
-    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
-}
-
-interface GitHubProviderOptions {
-    /**
-     * github user name
-     */
-    username: string;
-    /**
-     * github repo name
-     */
-    repo: string;
-    /**
-     * extra headers
-     */
-    extraHeaders?: Record<string, string>;
-    /**
-     * custom url handler
-     *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 public CDN links}
-     * @example
-     * (url, isDownloadAsar) => {
-     *   if (isDownloadAsar) {
-     *     url.hostname = 'mirror.ghproxy.com'
-     *     url.pathname = 'https://github.com' + url.pathname
-     *     return url
-     *   }
-     * }
-     */
-    urlHandler?: URLHandler;
-}
-declare class GitHubProvider extends BaseProvider {
-    name: string;
-    private options;
-    /**
-     * Update Provider for Github repo
-     * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
-     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-     *
-     * you can setup `urlHandler` in {@link GitHubProviderOptions} or `Updater` to modify url before request
-     * @param options provider options
-     */
-    constructor(options: GitHubProviderOptions);
-    get urlHandler(): URLHandler | undefined;
-    set urlHandler(handler: URLHandler);
-    private parseURL;
-    downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
-}
-
-declare function getHeader(response: Record<string, Arrayable<string>>, headerKey: any): any;
-declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
-declare function defaultDownloadAsar(url: string, headers: Record<string, any>, onDownloading?: OnDownloading): Promise<Buffer>;
-
-export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/provider.d.ts

@@ -1,65 +0,0 @@
-import { I as IProvider, d as defaultIsLowerVersion, a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, c as URLHandler, O as OnDownloading } from './types-C5P0h_bB.js';
-import { f as defaultVerify, a as defaultUnzipFile } from './zip-WRrEMkgp.js';
-import { Arrayable } from '@subframe7536/type-utils';
-
-declare abstract class BaseProvider implements IProvider {
-    name: string;
-    isLowerVersion: typeof defaultIsLowerVersion;
-    verifySignaure: typeof defaultVerify;
-    unzipFile: typeof defaultUnzipFile;
-    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
-}
-
-interface GitHubProviderOptions {
-    /**
-     * github user name
-     */
-    username: string;
-    /**
-     * github repo name
-     */
-    repo: string;
-    /**
-     * extra headers
-     */
-    extraHeaders?: Record<string, string>;
-    /**
-     * custom url handler
-     *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 public CDN links}
-     * @example
-     * (url, isDownloadAsar) => {
-     *   if (isDownloadAsar) {
-     *     url.hostname = 'mirror.ghproxy.com'
-     *     url.pathname = 'https://github.com' + url.pathname
-     *     return url
-     *   }
-     * }
-     */
-    urlHandler?: URLHandler;
-}
-declare class GitHubProvider extends BaseProvider {
-    name: string;
-    private options;
-    /**
-     * Update Provider for Github repo
-     * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
-     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
-     *
-     * you can setup `urlHandler` in {@link GitHubProviderOptions} or `Updater` to modify url before request
-     * @param options provider options
-     */
-    constructor(options: GitHubProviderOptions);
-    get urlHandler(): URLHandler | undefined;
-    set urlHandler(handler: URLHandler);
-    private parseURL;
-    downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
-}
-
-declare function getHeader(response: Record<string, Arrayable<string>>, headerKey: any): any;
-declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
-declare function defaultDownloadAsar(url: string, headers: Record<string, any>, onDownloading?: OnDownloading): Promise<Buffer>;
-
-export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/types-C5P0h_bB.d.cts

@@ -1,103 +0,0 @@
-import { Promisable } from '@subframe7536/type-utils';
-
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
-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;
-};
-declare function isUpdateJSON(json: any): json is UpdateJSON;
-declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
-
-type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
-type OnDownloading = (progress: DownloadingInfo) => void;
-interface DownloadingInfo {
-    /**
-     * download delta
-     */
-    delta: number;
-    /**
-     * downloaded percent, 0 ~ 100
-     *
-     * If not `Content-Length` header, will be nagative
-     */
-    percent: number;
-    /**
-     * total size
-     *
-     * If not `Content-Length` header, will be -1
-     */
-    total: number;
-    /**
-     * downloaded size
-     */
-    transferred: number;
-    /**
-     * download speed, bytes per second
-     */
-    bps: number;
-}
-interface IProvider {
-    /**
-     * provider name
-     */
-    name: string;
-    /**
-     * custom url handler
-     *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
-     */
-    urlHandler?: URLHandler;
-    onDownloading?: OnDownloading;
-    /**
-     * download update json
-     * @param versionPath parsed version path
-     */
-    downloadJSON: (versionPath: string) => Promise<UpdateJSON>;
-    /**
-     * download update asar
-     * @param name app name
-     * @param updateInfo existing update info
-     * @param onDownloading hook for on downloading
-     */
-    downloadAsar: (name: string, updateInfo: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
-    /**
-     * compare version
-     * @param oldVer old version string
-     * @param newVer new version string
-     * @returns if version1 < version2
-     */
-    isLowerVersion: (oldVer: string, newVer: string) => boolean;
-    /**
-     * unzip file buffer
-     * @param buffer source buffer
-     */
-    unzipFile: (buffer: Buffer) => Promise<Buffer>;
-    /**
-     * verify asar signature
-     * @param buffer file buffer
-     * @param signature signature
-     * @param cert certificate
-     * @returns if signature is valid, returns the version, otherwise returns `undefined`
-     */
-    verifySignaure: (buffer: Buffer, signature: string, cert: string) => Promisable<string | undefined>;
-}
-
-export { type DownloadingInfo as D, type IProvider as I, type OnDownloading as O, type UpdateInfo as U, type Version as V, type UpdateJSON as a, defaultVersionJsonGenerator as b, type URLHandler as c, defaultIsLowerVersion as d, isUpdateJSON as i, parseVersion as p };

package/dist/types-C5P0h_bB.d.ts

@@ -1,103 +0,0 @@
-import { Promisable } from '@subframe7536/type-utils';
-
-interface Version {
-    major: number;
-    minor: number;
-    patch: number;
-    stage: string;
-    stageVersion: number;
-}
-declare function parseVersion(version: string): Version;
-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;
-};
-declare function isUpdateJSON(json: any): json is UpdateJSON;
-declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
-
-type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
-type OnDownloading = (progress: DownloadingInfo) => void;
-interface DownloadingInfo {
-    /**
-     * download delta
-     */
-    delta: number;
-    /**
-     * downloaded percent, 0 ~ 100
-     *
-     * If not `Content-Length` header, will be nagative
-     */
-    percent: number;
-    /**
-     * total size
-     *
-     * If not `Content-Length` header, will be -1
-     */
-    total: number;
-    /**
-     * downloaded size
-     */
-    transferred: number;
-    /**
-     * download speed, bytes per second
-     */
-    bps: number;
-}
-interface IProvider {
-    /**
-     * provider name
-     */
-    name: string;
-    /**
-     * custom url handler
-     *
-     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
-     */
-    urlHandler?: URLHandler;
-    onDownloading?: OnDownloading;
-    /**
-     * download update json
-     * @param versionPath parsed version path
-     */
-    downloadJSON: (versionPath: string) => Promise<UpdateJSON>;
-    /**
-     * download update asar
-     * @param name app name
-     * @param updateInfo existing update info
-     * @param onDownloading hook for on downloading
-     */
-    downloadAsar: (name: string, updateInfo: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
-    /**
-     * compare version
-     * @param oldVer old version string
-     * @param newVer new version string
-     * @returns if version1 < version2
-     */
-    isLowerVersion: (oldVer: string, newVer: string) => boolean;
-    /**
-     * unzip file buffer
-     * @param buffer source buffer
-     */
-    unzipFile: (buffer: Buffer) => Promise<Buffer>;
-    /**
-     * verify asar signature
-     * @param buffer file buffer
-     * @param signature signature
-     * @param cert certificate
-     * @returns if signature is valid, returns the version, otherwise returns `undefined`
-     */
-    verifySignaure: (buffer: Buffer, signature: string, cert: string) => Promisable<string | undefined>;
-}
-
-export { type DownloadingInfo as D, type IProvider as I, type OnDownloading as O, type UpdateInfo as U, type Version as V, type UpdateJSON as a, defaultVersionJsonGenerator as b, type URLHandler as c, defaultIsLowerVersion as d, isUpdateJSON as i, parseVersion as p };

package/dist/utils.d.cts

@@ -1,80 +0,0 @@
-import { BrowserWindow } from 'electron';
-export { e as aesDecrypt, b as aesEncrypt, c as defaultSignature, a as defaultUnzipFile, f as defaultVerify, d as defaultZipFile, h as hashBuffer } from './zip-WRrEMkgp.cjs';
-export { U as UpdateInfo, a as UpdateJSON, V as Version, d as defaultIsLowerVersion, b as defaultVersionJsonGenerator, i as isUpdateJSON, p as parseVersion } from './types-C5P0h_bB.cjs';
-import { U as Updater } from './core-DmU2Vk_S.cjs';
-import '@subframe7536/type-utils';
-import 'node:events';
-
-/**
- * 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`)
- *
- * if is in dev, **always** return `'DEV.asar'`
- */
-declare function getPathFromAppNameAsar(...path: string[]): string;
-/**
- * get app version, if is in dev, return `getEntryVersion()`
- */
-declare function getAppVersion(): string;
-/**
- * get entry version
- */
-declare function getEntryVersion(): string;
-/**
- * use `require` to load native module from entry
- * @param moduleName file name in entry
- */
-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 is `org.${electron.app.name}`
- */
-declare function setAppUserModelId(id?: string): void;
-/**
- * disable hardware acceleration for Windows 7
- */
-declare function disableHWAccForWin7(): void;
-/**
- * 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
- *
- * useful for portable Windows app
- * @param dirName dir name, default to `data`
- */
-declare function setPortableAppDataPath(dirName?: string): void;
-/**
- * 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;
-declare function getPathFromPreload(...paths: string[]): string;
-declare function getPathFromPublic(...paths: string[]): string;
-declare function getPathFromEntryAsar(...paths: string[]): string;
-/**
- * handle all unhandled error
- * @param callback callback function
- */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
-
-/**
- * auto check update, download and install
- */
-declare function autoUpdate(updater: Updater): Promise<void>;
-
-export { autoUpdate, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };

package/dist/utils.d.ts

@@ -1,80 +0,0 @@
-import { BrowserWindow } from 'electron';
-export { e as aesDecrypt, b as aesEncrypt, c as defaultSignature, a as defaultUnzipFile, f as defaultVerify, d as defaultZipFile, h as hashBuffer } from './zip-WRrEMkgp.js';
-export { U as UpdateInfo, a as UpdateJSON, V as Version, d as defaultIsLowerVersion, b as defaultVersionJsonGenerator, i as isUpdateJSON, p as parseVersion } from './types-C5P0h_bB.js';
-import { U as Updater } from './core-CXETH_bb.js';
-import '@subframe7536/type-utils';
-import 'node:events';
-
-/**
- * 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`)
- *
- * if is in dev, **always** return `'DEV.asar'`
- */
-declare function getPathFromAppNameAsar(...path: string[]): string;
-/**
- * get app version, if is in dev, return `getEntryVersion()`
- */
-declare function getAppVersion(): string;
-/**
- * get entry version
- */
-declare function getEntryVersion(): string;
-/**
- * use `require` to load native module from entry
- * @param moduleName file name in entry
- */
-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 is `org.${electron.app.name}`
- */
-declare function setAppUserModelId(id?: string): void;
-/**
- * disable hardware acceleration for Windows 7
- */
-declare function disableHWAccForWin7(): void;
-/**
- * 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
- *
- * useful for portable Windows app
- * @param dirName dir name, default to `data`
- */
-declare function setPortableAppDataPath(dirName?: string): void;
-/**
- * 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;
-declare function getPathFromPreload(...paths: string[]): string;
-declare function getPathFromPublic(...paths: string[]): string;
-declare function getPathFromEntryAsar(...paths: string[]): string;
-/**
- * handle all unhandled error
- * @param callback callback function
- */
-declare function handleUnexpectedErrors(callback: (err: unknown) => void): void;
-
-/**
- * auto check update, download and install
- */
-declare function autoUpdate(updater: Updater): Promise<void>;
-
-export { autoUpdate, disableHWAccForWin7, getAppVersion, getEntryVersion, getPathFromAppNameAsar, getPathFromEntryAsar, getPathFromPreload, getPathFromPublic, handleUnexpectedErrors, isDev, isLinux, isMac, isWin, loadPage, requireNative, restartApp, setAppUserModelId, setPortableAppDataPath, singleInstance };