electron-incremental-update 2.0.0-beta.6 → 2.0.0-beta.7

package/dist/core-DJdvtwvU.d.ts

@@ -0,0 +1,134 @@
+import { EventEmitter } from 'node:events';
+import { a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, I as IProvider, c as URLHandler } from './types-CItP6bL-.js';
+
+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);
+}
+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;
+    warn: (msg: string) => void;
+    error: (msg: string, e?: unknown) => void;
+}
+interface UpdaterOption {
+    /**
+     * public 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;
+    logger?: Logger;
+}
+
+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 provider;
+    /**
+     * updater logger
+     */
+    logger?: Logger;
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    /**
+     * whether force update in DEV
+     */
+    forceUpdate?: boolean;
+    /**
+     * initialize incremental updater
+     * @param provider update provider
+     * @param option UpdaterOption
+     */
+    constructor(provider: IProvider, option?: 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
+     */
+    private fetch;
+    /**
+     * handle error message and emit error event
+     */
+    private err;
+    /**
+     * check update info using default options
+     */
+    checkUpdate(): Promise<boolean>;
+    /**
+     * check update info using existing update json
+     * @param data existing update json
+     */
+    checkUpdate(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;
+    /**
+     * setup provider URL handler
+     *
+     * @example
+     * updater.setURLHandler((url, isDownloadingAsar) => {
+     *   if (isDownloadingAsar) {
+     *     url.hostname = 'https://cdn.jsdelivr.net/gh'
+     *     return url
+     *   }
+     * })
+     */
+    setURLHandler(handler: URLHandler): void;
+}
+
+export { type CheckResult as C, type DownloadResult as D, ErrorInfo as E, type Logger as L, Updater as U, type UpdaterOption as a, UpdaterError as b };

package/dist/core-ZUlLHadf.d.cts

@@ -0,0 +1,134 @@
+import { EventEmitter } from 'node:events';
+import { a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, I as IProvider, c as URLHandler } from './types-CItP6bL-.cjs';
+
+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);
+}
+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;
+    warn: (msg: string) => void;
+    error: (msg: string, e?: unknown) => void;
+}
+interface UpdaterOption {
+    /**
+     * public 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;
+    logger?: Logger;
+}
+
+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 provider;
+    /**
+     * updater logger
+     */
+    logger?: Logger;
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    /**
+     * whether force update in DEV
+     */
+    forceUpdate?: boolean;
+    /**
+     * initialize incremental updater
+     * @param provider update provider
+     * @param option UpdaterOption
+     */
+    constructor(provider: IProvider, option?: 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
+     */
+    private fetch;
+    /**
+     * handle error message and emit error event
+     */
+    private err;
+    /**
+     * check update info using default options
+     */
+    checkUpdate(): Promise<boolean>;
+    /**
+     * check update info using existing update json
+     * @param data existing update json
+     */
+    checkUpdate(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;
+    /**
+     * setup provider URL handler
+     *
+     * @example
+     * updater.setURLHandler((url, isDownloadingAsar) => {
+     *   if (isDownloadingAsar) {
+     *     url.hostname = 'https://cdn.jsdelivr.net/gh'
+     *     return url
+     *   }
+     * })
+     */
+    setURLHandler(handler: URLHandler): void;
+}
+
+export { type CheckResult as C, type DownloadResult as D, ErrorInfo as E, type Logger as L, Updater as U, type UpdaterOption as a, UpdaterError as b };

package/dist/index.d.cts

@@ -0,0 +1,78 @@
+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';
+
+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>;
+interface AppOption {
+    /**
+     * update provider
+     */
+    provider: IProvider;
+    /**
+     * updater options
+     */
+    updater?: (() => Promisable<Updater>) | UpdaterOption;
+    /**
+     * hooks on rename temp asar path to `${app.name}.asar`
+     */
+    onInstall?: OnInstallFunction;
+    /**
+     * hooks before app start up
+     * @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
+     * @param err installing or startup error
+     * @param logger logger
+     */
+    onStartError?: (err: unknown, logger?: Logger) => void;
+}
+/**
+ * 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>;
+/**
+ * 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,
+ *   },
+ *   onStart: console.log
+ * })
+ * ```
+ */
+declare function initApp(appOptions: AppOption): Promise<void>;
+
+export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };

package/dist/index.d.ts

@@ -0,0 +1,78 @@
+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';
+
+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>;
+interface AppOption {
+    /**
+     * update provider
+     */
+    provider: IProvider;
+    /**
+     * updater options
+     */
+    updater?: (() => Promisable<Updater>) | UpdaterOption;
+    /**
+     * hooks on rename temp asar path to `${app.name}.asar`
+     */
+    onInstall?: OnInstallFunction;
+    /**
+     * hooks before app start up
+     * @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
+     * @param err installing or startup error
+     * @param logger logger
+     */
+    onStartError?: (err: unknown, logger?: Logger) => void;
+}
+/**
+ * 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>;
+/**
+ * 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,
+ *   },
+ *   onStart: console.log
+ * })
+ * ```
+ */
+declare function initApp(appOptions: AppOption): Promise<void>;
+
+export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };

package/dist/provider.d.cts

@@ -0,0 +1,76 @@
+import { I as IProvider, d as defaultIsLowerVersion, a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, c as URLHandler, O as OnDownloading } from './types-CItP6bL-.cjs';
+import { f as defaultVerifySignature, a as defaultUnzipFile } from './zip-DPF5IFkK.cjs';
+import { Arrayable } from '@subframe7536/type-utils';
+
+declare abstract class BaseProvider implements IProvider {
+    name: string;
+    isLowerVersion: typeof defaultIsLowerVersion;
+    verifySignaure: typeof defaultVerifySignature;
+    unzipFile: typeof defaultUnzipFile;
+    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+}
+
+interface GitHubProviderOptions {
+    /**
+     * github user name
+     */
+    username: string;
+    /**
+     * github repo name
+     */
+    repo: string;
+    /**
+     * github branch name that fetch version
+     * @default 'HEAD'
+     */
+    branch?: string;
+    /**
+     * extra headers
+     */
+    extraHeaders?: Record<string, string>;
+    /**
+     * custom url handler
+     *
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 public CDN links}
+     * @example
+     * (url, isDownloadAsar) => {
+     *   if (isDownloadAsar) {
+     *     url.hostname = 'mirror.ghproxy.com'
+     *     url.pathname = 'https://github.com' + url.pathname
+     *     return url
+     *   }
+     * }
+     */
+    urlHandler?: URLHandler;
+}
+declare class GitHubProvider extends BaseProvider {
+    name: string;
+    private options;
+    /**
+     * Update Provider for Github repo
+     * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
+     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+     *
+     * you can setup `urlHandler` in {@link GitHubProviderOptions} or `Updater` to modify url before request
+     * @param options provider options
+     */
+    constructor(options: GitHubProviderOptions);
+    get urlHandler(): URLHandler | undefined;
+    set urlHandler(handler: URLHandler);
+    private parseURL;
+    downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+}
+
+declare function getHeader(response: Record<string, Arrayable<string>>, headerKey: any): any;
+/**
+ * download json and parse UpdateJson
+ */
+declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
+/**
+ * download asar buffer, get total size from `Content-Length` header
+ */
+declare function defaultDownloadAsar(url: string, headers: Record<string, any>, onDownloading?: OnDownloading): Promise<Buffer>;
+
+export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/provider.d.ts

