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

package/dist/index.d.cts

@@ -1,35 +1,18 @@
-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';
+import { EventEmitter } from 'node:events';
+import { U as UpdateInfo, a as UpdateJSON } from './version-BYVQ367i.cjs';
+import { I as IProvider, D as DownloadingInfo } from './types-CGSkHX4Y.cjs';
+import { Promisable } from '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
-    readonly download: "Download failed";
-    readonly validate: "Validate failed";
-    readonly param: "Missing params";
-    readonly version: "Unsatisfied version";
+    readonly download: "Download Failed";
+    readonly validate: "Validate Failed";
+    readonly param: "Missing Params";
+    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;
-    data: Omit<T, 'beta'>;
-} | {
-    success: false;
-    /**
-     * minimal version that can update
-     */
-    data: string;
-} | {
-    success: false;
-    data: UpdaterError;
-};
-type DownloadResult = {
-    success: true;
-} | {
-    success: false;
-    data: UpdaterError;
-};
 interface Logger {
     info: (msg: string) => void;
     debug: (msg: string) => void;
@@ -38,143 +21,136 @@ interface Logger {
 }
 interface UpdaterOption {
     /**
-     * public key of signature, which will be auto generated by plugin,
+     * Update provider
+     *
+     * If you will not setup `UpdateJSON` or `Buffer` in params when checking update or download, this option is **required**
+     */
+    provider?: IProvider;
+    /**
+     * Certifaction key of signature, which will be auto generated by plugin,
      * generate by `selfsigned` if not set
      */
     SIGNATURE_CERT?: string;
     /**
-     * whether to receive beta update
+     * Whether to receive beta update
      */
     receiveBeta?: boolean;
+    /**
+     * Updater logger
+     */
     logger?: Logger;
 }
 
-declare class Updater {
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-not-available': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+    'update-cancelled': any;
+}> {
     private CERT;
+    private controller;
     private info?;
-    private options;
-    private asarPath;
-    private gzipPath;
-    private tmpFilePath;
-    private provider;
+    provider?: IProvider;
     /**
-     * updater logger
+     * Updater logger
      */
     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
+     * Initialize incremental updater
+     * @param options UpdaterOption
      */
-    constructor(provider: IProvider, option?: UpdaterOption);
-    private needUpdate;
+    constructor(options?: UpdaterOption);
     /**
-     * this function is used to parse download data.
-     * - if format is `'json'`
-     *   - if data is `UpdateJSON`, return it
-     *   - if data is string or absent, download URL data and return it
-     * - if format is `'buffer'`
-     *   - if data is `Buffer`, return it
-     *   - if data is string or absent, download URL data and return it
-     * @param format 'json' or 'buffer'
-     * @param data download URL or update json or buffer
+     * This function is used to parse download data.
+     *
+     * if data is absent, download URL from provider and return it,
+     * else if data is `UpdateJSON`, return it
      */
-    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>>;
+    checkForUpdates(): Promise<boolean>;
     /**
-     * check update info using existing update json
+     * Check update info using existing update json
      * @param data existing update json
      */
-    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    checkForUpdates(data: UpdateJSON): Promise<boolean>;
     /**
-     * download update using default options
+     * Download update using default options
      */
-    download(): Promise<DownloadResult>;
+    downloadUpdate(): Promise<boolean>;
     /**
-     * download update using custom url
-     * @param url custom download URL
-     */
-    download(url: string): Promise<DownloadResult>;
-    /**
-     * download update using existing `asar.gz` buffer and signature
+     * Download update using existing `asar.gz` buffer and signature
      * @param data existing `asar.gz` buffer
-     * @param sig signature
+     * @param info update info
      */
-    download(data: Buffer, sig: string): Promise<DownloadResult>;
+    downloadUpdate(data: Uint8Array, info: Omit<UpdateInfo, 'minimumVersion'>): Promise<boolean>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
+    cancel(): void;
 }
+/**
+ * Auto check update, download and install
+ */
+declare function autoUpdate(updater: Updater): Promise<void>;
 
-type Promisable<T> = T | Promise<T>;
 /**
- * hooks on rename temp asar path to `${app.name}.asar`
+ * 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>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
     /**
-     * update provider
+     * Path to index file that make {@link startupWithUpdater} as default export
+     *
+     * Generate from plugin configuration by default
      */
-    provider: IProvider;
+    mainPath?: string;
     /**
-     * updater options
+     * Updater options
      */
     updater?: (() => Promisable<Updater>) | UpdaterOption;
     /**
-     * hooks on rename temp asar path to `${app.name}.asar`
+     * Hooks on rename temp asar path to `${app.name}.asar`
      */
     onInstall?: OnInstallFunction;
     /**
-     * hooks before app start up
+     * Hooks before app startup
      * @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
+     * Hooks on app startup 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
+ * Utils to startup with updater
  * @param fn startup function
  * @example
  * // in electron/main/index.ts
@@ -184,28 +160,24 @@ interface AppOption {
  */
 declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>): (updater: Updater) => Promisable<void>;
 /**
- * initialize app
+ * Initialize Electron with updater
  * @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
+ * createElectronApp({
  *   updater: {
- *     SIGNATURE_CERT: 'custom certificate',
- *     repository,
- *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${app.name}.asar.gz`),
- *     receiveBeta: true,
+ *     provider: new GitHubProvider({
+ *       username: 'yourname',
+ *       repo: 'electron',
+ *     }),
+ *   },
+ *   beforeStart(mainFilePath, logger) {
+ *     logger?.debug(mainFilePath)
  *   },
- *   onStart: console.log
  * })
- * ```
  */
