electron-incremental-update 2.0.0-beta.8 → 2.0.0

package/dist/index.d.cts

@@ -1,47 +1,156 @@
-import { U as Updater, a as UpdaterOption, L as Logger } from './core-ZUlLHadf.cjs';
-export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-ZUlLHadf.cjs';
-import { I as IProvider } from './types-CItP6bL-.cjs';
-import 'node:events';
-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-DkCn03M3.cjs';
+import { Promisable } from '@subframe7536/type-utils';
+
+declare const ErrorInfo: {
+    readonly download: "Download Failed";
+    readonly validate: "Validate Failed";
+    readonly param: "Missing Params";
+    readonly network: "Network Error";
+};
+declare class UpdaterError extends Error {
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, 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;
+}
+
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-not-available': [reason: string, data?: UpdateInfo];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+    'update-cancelled': any;
+}> {
+    private CERT;
+    private controller;
+    private info?;
+    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;
+    /**
+     * 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): 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>;
 
-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!`)
+ * @default install(); logger.info('update success!')
  */
 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>;
     /**
-     * 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;
 }
 /**
- * utils for startuping with updater
+ * Utils to startup with updater
  * @param fn startup function
  * @example
  * // in electron/main/index.ts
@@ -51,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, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, createElectronApp, initApp, startupWithUpdater };

package/dist/index.d.ts

@@ -1,47 +1,156 @@
-import { U as Updater, a as UpdaterOption, L as Logger } from './core-DJdvtwvU.js';
-export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-DJdvtwvU.js';
-import { I as IProvider } from './types-CItP6bL-.js';
-import 'node:events';
-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-BLdN9rkY.js';
+import { Promisable } from '@subframe7536/type-utils';
+
+declare const ErrorInfo: {
+    readonly download: "Download Failed";
+    readonly validate: "Validate Failed";
+    readonly param: "Missing Params";
+    readonly network: "Network Error";
+};
+declare class UpdaterError extends Error {
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, 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;
+}
+
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-not-available': [reason: string, data?: UpdateInfo];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+    'update-cancelled': any;
+}> {
+    private CERT;
+    private controller;
+    private info?;
+    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;
+    /**
+     * 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): 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>;
 
-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!`)
+ * @default install(); logger.info('update success!')
  */
 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>;
     /**
-     * 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;
 }
 /**
- * utils for startuping with updater
+ * Utils to startup with updater
  * @param fn startup function
  * @example
  * // in electron/main/index.ts
@@ -51,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, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, createElectronApp, initApp, startupWithUpdater };