@@ -0,0 +1,76 @@
+import { I as IProvider, d as defaultIsLowerVersion, a as UpdateJSON, U as UpdateInfo, D as DownloadingInfo, c as URLHandler, O as OnDownloading } from './types-CItP6bL-.js';
+import { f as defaultVerifySignature, a as defaultUnzipFile } from './zip-DPF5IFkK.js';
+import { Arrayable } from '@subframe7536/type-utils';
+
+declare abstract class BaseProvider implements IProvider {
+    name: string;
+    isLowerVersion: typeof defaultIsLowerVersion;
+    verifySignaure: typeof defaultVerifySignature;
+    unzipFile: typeof defaultUnzipFile;
+    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+}
+
+interface GitHubProviderOptions {
+    /**
+     * github user name
+     */
+    username: string;
+    /**
+     * github repo name
+     */
+    repo: string;
+    /**
+     * github branch name that fetch version
+     * @default 'HEAD'
+     */
+    branch?: string;
+    /**
+     * extra headers
+     */
+    extraHeaders?: Record<string, string>;
+    /**
+     * custom url handler
+     *
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 public CDN links}
+     * @example
+     * (url, isDownloadAsar) => {
+     *   if (isDownloadAsar) {
+     *     url.hostname = 'mirror.ghproxy.com'
+     *     url.pathname = 'https://github.com' + url.pathname
+     *     return url
+     *   }
+     * }
+     */
+    urlHandler?: URLHandler;
+}
+declare class GitHubProvider extends BaseProvider {
+    name: string;
+    private options;
+    /**
+     * Update Provider for Github repo
+     * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
+     * - download update asar from `https://github.com/{user}/{repo}/releases/download/v{version}/{name}-{version}.asar.gz`
+     *
+     * you can setup `urlHandler` in {@link GitHubProviderOptions} or `Updater` to modify url before request
+     * @param options provider options
+     */
+    constructor(options: GitHubProviderOptions);
+    get urlHandler(): URLHandler | undefined;
+    set urlHandler(handler: URLHandler);
+    private parseURL;
+    downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+}
+
+declare function getHeader(response: Record<string, Arrayable<string>>, headerKey: any): any;
+/**
+ * download json and parse UpdateJson
+ */
+declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
+/**
+ * download asar buffer, get total size from `Content-Length` header
+ */
+declare function defaultDownloadAsar(url: string, headers: Record<string, any>, onDownloading?: OnDownloading): Promise<Buffer>;
+
+export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/types-CItP6bL-.d.cts

@@ -0,0 +1,104 @@
+import { Promisable } from '@subframe7536/type-utils';
+
+interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+    stage: string;
+    stageVersion: number;
+}
+declare function parseVersion(version: string): Version;
+declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
+/**
+ * update info json
+ */
+type UpdateInfo = {
+    signature: string;
+    minimumVersion: string;
+    version: string;
+};
+/**
+ * {@link UpdateInfo} with beta
+ */
+type UpdateJSON = UpdateInfo & {
+    beta: UpdateInfo;
+};
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
+
+type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
+type OnDownloading = (progress: DownloadingInfo) => void;
+interface DownloadingInfo {
+    /**
+     * download delta
+     */
+    delta: number;
+    /**
+     * downloaded percent, 0 ~ 100
+     *
+     * If not `Content-Length` header, will be nagative
+     */
+    percent: number;
+    /**
+     * total size
+     *
+     * If not `Content-Length` header, will be -1
+     */
+    total: number;
+    /**
+     * downloaded size
+     */
+    transferred: number;
+    /**
+     * download speed, bytes per second
+     */
+    bps: number;
+}
+interface IProvider {
+    /**
+     * provider name
+     */
+    name: string;
+    /**
+     * custom url handler
+     *
+     * for Github, there are some {@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L34 public CDN links}
+     */
+    urlHandler?: URLHandler;
+    onDownloading?: OnDownloading;
+    /**
+     * download update json
+     * @param versionPath parsed version path
+     */
+    downloadJSON: (versionPath: string) => Promise<UpdateJSON>;
+    /**
+     * download update asar
+     * @param name app name
+     * @param updateInfo existing update info
+     * @param onDownloading hook for on downloading
+     */
+    downloadAsar: (name: string, updateInfo: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
+    /**
+     * compare version
+     * @param oldVer old version string
+     * @param newVer new version string
+     * @returns if version1 < version2
+     */
+    isLowerVersion: (oldVer: string, newVer: string) => boolean;
+    /**
+     * unzip file buffer
+     * @param buffer source buffer
+     */
+    unzipFile: (buffer: Buffer) => Promise<Buffer>;
+    /**
+     * verify asar signature
+     * @param buffer file buffer
+     * @param version target version
+     * @param signature signature
+     * @param cert certificate
+     * @returns if signature is valid, returns the version, otherwise returns `undefined`
+     */
+    verifySignaure: (buffer: Buffer, version: string, signature: string, cert: string) => Promisable<boolean>;
+}
+
+export { type DownloadingInfo as D, type IProvider as I, type OnDownloading as O, type UpdateInfo as U, type Version as V, type UpdateJSON as a, defaultVersionJsonGenerator as b, type URLHandler as c, defaultIsLowerVersion as d, isUpdateJSON as i, parseVersion as p };