-declare function initApp(appOptions: AppOption): Promise<void>;
+declare function createElectronApp(appOptions?: AppOption): Promise<void>;
+/**
+ * @alias {@link createElectronApp}
+ */
+declare const initApp: typeof createElectronApp;
 
-export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, createElectronApp, initApp, startupWithUpdater };

package/dist/index.d.ts

@@ -1,35 +1,18 @@
-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';
+import { EventEmitter } from 'node:events';
+import { U as UpdateInfo, a as UpdateJSON } from './version-BYVQ367i.js';
+import { I as IProvider, D as DownloadingInfo } from './types-C8JhnJjU.js';
+import { Promisable } from '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
-    readonly download: "Download failed";
-    readonly validate: "Validate failed";
-    readonly param: "Missing params";
-    readonly version: "Unsatisfied version";
+    readonly download: "Download Failed";
+    readonly validate: "Validate Failed";
+    readonly param: "Missing Params";
+    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;
-    data: Omit<T, 'beta'>;
-} | {
-    success: false;
-    /**
-     * minimal version that can update
-     */
-    data: string;
-} | {
-    success: false;
-    data: UpdaterError;
-};
-type DownloadResult = {
-    success: true;
-} | {
-    success: false;
-    data: UpdaterError;
-};
 interface Logger {
     info: (msg: string) => void;
     debug: (msg: string) => void;
@@ -38,143 +21,136 @@ interface Logger {
 }
 interface UpdaterOption {
     /**
-     * public key of signature, which will be auto generated by plugin,
+     * Update provider
+     *
+     * If you will not setup `UpdateJSON` or `Buffer` in params when checking update or download, this option is **required**
+     */
+    provider?: IProvider;
+    /**
+     * Certifaction key of signature, which will be auto generated by plugin,
      * generate by `selfsigned` if not set
      */
     SIGNATURE_CERT?: string;
     /**
-     * whether to receive beta update
+     * Whether to receive beta update
      */
     receiveBeta?: boolean;
+    /**
+     * Updater logger
+     */
     logger?: Logger;
 }
 
-declare class Updater {
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-not-available': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+    'update-cancelled': any;
+}> {
     private CERT;
+    private controller;
     private info?;
-    private options;
-    private asarPath;
-    private gzipPath;
-    private tmpFilePath;
-    private provider;
+    provider?: IProvider;
     /**
-     * updater logger
+     * Updater logger
      */
     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
+     * Initialize incremental updater
+     * @param options UpdaterOption
      */
-    constructor(provider: IProvider, option?: UpdaterOption);
-    private needUpdate;
+    constructor(options?: UpdaterOption);
     /**
-     * this function is used to parse download data.
-     * - if format is `'json'`
-     *   - if data is `UpdateJSON`, return it
-     *   - if data is string or absent, download URL data and return it
-     * - if format is `'buffer'`
-     *   - if data is `Buffer`, return it
-     *   - if data is string or absent, download URL data and return it
-     * @param format 'json' or 'buffer'
-     * @param data download URL or update json or buffer
+     * This function is used to parse download data.
+     *
+     * if data is absent, download URL from provider and return it,
+     * else if data is `UpdateJSON`, return it
      */
-    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>>;
+    checkForUpdates(): Promise<boolean>;
     /**
-     * check update info using existing update json
+     * Check update info using existing update json
      * @param data existing update json
      */
-    checkUpdate<T extends UpdateJSON>(data: T): Promise<CheckResult<T>>;
+    checkForUpdates(data: UpdateJSON): Promise<boolean>;
     /**
-     * download update using default options
+     * Download update using default options
      */
-    download(): Promise<DownloadResult>;
+    downloadUpdate(): Promise<boolean>;
     /**
-     * download update using custom url
-     * @param url custom download URL
-     */
-    download(url: string): Promise<DownloadResult>;
-    /**
-     * download update using existing `asar.gz` buffer and signature
+     * Download update using existing `asar.gz` buffer and signature
      * @param data existing `asar.gz` buffer
-     * @param sig signature
+     * @param info update info
      */
-    download(data: Buffer, sig: string): Promise<DownloadResult>;
+    downloadUpdate(data: Uint8Array, info: Omit<UpdateInfo, 'minimumVersion'>): Promise<boolean>;
     /**
      * quit App and install
      */
     quitAndInstall(): void;
+    cancel(): void;
 }
+/**
+ * Auto check update, download and install
+ */
+declare function autoUpdate(updater: Updater): Promise<void>;
 
-type Promisable<T> = T | Promise<T>;
 /**
- * hooks on rename temp asar path to `${app.name}.asar`
+ * 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>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
     /**
-     * update provider
+     * Path to index file that make {@link startupWithUpdater} as default export
+     *
+     * Generate from plugin configuration by default
      */
-    provider: IProvider;
+    mainPath?: string;
     /**
-     * updater options
+     * Updater options
      */
     updater?: (() => Promisable<Updater>) | UpdaterOption;
     /**
-     * hooks on rename temp asar path to `${app.name}.asar`
+     * Hooks on rename temp asar path to `${app.name}.asar`
      */
     onInstall?: OnInstallFunction;
     /**
-     * hooks before app start up
+     * Hooks before app startup
      * @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
+     * Hooks on app startup 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
+ * Utils to startup with updater
  * @param fn startup function
  * @example
  * // in electron/main/index.ts
@@ -184,28 +160,24 @@ interface AppOption {
  */
 declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>): (updater: Updater) => Promisable<void>;
 /**
- * initialize app
+ * Initialize Electron with updater
  * @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
+ * createElectronApp({
  *   updater: {
- *     SIGNATURE_CERT: 'custom certificate',
- *     repository,
- *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${app.name}.asar.gz`),
- *     receiveBeta: true,
+ *     provider: new GitHubProvider({
+ *       username: 'yourname',
+ *       repo: 'electron',
+ *     }),
+ *   },
+ *   beforeStart(mainFilePath, logger) {
+ *     logger?.debug(mainFilePath)
  *   },
- *   onStart: console.log
  * })
- * ```
  */
-declare function initApp(appOptions: AppOption): Promise<void>;
+declare function createElectronApp(appOptions?: AppOption): Promise<void>;
+/**
+ * @alias {@link createElectronApp}
+ */
+declare const initApp: typeof createElectronApp;
 
-export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, createElectronApp, initApp, startupWithUpdater };