electron-incremental-update 2.4.2 → 3.0.0-beta.2

package/dist/index.d.cts

@@ -1,194 +1,204 @@
-import { U as UpdateInfo, I as IProvider, D as DownloadingInfo, a as UpdateJSON, b as UpdateJSONWithURL } from './types-CU7GyVez.cjs';
-import { Promisable } from '@subframe7536/type-utils';
-import { EventEmitter } from 'node:events';
-import 'node:url';
+import { a as UpdateJSONWithURL, m as Promisable, n as IProvider, o as UpdateInfo, s as UpdateJSON, t as DownloadingInfo } from "./types-BM9Jfu7q.cjs";
+import { EventEmitter } from "node:events";
 
-type UpdaterErrorCode = 'ERR_DOWNLOAD' | 'ERR_VALIDATE' | 'ERR_PARAM' | 'ERR_NETWORK';
-type UpdaterUnavailableCode = 'UNAVAILABLE_ERROR' | 'UNAVAILABLE_DEV' | 'UNAVAILABLE_VERSION';
+//#region src/entry/types.d.ts
+type UpdaterErrorCode = "ERR_DOWNLOAD" | "ERR_VALIDATE" | "ERR_PARAM" | "ERR_NETWORK";
+type UpdaterUnavailableCode = "UNAVAILABLE_ERROR" | "UNAVAILABLE_DEV" | "UNAVAILABLE_VERSION";
 declare class UpdaterError extends Error {
-    code: UpdaterErrorCode;
-    constructor(code: UpdaterErrorCode, info: string);
+  code: UpdaterErrorCode;
+  constructor(code: UpdaterErrorCode, info: string);
 }
 interface Logger {
-    info: (msg: string) => void;
-    debug: (msg: string) => void;
-    warn: (msg: string) => void;
-    error: (msg: string, e?: unknown) => void;
+  info: (msg: string) => void;
+  debug: (msg: string) => void;
+  warn: (msg: string) => void;
+  error: (msg: string, e?: unknown) => void;
 }
 interface UpdaterOption {
-    /**
-     * 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
-     */
-    receiveBeta?: boolean;
-    /**
-     * Updater logger
-     */
-    logger?: Logger;
+  /**
+  * 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
+  */
+  receiveBeta?: boolean;
+  /**
+  * Updater logger
+  */
+  logger?: Logger;
 }
 /**
- * Update info with current app version and entry version
- */
+* Update info with current app version and entry version
+*/
 type UpdateInfoWithExtraVersion = UpdateInfo & {
-    /**
-     * Current app version
-     */
-    appVersion: string;
-    /**
-     * Current entry version
-     */
-    entryVersion: string;
+  /**
+  * Current app version
+  */
+  appVersion: string;
+  /**
+  * Current entry version
+  */
+  entryVersion: string;
 };
