electron-incremental-update 0.7.8 → 0.7.9

package/README.md

@@ -60,16 +60,17 @@ import { name, repository } from '../package.json'
 
 const SIGNATURE_CERT = '' // auto generate certificate when start app
 
-const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
+const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
+const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
 initApp({ onStart: console.log })
   // can be updater option or function that return updater
   .setUpdater({
     SIGNATURE_CERT,
     productName: name,
     repository,
-    updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
-    releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
-    debug: true,
+    updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
+    releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
+    receiveBeta: true
   })
 ```
 
@@ -94,18 +95,16 @@ const startup: StartupWithUpdater = (updater: Updater) => {
   console.log(`\tasar path: ${getProductAsarPath(name)}`)
   console.log(`\tentry:     ${getEntryVersion()}`)
   console.log(`\tapp:       ${getProductVersion(name)}`)
-  let size = 0
-  updater.on('downloading', (progress) => {
-    console.log(`${(progress / size).toFixed(2)}%`)
-  })
-  updater.on('debug', data => console.log('[updater]:', data))
+  updater.onDownloading = ({ percent }) => {
+    console.log(percent)
+  }
+  updater.logger = console
   updater.checkUpdate().then(async (result) => {
     if (result === undefined) {
       console.log('Update Unavailable')
     } else if (result instanceof Error) {
       console.error(result)
     } else {
-      size = result.size
       console.log('new version: ', result.version)
       const { response } = await dialog.showMessageBox({
         type: 'info',

package/dist/chunk-2JVXVTC5.mjs

@@ -0,0 +1,9 @@
+// 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 {
+  isUpdateJSON
+};

package/dist/{chunk-SWXNCK6H.mjs → chunk-4TION32M.mjs}

@@ -1,10 +1,6 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
+import {
+  __require
+} from "./chunk-ZFXKCRJC.mjs";
 
 // src/utils.ts
 import { existsSync, readFileSync, rmSync, writeFileSync } from "node:fs";
@@ -82,11 +78,11 @@ function waitAppReady(duration = 1e3) {
     }, duration);
     app.whenReady().then(() => {
       clearTimeout(timeout);
-      resolve(null);
+      resolve();
     });
   });
 }
-async function unzipFile(gzipPath, targetFilePath) {
+async function unzipFile(gzipPath, targetFilePath = gzipPath.slice(0, -3)) {
   if (!existsSync(gzipPath)) {
     throw new Error(`path to zipped file not exist: ${gzipPath}`);
   }
@@ -132,14 +128,25 @@ function parseVersion(version) {
     throw new TypeError(`invalid version: ${version}`);
   }
   const [major, minor, patch] = match.slice(1, 4).map(Number);
-  if (isNaN(major) || isNaN(minor) || isNaN(patch)) {
+  const ret = {
+    major,
+    minor,
+    patch,
+    stage: "",
+    stageVersion: -1
+  };
+  if (match[4]) {
+    let [stage, _v] = match[4].split(".");
+    ret.stage = stage;
+    ret.stageVersion = Number(_v) || -1;
+  }
+  if (isNaN(major) || isNaN(minor) || isNaN(patch) || isNaN(ret.stageVersion)) {
     throw new TypeError(`invalid version: ${version}`);
   }
-  return { major, minor, patch, stage: match[4] };
+  return ret;
 }
 
 export {
-  __require,
   getProductAsarPath,
   getEntryVersion,
   getProductVersion,

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

@@ -31,14 +31,7 @@ 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,
-  isUpdateJSON
+  verify
 };

package/dist/chunk-ZFXKCRJC.mjs

@@ -0,0 +1,11 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+export {
+  __require
+};

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { Buffer } from 'node:buffer';
-import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
+import { UpdateJSON } from './updateJson.mjs';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -11,39 +11,68 @@ declare class VerifyFailedError extends Error {
     cert: string;
     constructor(signature: string, cert: string);
 }
+declare class IncrementalUpdater implements Updater {
+    private info?;
+    private option;
+    private asarPath;
+    private gzipPath;
+    private tmpFilePath;
+    logger?: Logger;
+    onDownloading?: (progress: DownloadingInfo) => void;
+    get productName(): string;
+    set productName(name: string);
+    get receiveBeta(): boolean;
+    set receiveBeta(receiveBeta: boolean);
+    constructor(option: UpdaterOption);
+    private needUpdate;
+    private parseData;
+    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
+    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
+}
 /**
- * Creates an updater based on the provided options
+ * create updater instance
+ * @param option updater option
+ * @returns updater
  */
-declare function createUpdater(updaterOptions: UpdaterOption): Updater;
+declare function createUpdater(option: UpdaterOption): IncrementalUpdater;
 
 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 DownloadingInfo = {
+    /**
+     * downloaded percent, 0% - 100%
+     */
+    percent: string;
+    /**
+     * total size
+     */
+    total: number;
+    /**
+     * downloaded size
+     */
+    current: number;
+};
+type Logger = {
+    info: (msg: string) => void;
+    debug: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string, e?: Error) => void;
 };
-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;
+    productName: string;
+    receiveBeta: boolean;
     /**
      * check update info
-     * @param data update json url
+     * @param data update json url or object
      * @returns
      * - `{size: number, version: string}`: available
      * - `false`: unavailable
      * - `Error`: fail ({@link MinimumVersionError} or other)
      */
-    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
+    checkUpdate: (data?: string | UpdateJSON) => Promise<CheckResultType>;
     /**
      * download update
      *
@@ -54,30 +83,30 @@ interface Updater {
      * - `true`: success
      * - `Error`: fail ({@link VerifyFailedError} or other)
      */
-    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
-    debug: boolean;
-    productName: string;
-    receiveBeta: boolean;
+    download: (data?: string | Buffer, sig?: string) => Promise<DownloadResult>;
+    /**
+     * log function
+     * @param data log info
+     */
+    logger?: Logger;
+    onDownloading?: (progress: DownloadingInfo) => void;
 }
-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
+     * custom version compare function
+     * @param version1 old version string
+     * @param version2 new version string
+     * @returns whether version1 < version2
      */
-    compareVersion?: FunctionCompareVersion;
+    compareVersion?: (version1: string, version2: string) => boolean | Promise<boolean>;
     /**
-     * custom verify signature function {@link FunctionVerifySignature}
+     * custom verify signature function
      * @param buffer file buffer
      * @param signature signature
      * @param cert certificate
+     * @returns if signature is valid, returns the version or `true` , otherwise returns `false`
      */
-    verifySignaure?: FunctionVerifySignature;
+    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | boolean | Promise<string | boolean>;
     /**
      * custom download JSON function
      * @param url download url
@@ -85,7 +114,7 @@ type UpdaterOverrideFunctions = {
      * @param header download header
      * @returns `UpdateJSON`
      */
-    downloadJSON?: FunctionDownloadJSON;
+    downloadJSON?: (url: string, headers: Record<string, any>) => Promise<UpdateJSON>;
     /**
      * custom download buffer function
      * @param url download url
@@ -93,7 +122,7 @@ type UpdaterOverrideFunctions = {
      * @param header download header
      * @returns `Buffer`
      */
-    downloadBuffer?: FunctionDownloadBuffer;
+    downloadBuffer?: (url: string, headers: Record<string, any>, total: number, onDownloading?: (progress: DownloadingInfo) => void) => Promise<Buffer>;
 };
 type UpdaterDownloadConfig = {
     /**
@@ -148,10 +177,6 @@ interface UpdaterOption {
      * @throws if `releaseAsarURL` and `repository` are all not set
      */
     releaseAsarURL?: string;
-    /**
-     * whether to enable debug listener
-     */
-    debug?: boolean;
     /**
      * whether to receive beta update
      */
@@ -196,19 +221,20 @@ type SetUpdater = {
  *
  * const SIGNATURE_CERT = '' // auto generate certificate when start app
  *
- * const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
+ * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
+ * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
  * initApp({ onStart: console.log })
  *   // can be updater option or function that return updater
  *   .setUpdater({
  *     SIGNATURE_CERT,
  *     productName: name,
  *     repository,
- *     updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
- *     debug: true,
+ *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
+ *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
+ *     receiveBeta: true,
  *   })
  * ```
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, FunctionCompareVersion, FunctionVerifySignature, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };
+export { AppOption, IncrementalUpdater, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Buffer } from 'node:buffer';
-import { U as UpdateJSON } from './updateJson-7e45d9e1.js';
+import { UpdateJSON } from './updateJson.js';
 
 declare class MinimumVersionError extends Error {
     currentVersion: string;
@@ -11,39 +11,68 @@ declare class VerifyFailedError extends Error {
     cert: string;
     constructor(signature: string, cert: string);
 }
+declare class IncrementalUpdater implements Updater {
+    private info?;
+    private option;
+    private asarPath;
+    private gzipPath;
+    private tmpFilePath;
+    logger?: Logger;
+    onDownloading?: (progress: DownloadingInfo) => void;
+    get productName(): string;
+    set productName(name: string);
+    get receiveBeta(): boolean;
+    set receiveBeta(receiveBeta: boolean);
+    constructor(option: UpdaterOption);
+    private needUpdate;
+    private parseData;
+    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
+    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
+}
 /**
- * Creates an updater based on the provided options
+ * create updater instance
+ * @param option updater option
+ * @returns updater
  */
-declare function createUpdater(updaterOptions: UpdaterOption): Updater;
+declare function createUpdater(option: UpdaterOption): IncrementalUpdater;
 
 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 DownloadingInfo = {
+    /**
+     * downloaded percent, 0% - 100%
+     */
+    percent: string;
+    /**
+     * total size
+     */
+    total: number;
+    /**
+     * downloaded size
+     */
+    current: number;
+};
+type Logger = {
+    info: (msg: string) => void;
+    debug: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string, e?: Error) => void;
 };
