electron-incremental-update 0.9.1 → 1.0.1

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { U as UpdateJSON } from './updateJson-synsK-Pt.mjs';
+import { U as UpdateInfo, a as UpdateJSON } from './noDep-TvZoKVF8.mjs';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -13,18 +13,15 @@ declare class VerifyFailedError extends Error {
 declare class DownloadError extends Error {
     constructor(msg: string);
 }
+type CheckResult = UpdateInfo | undefined | CheckResultError;
 type CheckResultError = MinimumVersionError | DownloadError | TypeError | Error;
-type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
-type CheckResultType = {
-    size: number;
-    version: string;
-} | undefined | CheckResultError;
 type DownloadResult = true | DownloadResultError;
+type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
 type DownloadingInfo = {
     /**
      * downloaded percent, 0% - 100%
      */
-    percent: string;
+    percent: `${number}%`;
     /**
      * total size
      */
@@ -40,47 +37,6 @@ type Logger = {
     warn: (msg: string) => void;
     error: (msg: string, e?: Error) => void;
 };
-interface Updater {
-    /**
-     * the name of the product, also the basename of the asar
-     */
-    productName: string;
-    /**
-     * whether receive beta version
-     */
-    receiveBeta: boolean;
-    /**
-     * check update info
-     * @param data update json url or object
-     * @returns
-     * - `{size: number, version: string}`: available
-     * - `undefined`: unavailable
-     * - `CheckResultError`: fail
-     */
-    checkUpdate: (data?: string | UpdateJSON) => Promise<CheckResultType>;
-    /**
-     * download update
-     *
-     * if you want to update **offline**, you can set both `src` and `sig` to verify and install
-     * @param data asar download url or buffer
-     * @param sig signature
-     * @returns
-     * - `true`: success
-     * - `DownloadResultError`: fail
-     */
-    download: (data?: string | Buffer, sig?: string) => Promise<DownloadResult>;
-    /**
-     * log function
-     * @param data log info
-     */
-    logger?: Logger;
-    /**
-     * download progress function
-     * @param progress download progress info
-     * @returns void
-     */
-    onDownloading?: (progress: DownloadingInfo) => void;
-}
 type UpdaterOverrideFunctions = {
     /**
      * custom version compare function
@@ -130,7 +86,7 @@ interface UpdaterOption {
      * public key of signature, which will be auto generated by plugin
      * @example
      * ```ts
-     * // auto filled by plugin
+     * // just empty here, auto filled by plugin
      * const SIGNATURE_CERT = ''
      *
      * const updater = createUpdater({
@@ -140,12 +96,6 @@ interface UpdaterOption {
      * ```
      */
     SIGNATURE_CERT: string;
-    /**
-     * name of your application, you can use the `name` in `package.json`
-     *
-     * @default DEFAULT_APP_NAME
-     */
-    productName?: string;
     /**
      * repository url, e.g. `https://github.com/electron/electron`
      *
@@ -163,7 +113,7 @@ interface UpdaterOption {
     updateJsonURL?: string;
     /**
      * URL of release asar.gz
-     * @default `${repository}/releases/download/v${version}/${productName}-${version}.asar.gz`
+     * @default `${repository}/releases/download/v${version}/${app.name}-${version}.asar.gz`
      * @throws if `releaseAsarURL` and `repository` are all not set
      */
     releaseAsarURL?: string;
@@ -175,35 +125,89 @@ interface UpdaterOption {
     downloadConfig?: UpdaterDownloadConfig;
 }
 
-declare class IncrementalUpdater implements Updater {
+declare class Updater {
     private info?;
     private option;
     private asarPath;
     private gzipPath;
     private tmpFilePath;
+    /**
+     * 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?: (progress: DownloadingInfo) => void;
-    get productName(): string;
+    /**
+     * whether receive beta version
+     */
     get receiveBeta(): boolean;
     set receiveBeta(receiveBeta: boolean);
+    /**
+     * initialize incremental updater
+     * @param option UpdaterOption
+     */
     constructor(option: UpdaterOption);
     private needUpdate;
+    /**
+     * 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
+     */
     private parseData;
-    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
-    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
+    /**
+     * check update info
+     *
+     * if you want to update **offline**, you can set `data` and `sig` add update info
+     * @param data custom download URL of `updatejson` or existing update json
+     * @returns
+     * - Available:`{size: number, version: string}`
+     * - Unavailable: `undefined`
+     * - Fail: `CheckResultError`
+     */
+    checkUpdate(data?: string | UpdateJSON): Promise<CheckResult>;
+    /**
+     * download update
+     *
+     * if you want to update **offline**, you can set both `data` and `sig` to verify and install
+     * @param data custom download URL of `asar.gz` or existing `asar.gz` buffer
+     * @param sig signature
+     * @returns
+     * - `true`: success
+     * - `DownloadResultError`: fail
+     */
+    download(data?: Buffer, sig?: string): Promise<DownloadResult>;
+    /**
+     * quit App and install
+     */
+    quitAndInstall(): void;
 }
+
 /**
  * create updater instance
  * @param option updater option
  * @returns updater
  */
-declare function createUpdater(option: UpdaterOption): IncrementalUpdater;
+declare function createUpdater(option: UpdaterOption): Updater;
 
 type Promisable<T> = T | Promise<T>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 type AppOption = {
     /**
      * path of electron output dist when in development
-     * @default 'dist-electron'
+     * @default '../dist-electron'
      */
     electronDevDistPath?: string;
     /**
@@ -211,53 +215,71 @@ type AppOption = {
      * @default 'main/index.js'
      */
     mainPath?: string;
+    /**
+     * update hooks
+     */
     hooks?: {
         /**
-         * hooks before replace the old asar is replaced by the new asar
-         *
-         * @param oldAsarPath old asar path
-         * @param updateTempAsarPath new asar path, end with .tmp
+         * 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!`)
          */
-        beforeDoUpdate?: (oldAsarPath: string, updateTempAsarPath: string) => Promisable<void>;
+        onInstall?: OnInstallFunction;
         /**
-         * hooks before start up
+         * hooks before start
+         * @param appNameAsarPath path of `${app.name}.asar`
+         * @param logger logger
          */
-        beforeStart?: (productAsarPath: string) => Promisable<void>;
+        beforeStart?: (appNameAsarPath: string, logger?: Logger) => Promisable<void>;
         /**
          * hooks on start up error
+         * @param err installing or startup error
+         * @param logger logger
          */
-        onStartError?: (err: unknown) => void;
+        onStartError?: (err: unknown, logger?: Logger) => void;
     };
 };
-type StartupWithUpdater = (updater: Updater) => void;
-type SetUpdater = {
+/**
+ * utils for startuping 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>;
+type StartupWithUpdater = {
     /**
-     * set updater option or create function
+     * starup app
+     * @param updater updater option or create function
      */
-    setUpdater: (updater: (() => Promisable<Updater>) | UpdaterOption) => void;
+    startupWithUpdater: (updater: (() => Promisable<Updater>) | UpdaterOption) => void;
 };
 /**
  * initialize app
  * @example
  * ```ts
  * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
- * import { name, repository } from '../package.json'
+ * import { repository } from '../package.json'
  *
  * const SIGNATURE_CERT = '' // auto generate certificate when start app
  * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
  * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
  * initApp({ onStart: console.log })
  *   // can be updater option or function that return updater
- *   .setUpdater({
+ *   .startupWithUpdater({
  *     SIGNATURE_CERT,
- *     productName: name,
  *     repository,
  *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
+ *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${app.name}.asar.gz`),
  *     receiveBeta: true,
  *   })
  * ```
  */
-declare function initApp(appOptions?: AppOption): SetUpdater;
+declare function initApp(appOptions?: AppOption): StartupWithUpdater;
 
-export { type AppOption, IncrementalUpdater, type StartupWithUpdater, type Updater, type UpdaterOption, createUpdater, initApp };
+export { type AppOption, type CheckResult, type CheckResultError, DownloadError, type DownloadResult, type DownloadResultError, type DownloadingInfo, type Logger, MinimumVersionError, Updater, type UpdaterDownloadConfig, type UpdaterOption, type UpdaterOverrideFunctions, VerifyFailedError, createUpdater, initApp, startupWithUpdater };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { U as UpdateJSON } from './updateJson-synsK-Pt.js';
+import { U as UpdateInfo, a as UpdateJSON } from './noDep-TvZoKVF8.js';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -13,18 +13,15 @@ declare class VerifyFailedError extends Error {
 declare class DownloadError extends Error {
     constructor(msg: string);
 }
+type CheckResult = UpdateInfo | undefined | CheckResultError;
 type CheckResultError = MinimumVersionError | DownloadError | TypeError | Error;
-type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
-type CheckResultType = {
-    size: number;
-    version: string;
-} | undefined | CheckResultError;
 type DownloadResult = true | DownloadResultError;
+type DownloadResultError = DownloadError | VerifyFailedError | TypeError | Error;
 type DownloadingInfo = {
     /**
      * downloaded percent, 0% - 100%
      */
-    percent: string;
+    percent: `${number}%`;
     /**
      * total size
      */
@@ -40,47 +37,6 @@ type Logger = {
     warn: (msg: string) => void;
     error: (msg: string, e?: Error) => void;
 };
-interface Updater {
-    /**
-     * the name of the product, also the basename of the asar
-     */
-    productName: string;
-    /**
-     * whether receive beta version
-     */
-    receiveBeta: boolean;
-    /**
-     * check update info
-     * @param data update json url or object
-     * @returns
-     * - `{size: number, version: string}`: available
-     * - `undefined`: unavailable
-     * - `CheckResultError`: fail
-     */
-    checkUpdate: (data?: string | UpdateJSON) => Promise<CheckResultType>;
-    /**
-     * download update
-     *
-     * if you want to update **offline**, you can set both `src` and `sig` to verify and install
-     * @param data asar download url or buffer
-     * @param sig signature
-     * @returns
-     * - `true`: success
-     * - `DownloadResultError`: fail
-     */
-    download: (data?: string | Buffer, sig?: string) => Promise<DownloadResult>;
-    /**
-     * log function
-     * @param data log info
-     */
-    logger?: Logger;
-    /**
-     * download progress function
-     * @param progress download progress info
-     * @returns void
-     */
-    onDownloading?: (progress: DownloadingInfo) => void;
-}
 type UpdaterOverrideFunctions = {
     /**
      * custom version compare function
@@ -130,7 +86,7 @@ interface UpdaterOption {
      * public key of signature, which will be auto generated by plugin
      * @example
      * ```ts
-     * // auto filled by plugin
+     * // just empty here, auto filled by plugin
      * const SIGNATURE_CERT = ''
      *
      * const updater = createUpdater({
@@ -140,12 +96,6 @@ interface UpdaterOption {
      * ```
      */
     SIGNATURE_CERT: string;
-    /**
-     * name of your application, you can use the `name` in `package.json`
-     *
-     * @default DEFAULT_APP_NAME
-     */
-    productName?: string;
     /**
      * repository url, e.g. `https://github.com/electron/electron`
      *
@@ -163,7 +113,7 @@ interface UpdaterOption {
     updateJsonURL?: string;
     /**
      * URL of release asar.gz
-     * @default `${repository}/releases/download/v${version}/${productName}-${version}.asar.gz`
+     * @default `${repository}/releases/download/v${version}/${app.name}-${version}.asar.gz`
      * @throws if `releaseAsarURL` and `repository` are all not set
      */
     releaseAsarURL?: string;
@@ -175,35 +125,89 @@ interface UpdaterOption {
     downloadConfig?: UpdaterDownloadConfig;
 }
 
-declare class IncrementalUpdater implements Updater {
+declare class Updater {
     private info?;
     private option;
     private asarPath;
     private gzipPath;
     private tmpFilePath;
+    /**
+     * 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?: (progress: DownloadingInfo) => void;
-    get productName(): string;
+    /**
+     * whether receive beta version
+     */
     get receiveBeta(): boolean;
     set receiveBeta(receiveBeta: boolean);
+    /**
+     * initialize incremental updater
+     * @param option UpdaterOption
+     */
     constructor(option: UpdaterOption);
     private needUpdate;
+    /**
+     * 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
+     */
     private parseData;
-    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
-    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
+    /**
+     * check update info
+     *
+     * if you want to update **offline**, you can set `data` and `sig` add update info
+     * @param data custom download URL of `updatejson` or existing update json
+     * @returns
+     * - Available:`{size: number, version: string}`
+     * - Unavailable: `undefined`
+     * - Fail: `CheckResultError`
+     */
+    checkUpdate(data?: string | UpdateJSON): Promise<CheckResult>;
+    /**
+     * download update
+     *
+     * if you want to update **offline**, you can set both `data` and `sig` to verify and install
+     * @param data custom download URL of `asar.gz` or existing `asar.gz` buffer
+     * @param sig signature
+     * @returns
+     * - `true`: success
+     * - `DownloadResultError`: fail
+     */
+    download(data?: Buffer, sig?: string): Promise<DownloadResult>;
+    /**
+     * quit App and install
+     */
+    quitAndInstall(): void;
 }
+
 /**
  * create updater instance
  * @param option updater option
  * @returns updater
  */
-declare function createUpdater(option: UpdaterOption): IncrementalUpdater;
+declare function createUpdater(option: UpdaterOption): Updater;
 
 type Promisable<T> = T | Promise<T>;
+type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 type AppOption = {
     /**
      * path of electron output dist when in development
-     * @default 'dist-electron'
+     * @default '../dist-electron'
      */
     electronDevDistPath?: string;
     /**
@@ -211,53 +215,71 @@ type AppOption = {
      * @default 'main/index.js'
      */
     mainPath?: string;
+    /**
+     * update hooks
+     */
     hooks?: {
         /**
-         * hooks before replace the old asar is replaced by the new asar
-         *
-         * @param oldAsarPath old asar path
-         * @param updateTempAsarPath new asar path, end with .tmp
+         * 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!`)
          */
-        beforeDoUpdate?: (oldAsarPath: string, updateTempAsarPath: string) => Promisable<void>;
+        onInstall?: OnInstallFunction;
         /**
-         * hooks before start up
+         * hooks before start
+         * @param appNameAsarPath path of `${app.name}.asar`
+         * @param logger logger
          */
-        beforeStart?: (productAsarPath: string) => Promisable<void>;
+        beforeStart?: (appNameAsarPath: string, logger?: Logger) => Promisable<void>;
         /**
          * hooks on start up error
+         * @param err installing or startup error
+         * @param logger logger
          */
-        onStartError?: (err: unknown) => void;
+        onStartError?: (err: unknown, logger?: Logger) => void;
     };
 };
-type StartupWithUpdater = (updater: Updater) => void;
-type SetUpdater = {
+/**
+ * utils for startuping 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>;
+type StartupWithUpdater = {
     /**
-     * set updater option or create function
+     * starup app
+     * @param updater updater option or create function
      */
-    setUpdater: (updater: (() => Promisable<Updater>) | UpdaterOption) => void;
+    startupWithUpdater: (updater: (() => Promisable<Updater>) | UpdaterOption) => void;
 };
 /**
  * initialize app
  * @example
  * ```ts
  * import { getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
- * import { name, repository } from '../package.json'
+ * import { repository } from '../package.json'
  *
  * const SIGNATURE_CERT = '' // auto generate certificate when start app
  * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
  * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
  * initApp({ onStart: console.log })
  *   // can be updater option or function that return updater
- *   .setUpdater({
+ *   .startupWithUpdater({
  *     SIGNATURE_CERT,
- *     productName: name,
  *     repository,
  *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
+ *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${app.name}.asar.gz`),
  *     receiveBeta: true,
  *   })
  * ```
  */
-declare function initApp(appOptions?: AppOption): SetUpdater;
+declare function initApp(appOptions?: AppOption): StartupWithUpdater;
 
-export { type AppOption, IncrementalUpdater, type StartupWithUpdater, type Updater, type UpdaterOption, createUpdater, initApp };
+export { type AppOption, type CheckResult, type CheckResultError, DownloadError, type DownloadResult, type DownloadResultError, type DownloadingInfo, type Logger, MinimumVersionError, Updater, type UpdaterDownloadConfig, type UpdaterOption, type UpdaterOverrideFunctions, VerifyFailedError, createUpdater, initApp, startupWithUpdater };