-
+//#endregion
+//#region src/entry/updater.d.ts
 declare class Updater<T extends UpdateInfoWithExtraVersion = UpdateInfoWithExtraVersion> extends EventEmitter<{
-    'update-available': [data: T];
-    'update-not-available': [code: UpdaterUnavailableCode, msg: string, info?: T];
-    'error': [error: UpdaterError];
-    'download-progress': [info: DownloadingInfo];
-    'update-downloaded': [];
-    'update-cancelled': [];
+  "update-available": [data: T];
+  "update-not-available": [code: UpdaterUnavailableCode, msg: string, info?: T];
+  error: [error: UpdaterError];
+  "download-progress": [info: DownloadingInfo];
+  "update-downloaded": [];
+  "update-cancelled": [];
 }> {
-    private CERT;
-    private controller;
-    private info?;
-    private tmpFilePath?;
-    private processing;
-    provider?: IProvider;
-    /**
-     * Updater logger
-     */
-    logger?: Logger;
-    /**
-     * Whether to receive beta update
-     */
-    receiveBeta?: boolean;
-    /**
-     * Whether force update in DEV
-     */
-    forceUpdate?: boolean;
-    /**
-     * Initialize incremental updater
-     * @param options UpdaterOption
-     */
-    constructor(options?: UpdaterOption);
-    /**
-     * 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 fetch;
-    private cleanup;
-    /**
-     * Handle error message and emit error event
-     */
-    private err;
-    /**
-     * Check update info using default options
-     */
-    checkForUpdates(): Promise<boolean>;
-    /**
-     * Check update info using existing update json
-     * @param data existing update json
-     */
-    checkForUpdates(data: UpdateJSON | UpdateJSONWithURL): Promise<boolean>;
-    /**
-     * Download update using default options
-     */
-    downloadUpdate(): Promise<boolean>;
-    /**
-     * Download update using existing `asar.gz` buffer and signature
-     * @param data existing `asar.gz` buffer
-     * @param info update info
-     */
-    downloadUpdate(data: Uint8Array, info: Omit<UpdateInfo, 'minimumVersion'>): Promise<boolean>;
-    /**
-     * quit App and install
-     */
-    quitAndInstall(): void;
-    cancel(): void;
+  private CERT;
+  private controller;
+  private info?;
+  private tmpFilePath?;
+  private processing;
+  provider?: IProvider;
+  /**
+  * Updater logger
+  */
+  logger?: Logger;
+  /**
+  * Whether to receive beta update
+  */
+  receiveBeta?: boolean;
+  /**
+  * Whether force update in DEV
+  */
+  forceUpdate?: boolean;
+  /**
+  * Initialize incremental updater
+  * @param options UpdaterOption
+  */
+  constructor(options?: UpdaterOption);
+  /**
+  * 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 fetch;
+  /**
+  * This function is used to parse download data.
+  *
+  * if data is absent, download URL from provider and return it,
+  * else if data is `Buffer`, return it
+  * @param format 'json' or 'buffer'
+  * @param data download URL or update json or buffer
+  */
+  private fetch;
+  private cleanup;
+  /**
+  * Handle error message and emit error event
+  */
+  private err;
+  /**
+  * Check update info using default options
+  */
+  checkForUpdates(): Promise<boolean>;
+  /**
+  * Check update info using existing update json
+  * @param data existing update json
+  */
+  checkForUpdates(data: UpdateJSON | UpdateJSONWithURL): Promise<boolean>;
+  /**
+  * Download update using default options
+  */
+  downloadUpdate(): Promise<boolean>;
+  /**
+  * Download update using existing `asar.gz` buffer and signature
+  * @param data existing `asar.gz` buffer
+  * @param info update info
+  */
+  downloadUpdate(data: Uint8Array, info: Omit<UpdateInfo, "minimumVersion">): Promise<boolean>;
+  /**
+  * quit App and install
+  */
+  quitAndInstall(): void;
+  cancel(): void;
 }
 /**
- * Auto check update, download and install
- */
+* Auto check update, download and install
+*/
 declare function autoUpdate(updater: Updater): Promise<void>;
-
+//#endregion
+//#region src/entry/core.d.ts
 /**
- * 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!')
- */
+* 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 {
-    /**
-     * Path to index file that make {@link startupWithUpdater} as default export
-     *
-     * Generate from plugin configuration by default
-     */
-    mainPath?: string;
-    /**
-     * Updater options
-     */
-    updater?: (() => Promisable<Updater>) | UpdaterOption;
-    /**
-     * Hooks on rename temp asar path to `${app.name}.asar`
-     */
-    onInstall?: OnInstallFunction;
-    /**
-     * Hooks before app startup
-     * @param mainFilePath main file path of `${app.name}.asar`
-     * @param logger logger
-     */
-    beforeStart?: (mainFilePath: string, logger?: Logger) => Promisable<void>;
-    /**
-     * Hooks on app startup error
-     * @param err installing or startup error
-     * @param logger logger
-     */
-    onStartError?: (err: unknown, logger?: Logger) => void;
+  /**
+  * Path to index file that make {@link startupWithUpdater} as default export
+  *
+  * Generate from plugin configuration by default
+  */
+  mainPath?: string;
+  /**
+  * Updater options
+  */
+  updater?: (() => Promisable<Updater>) | UpdaterOption;
+  /**
+  * Hooks on rename temp asar path to `${app.name}.asar`
+  */
+  onInstall?: OnInstallFunction;
+  /**
+  * Hooks before app startup
+  * @param mainFilePath main file path of `${app.name}.asar`
+  * @param logger logger
+  */
+  beforeStart?: (mainFilePath: string, logger?: Logger) => Promisable<void>;
+  /**
+  * Hooks on app startup error
+  * @param err installing or startup error
+  * @param logger logger
+  */
+  onStartError?: (err: unknown, logger?: Logger) => void;
 }
 /**
- * Utils to startup with updater
- * @param fn startup function
- * @example
- * // in electron/main/index.ts
- * export default startupWithUpdater((updater) => {
- *   updater.checkUpdate()
- * })
- */
+* Utils to startup 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 Electron with updater
- * @example
- * createElectronApp({
- *   updater: {
- *     provider: new GitHubProvider({
- *       username: 'yourname',
- *       repo: 'electron',
- *     }),
- *   },
- *   beforeStart(mainFilePath, logger) {
- *     logger?.debug(mainFilePath)
- *   },
- * })
- */
+* Initialize Electron with updater
+* @example
+* createElectronApp({
+*   updater: {
+*     provider: new GitHubProvider({
+*       username: 'yourname',
+*       repo: 'electron',
+*     }),
+*   },
+*   beforeStart(mainFilePath, logger) {
+*     logger?.debug(mainFilePath)
+*   },
+* })
+*/
 declare function createElectronApp(appOptions?: AppOption): Promise<void>;
 /**
- * @alias {@link createElectronApp}
- */
+* @deprecated Use {@link createElectronApp} instead
+*/
 declare const initApp: typeof createElectronApp;
-
-export { type AppOption, type Logger, type UpdateInfoWithExtraVersion, Updater, UpdaterError, type UpdaterErrorCode, type UpdaterOption, type UpdaterUnavailableCode, autoUpdate, createElectronApp, initApp, startupWithUpdater };
+//#endregion
+export { AppOption, Logger, UpdateInfoWithExtraVersion, Updater, UpdaterError, UpdaterErrorCode, UpdaterOption, UpdaterUnavailableCode, autoUpdate, createElectronApp, initApp, startupWithUpdater };

package/dist/index.d.mts

@@ -0,0 +1,204 @@
+import { a as UpdateJSONWithURL, m as Promisable, n as IProvider, o as UpdateInfo, s as UpdateJSON, t as DownloadingInfo } from "./types-DASqEPXE.mjs";
+import { EventEmitter } from "node:events";
+
+//#region src/entry/types.d.ts
+type UpdaterErrorCode = "ERR_DOWNLOAD" | "ERR_VALIDATE" | "ERR_PARAM" | "ERR_NETWORK";
+type UpdaterUnavailableCode = "UNAVAILABLE_ERROR" | "UNAVAILABLE_DEV" | "UNAVAILABLE_VERSION";
+declare class UpdaterError extends Error {
+  code: UpdaterErrorCode;
+  constructor(code: UpdaterErrorCode, info: string);
+}
+interface Logger {
+  info: (msg: string) => void;
+  debug: (msg: string) => void;
+  warn: (msg: string) => void;
+  error: (msg: string, e?: unknown) => void;
+}
+interface UpdaterOption {
+  /**
+  * 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
+  */
+  receiveBeta?: boolean;
+  /**
+  * Updater logger
+  */
+  logger?: Logger;
+}
+/**
+* Update info with current app version and entry version
+*/
+type UpdateInfoWithExtraVersion = UpdateInfo & {
+  /**
+  * Current app version
+  */
+  appVersion: string;
+  /**
+  * Current entry version
+  */
+  entryVersion: string;
+};
+//#endregion
+//#region src/entry/updater.d.ts
+declare class Updater<T extends UpdateInfoWithExtraVersion = UpdateInfoWithExtraVersion> extends EventEmitter<{
+  "update-available": [data: T];
+  "update-not-available": [code: UpdaterUnavailableCode, msg: string, info?: T];
+  error: [error: UpdaterError];
+  "download-progress": [info: DownloadingInfo];
+  "update-downloaded": [];
+  "update-cancelled": [];
+}> {
+  private CERT;
+  private controller;
+  private info?;
+  private tmpFilePath?;
+  private processing;
+  provider?: IProvider;
+  /**
+  * Updater logger
+  */
+  logger?: Logger;
+  /**
+  * Whether to receive beta update
+  */
+  receiveBeta?: boolean;
+  /**
+  * Whether force update in DEV
+  */
+  forceUpdate?: boolean;
+  /**
+  * Initialize incremental updater
+  * @param options UpdaterOption
+  */
+  constructor(options?: UpdaterOption);
+  /**
+  * 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 fetch;
+  /**
+  * This function is used to parse download data.
+  *
+  * if data is absent, download URL from provider and return it,
+  * else if data is `Buffer`, return it
+  * @param format 'json' or 'buffer'
+  * @param data download URL or update json or buffer
+  */
+  private fetch;
+  private cleanup;
+  /**
+  * Handle error message and emit error event
+  */
+  private err;
+  /**
+  * Check update info using default options
+  */
+  checkForUpdates(): Promise<boolean>;
+  /**
+  * Check update info using existing update json
+  * @param data existing update json
+  */
+  checkForUpdates(data: UpdateJSON | UpdateJSONWithURL): Promise<boolean>;
+  /**
+  * Download update using default options
+  */
+  downloadUpdate(): Promise<boolean>;
+  /**
+  * Download update using existing `asar.gz` buffer and signature
+  * @param data existing `asar.gz` buffer
+  * @param info update info
+  */
+  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>;
+//#endregion
+//#region src/entry/core.d.ts
+/**
+* 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 {
+  /**
+  * Path to index file that make {@link startupWithUpdater} as default export
+  *
+  * Generate from plugin configuration by default
+  */
+  mainPath?: string;
+  /**
+  * Updater options
+  */
+  updater?: (() => Promisable<Updater>) | UpdaterOption;
+  /**
+  * Hooks on rename temp asar path to `${app.name}.asar`
+  */
+  onInstall?: OnInstallFunction;
+  /**
+  * Hooks before app startup
+  * @param mainFilePath main file path of `${app.name}.asar`
+  * @param logger logger
+  */
+  beforeStart?: (mainFilePath: string, logger?: Logger) => Promisable<void>;
+  /**
+  * Hooks on app startup error
+  * @param err installing or startup error
+  * @param logger logger
+  */
+  onStartError?: (err: unknown, logger?: Logger) => void;
+}
+/**
+* Utils to startup 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 Electron with updater
+* @example
+* createElectronApp({
+*   updater: {
+*     provider: new GitHubProvider({
+*       username: 'yourname',
+*       repo: 'electron',
+*     }),
+*   },
+*   beforeStart(mainFilePath, logger) {
+*     logger?.debug(mainFilePath)
+*   },
+* })
+*/
+declare function createElectronApp(appOptions?: AppOption): Promise<void>;
+/**
+* @deprecated Use {@link createElectronApp} instead
+*/
+declare const initApp: typeof createElectronApp;
+//#endregion
+export { AppOption, Logger, UpdateInfoWithExtraVersion, Updater, UpdaterError, UpdaterErrorCode, UpdaterOption, UpdaterUnavailableCode, autoUpdate, createElectronApp, initApp, startupWithUpdater };