-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;
+    productName: string;
+    receiveBeta: boolean;
     /**
      * check update info
-     * @param data update json url
+     * @param data update json url or object
      * @returns
      * - `{size: number, version: string}`: available
      * - `false`: unavailable
      * - `Error`: fail ({@link MinimumVersionError} or other)
      */
-    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
+    checkUpdate: (data?: string | UpdateJSON) => Promise<CheckResultType>;
     /**
      * download update
      *
@@ -54,30 +83,30 @@ interface Updater {
      * - `true`: success
      * - `Error`: fail ({@link VerifyFailedError} or other)
      */
-    download(data?: string | Buffer, sig?: string): Promise<DownloadResult>;
-    debug: boolean;
-    productName: string;
-    receiveBeta: boolean;
+    download: (data?: string | Buffer, sig?: string) => Promise<DownloadResult>;
+    /**
+     * log function
+     * @param data log info
+     */
+    logger?: Logger;
+    onDownloading?: (progress: DownloadingInfo) => void;
 }
-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
+     * custom version compare function
+     * @param version1 old version string
+     * @param version2 new version string
+     * @returns whether version1 < version2
      */
-    compareVersion?: FunctionCompareVersion;
+    compareVersion?: (version1: string, version2: string) => boolean | Promise<boolean>;
     /**
-     * custom verify signature function {@link FunctionVerifySignature}
+     * custom verify signature function
      * @param buffer file buffer
      * @param signature signature
      * @param cert certificate
+     * @returns if signature is valid, returns the version or `true` , otherwise returns `false`
      */
