electron-incremental-update 2.0.0-beta.1 → 2.0.0-beta.3

package/dist/provider.d.cts

@@ -1,37 +1,63 @@
-import { i as isLowerVersionDefault, U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.cjs';
-import { v as verifySignatureDefault } from './decrypt-BNBcodiO.cjs';
-import { U as URLHandler, I as IProvider, D as DownloadingInfo, O as OnDownloading } from './types-DxPmQmaq.cjs';
+import { d as defaultIsLowerVersion, U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.cjs';
+import { I as IProvider, D as DownloadingInfo, U as URLHandler, O as OnDownloading } from './types-Tequ_V2o.cjs';
+import { e as defaultVerify, d as defaultUnzipFile } from './unzip-JjYLjJkH.cjs';
 import '@subframe7536/type-utils';
 
+declare abstract class BaseProvider implements IProvider {
+    name: string;
+    isLowerVersion: typeof defaultIsLowerVersion;
+    verifySignaure: typeof defaultVerify;
+    unzipFile: typeof defaultUnzipFile;
+    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+}
+
 interface GitHubProviderOptions {
     /**
      * github repo root url
-     * @example 'https://github.com/electron/electron'
+     * @example 'https://github.com/electron/electron/'
      */
     url: 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#L34 public CDN links}
+     * 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 implements IProvider {
+declare class GitHubProvider extends BaseProvider {
     private ua;
     name: string;
     urlHandler?: URLHandler;
     private url;
     private extraHeaders?;
+    /**
+     * 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);
     private parseURL;
-    isLowerVersion: typeof isLowerVersionDefault;
-    verifySignaure: typeof verifySignatureDefault;
     downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    downloadBuffer(name: string, { version, size }: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+    downloadAsar(name: string, { version, size }: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
-declare function downloadUpdateJSONDefault(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
-declare function downloadAsarBufferDefault(url: string, headers: Record<string, any>, total: number, onDownloading?: OnDownloading): Promise<Buffer>;
+declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
+declare function defaultDownloadAsar(url: string, headers: Record<string, any>, total: number, onDownloading?: OnDownloading): Promise<Buffer>;
 
-export { DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, downloadAsarBufferDefault, downloadUpdateJSONDefault };
+export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON };

package/dist/provider.d.ts

@@ -1,37 +1,63 @@
-import { i as isLowerVersionDefault, U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.js';
-import { v as verifySignatureDefault } from './decrypt-BNBcodiO.js';
-import { U as URLHandler, I as IProvider, D as DownloadingInfo, O as OnDownloading } from './types-seJf3Wbc.js';
+import { d as defaultIsLowerVersion, U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.js';
+import { I as IProvider, D as DownloadingInfo, U as URLHandler, O as OnDownloading } from './types-DxhNaNgR.js';
+import { e as defaultVerify, d as defaultUnzipFile } from './unzip-JjYLjJkH.js';
 import '@subframe7536/type-utils';
 
+declare abstract class BaseProvider implements IProvider {
+    name: string;
+    isLowerVersion: typeof defaultIsLowerVersion;
+    verifySignaure: typeof defaultVerify;
+    unzipFile: typeof defaultUnzipFile;
+    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+}
+
 interface GitHubProviderOptions {
     /**
      * github repo root url
-     * @example 'https://github.com/electron/electron'
+     * @example 'https://github.com/electron/electron/'
      */
     url: 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#L34 public CDN links}
+     * 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 implements IProvider {
+declare class GitHubProvider extends BaseProvider {
     private ua;
     name: string;
     urlHandler?: URLHandler;
     private url;
     private extraHeaders?;
+    /**
+     * 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);
     private parseURL;
-    isLowerVersion: typeof isLowerVersionDefault;
-    verifySignaure: typeof verifySignatureDefault;
     downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    downloadBuffer(name: string, { version, size }: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+    downloadAsar(name: string, { version, size }: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
-declare function downloadUpdateJSONDefault(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
-declare function downloadAsarBufferDefault(url: string, headers: Record<string, any>, total: number, onDownloading?: OnDownloading): Promise<Buffer>;
+declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
+declare function defaultDownloadAsar(url: string, headers: Record<string, any>, total: number, onDownloading?: OnDownloading): Promise<Buffer>;
 
-export { DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, downloadAsarBufferDefault, downloadUpdateJSONDefault };
+export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON };

package/dist/provider.js

@@ -1,14 +1,9 @@
-import {
-  isLowerVersionDefault,
-  isUpdateJSON,
-  verifySignatureDefault,
-  waitAppReady
-} from "./chunk-RSLOPAIZ.js";
+import { defaultVerify, defaultUnzipFile } from './chunk-5WFXC5GU.js';
+import { defaultIsLowerVersion, isUpdateJSON } from './chunk-BVFQWBLK.js';
+import { app, net } from 'electron';
 
-// src/provider/download.ts
-import { net } from "electron";
-async function downlaodFn(url, headers, onResponse) {
-  await waitAppReady();
+async function downloadFn(url, headers, onResponse) {
+  await app.whenReady();
   return new Promise((resolve, reject) => {
     const request = net.request({ url, method: "GET", redirect: "follow" });
     Object.keys(headers).forEach((key) => request.setHeader(key, headers[key]));
@@ -21,8 +16,8 @@ async function downlaodFn(url, headers, onResponse) {
     request.end();
   });
 }
-async function downloadUpdateJSONDefault(url, headers) {
-  return await downlaodFn(url, headers, (resp, resolve, reject) => {
+async function defaultDownloadUpdateJSON(url, headers) {
+  return await downloadFn(url, headers, (resp, resolve, reject) => {
     let data = "";
     resp.on("data", (chunk) => data += chunk);
     resp.on("end", () => {
@@ -33,66 +28,89 @@ async function downloadUpdateJSONDefault(url, headers) {
         } else {
           throw Error;
         }
-      } catch (ignore) {
+      } catch {
         reject(new Error("invalid update json"));
       }
     });
   });
 }
-async function downloadAsarBufferDefault(url, headers, total, onDownloading) {
-  let current = 0;
-  return await downlaodFn(url, headers, (resp, resolve) => {
+async function defaultDownloadAsar(url, headers, total, onDownloading) {
+  let transferred = 0;
+  let time = Date.now();
+  return await downloadFn(url, headers, (resp, resolve) => {
     let data = [];
     resp.on("data", (chunk) => {
-      current += chunk.length;
-      onDownloading?.({ percent: `${+(current / total).toFixed(2) * 100}%`, total, current });
+      transferred += chunk.length;
+      const current = Date.now();
+      onDownloading?.({
+        percent: +(transferred / total).toFixed(2) * 100,
+        total,
+        transferred,
+        delta: chunk.length,
+        bps: chunk.length / ((current - time) * 1e3)
+      });
+      time = current;
       data.push(chunk);
     });
     resp.on("end", () => resolve(Buffer.concat(data)));
   });
 }
 
+// src/provider/base.ts
+var BaseProvider = class {
+  name = "BaseProvider";
+  isLowerVersion = defaultIsLowerVersion;
+  verifySignaure = defaultVerify;
+  unzipFile = defaultUnzipFile;
+};
+
 // src/provider/github.ts
-var GitHubProvider = class {
+var GitHubProvider = class extends BaseProvider {
   ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
   name = "GithubProvider";
   urlHandler;
   url;
   extraHeaders;
+  /**
+   * 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) {
-    this.url = new URL(options.url);
+    super();
     this.extraHeaders = options.extraHeaders;
     this.urlHandler = options.urlHandler;
-    if (this.url.host !== "github.com") {
+    if (!options.url.startsWith("https://github.com")) {
       throw new Error(`${this.name}: invalid github url: ${options.url}`);
     }
-    if (!this.url.pathname.endsWith("/")) {
-      this.url.pathname += "/";
+    this.url = options.url;
+    if (!this.url.endsWith("/")) {
+      this.url += "/";
     }
   }
-  parseURL(isDownloadAsar, path) {
-    const url = this.url.href + path;
-    return this.urlHandler ? this.urlHandler(url, isDownloadAsar) : url;
+  async parseURL(isDownloadAsar, extraPath) {
+    const _url = new URL(this.url);
+    _url.hostname = isDownloadAsar ? "github.com" : "raw.githubusercontent.com";
+    _url.pathname += extraPath;
+    return (await this.urlHandler?.(_url, isDownloadAsar) || _url).toString();
   }
-  isLowerVersion = isLowerVersionDefault;
-  verifySignaure = verifySignatureDefault;
   async downloadJSON(versionPath) {
-    return await downloadUpdateJSONDefault(
-      this.parseURL(false, `HEAD/${versionPath}`),
+    return await defaultDownloadUpdateJSON(
+      await this.parseURL(false, `HEAD/${versionPath}`),
       { userAgent: this.ua, accept: "application/json", ...this.extraHeaders }
     );
   }
-  async downloadBuffer(name, { version, size }, onDownloading) {
-    return await downloadAsarBufferDefault(
-      this.parseURL(true, `releases/download/v${version}/${name}-${version}.asar.gz`),
+  async downloadAsar(name, { version, size }, onDownloading) {
+    return await defaultDownloadAsar(
+      await this.parseURL(true, `releases/download/v${version}/${name}-${version}.asar.gz`),
       { userAgent: this.ua, accept: "application/octet-stream", ...this.extraHeaders },
       size,
       onDownloading
     );
   }
 };
-export {
-  GitHubProvider,
-  downloadAsarBufferDefault,
-  downloadUpdateJSONDefault
-};
+
+export { BaseProvider, GitHubProvider, defaultDownloadAsar, defaultDownloadUpdateJSON };

package/dist/{types-seJf3Wbc.d.ts → types-DxhNaNgR.d.ts}

@@ -1,13 +1,17 @@
 import { Promisable } from '@subframe7536/type-utils';
-import { U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.js';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.js';
 
-type URLHandler = (url: string, isDownloadAsar: boolean) => string;
+type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
 type OnDownloading = (progress: DownloadingInfo) => void;
 interface DownloadingInfo {
     /**
-     * downloaded percent, 0% - 100%
+     * download delta
      */
-    percent: `${number}%`;
+    delta: number;
+    /**
+     * downloaded percent, 0 ~ 100
+     */
+    percent: number;
     /**
      * total size
      */
@@ -15,7 +19,11 @@ interface DownloadingInfo {
     /**
      * downloaded size
      */
-    current: number;
+    transferred: number;
+    /**
+     * download speed, bytes per second
+     */
+    bps: number;
 }
 interface IProvider {
     /**
@@ -40,14 +48,20 @@ interface IProvider {
      * @param updateInfo existing update info
      * @param onDownloading hook for on downloading
      */
-    downloadBuffer: (name: string, updateInfo: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
+    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) => Promisable<boolean>;
+    isLowerVersion: (oldVer: string, newVer: string) => boolean;
+    /**
+     * unzip file
+     * @param buffer source buffer
+     * @param targetFilePath target file path
+     */
+    unzipFile: (buffer: Buffer, targetFilePath: string) => Promise<void>;
     /**
      * verify asar signature
      * @param buffer file buffer

package/dist/{types-DxPmQmaq.d.cts → types-Tequ_V2o.d.cts}

@@ -1,13 +1,17 @@
 import { Promisable } from '@subframe7536/type-utils';
-import { U as UpdateJSON, a as UpdateInfo } from './version-CffZWDhZ.cjs';
+import { U as UpdateJSON, a as UpdateInfo } from './version-CemSHimT.cjs';
 
-type URLHandler = (url: string, isDownloadAsar: boolean) => string;
+type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
 type OnDownloading = (progress: DownloadingInfo) => void;
 interface DownloadingInfo {
     /**
-     * downloaded percent, 0% - 100%
+     * download delta
      */
-    percent: `${number}%`;
+    delta: number;
+    /**
+     * downloaded percent, 0 ~ 100
+     */
+    percent: number;
     /**
      * total size
      */
@@ -15,7 +19,11 @@ interface DownloadingInfo {
     /**
      * downloaded size
      */
-    current: number;
+    transferred: number;
+    /**
+     * download speed, bytes per second
+     */
+    bps: number;
 }
 interface IProvider {
     /**
@@ -40,14 +48,20 @@ interface IProvider {
      * @param updateInfo existing update info
      * @param onDownloading hook for on downloading
      */
-    downloadBuffer: (name: string, updateInfo: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
+    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) => Promisable<boolean>;
+    isLowerVersion: (oldVer: string, newVer: string) => boolean;
+    /**
+     * unzip file
+     * @param buffer source buffer
+     * @param targetFilePath target file path
+     */
+    unzipFile: (buffer: Buffer, targetFilePath: string) => Promise<void>;
     /**
      * verify asar signature
      * @param buffer file buffer

package/dist/unzip-JjYLjJkH.d.cts

@@ -0,0 +1,9 @@
+declare function hashBuffer(data: string | Buffer, length: number): Buffer;
+declare function aesEncrypt(plainText: string, key: Buffer, iv: Buffer): string;
+declare function defaultSignature(buffer: Buffer, privateKey: string, cert: string, version: string): string;
+declare function aesDecrypt(encryptedText: string, key: Buffer, iv: Buffer): string;
+declare function defaultVerify(buffer: Buffer, signature: string, cert: string): string | undefined;
+
+declare function defaultUnzipFile(buffer: Buffer, targetFilePath: string): Promise<void>;
+
+export { aesEncrypt as a, defaultSignature as b, aesDecrypt as c, defaultUnzipFile as d, defaultVerify as e, hashBuffer as h };

package/dist/unzip-JjYLjJkH.d.ts

@@ -0,0 +1,9 @@
+declare function hashBuffer(data: string | Buffer, length: number): Buffer;
+declare function aesEncrypt(plainText: string, key: Buffer, iv: Buffer): string;
+declare function defaultSignature(buffer: Buffer, privateKey: string, cert: string, version: string): string;
+declare function aesDecrypt(encryptedText: string, key: Buffer, iv: Buffer): string;
+declare function defaultVerify(buffer: Buffer, signature: string, cert: string): string | undefined;
+
+declare function defaultUnzipFile(buffer: Buffer, targetFilePath: string): Promise<void>;
+
+export { aesEncrypt as a, defaultSignature as b, aesDecrypt as c, defaultUnzipFile as d, defaultVerify as e, hashBuffer as h };