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

package/dist/index.d.cts

@@ -1,15 +1,17 @@
-import { U as UpdateJSON } from './version-CffZWDhZ.cjs';
-import { O as OnDownloading, U as URLHandler, I as IProvider } from './types-DxPmQmaq.cjs';
+import { EventEmitter } from 'node:events';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.cjs';
+import { D as DownloadingInfo, I as IProvider, U as URLHandler } from './types-Tequ_V2o.cjs';
 import '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
     readonly download: "Download failed";
     readonly validate: "Validate failed";
     readonly param: "Missing params";
-    readonly version: "Unsatisfied version";
+    readonly network: "Network error";
 };
 declare class UpdaterError extends Error {
-    constructor(msg: typeof ErrorInfo[keyof typeof ErrorInfo], info: string);
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, info: string);
 }
 type CheckResult<T extends UpdateJSON> = {
     success: true;
@@ -49,12 +51,17 @@ interface UpdaterOption {
     logger?: Logger;
 }
 
-declare class Updater {
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-unavailable': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+}> {
     private CERT;
     private info?;
-    private options;
     private asarPath;
-    private gzipPath;
     private tmpFilePath;
     private provider;
     /**
@@ -62,34 +69,19 @@ declare class Updater {
      */
     logger?: Logger;
     /**
-     * downloading progress hook
-     * @param progress download progress
-     * @example
-     * updater.onDownloading = ({ percent, total, current }) => {
-     *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
-     * }
-     */
-    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
+     * whether to receive beta update
      */
-    handleURL?: URLHandler;
+    receiveBeta?: boolean;
     /**
-     * whether receive beta version
+     * whether force update in DEV
      */
-    get receiveBeta(): boolean;
-    set receiveBeta(receiveBeta: boolean);
+    forceUpdate?: boolean;
     /**
      * initialize incremental updater
      * @param provider update provider
      * @param option UpdaterOption
      */
     constructor(provider: IProvider, option?: UpdaterOption);
-    private needUpdate;
     /**
      * this function is used to parse download data.
      * - if format is `'json'`
@@ -101,40 +93,45 @@ declare class Updater {
      * @param format 'json' or 'buffer'
      * @param data download URL or update json or buffer
      */
-    private parseData;
+    private fetch;
     /**
-     * check update info using default options
+     * handle error message and emit error event
      */
-    checkUpdate<T extends UpdateJSON>(): Promise<CheckResult<T>>;
+    private err;
     /**
-     * check update info using custom url
-     * @param url custom download URL of `updatejson`
+     * check update info using default options
      */
-    checkUpdate<T extends UpdateJSON>(url: string): Promise<CheckResult<T>>;
+    checkUpdate(): Promise<boolean>;
     /**
      * check update info using existing update json
      * @param data existing update json
      */
-    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
     /**
      * download update using default options
      */
-    download(): Promise<DownloadResult>;
-    /**
-     * download update using custom url
-     * @param url custom download URL
-     */
-    download(url: string): Promise<DownloadResult>;
+    download(): Promise<boolean>;
     /**
      * download update using existing `asar.gz` buffer and signature
      * @param data existing `asar.gz` buffer
      * @param sig signature
      */
-    download(data: Buffer, sig: string): Promise<DownloadResult>;
+    download(data: Uint8Array | Buffer, sig: string): Promise<boolean>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
+    /**
+     * setup provider URL handler
+     *
+     * @example
+     * updater.setURLHandler((url, isDownloadingAsar) => {
+     *   if (isDownloadingAsar) {
+     *     return url.replace('https://raw.githubusercontent.com', 'https://cdn.jsdelivr.net/gh')
+     *   }
+     * })
+     */
+    setURLHandler(handler: URLHandler): void;
 }
 
 type Promisable<T> = T | Promise<T>;
@@ -146,7 +143,7 @@ type Promisable<T> = T | Promise<T>;
  * @param logger logger
  * @default install(); logger.info(`update success!`)
  */
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger: Logger) => Promisable<void>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
     /**
      * update provider
@@ -165,13 +162,13 @@ interface AppOption {
      * @param mainFilePath main file path of `${app.name}.asar`
      * @param logger logger
      */