-    verifySignaure?: FunctionVerifySignature;
+    verifySignaure?: (buffer: Buffer, signature: string, cert: string) => string | boolean | Promise<string | boolean>;
     /**
      * custom download JSON function
      * @param url download url
@@ -85,7 +114,7 @@ type UpdaterOverrideFunctions = {
      * @param header download header
      * @returns `UpdateJSON`
      */
-    downloadJSON?: FunctionDownloadJSON;
+    downloadJSON?: (url: string, headers: Record<string, any>) => Promise<UpdateJSON>;
     /**
      * custom download buffer function
      * @param url download url
@@ -93,7 +122,7 @@ type UpdaterOverrideFunctions = {
      * @param header download header
      * @returns `Buffer`
      */
-    downloadBuffer?: FunctionDownloadBuffer;
+    downloadBuffer?: (url: string, headers: Record<string, any>, total: number, onDownloading?: (progress: DownloadingInfo) => void) => Promise<Buffer>;
 };
 type UpdaterDownloadConfig = {
     /**
@@ -148,10 +177,6 @@ interface UpdaterOption {
      * @throws if `releaseAsarURL` and `repository` are all not set
      */
     releaseAsarURL?: string;
-    /**
-     * whether to enable debug listener
-     */
-    debug?: boolean;
     /**
      * whether to receive beta update
      */
@@ -196,19 +221,20 @@ type SetUpdater = {
  *
  * const SIGNATURE_CERT = '' // auto generate certificate when start app
  *
- * const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
+ * const { cdnPrefix: asarPrefix } = getGithubReleaseCdnGroup()[0]
+ * const { cdnPrefix: jsonPrefix } = getGithubFileCdnGroup()[0]
  * initApp({ onStart: console.log })
  *   // can be updater option or function that return updater
  *   .setUpdater({
  *     SIGNATURE_CERT,
  *     productName: name,
  *     repository,
- *     updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
- *     releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
- *     debug: true,
+ *     updateJsonURL: parseGithubCdnURL(repository, jsonPrefix, 'version.json'),
+ *     releaseAsarURL: parseGithubCdnURL(repository, asarPrefix, `download/latest/${name}.asar.gz`),
+ *     receiveBeta: true,
  *   })
  * ```
  */
 declare function initApp(appOptions?: AppOption): SetUpdater;
 
-export { AppOption, FunctionCompareVersion, FunctionVerifySignature, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };
+export { AppOption, IncrementalUpdater, MinimumVersionError, StartupWithUpdater, Updater, UpdaterOption, VerifyFailedError, createUpdater, initApp };