electron-incremental-update 1.3.0 → 2.0.0-beta.10

package/dist/index.d.ts

@@ -1,148 +1,75 @@
-import { U as UpdateInfo, a as UpdateJSON } from './pure-GoN_3MEj.js';
+import { EventEmitter } from 'node:events';
+import { U as UpdateInfo, a as UpdateJSON } from './version-C4tF_trh.js';
+import { I as IProvider, D as DownloadingInfo } from './types-Bnc4jz6R.js';
+import '@subframe7536/type-utils';
 
 declare const ErrorInfo: {
-    readonly downlaod: "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 = UpdateInfo | undefined | UpdaterError;
-type DownloadResult = true | UpdaterError;
-type DownloadingInfo = {
-    /**
-     * downloaded percent, 0% - 100%
-     */
-    percent: `${number}%`;
-    /**
-     * total size
-     */
-    total: number;
-    /**
-     * downloaded size
-     */
-    current: number;
-};
-type Logger = {
+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 if version1 < version2
-     */
-    isLowerVersion?: (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 = {
+    error: (msg: string, e?: unknown) => void;
+}
+interface UpdaterOption {
     /**
-     * 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'
+     * Update provider, call setup later
      */
-    userAgent?: string;
+    provider?: IProvider;
     /**
-     * extra download header, `accept` and `user-agent` is set by default
-     */
-    extraHeader?: Record<string, string>;
-};
-interface UpdaterOption {
-    /**
-     * public key of signature, which will be auto generated by plugin,
+     * Certifaction 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
+     * Whether to receive beta update
      */
-    releaseAsarURL?: string;
+    receiveBeta?: boolean;
     /**
-     * whether to receive beta update
+     * Updater logger
      */
-    receiveBeta?: boolean;
-    overrideFunctions?: UpdaterOverrideFunctions;
-    downloadConfig?: UpdaterDownloadConfig;
+    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 option;
-    private asarPath;
-    private gzipPath;
-    private tmpFilePath;
+    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}`)
-     * }
+     * Whether to receive beta update
      */
-    onDownloading?: (progress: DownloadingInfo) => void;
+    receiveBeta?: boolean;
     /**
-     * whether receive beta version
+     * Whether force update in DEV
      */
-    get receiveBeta(): boolean;
-    set receiveBeta(receiveBeta: boolean);
+    forceUpdate?: boolean;
     /**
-     * initialize incremental updater
-     * @param option UpdaterOption
+     * Initialize incremental updater
+     * @param options UpdaterOption
      */
-    constructor(option?: UpdaterOption);
-    private needUpdate;
+    constructor(options?: UpdaterOption);
+    private checkProvider;
     /**
-     * this function is used to parse download data.
+     * 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
@@ -152,122 +79,74 @@ 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
-     * @returns
-     * - Available: `{size: number, version: string}`
-     * - Unavailable: `undefined`
-     * - Fail: `UpdaterError`
+     * Handle error message and emit error event
      */
-    checkUpdate(): Promise<CheckResult>;
+    private err;
     /**
-     * check update info using custom url
-     * @param url custom download URL of `updatejson`
-     * @returns
-     * - Available:`{size: number, version: string}`
-     * - Unavailable: `undefined`
-     * - Fail: `UpdaterError`
+     * Check update info using default options
      */
-    checkUpdate(url: string): Promise<CheckResult>;
+    checkUpdate(): Promise<boolean>;
     /**
-     * check update info using existing update json
+     * Check update info using existing update json
      * @param data existing update json
-     * @returns
-     * - Available:`{size: number, version: string}`
-     * - Unavailable: `undefined`
-     * - Fail: `UpdaterError`
      */
-    checkUpdate(data: UpdateJSON): Promise<CheckResult>;
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
     /**
-     * download update using default options
-     * @returns
-     * - Success: `true`
-     * - Fail: `UpdaterError`
+     * Download update using default options
      */
-    download(): Promise<DownloadResult>;
+    downloadUpdate(): Promise<boolean>;
     /**
-     * download update using custom url
-     * @param url custom download URL
-     * @returns
-     * - Success: `true`
-     * - Fail: `UpdaterError`
-     */
-    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
-     * @returns
-     * - Success: `true`
-     * - Fail: `UpdaterError`
+     * @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;
 }
-
-type Func = Required<UpdaterOverrideFunctions>;
-declare const downloadJSONDefault: Func['downloadJSON'];
-declare const downloadBufferDefault: Func['downloadBuffer'];
-
-declare const isLowerVersionDefault: Func['isLowerVersion'];
-
 /**
- * create updater instance
- * @param option updater option
- * @returns updater
+ * Auto check update, download and install
  */
-declare function createUpdater(option?: UpdaterOption): Updater;
+declare function autoUpdate(updater: Updater): Promise<void>;
 
 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>;
-type AppOption = {
+interface AppOption {
     /**
-     * updater options
+     * 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
+ * Utils to startup with updater
  * @param fn startup function
  * @example
  * // in electron/main/index.ts
@@ -279,26 +158,18 @@ declare function startupWithUpdater(fn: (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,
+ *     provider: new GitHubProvider({
+ *       username: 'jerry7536',
+ *       repo: 'electron2',
+ *     }),
+ *   },
+ *   beforeStart(mainFilePath, logger) {
+ *     logger?.debug(mainFilePath)
  *   },
- *   onStart: console.log
  * })
- * ```
  */
 declare function initApp(appOptions?: AppOption): Promise<void>;
 
-export { type AppOption, type CheckResult, type DownloadResult, type DownloadingInfo, ErrorInfo, type Func, type Logger, Updater, type UpdaterDownloadConfig, UpdaterError, type UpdaterOption, type UpdaterOverrideFunctions, createUpdater, downloadBufferDefault, downloadJSONDefault, initApp, isLowerVersionDefault, startupWithUpdater };
+export { type AppOption, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, initApp, startupWithUpdater };