-    beforeStart?: (mainFilePath: string, logger: Logger) => Promisable<void>;
+    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;
+    onStartError?: (err: unknown, logger?: Logger) => void;
 }
 /**
  * utils for startuping with updater

package/dist/index.d.ts

@@ -1,15 +1,17 @@
-import { U as UpdateJSON } from './version-CffZWDhZ.js';
-import { O as OnDownloading, U as URLHandler, I as IProvider } from './types-seJf3Wbc.js';
+import { EventEmitter } from 'node:events';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.js';
+import { D as DownloadingInfo, I as IProvider, U as URLHandler } from './types-DxhNaNgR.js';
 import '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
     readonly download: "Download failed";
     readonly validate: "Validate failed";
     readonly param: "Missing params";
-    readonly version: "Unsatisfied version";
+    readonly network: "Network error";
 };
 declare class UpdaterError extends Error {
-    constructor(msg: typeof ErrorInfo[keyof typeof ErrorInfo], info: string);
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, info: string);
 }
 type CheckResult<T extends UpdateJSON> = {
     success: true;
@@ -49,12 +51,17 @@ interface UpdaterOption {
     logger?: Logger;
 }
 
-declare class Updater {
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-unavailable': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+}> {
     private CERT;
     private info?;
-    private options;
     private asarPath;
-    private gzipPath;
     private tmpFilePath;
     private provider;
     /**
@@ -62,34 +69,19 @@ declare class Updater {
      */
     logger?: Logger;
     /**
-     * downloading progress hook
-     * @param progress download progress
-     * @example
-     * updater.onDownloading = ({ percent, total, current }) => {
-     *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
-     * }
-     */
-    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
+     * whether to receive beta update
      */
-    handleURL?: URLHandler;
+    receiveBeta?: boolean;
     /**
-     * whether receive beta version
+     * whether force update in DEV
      */
-    get receiveBeta(): boolean;
-    set receiveBeta(receiveBeta: boolean);
+    forceUpdate?: boolean;
     /**
      * initialize incremental updater
      * @param provider update provider
      * @param option UpdaterOption
      */
     constructor(provider: IProvider, option?: UpdaterOption);
-    private needUpdate;
     /**
      * this function is used to parse download data.
      * - if format is `'json'`
@@ -101,40 +93,45 @@ declare class Updater {
      * @param format 'json' or 'buffer'
      * @param data download URL or update json or buffer
      */
-    private parseData;
+    private fetch;
     /**
-     * check update info using default options
+     * handle error message and emit error event
      */
-    checkUpdate<T extends UpdateJSON>(): Promise<CheckResult<T>>;
+    private err;
     /**
-     * check update info using custom url
-     * @param url custom download URL of `updatejson`
+     * check update info using default options
      */
-    checkUpdate<T extends UpdateJSON>(url: string): Promise<CheckResult<T>>;
+    checkUpdate(): Promise<boolean>;
     /**
      * check update info using existing update json
      * @param data existing update json
      */
-    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
     /**
      * download update using default options
      */
-    download(): Promise<DownloadResult>;
-    /**
-     * download update using custom url
-     * @param url custom download URL
-     */
-    download(url: string): Promise<DownloadResult>;
+    download(): Promise<boolean>;
     /**
      * download update using existing `asar.gz` buffer and signature
      * @param data existing `asar.gz` buffer
      * @param sig signature
      */
-    download(data: Buffer, sig: string): Promise<DownloadResult>;
+    download(data: Uint8Array | Buffer, sig: string): Promise<boolean>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
+    /**
+     * setup provider URL handler
+     *
+     * @example
+     * updater.setURLHandler((url, isDownloadingAsar) => {
+     *   if (isDownloadingAsar) {
+     *     return url.replace('https://raw.githubusercontent.com', 'https://cdn.jsdelivr.net/gh')
+     *   }
+     * })
+     */
+    setURLHandler(handler: URLHandler): void;
 }
 
 type Promisable<T> = T | Promise<T>;
@@ -146,7 +143,7 @@ type Promisable<T> = T | Promise<T>;
  * @param logger logger
  * @default install(); logger.info(`update success!`)
  */
-type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger: Logger) => Promisable<void>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
     /**
      * update provider
@@ -165,13 +162,13 @@ interface AppOption {
      * @param mainFilePath main file path of `${app.name}.asar`
      * @param logger logger
      */
-    beforeStart?: (mainFilePath: string, logger: Logger) => Promisable<void>;
+    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;
+    onStartError?: (err: unknown, logger?: Logger) => void;
 }
 /**
  * utils for startuping with updater