electron-incremental-update 2.0.0-beta.8 → 2.0.0

package/dist/provider.d.cts

@@ -1,45 +1,59 @@
-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';
+import { URL } from 'node:url';
+import { Promisable, Arrayable } from '@subframe7536/type-utils';
+import { d as defaultIsLowerVersion, a as UpdateJSON, U as UpdateInfo } from './version-BYVQ367i.cjs';
+import { I as IProvider, D as DownloadingInfo, O as OnDownloading } from './types-DkCn03M3.cjs';
+import { f as defaultVerifySignature, a as defaultUnzipFile } from './zip-rm9ED9nU.cjs';
 
 declare abstract class BaseProvider implements IProvider {
     name: string;
+    /**
+     * @inheritdoc
+     */
     isLowerVersion: typeof defaultIsLowerVersion;
+    /**
+     * @inheritdoc
+     */
     verifySignaure: typeof defaultVerifySignature;
+    /**
+     * @inheritdoc
+     */
     unzipFile: typeof defaultUnzipFile;
-    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+    /**
+     * @inheritdoc
+     */
+    abstract downloadJSON(versionPath: string, signal: AbortSignal): Promise<UpdateJSON>;
+    /**
+     * @inheritdoc
+     */
+    abstract downloadAsar(name: string, info: UpdateInfo, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
+type URLHandler = (url: URL) => Promisable<URL | string | undefined | null>;
 interface GitHubProviderOptions {
     /**
-     * github user name
+     * Github user name
      */
-    username: string;
+    user: string;
     /**
-     * github repo name
+     * Github repo name
      */
     repo: string;
     /**
-     * github branch name that fetch version
+     * Github branch name that fetch version
      * @default 'HEAD'
      */
     branch?: string;
     /**
-     * extra headers
+     * 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}
+     * Custom url handler ({@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 some public CDN links})
      * @example
-     * (url, isDownloadAsar) => {
-     *   if (isDownloadAsar) {
-     *     url.hostname = 'mirror.ghproxy.com'
-     *     url.pathname = 'https://github.com' + url.pathname
-     *     return url
-     *   }
+     * (url) => {
+     *   url.hostname = 'mirror.ghproxy.com'
+     *   url.pathname = 'https://github.com' + url.pathname
+     *   return url
      * }
      */
     urlHandler?: URLHandler;
@@ -49,28 +63,47 @@ declare class GitHubProvider extends BaseProvider {
     private options;
     /**
      * Update Provider for Github repo
-     * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
+     * - download update json from `https://github.com/{user}/{repo}/raw/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
+     * you can setup `urlHandler` in {@link GitHubProviderOptions} 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>;
+    /**
+     * @inheritdoc
+     */
+    downloadJSON(versionPath: string, signal: AbortSignal): Promise<UpdateJSON>;
+    /**
+     * @inheritdoc
+     */
+    downloadAsar(name: string, info: UpdateInfo, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
-declare function getHeader(response: Record<string, Arrayable<string>>, headerKey: any): any;
 /**
- * download json and parse UpdateJson
+ * Safe get value from header
+ * @param headers response header
+ * @param key target header key
+ */
+declare function getHeader(headers: Record<string, Arrayable<string>>, key: any): any;
+/**
+ * Default function to download json and parse to UpdateJson
+ * @param url target url
+ * @param headers extra headers
+ * @param signal abort signal
  */
-declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
+declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>, signal: AbortSignal): Promise<UpdateJSON>;
 /**
- * download asar buffer, get total size from `Content-Length` header
+ * Default function to download asar buffer,
+ * get total size from `Content-Length` header
+ * @param url target url
+ * @param headers extra headers
+ * @param signal abort signal
+ * @param onDownloading on downloading callback
  */
-declare function defaultDownloadAsar(url: string, headers: Record<string, any>, onDownloading?: OnDownloading): Promise<Buffer>;
+declare function defaultDownloadAsar(url: string, headers: Record<string, any>, signal: AbortSignal, onDownloading?: OnDownloading): Promise<Buffer>;
 
-export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };
+export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, type URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/provider.d.ts

@@ -1,45 +1,59 @@
-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';
+import { URL } from 'node:url';
+import { Promisable, Arrayable } from '@subframe7536/type-utils';
+import { d as defaultIsLowerVersion, a as UpdateJSON, U as UpdateInfo } from './version-BYVQ367i.js';
+import { I as IProvider, D as DownloadingInfo, O as OnDownloading } from './types-BLdN9rkY.js';
+import { f as defaultVerifySignature, a as defaultUnzipFile } from './zip-rm9ED9nU.js';
 
 declare abstract class BaseProvider implements IProvider {
     name: string;
+    /**
+     * @inheritdoc
+     */
     isLowerVersion: typeof defaultIsLowerVersion;
+    /**
+     * @inheritdoc
+     */
     verifySignaure: typeof defaultVerifySignature;
+    /**
+     * @inheritdoc
+     */
     unzipFile: typeof defaultUnzipFile;
-    abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
-    abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
+    /**
+     * @inheritdoc
+     */
+    abstract downloadJSON(versionPath: string, signal: AbortSignal): Promise<UpdateJSON>;
+    /**
+     * @inheritdoc
+     */
+    abstract downloadAsar(name: string, info: UpdateInfo, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
+type URLHandler = (url: URL) => Promisable<URL | string | undefined | null>;
 interface GitHubProviderOptions {
     /**
-     * github user name
+     * Github user name
      */
-    username: string;
+    user: string;
     /**
-     * github repo name
+     * Github repo name
      */
     repo: string;
     /**
-     * github branch name that fetch version
+     * Github branch name that fetch version
      * @default 'HEAD'
      */
     branch?: string;
     /**
-     * extra headers
+     * 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}
+     * Custom url handler ({@link https://github.com/XIU2/UserScript/blob/master/GithubEnhanced-High-Speed-Download.user.js#L40 some public CDN links})
      * @example
-     * (url, isDownloadAsar) => {
-     *   if (isDownloadAsar) {
-     *     url.hostname = 'mirror.ghproxy.com'
-     *     url.pathname = 'https://github.com' + url.pathname
-     *     return url
-     *   }
+     * (url) => {
+     *   url.hostname = 'mirror.ghproxy.com'
+     *   url.pathname = 'https://github.com' + url.pathname
+     *   return url
      * }
      */
     urlHandler?: URLHandler;
@@ -49,28 +63,47 @@ declare class GitHubProvider extends BaseProvider {
     private options;
     /**
      * Update Provider for Github repo
-     * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
+     * - download update json from `https://github.com/{user}/{repo}/raw/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
+     * you can setup `urlHandler` in {@link GitHubProviderOptions} 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>;
+    /**
+     * @inheritdoc
+     */
+    downloadJSON(versionPath: string, signal: AbortSignal): Promise<UpdateJSON>;
+    /**
+     * @inheritdoc
+     */
+    downloadAsar(name: string, info: UpdateInfo, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
-declare function getHeader(response: Record<string, Arrayable<string>>, headerKey: any): any;
 /**
- * download json and parse UpdateJson
+ * Safe get value from header
+ * @param headers response header
+ * @param key target header key
+ */
+declare function getHeader(headers: Record<string, Arrayable<string>>, key: any): any;
+/**
+ * Default function to download json and parse to UpdateJson
+ * @param url target url
+ * @param headers extra headers
+ * @param signal abort signal
  */
-declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>): Promise<UpdateJSON>;
+declare function defaultDownloadUpdateJSON(url: string, headers: Record<string, any>, signal: AbortSignal): Promise<UpdateJSON>;
 /**
- * download asar buffer, get total size from `Content-Length` header
+ * Default function to download asar buffer,
+ * get total size from `Content-Length` header
+ * @param url target url
+ * @param headers extra headers
+ * @param signal abort signal
+ * @param onDownloading on downloading callback
  */
-declare function defaultDownloadAsar(url: string, headers: Record<string, any>, onDownloading?: OnDownloading): Promise<Buffer>;
+declare function defaultDownloadAsar(url: string, headers: Record<string, any>, signal: AbortSignal, onDownloading?: OnDownloading): Promise<Buffer>;
 
-export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };
+export { BaseProvider, DownloadingInfo, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, type URLHandler, defaultDownloadAsar, defaultDownloadUpdateJSON, getHeader };

package/dist/provider.js

@@ -1,21 +1,21 @@
 import { defaultVerifySignature, defaultUnzipFile } from './chunk-KZSYEXLO.js';
-import { defaultIsLowerVersion, isUpdateJSON } from './chunk-72ZAJ7AF.js';
+import { defaultIsLowerVersion, isUpdateJSON } from './chunk-RCRKUKFX.js';
 import { URL } from 'node:url';
-import { app, net } from 'electron';
+import electron from 'electron';
 
-function getHeader(response, headerKey) {
-  const value = response.headers[headerKey];
+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, onResponse) {
-  await app.whenReady();
+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")));
@@ -25,53 +25,72 @@ async function downloadFn(url, headers, onResponse) {
     request.end();
   });
 }
-async function defaultDownloadUpdateJSON(url, headers) {
-  return await downloadFn(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 {
-        reject(new Error("invalid update json"));
-      }
-    });
-  });
+      });
+    }
+  );
 }
