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

package/dist/provider.js

@@ -1,17 +1,21 @@
-import {
-  isLowerVersionDefault,
-  isUpdateJSON,
-  verifySignatureDefault,
-  waitAppReady
-} from "./chunk-RSLOPAIZ.js";
+import { defaultVerifySignature, defaultUnzipFile } from './chunk-KZSYEXLO.js';
+import { defaultIsLowerVersion, isUpdateJSON } from './chunk-RCRKUKFX.js';
+import { URL } from 'node:url';
+import electron from 'electron';
 
-// src/provider/download.ts
-import { net } from "electron";
-async function downlaodFn(url, headers, onResponse) {
-  await waitAppReady();
+function getHeader(headers, key) {
+  const value = headers[key];
+  if (Array.isArray(value)) {
+    return value.length === 0 ? null : value[value.length - 1];
+  } else {
+    return value;
+  }
+}
+async function downloadFn(url, headers, signal, onResponse) {
+  await electron.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]));
+    const request = electron.net.request({ url, method: "GET", redirect: "follow", headers, cache: "no-cache" });
+    signal.addEventListener("abort", () => request.abort(), { once: true });
     request.on("response", (resp) => {
       resp.on("aborted", () => reject(new Error("aborted")));
       resp.on("error", () => reject(new Error("download error")));
@@ -21,78 +25,128 @@ async function downlaodFn(url, headers, onResponse) {
     request.end();
   });
 }
-async function downloadUpdateJSONDefault(url, headers) {
-  return await downlaodFn(url, headers, (resp, resolve, reject) => {
-    let data = "";
-    resp.on("data", (chunk) => data += chunk);
-    resp.on("end", () => {
-      try {
-        const json = JSON.parse(data);
-        if (isUpdateJSON(json)) {
-          resolve(json);
-        } else {
-          throw Error;
+async function defaultDownloadUpdateJSON(url, headers, signal) {
+  return await downloadFn(
+    url,
+    headers,
+    signal,
+    (resp, resolve, reject) => {
+      let data = "";
+      resp.on("data", (chunk) => data += chunk);
+      resp.on("end", () => {
+        try {
+          const json = JSON.parse(data);
+          if (isUpdateJSON(json)) {
+            resolve(json);
+          } else {
+            throw Error;
+          }
+        } catch {
+          reject(new Error("invalid update json " + data));
         }
-      } catch (ignore) {
-        reject(new Error("invalid update json"));
-      }
-    });
-  });
+      });
+    }
+  );
 }
-async function downloadAsarBufferDefault(url, headers, total, onDownloading) {
-  let current = 0;
-  return await downlaodFn(url, headers, (resp, resolve) => {
-    let data = [];
-    resp.on("data", (chunk) => {
-      current += chunk.length;
-      onDownloading?.({ percent: `${+(current / total).toFixed(2) * 100}%`, total, current });
-      data.push(chunk);
-    });
-    resp.on("end", () => resolve(Buffer.concat(data)));
-  });
+async function defaultDownloadAsar(url, headers, signal, onDownloading) {
+  let transferred = 0;
+  let time = Date.now();
+  return await downloadFn(
+    url,
+    headers,
+    signal,
+    (resp, resolve) => {
+      const total = +getHeader(resp.headers, "content-length") || -1;
+      let data = [];
+      resp.on("data", (chunk) => {
+        const delta = chunk.length;
+        transferred += delta;
+        const current = Date.now();
+        onDownloading?.({
+          percent: total ? +(transferred / total).toFixed(2) * 100 : -1,
+          total,
+          transferred,
+          delta,
+          bps: delta / ((current - time) * 1e3)
+        });
+        time = current;
+        data.push(chunk);
+      });
+      resp.on("end", () => resolve(Buffer.concat(data)));
+    }
+  );
 }
 
+// src/provider/base.ts
+var BaseProvider = class {
+  name = "BaseProvider";
+  /**
+   * @inheritdoc
+   */
+  isLowerVersion = defaultIsLowerVersion;
+  /**
+   * @inheritdoc
+   */
+  verifySignaure = defaultVerifySignature;
+  /**
+   * @inheritdoc
+   */
+  unzipFile = defaultUnzipFile;
+};
+
 // src/provider/github.ts
-var GitHubProvider = class {
-  ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
+var GitHubProvider = class extends BaseProvider {
   name = "GithubProvider";
-  urlHandler;
-  url;
-  extraHeaders;
+  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} to modify url before request
+   * @param options provider options
+   */
   constructor(options) {
-    this.url = new URL(options.url);
-    this.extraHeaders = options.extraHeaders;
-    this.urlHandler = options.urlHandler;
-    if (this.url.host !== "github.com") {
-      throw new Error(`${this.name}: invalid github url: ${options.url}`);
-    }
-    if (!this.url.pathname.endsWith("/")) {
-      this.url.pathname += "/";
+    super();
+    this.options = options;
+    if (!options.branch) {
+      this.options.branch = "HEAD";
     }
   }
-  parseURL(isDownloadAsar, path) {
-    const url = this.url.href + path;
-    return this.urlHandler ? this.urlHandler(url, isDownloadAsar) : url;
+  get urlHandler() {
+    return this.options.urlHandler;
+  }
+  set urlHandler(handler) {
+    this.options.urlHandler = handler;
   }
-  isLowerVersion = isLowerVersionDefault;
-  verifySignaure = verifySignatureDefault;
-  async downloadJSON(versionPath) {
-    return await downloadUpdateJSONDefault(
-      this.parseURL(false, `HEAD/${versionPath}`),
-      { userAgent: this.ua, accept: "application/json", ...this.extraHeaders }
+  async parseURL(isDownloadAsar, extraPath) {
+    const url = new URL(
+      `/${this.options.user}/${this.options.repo}/${extraPath}`,
+      "https://" + (isDownloadAsar ? "github.com" : "raw.githubusercontent.com")
     );
+    return (await this.urlHandler?.(url, isDownloadAsar) || url).toString();
   }
-  async downloadBuffer(name, { version, size }, onDownloading) {
-    return await downloadAsarBufferDefault(
-      this.parseURL(true, `releases/download/v${version}/${name}-${version}.asar.gz`),
-      { userAgent: this.ua, accept: "application/octet-stream", ...this.extraHeaders },
-      size,
+  /**
+   * @inheritdoc
+   */
+  async downloadJSON(versionPath, signal) {
+    return await defaultDownloadUpdateJSON(
+      await this.parseURL(false, `${this.options.branch}/${versionPath}`),
+      { Accept: "application/json", ...this.options.extraHeaders },
+      signal
+    );
+  }
+  /**
+   * @inheritdoc
+   */
+  async downloadAsar(name, info, signal, onDownloading) {
+    return await defaultDownloadAsar(
+      await this.parseURL(true, `releases/download/v${info.version}/${name}-${info.version}.asar.gz`),
+      { Accept: "application/octet-stream", ...this.options.extraHeaders },
+      signal,
       onDownloading
     );
   }
 };
-export {
-  GitHubProvider,
-  downloadAsarBufferDefault,
-  downloadUpdateJSONDefault
-};
+
+export { BaseProvider, GitHubProvider, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/types-C8JhnJjU.d.ts

@@ -0,0 +1,80 @@
+import { Promisable } from '@subframe7536/type-utils';
+import { a as UpdateJSON, U as UpdateInfo } from './version-BYVQ367i.js';
+
+type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
+type OnDownloading = (progress: DownloadingInfo) => void;
+interface DownloadingInfo {
+    /**
+     * Download buffer delta
+     */
+    delta: number;
+    /**
+     * Downloaded percent, 0 ~ 100
+     *
+     * If no `Content-Length` header, will be -1
+     */
+    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 in project
+     * @param signal abort signal
+     */
+    downloadJSON: (versionPath: string, signal: AbortSignal) => Promise<UpdateJSON>;
+    /**
+     * Download update asar
+     * @param name app name
+     * @param updateInfo existing update info
+     * @param signal abort signal
+     * @param onDownloading hook for on downloading
+     */
+    downloadAsar: (name: string, updateInfo: UpdateInfo, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
+    /**
+     * Check the old version is less than new version
+     * @param oldVer old version string
+     * @param newVer new version string
+     */
+    isLowerVersion: (oldVer: string, newVer: string) => boolean;
+    /**
+     * Function to decompress file using brotli
+     * @param buffer compressed file buffer
+     */
+    unzipFile: (buffer: Buffer) => Promise<Buffer>;
+    /**
+     * Verify asar signature,
+     * if signature is valid, returns the version, otherwise returns `undefined`
+     * @param buffer file buffer
+     * @param version target version
+     * @param signature signature
+     * @param cert certificate
+     */
+    verifySignaure: (buffer: Buffer, version: string, signature: string, cert: string) => Promisable<boolean>;
+}
+
+export type { DownloadingInfo as D, IProvider as I, OnDownloading as O, URLHandler as U };

package/dist/types-CGSkHX4Y.d.cts

@@ -0,0 +1,80 @@
+import { Promisable } from '@subframe7536/type-utils';
+import { a as UpdateJSON, U as UpdateInfo } from './version-BYVQ367i.cjs';
+
+type URLHandler = (url: URL, isDownloadAsar: boolean) => Promisable<URL | string | undefined | null>;
+type OnDownloading = (progress: DownloadingInfo) => void;
+interface DownloadingInfo {
+    /**
+     * Download buffer delta
+     */
+    delta: number;
+    /**
+     * Downloaded percent, 0 ~ 100
+     *
+     * If no `Content-Length` header, will be -1
+     */
+    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 in project
+     * @param signal abort signal
+     */
+    downloadJSON: (versionPath: string, signal: AbortSignal) => Promise<UpdateJSON>;
+    /**
+     * Download update asar
+     * @param name app name
+     * @param updateInfo existing update info
+     * @param signal abort signal
+     * @param onDownloading hook for on downloading
+     */
+    downloadAsar: (name: string, updateInfo: UpdateInfo, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void) => Promise<Buffer>;
+    /**
+     * Check the old version is less than new version
+     * @param oldVer old version string
+     * @param newVer new version string
+     */
+    isLowerVersion: (oldVer: string, newVer: string) => boolean;
+    /**
+     * Function to decompress file using brotli
+     * @param buffer compressed file buffer
+     */
+    unzipFile: (buffer: Buffer) => Promise<Buffer>;
+    /**
+     * Verify asar signature,
+     * if signature is valid, returns the version, otherwise returns `undefined`
+     * @param buffer file buffer
+     * @param version target version
+     * @param signature signature
+     * @param cert certificate
+     */
+    verifySignaure: (buffer: Buffer, version: string, signature: string, cert: string) => Promisable<boolean>;
+}
+
+export type { DownloadingInfo as D, IProvider as I, OnDownloading as O, URLHandler as U };