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

package/dist/index.d.cts

@@ -1,128 +1,62 @@
-import { U as UpdateInfo, a as UpdateJSON } from './pure-GoN_3MEj.cjs';
+import { U as UpdateJSON } from './version-CffZWDhZ.cjs';
+import { O as OnDownloading, U as URLHandler, I as IProvider } from './types-DxPmQmaq.cjs';
+import '@subframe7536/type-utils';
 
-declare class MinimumVersionError extends Error {
-    currentVersion: string;
-    minVersion: string;
-    constructor(version: string, minimumVersion: string);
-}
-declare class VerifyFailedError extends Error {
-    signature: string;
-    cert: string;
-    constructor(signature: string, cert: string);
-}
-declare class DownloadError extends Error {
-    constructor(msg: string);
+declare const ErrorInfo: {
+    readonly download: "Download failed";
+    readonly validate: "Validate failed";
+    readonly param: "Missing params";
+    readonly version: "Unsatisfied version";
+};
+declare class UpdaterError extends Error {
+    constructor(msg: typeof ErrorInfo[keyof typeof ErrorInfo], info: string);
 }
-type CheckResult = UpdateInfo | undefined | CheckResultError;
-type CheckResultError = MinimumVersionError | DownloadError | TypeError | Error;
-type DownloadResult = true | DownloadResultError;
-type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
-type DownloadingInfo = {
-    /**
-     * downloaded percent, 0% - 100%
-     */
-    percent: `${number}%`;
-    /**
-     * total size
-     */
-    total: number;
-    /**
-     * downloaded size
-     */
-    current: number;
+type CheckResult<T extends UpdateJSON> = {
+    success: true;
+    data: Omit<T, 'beta'>;
+} | {
+    success: false;
+    /**
+     * minimal version that can update
+     */
+    data: string;
+} | {
+    success: false;
+    data: UpdaterError;
 };
-type Logger = {
+type DownloadResult = {
+    success: true;
+} | {
+    success: false;
+    data: UpdaterError;
+};
+interface Logger {
     info: (msg: string) => void;
     debug: (msg: string) => void;
     warn: (msg: string) => void;
-    error: (msg: string, e?: Error) => void;
-};
-type UpdaterOverrideFunctions = {
-    /**
-     * custom version compare function
-     * @param version1 old version string
-     * @param version2 new version string
-     * @returns whether version1 < version2
-     */
-    compareVersion?: (version1: string, version2: string) => boolean | Promise<boolean>;
-    /**
-     * custom verify signature function
-     * @param buffer file buffer
-     * @param signature signature
-     * @param cert certificate
-     * @returns if signature is valid, returns the version or `true` , otherwise returns `false`
-     */
-    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | false | Promise<string | false>;
-    /**
-     * custom download JSON function
-     * @param url download url
-     * @param header download header
-     * @returns `UpdateJSON`
-     */
-    downloadJSON?: (url: string, headers: Record<string, any>) => Promise<UpdateJSON>;
-    /**
-     * custom download buffer function
-     * @param url download url
-     * @param headers download header
-     * @param total precaculated file total size
-     * @param onDownloading on downloading callback
-     * @returns `Buffer`
-     */
-    downloadBuffer?: (url: string, headers: Record<string, any>, total: number, onDownloading?: (progress: DownloadingInfo) => void) => Promise<Buffer>;
-};
-type UpdaterDownloadConfig = {
-    /**
-     * download user agent
-     * @default 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36'
-     */
-    userAgent?: string;
-    /**
-     * extra download header, `accept` and `user-agent` is set by default
-     */
-    extraHeader?: Record<string, string>;
-};
+    error: (msg: string, e?: unknown) => void;
+}
 interface UpdaterOption {
     /**
      * public key of signature, which will be auto generated by plugin,
      * generate by `selfsigned` if not set
      */
     SIGNATURE_CERT?: string;
-    /**
-     * repository url, e.g. `https://github.com/electron/electron`
-     *
-     * you can use the `repository` in `package.json`
-     *
-     * if `updateJsonURL` or `releaseAsarURL` are absent,
-     * `repository` will be used to determine the url
-     */
-    repository?: string;
-    /**
-     * URL of version info json
-     * @default `${repository.replace('github.com', 'raw.githubusercontent.com')}/master/version.json`
-     * @throws if `updateJsonURL` and `repository` are all not set
-     */
-    updateJsonURL?: string;
-    /**
-     * URL of release asar.gz
-     * @default `${repository}/releases/download/v${version}/${app.name}-${version}.asar.gz`
-     * @throws if `releaseAsarURL` and `repository` are all not set
-     */
-    releaseAsarURL?: string;
     /**
      * whether to receive beta update
      */
     receiveBeta?: boolean;
-    overrideFunctions?: UpdaterOverrideFunctions;
-    downloadConfig?: UpdaterDownloadConfig;
+    logger?: Logger;
 }
 
 declare class Updater {
     private CERT;
     private info?;
-    private option;
+    private options;
     private asarPath;
     private gzipPath;
     private tmpFilePath;
+    private provider;
     /**
      * updater logger
      */
@@ -135,7 +69,15 @@ declare class Updater {
      *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
      * }
      */
-    onDownloading?: (progress: DownloadingInfo) => void;
+    onDownloading?: OnDownloading;
+    /**
+     * URL handler hook
+     *
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
+     * @param url source url
+     * @param isDownloadAsar whether is download asar
+     */
+    handleURL?: URLHandler;
     /**
      * whether receive beta version
      */
@@ -143,9 +85,10 @@ declare class Updater {
     set receiveBeta(receiveBeta: boolean);
     /**
      * initialize incremental updater
+     * @param provider update provider
      * @param option UpdaterOption
      */
-    constructor(option?: UpdaterOption);
+    constructor(provider: IProvider, option?: UpdaterOption);
     private needUpdate;
     /**
      * this function is used to parse download data.
@@ -160,84 +103,76 @@ declare class Updater {
      */
     private parseData;
     /**
-     * check update info
-     *
-     * if you want to update **offline**, you can set `data` and `sig` add update info
-     * @param data custom download URL of `updatejson` or existing update json
-     * @returns
-     * - Available:`{size: number, version: string}`
-     * - Unavailable: `undefined`
-     * - Fail: `CheckResultError`
+     * check update info using default options
      */
-    checkUpdate(data?: string | UpdateJSON): Promise<CheckResult>;
+    checkUpdate<T extends UpdateJSON>(): Promise<CheckResult<T>>;
     /**
-     * download update
-     *
-     * if you want to update **offline**, you can set both `data` and `sig` to verify and install
-     * @param data custom download URL of `asar.gz` or existing `asar.gz` buffer
+     * check update info using custom url
+     * @param url custom download URL of `updatejson`
+     */
+    checkUpdate<T extends UpdateJSON>(url: string): Promise<CheckResult<T>>;
+    /**
+     * check update info using existing update json
+     * @param data existing update json
+     */
+    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    /**
+     * download update using default options
+     */
+    download(): Promise<DownloadResult>;
+    /**
+     * download update using custom url
+     * @param url custom download URL
+     */
+    download(url: string): Promise<DownloadResult>;
+    /**
+     * download update using existing `asar.gz` buffer and signature
+     * @param data existing `asar.gz` buffer
      * @param sig signature
-     * @returns
-     * - `true`: success
-     * - `DownloadResultError`: fail
      */
-    download(data?: Buffer, sig?: string): Promise<DownloadResult>;
+    download(data: Buffer, sig: string): Promise<DownloadResult>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
 }
 
+type Promisable<T> = T | Promise<T>;
 /**
- * create updater instance
- * @param option updater option
- * @returns updater
+ * 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!`)
  */
-declare function createUpdater(option?: UpdaterOption): Updater;
-
-type Promisable<T> = T | Promise<T>;
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
-type AppOption = {
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger: Logger) => Promisable<void>;
+interface AppOption {
+    /**
+     * update provider
+     */
+    provider: IProvider;
     /**
      * updater options
      */
     updater?: (() => Promisable<Updater>) | UpdaterOption;
     /**
-     * path of electron output dist when in development
-     * @default '../dist-electron'
+     * hooks on rename temp asar path to `${app.name}.asar`
      */
-    electronDevDistPath?: string;
+    onInstall?: OnInstallFunction;
     /**
-     * relative path of main entry in electron dist
-     * @default 'main/index.js'
+     * hooks before app start up
+     * @param mainFilePath main file path of `${app.name}.asar`
+     * @param logger logger
      */
-    mainPath?: string;
+    beforeStart?: (mainFilePath: string, logger: Logger) => Promisable<void>;
     /**
-     * update hooks
+     * hooks on app start up error
+     * @param err installing or startup error
+     * @param logger logger
      */
-    hooks?: {
-        /**
-         * 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!`)
-         */
-        onInstall?: OnInstallFunction;
-        /**
-         * hooks before start
-         * @param appNameAsarPath path of `${app.name}.asar`
-         * @param logger logger
-         */
-        beforeStart?: (appNameAsarPath: string, logger?: Logger) => Promisable<void>;
-        /**
-         * hooks on start up error
-         * @param err installing or startup error
-         * @param logger logger
-         */
-        onStartError?: (err: unknown, logger?: Logger) => void;
-    };
-};
+    onStartError?: (err: unknown, logger: Logger) => void;
+}
 /**
  * utils for startuping with updater
  * @param fn startup function
@@ -271,6 +206,6 @@ declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>):
  * })
  * ```
  */
-declare function initApp(appOptions?: AppOption): Promise<void>;
+declare function initApp(appOptions: AppOption): Promise<void>;
 
-export { type AppOption, type CheckResult, type CheckResultError, DownloadError, type DownloadResult, type DownloadResultError, type DownloadingInfo, type Logger, MinimumVersionError, Updater, type UpdaterDownloadConfig, type UpdaterOption, type UpdaterOverrideFunctions, VerifyFailedError, createUpdater, initApp, startupWithUpdater };
+export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, initApp, startupWithUpdater };

package/dist/index.d.ts

@@ -1,128 +1,62 @@
-import { U as UpdateInfo, a as UpdateJSON } from './pure-GoN_3MEj.js';
+import { U as UpdateJSON } from './version-CffZWDhZ.js';
+import { O as OnDownloading, U as URLHandler, I as IProvider } from './types-seJf3Wbc.js';
+import '@subframe7536/type-utils';
 
-declare class MinimumVersionError extends Error {
-    currentVersion: string;
-    minVersion: string;
-    constructor(version: string, minimumVersion: string);
-}
-declare class VerifyFailedError extends Error {
-    signature: string;
-    cert: string;
-    constructor(signature: string, cert: string);
-}
-declare class DownloadError extends Error {
-    constructor(msg: string);
+declare const ErrorInfo: {
+    readonly download: "Download failed";
+    readonly validate: "Validate failed";
+    readonly param: "Missing params";
+    readonly version: "Unsatisfied version";
+};
+declare class UpdaterError extends Error {
+    constructor(msg: typeof ErrorInfo[keyof typeof ErrorInfo], info: string);
 }
-type CheckResult = UpdateInfo | undefined | CheckResultError;
-type CheckResultError = MinimumVersionError | DownloadError | TypeError | Error;
-type DownloadResult = true | DownloadResultError;
-type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
-type DownloadingInfo = {
-    /**
-     * downloaded percent, 0% - 100%
-     */
-    percent: `${number}%`;
-    /**
-     * total size
-     */
-    total: number;
-    /**
-     * downloaded size
-     */
-    current: number;
+type CheckResult<T extends UpdateJSON> = {
+    success: true;
+    data: Omit<T, 'beta'>;
+} | {
+    success: false;
+    /**
+     * minimal version that can update
+     */
+    data: string;
+} | {
+    success: false;
+    data: UpdaterError;
 };
-type Logger = {
+type DownloadResult = {
+    success: true;
+} | {
+    success: false;
+    data: UpdaterError;
+};
+interface Logger {
     info: (msg: string) => void;
     debug: (msg: string) => void;
     warn: (msg: string) => void;
-    error: (msg: string, e?: Error) => void;
-};
-type UpdaterOverrideFunctions = {
-    /**
-     * custom version compare function
-     * @param version1 old version string
-     * @param version2 new version string
-     * @returns whether version1 < version2
-     */
-    compareVersion?: (version1: string, version2: string) => boolean | Promise<boolean>;
-    /**
-     * custom verify signature function
-     * @param buffer file buffer
-     * @param signature signature
-     * @param cert certificate
-     * @returns if signature is valid, returns the version or `true` , otherwise returns `false`
-     */
-    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | false | Promise<string | false>;
-    /**
-     * custom download JSON function
-     * @param url download url
-     * @param header download header
-     * @returns `UpdateJSON`
-     */
-    downloadJSON?: (url: string, headers: Record<string, any>) => Promise<UpdateJSON>;
-    /**
-     * custom download buffer function
-     * @param url download url
-     * @param headers download header
-     * @param total precaculated file total size
-     * @param onDownloading on downloading callback
-     * @returns `Buffer`
-     */
-    downloadBuffer?: (url: string, headers: Record<string, any>, total: number, onDownloading?: (progress: DownloadingInfo) => void) => Promise<Buffer>;
-};
-type UpdaterDownloadConfig = {
-    /**
-     * download user agent
-     * @default 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36'
-     */
-    userAgent?: string;
-    /**
-     * extra download header, `accept` and `user-agent` is set by default
-     */
-    extraHeader?: Record<string, string>;
-};
+    error: (msg: string, e?: unknown) => void;
+}
 interface UpdaterOption {
     /**
      * public key of signature, which will be auto generated by plugin,
      * generate by `selfsigned` if not set
      */
     SIGNATURE_CERT?: string;
-    /**
-     * repository url, e.g. `https://github.com/electron/electron`
-     *
-     * you can use the `repository` in `package.json`
-     *
-     * if `updateJsonURL` or `releaseAsarURL` are absent,
-     * `repository` will be used to determine the url
-     */
-    repository?: string;
-    /**
-     * URL of version info json
-     * @default `${repository.replace('github.com', 'raw.githubusercontent.com')}/master/version.json`
-     * @throws if `updateJsonURL` and `repository` are all not set
-     */
-    updateJsonURL?: string;
-    /**
-     * URL of release asar.gz
-     * @default `${repository}/releases/download/v${version}/${app.name}-${version}.asar.gz`
-     * @throws if `releaseAsarURL` and `repository` are all not set
-     */
-    releaseAsarURL?: string;
     /**
      * whether to receive beta update
      */
     receiveBeta?: boolean;
-    overrideFunctions?: UpdaterOverrideFunctions;
-    downloadConfig?: UpdaterDownloadConfig;
+    logger?: Logger;
 }
 
 declare class Updater {
     private CERT;
     private info?;
-    private option;
+    private options;
     private asarPath;
     private gzipPath;
     private tmpFilePath;
+    private provider;
     /**
      * updater logger
      */
@@ -135,7 +69,15 @@ declare class Updater {
      *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
      * }
      */
-    onDownloading?: (progress: DownloadingInfo) => void;
+    onDownloading?: OnDownloading;
+    /**
+     * URL handler hook
+     *
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
+     * @param url source url
+     * @param isDownloadAsar whether is download asar
+     */
+    handleURL?: URLHandler;
     /**
      * whether receive beta version
      */
@@ -143,9 +85,10 @@ declare class Updater {
     set receiveBeta(receiveBeta: boolean);
     /**
      * initialize incremental updater
+     * @param provider update provider
      * @param option UpdaterOption
      */
-    constructor(option?: UpdaterOption);
+    constructor(provider: IProvider, option?: UpdaterOption);
     private needUpdate;
     /**
      * this function is used to parse download data.
@@ -160,84 +103,76 @@ declare class Updater {
      */
     private parseData;
     /**
-     * check update info
-     *
-     * if you want to update **offline**, you can set `data` and `sig` add update info
-     * @param data custom download URL of `updatejson` or existing update json
-     * @returns
-     * - Available:`{size: number, version: string}`
-     * - Unavailable: `undefined`
-     * - Fail: `CheckResultError`
+     * check update info using default options
      */
-    checkUpdate(data?: string | UpdateJSON): Promise<CheckResult>;
+    checkUpdate<T extends UpdateJSON>(): Promise<CheckResult<T>>;
     /**
-     * download update
-     *
-     * if you want to update **offline**, you can set both `data` and `sig` to verify and install
-     * @param data custom download URL of `asar.gz` or existing `asar.gz` buffer
+     * check update info using custom url
+     * @param url custom download URL of `updatejson`
+     */
+    checkUpdate<T extends UpdateJSON>(url: string): Promise<CheckResult<T>>;
+    /**
+     * check update info using existing update json
+     * @param data existing update json
+     */
+    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    /**
+     * download update using default options
+     */
+    download(): Promise<DownloadResult>;
+    /**
+     * download update using custom url
+     * @param url custom download URL
+     */
+    download(url: string): Promise<DownloadResult>;
+    /**
+     * download update using existing `asar.gz` buffer and signature
+     * @param data existing `asar.gz` buffer
      * @param sig signature
-     * @returns
-     * - `true`: success
-     * - `DownloadResultError`: fail
      */
-    download(data?: Buffer, sig?: string): Promise<DownloadResult>;
+    download(data: Buffer, sig: string): Promise<DownloadResult>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
 }
 
+type Promisable<T> = T | Promise<T>;
 /**
- * create updater instance
- * @param option updater option
- * @returns updater
+ * 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!`)
  */
-declare function createUpdater(option?: UpdaterOption): Updater;
-
-type Promisable<T> = T | Promise<T>;
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
-type AppOption = {
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger: Logger) => Promisable<void>;
+interface AppOption {
+    /**
+     * update provider
+     */
+    provider: IProvider;
     /**
      * updater options
      */
     updater?: (() => Promisable<Updater>) | UpdaterOption;
     /**
-     * path of electron output dist when in development
-     * @default '../dist-electron'
+     * hooks on rename temp asar path to `${app.name}.asar`
      */
-    electronDevDistPath?: string;
+    onInstall?: OnInstallFunction;
     /**
-     * relative path of main entry in electron dist
-     * @default 'main/index.js'
+     * hooks before app start up
+     * @param mainFilePath main file path of `${app.name}.asar`
+     * @param logger logger
      */
-    mainPath?: string;
+    beforeStart?: (mainFilePath: string, logger: Logger) => Promisable<void>;
     /**
-     * update hooks
+     * hooks on app start up error
+     * @param err installing or startup error
+     * @param logger logger
      */
-    hooks?: {
-        /**
-         * 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!`)
-         */
-        onInstall?: OnInstallFunction;
-        /**
-         * hooks before start
-         * @param appNameAsarPath path of `${app.name}.asar`
-         * @param logger logger
-         */
-        beforeStart?: (appNameAsarPath: string, logger?: Logger) => Promisable<void>;
-        /**
-         * hooks on start up error
-         * @param err installing or startup error
-         * @param logger logger
-         */
-        onStartError?: (err: unknown, logger?: Logger) => void;
-    };
-};
+    onStartError?: (err: unknown, logger: Logger) => void;
+}
 /**
  * utils for startuping with updater
  * @param fn startup function
@@ -271,6 +206,6 @@ declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>):
  * })
  * ```
  */
-declare function initApp(appOptions?: AppOption): Promise<void>;
+declare function initApp(appOptions: AppOption): Promise<void>;
 
-export { type AppOption, type CheckResult, type CheckResultError, DownloadError, type DownloadResult, type DownloadResultError, type DownloadingInfo, type Logger, MinimumVersionError, Updater, type UpdaterDownloadConfig, type UpdaterOption, type UpdaterOverrideFunctions, VerifyFailedError, createUpdater, initApp, startupWithUpdater };
+export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, initApp, startupWithUpdater };