-async function defaultDownloadAsar(url, headers, onDownloading) {
+async function defaultDownloadAsar(url, headers, signal, onDownloading) {
   let transferred = 0;
   let time = Date.now();
-  return await downloadFn(url, headers, (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: +(transferred / total).toFixed(2) * 100,
-        total,
-        transferred,
-        delta,
-        bps: delta / ((current - time) * 1e3)
+  return await downloadFn(
+    url,
+    headers,
+    signal,
+    (resp, resolve) => {
+      const total = +getHeader(resp.headers, "content-length") || -1;
+      const 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)
+        });
+        time = current;
+        data.push(chunk);
       });
-      time = current;
-      data.push(chunk);
-    });
-    resp.on("end", () => resolve(Buffer.concat(data)));
-  });
+      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;
 };
 
@@ -81,15 +100,18 @@ var GitHubProvider = class extends BaseProvider {
   options;
   /**
    * Update Provider for Github repo
-   * - download update json from `https://raw.githubusercontent.com/{user}/{repo}/HEAD/{versionPath}`
+   * - download update json from `https://github.com/{user}/{repo}/raw/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
+   * you can setup `urlHandler` in {@link GitHubProviderOptions} to modify url before request
    * @param options provider options
    */
   constructor(options) {
     super();
     this.options = options;
+    if (!options.branch) {
+      this.options.branch = "HEAD";
+    }
   }
   get urlHandler() {
     return this.options.urlHandler;
@@ -97,23 +119,31 @@ var GitHubProvider = class extends BaseProvider {
   set urlHandler(handler) {
     this.options.urlHandler = handler;
   }
-  async parseURL(isDownloadAsar, extraPath) {
+  async parseURL(extraPath) {
     const url = new URL(
-      `/${this.options.username}/${this.options.repo}/${extraPath}`,
-      "https://" + (isDownloadAsar ? "github.com" : "raw.githubusercontent.com")
+      `/${this.options.user}/${this.options.repo}/${extraPath}`,
+      "https://github.com"
     );
-    return (await this.urlHandler?.(url, isDownloadAsar) || url).toString();
+    return (await this.urlHandler?.(url) || url).toString();
   }
-  async downloadJSON(versionPath) {
+  /**
+   * @inheritdoc
+   */
+  async downloadJSON(versionPath, signal) {
     return await defaultDownloadUpdateJSON(
-      await this.parseURL(false, `${this.options.branch ?? "HEAD"}/${versionPath}`),
-      { accept: "application/json", ...this.options.extraHeaders }
+      await this.parseURL(`raw/${this.options.branch}/${versionPath}`),
+      { Accept: "application/json", ...this.options.extraHeaders },
+      signal
     );
   }
-  async downloadAsar(name, info, onDownloading) {
+  /**
+   * @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 },
+      await this.parseURL(`releases/download/v${info.version}/${name}-${info.version}.asar.gz`),
+      { Accept: "application/octet-stream", ...this.options.extraHeaders },
+      signal,
       onDownloading
     );
   }

package/dist/types-BLdN9rkY.d.ts

@@ -0,0 +1,72 @@
+import { Promisable } from '@subframe7536/type-utils';
+import { a as UpdateJSON, U as UpdateInfo } from './version-BYVQ367i.js';
+
+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;
+    /**
+     * 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 };

package/dist/types-DkCn03M3.d.cts

@@ -0,0 +1,72 @@
+import { Promisable } from '@subframe7536/type-utils';
+import { a as UpdateJSON, U as UpdateInfo } from './version-BYVQ367i.cjs';
+
+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;
+    /**
+     * 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 };