electron-incremental-update 0.7.6 → 0.7.8

package/dist/{chunk-Q2K52LOG.mjs → chunk-2XHZMWRR.mjs}

@@ -31,7 +31,14 @@ var verify = (buffer, signature2, cert) => {
   }
 };
 
+// src/updateJson.ts
+function isUpdateJSON(json) {
+  const is = (j) => "signature" in j && "version" in j && "size" in j && "minimumVersion" in j;
+  return is(json) && "beta" in json && is(json.beta);
+}
+
 export {
   signature,
-  verify
+  verify,
+  isUpdateJSON
 };

package/dist/{chunk-67MCNA7W.mjs → chunk-SWXNCK6H.mjs}

@@ -20,9 +20,20 @@ function getEntryVersion() {
 function getProductVersion(name) {
   return app.isPackaged ? readFileSync(join(getProductAsarPath(name), "version"), "utf-8") : getEntryVersion();
 }
+var NoSuchNativeModuleError = class extends Error {
+  moduleName;
+  constructor(moduleName) {
+    super(`no such native module: ${moduleName}`);
+    this.moduleName = moduleName;
+  }
+};
 function requireNative(packageName) {
   const path = app.isPackaged ? join(app.getAppPath(), "node_modules", packageName) : packageName;
-  return __require(path);
+  try {
+    return __require(path);
+  } catch (error) {
+    throw new NoSuchNativeModuleError(packageName);
+  }
 }
 function parseGithubCdnURL(repository, cdnPrefix, relativeFilePath) {
   if (!repository.startsWith("https://github.com/")) {
@@ -114,12 +125,25 @@ function handleUnexpectedErrors(callback) {
   process.on("uncaughtException", listener);
   process.on("unhandledRejection", listener);
 }
+function parseVersion(version) {
+  const semver = /^(\d+)\.(\d+)\.(\d+)(?:-([a-zA-Z0-9\.-]+))?/i;
+  const match = semver.exec(version);
+  if (!match) {
+    throw new TypeError(`invalid version: ${version}`);
+  }
+  const [major, minor, patch] = match.slice(1, 4).map(Number);
+  if (isNaN(major) || isNaN(minor) || isNaN(patch)) {
+    throw new TypeError(`invalid version: ${version}`);
+  }
+  return { major, minor, patch, stage: match[4] };
+}
 
 export {
   __require,
   getProductAsarPath,
   getEntryVersion,
   getProductVersion,
+  NoSuchNativeModuleError,
   requireNative,
   parseGithubCdnURL,
   getGithubFileCdnGroup,
@@ -128,5 +152,6 @@ export {
   waitAppReady,
   unzipFile,
   zipFile,
-  handleUnexpectedErrors
+  handleUnexpectedErrors,
+  parseVersion
 };

package/dist/index.d.mts

@@ -1,32 +1,47 @@
 import { Buffer } from 'node:buffer';
+import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
 
-type CheckResultType = Omit<UpdateJSON, 'signature'> | undefined | Error;
-type InstallResult = true | Error;
+declare class MinimumVersionError extends Error {
+    currentVersion: string;
+    minVersion: string;
+    constructor(version: string, minimumVersion: string);
+}
+declare class VerifyFailedError extends Error {
+    signature: string;
+    cert: string;
+    constructor(signature: string, cert: string);
+}
+/**
+ * Creates an updater based on the provided options
+ */
+declare function createUpdater(updaterOptions: UpdaterOption): Updater;
+
+type CheckResultType = {
+    size: number;
+    version: string;
+} | undefined | Error | MinimumVersionError | TypeError;
+type DownloadResult = true | Error | VerifyFailedError | TypeError;
 type UpdateEvents = {
     downloading: [progress: number];
+    downloadBuffer: [buffer: Buffer];
     debug: [msg: string | Error];
 };
-type UpdateJSON = {
-    signature: string;
-    version: string;
-    size: number;
-};
-type MaybeArray<T> = T extends undefined | null | never ? [] : T extends any[] ? T['length'] extends 1 ? [data: T[0]] : T : [data: T];
-interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event extends Exclude<keyof T, number> = Exclude<keyof T, number>> {
-    removeAllListeners<E extends Event>(event?: E): this;
-    listeners<E extends Event>(eventName: E): Function[];
-    eventNames(): (Event)[];
-    on<E extends Event>(eventName: E, listener: (...data: MaybeArray<T[E]>) => void): this;
-    once<E extends Event>(eventName: E, listener: (...data: MaybeArray<T[E]>) => void): this;
-    emit<E extends Event>(eventName: E, ...args: MaybeArray<T[E]>): boolean;
-    off<E extends Event>(eventName: E, listener: (...args: MaybeArray<T[E]>) => void): this;
+type Evt = Exclude<keyof UpdateEvents, number>;
+interface Updater {
+    removeAllListeners<E extends Evt>(event?: E): this;
+    listeners<E extends Evt>(eventName: E): Function[];
+    eventNames(): Evt[];
+    on<E extends Evt>(eventName: E, listener: (...data: UpdateEvents[E]) => void): this;
+    once<E extends Evt>(eventName: E, listener: (...data: UpdateEvents[E]) => void): this;
+    emit<E extends Evt>(eventName: E, ...args: UpdateEvents[E]): boolean;
+    off<E extends Evt>(eventName: E, listener: (...args: UpdateEvents[E]) => void): this;
     /**
      * check update info
      * @param data update json url
      * @returns
      * - `{size: number, version: string}`: available
      * - `false`: unavailable
-     * - `Error`: fail
+     * - `Error`: fail ({@link MinimumVersionError} or other)
      */
     checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
     /**
@@ -37,15 +52,60 @@ interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event
      * @param sig signature
      * @returns
      * - `true`: success
-     * - `Error`: fail
+     * - `Error`: fail ({@link VerifyFailedError} or other)
      */
-    download(data?: string | Buffer, sig?: string): Promise<InstallResult>;
-    setDebugMode(debug: boolean): void;
+    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
+    debug: boolean;
     productName: string;
+    receiveBeta: boolean;
 }
-type FunctionVerifySignature = (buffer: Buffer, signature: string, cert: string) => string | false;
-type FunctionCompareVersion = (oldVersion: string, newVersion: string) => boolean;
-type Updater = TypedUpdater<UpdateEvents>;
+type FunctionVerifySignature = (buffer: Buffer, signature: string, cert: string) => string | false | Promise<string | false>;
+type FunctionCompareVersion = (oldVersion: string, newVersion: string) => boolean | Promise<boolean>;
+type FunctionDownloadBuffer = (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
+type FunctionDownloadJSON = (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
+type UpdaterOverrideFunctions = {
+    /**
+     * custom version compare function {@link FunctionCompareVersion}
+     * @param oldVersion old version string
+     * @param newVersion new version string
+     * @returns whether oldVersion < newVersion
+     */
+    compareVersion?: FunctionCompareVersion;
+    /**
+     * custom verify signature function {@link FunctionVerifySignature}
+     * @param buffer file buffer
+     * @param signature signature
+     * @param cert certificate
+     */
+    verifySignaure?: FunctionVerifySignature;
+    /**
+     * custom download JSON function
+     * @param url download url
+     * @param updater updater, to trigger events
+     * @param header download header
+     * @returns `UpdateJSON`
+     */
+    downloadJSON?: FunctionDownloadJSON;
+    /**
+     * custom download buffer function
+     * @param url download url
+     * @param updater updater, to trigger events
+     * @param header download header
+     * @returns `Buffer`
+     */
+    downloadBuffer?: FunctionDownloadBuffer;
+};
+type UpdaterDownloadConfig = {
+    /**
+     * 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'
+     */
+    userAgent?: string;
+    /**
+     * 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
@@ -92,56 +152,14 @@ interface UpdaterOption {
      * whether to enable debug listener
      */
     debug?: boolean;
-    overrideFunctions?: {
-        /**
-         * custom version compare function {@link FunctionCompareVersion}
-         * @param oldVersion old version string
-         * @param newVersion new version string
-         * @returns whether oldVersion < newVersion
-         */
-        compareVersion?: FunctionCompareVersion;
-        /**
-         * custom verify signature function {@link FunctionVerifySignature}
-         * @param buffer file buffer
-         * @param signature signature
-         * @param cert certificate
-         */
-        verifySignaure?: FunctionVerifySignature;
-        /**
-         * custom download JSON function
-         * @param url download url
-         * @param updater updater, to trigger events
-         * @param header download header
-         * @returns `UpdateJSON`
-         */
-        downloadJSON?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
-        /**
-         * custom download buffer function
-         * @param url download url
-         * @param updater updater, to trigger events
-         * @param header download header
-         * @returns `Buffer`
-         */
-        downloadBuffer?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
-    };
-    downloadConfig?: {
-        /**
-         * 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'
-         */
-        userAgent?: string;
-        /**
-         * extra download header, `accept` and `user-agent` is set by default
-         */
-        extraHeader?: Record<string, string>;
-    };
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    overrideFunctions?: UpdaterOverrideFunctions;
+    downloadConfig?: UpdaterDownloadConfig;
 }
 
-/**
- * Creates an updater based on the provided options
- */
-declare function createUpdater(updaterOptions: UpdaterOption): Updater;
-
 type AppOption = {
     /**
      * path of electron output dist when in development
@@ -193,4 +211,4 @@ type SetUpdater = {
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, FunctionCompareVersion, FunctionVerifySignature, StartupWithUpdater, UpdateJSON, Updater, UpdaterOption, createUpdater, initApp };
+export { AppOption, FunctionCompareVersion, FunctionVerifySignature, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };

package/dist/index.d.ts

@@ -1,32 +1,47 @@
 import { Buffer } from 'node:buffer';
+import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
 
-type CheckResultType = Omit<UpdateJSON, 'signature'> | undefined | Error;
-type InstallResult = true | Error;
+declare class MinimumVersionError extends Error {
+    currentVersion: string;
+    minVersion: string;
+    constructor(version: string, minimumVersion: string);
+}
+declare class VerifyFailedError extends Error {
+    signature: string;
+    cert: string;
+    constructor(signature: string, cert: string);
+}
+/**
+ * Creates an updater based on the provided options
+ */
+declare function createUpdater(updaterOptions: UpdaterOption): Updater;
+
+type CheckResultType = {
+    size: number;
+    version: string;
+} | undefined | Error | MinimumVersionError | TypeError;
+type DownloadResult = true | Error | VerifyFailedError | TypeError;
 type UpdateEvents = {
     downloading: [progress: number];
+    downloadBuffer: [buffer: Buffer];
     debug: [msg: string | Error];
 };
-type UpdateJSON = {
-    signature: string;
-    version: string;
-    size: number;
-};
-type MaybeArray<T> = T extends undefined | null | never ? [] : T extends any[] ? T['length'] extends 1 ? [data: T[0]] : T : [data: T];
-interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event extends Exclude<keyof T, number> = Exclude<keyof T, number>> {
-    removeAllListeners<E extends Event>(event?: E): this;
-    listeners<E extends Event>(eventName: E): Function[];
-    eventNames(): (Event)[];
-    on<E extends Event>(eventName: E, listener: (...data: MaybeArray<T[E]>) => void): this;
-    once<E extends Event>(eventName: E, listener: (...data: MaybeArray<T[E]>) => void): this;
-    emit<E extends Event>(eventName: E, ...args: MaybeArray<T[E]>): boolean;
-    off<E extends Event>(eventName: E, listener: (...args: MaybeArray<T[E]>) => void): this;
+type Evt = Exclude<keyof UpdateEvents, number>;
+interface Updater {
+    removeAllListeners<E extends Evt>(event?: E): this;
+    listeners<E extends Evt>(eventName: E): Function[];
+    eventNames(): Evt[];
+    on<E extends Evt>(eventName: E, listener: (...data: UpdateEvents[E]) => void): this;
+    once<E extends Evt>(eventName: E, listener: (...data: UpdateEvents[E]) => void): this;
+    emit<E extends Evt>(eventName: E, ...args: UpdateEvents[E]): boolean;
+    off<E extends Evt>(eventName: E, listener: (...args: UpdateEvents[E]) => void): this;
     /**
      * check update info
      * @param data update json url
      * @returns
      * - `{size: number, version: string}`: available
      * - `false`: unavailable
-     * - `Error`: fail
+     * - `Error`: fail ({@link MinimumVersionError} or other)
      */
     checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
     /**
@@ -37,15 +52,60 @@ interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event
      * @param sig signature
      * @returns
      * - `true`: success
-     * - `Error`: fail
+     * - `Error`: fail ({@link VerifyFailedError} or other)
      */
-    download(data?: string | Buffer, sig?: string): Promise<InstallResult>;
-    setDebugMode(debug: boolean): void;
+    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
+    debug: boolean;
     productName: string;
+    receiveBeta: boolean;
 }
-type FunctionVerifySignature = (buffer: Buffer, signature: string, cert: string) => string | false;
-type FunctionCompareVersion = (oldVersion: string, newVersion: string) => boolean;
-type Updater = TypedUpdater<UpdateEvents>;
+type FunctionVerifySignature = (buffer: Buffer, signature: string, cert: string) => string | false | Promise<string | false>;
+type FunctionCompareVersion = (oldVersion: string, newVersion: string) => boolean | Promise<boolean>;
+type FunctionDownloadBuffer = (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
+type FunctionDownloadJSON = (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
+type UpdaterOverrideFunctions = {
+    /**
+     * custom version compare function {@link FunctionCompareVersion}
+     * @param oldVersion old version string
+     * @param newVersion new version string
+     * @returns whether oldVersion < newVersion
+     */
+    compareVersion?: FunctionCompareVersion;
+    /**
+     * custom verify signature function {@link FunctionVerifySignature}
+     * @param buffer file buffer
+     * @param signature signature
+     * @param cert certificate
+     */
+    verifySignaure?: FunctionVerifySignature;
+    /**
+     * custom download JSON function
+     * @param url download url
+     * @param updater updater, to trigger events
+     * @param header download header
+     * @returns `UpdateJSON`
+     */
+    downloadJSON?: FunctionDownloadJSON;
+    /**
+     * custom download buffer function
+     * @param url download url
+     * @param updater updater, to trigger events
+     * @param header download header
+     * @returns `Buffer`
+     */
+    downloadBuffer?: FunctionDownloadBuffer;
+};
+type UpdaterDownloadConfig = {
+    /**
+     * 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'
+     */
+    userAgent?: string;
+    /**
+     * 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
@@ -92,56 +152,14 @@ interface UpdaterOption {
      * whether to enable debug listener
      */
     debug?: boolean;
-    overrideFunctions?: {
-        /**
-         * custom version compare function {@link FunctionCompareVersion}
-         * @param oldVersion old version string
-         * @param newVersion new version string
-         * @returns whether oldVersion < newVersion
-         */
-        compareVersion?: FunctionCompareVersion;
-        /**
-         * custom verify signature function {@link FunctionVerifySignature}
-         * @param buffer file buffer
-         * @param signature signature
-         * @param cert certificate
-         */
-        verifySignaure?: FunctionVerifySignature;
-        /**
-         * custom download JSON function
-         * @param url download url
-         * @param updater updater, to trigger events
-         * @param header download header
-         * @returns `UpdateJSON`
-         */
-        downloadJSON?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
-        /**
-         * custom download buffer function
-         * @param url download url
-         * @param updater updater, to trigger events
-         * @param header download header
-         * @returns `Buffer`
-         */
-        downloadBuffer?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
-    };
-    downloadConfig?: {
-        /**
-         * 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'
-         */
-        userAgent?: string;
-        /**
-         * extra download header, `accept` and `user-agent` is set by default
-         */
-        extraHeader?: Record<string, string>;
-    };
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    overrideFunctions?: UpdaterOverrideFunctions;
+    downloadConfig?: UpdaterDownloadConfig;
 }
 
-/**
- * Creates an updater based on the provided options
- */
-declare function createUpdater(updaterOptions: UpdaterOption): Updater;
-
 type AppOption = {
     /**
      * path of electron output dist when in development
@@ -193,4 +211,4 @@ type SetUpdater = {
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, FunctionCompareVersion, FunctionVerifySignature, StartupWithUpdater, UpdateJSON, Updater, UpdaterOption, createUpdater, initApp };
+export { AppOption, FunctionCompareVersion, FunctionVerifySignature, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };