electron-incremental-update 2.2.2 → 2.2.4

package/dist/provider.d.ts

@@ -1,10 +1,12 @@
-import { I as IProvider, U as UpdateJSONWithURL, a as UpdateInfoWithURL, D as DownloadingInfo, O as OnDownloading, b as URLHandler } from './types-CStrrQPl.js';
-import { c as defaultVerifySignature, f as defaultUnzipFile } from './zip-DQdr8pFv.js';
-import { d as defaultIsLowerVersion, a as UpdateJSON } from './version-Bl_0oO5f.js';
-import { Arrayable } from '@subframe7536/type-utils';
+import { c as defaultVerifySignature, l as defaultUnzipFile } from './zip-DbfskMQi.js';
+export { j as defaultDownloadAsar, f as defaultDownloadJSON, i as defaultDownloadUpdateJSON, e as downloadUtil, g as getHeader } from './zip-DbfskMQi.js';
+import { e as UpdateInfoWithURL, I as IProvider, d as defaultIsLowerVersion, D as DownloadingInfo, f as URLHandler } from './types-C5M2xRjF.js';
+export { b as UpdateJSONWithURL } from './types-C5M2xRjF.js';
+import '@subframe7536/type-utils';
+import 'electron';
 import 'node:url';
 
-declare abstract class BaseProvider implements IProvider {
+declare abstract class BaseProvider<T extends UpdateInfoWithURL = UpdateInfoWithURL> implements IProvider<T> {
     name: string;
     /**
      * @inheritdoc
@@ -21,45 +23,13 @@ declare abstract class BaseProvider implements IProvider {
     /**
      * @inheritdoc
      */
-    abstract downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<UpdateJSONWithURL>;
+    abstract downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<T>;
     /**
      * @inheritdoc
      */
     abstract downloadAsar(info: UpdateInfoWithURL, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
-/**
- * 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;
-type ResolveDataFn = (data: string, resolve: (data: any) => void, reject: (e: any) => void) => void;
-/**
- * Default function to download json and parse to UpdateJson
- * @param url target url
- * @param headers extra headers
- * @param signal abort signal
- * @param resolveData on resolve
- */
-declare function defaultDownloadJSON<T>(url: string, headers: Record<string, any>, signal: AbortSignal, resolveData?: ResolveDataFn): Promise<T>;
-/**
- * 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>, signal: AbortSignal): Promise<UpdateJSON>;
-/**
- * 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>, signal: AbortSignal, onDownloading?: OnDownloading): Promise<Buffer>;
-
 interface GitHubProviderOptions {
     /**
      * Github user name
@@ -89,7 +59,7 @@ interface GitHubProviderOptions {
      */
     urlHandler?: URLHandler;
 }
-declare class GitHubProvider extends BaseProvider {
+declare class GitHubProvider<T extends UpdateInfoWithURL = UpdateInfoWithURL> extends BaseProvider<T> {
     name: string;
     private options;
     /**
@@ -108,7 +78,7 @@ declare class GitHubProvider extends BaseProvider {
     /**
      * @inheritdoc
      */
-    downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<UpdateJSONWithURL>;
+    downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<T>;
     /**
      * @inheritdoc
      */
@@ -137,7 +107,7 @@ interface GitHubApiProviderOptions {
      */
     urlHandler?: URLHandler;
 }
-declare class GitHubApiProvider extends BaseProvider {
+declare class GitHubApiProvider<T extends UpdateInfoWithURL = UpdateInfoWithURL> extends BaseProvider<T> {
     name: string;
     private options;
     /**
@@ -157,11 +127,11 @@ declare class GitHubApiProvider extends BaseProvider {
     /**
      * @inheritdoc
      */
-    downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<UpdateJSONWithURL>;
+    downloadJSON(name: string, versionPath: string, signal: AbortSignal): Promise<T>;
     /**
      * @inheritdoc
      */
     downloadAsar(info: UpdateInfoWithURL, signal: AbortSignal, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }
 
-export { BaseProvider, DownloadingInfo, GitHubApiProvider, type GitHubApiProviderOptions, GitHubProvider, type GitHubProviderOptions, IProvider, OnDownloading, URLHandler, UpdateInfoWithURL, UpdateJSONWithURL, defaultDownloadAsar, defaultDownloadJSON, defaultDownloadUpdateJSON, getHeader };
+export { BaseProvider, DownloadingInfo, GitHubApiProvider, type GitHubApiProviderOptions, GitHubProvider, type GitHubProviderOptions, IProvider, URLHandler, UpdateInfoWithURL };

package/dist/provider.js

@@ -1,6 +1,6 @@
-import { defaultVerifySignature, defaultUnzipFile } from './chunk-XGWQQVIZ.js';
-import { defaultIsLowerVersion, isUpdateJSON } from './chunk-AAAM44NW.js';
-import electron from 'electron';
+import { defaultVerifySignature, defaultUnzipFile, defaultDownloadUpdateJSON, defaultDownloadAsar, defaultDownloadJSON } from './chunk-D7NXTCQW.js';
+export { defaultDownloadAsar, defaultDownloadJSON, defaultDownloadUpdateJSON, downloadUtil, getHeader } from './chunk-D7NXTCQW.js';
+import { defaultIsLowerVersion } from './chunk-AAAM44NW.js';
 import { URL } from 'node:url';
 
 // src/provider/base.ts
@@ -19,97 +19,6 @@ var BaseProvider = class {
    */
   unzipFile = defaultUnzipFile;
 };
-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 = 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")));
-      onResponse(resp, resolve, reject);
-    });
-    request.on("error", reject);
-    request.end();
-  });
-}
-function trimData(data) {
-  return data.trim().slice(0, 5e3).replace(/\s+/g, " ");
-}
-var defaultResolveDataFn = (data, resolve, reject) => {
-  try {
-    resolve(JSON.parse(data));
-  } catch {
-    reject(new Error(`Invalid json, "${trimData(data)}"`));
-  }
-};
-async function defaultDownloadJSON(url, headers, signal, resolveData = defaultResolveDataFn) {
-  return await downloadFn(
-    url,
-    headers,
-    signal,
-    (resp, resolve, reject) => {
-      let data = "";
-      resp.on("data", (chunk) => data += chunk);
-      resp.on("end", () => resolveData(data, resolve, reject));
-    }
-  );
-}
-async function defaultDownloadUpdateJSON(url, headers, signal) {
-  return await defaultDownloadJSON(
-    url,
-    headers,
-    signal,
-    (data, resolve, reject) => {
-      try {
-        const json = JSON.parse(data);
-        if (isUpdateJSON(json)) {
-          resolve(json);
-        } else {
-          throw Error;
-        }
-      } catch {
-        reject(new Error(`Invalid update json, "${trimData(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;
-      const data = [];
-      resp.on("data", (chunk) => {
-        const delta = chunk.length;
-        transferred += delta;
-        const current = Date.now();
-        onDownloading?.({
-          percent: total > 0 ? +(transferred / total).toFixed(2) * 100 : -1,
-          total,
-          transferred,
-          delta,
-          bps: delta / (current - time)
-        });
-        time = current;
-        data.push(chunk);
-      });
-      resp.on("end", () => resolve(Buffer.concat(data)));
-    }
-  );
-}
 var GitHubProvider = class extends BaseProvider {
   name = "GithubProvider";
   options;
@@ -266,4 +175,4 @@ var GitHubApiProvider = class extends BaseProvider {
   }
 };
 
-export { BaseProvider, GitHubApiProvider, GitHubProvider, defaultDownloadAsar, defaultDownloadJSON, defaultDownloadUpdateJSON, getHeader };
+export { BaseProvider, GitHubApiProvider, GitHubProvider };

package/dist/{types-CStrrQPl.d.ts → types-C5M2xRjF.d.cts}

@@ -1,11 +1,82 @@
 import { Promisable } from '@subframe7536/type-utils';
 import { URL } from 'node:url';
-import { U as UpdateInfo } from './version-Bl_0oO5f.js';
+
+interface Version {
+    /**
+     * `4` of `4.3.2-beta.1`
+     */
+    major: number;
+    /**
+     * `3` of `4.3.2-beta.1`
+     */
+    minor: number;
+    /**
+     * `2` of `4.3.2-beta.1`
+     */
+    patch: number;
+    /**
+     * `beta` of `4.3.2-beta.1`
+     */
+    stage: string;
+    /**
+     * `1` of `4.3.2-beta.1`
+     */
+    stageVersion: number;
+}
+/**
+ * Parse version string to {@link Version}, like `0.2.0-beta.1`
+ * @param version version string
+ */
+declare function parseVersion(version: string): Version;
+/**
+ * Default function to check the old version is less than new version
+ * @param oldVer old version string
+ * @param newVer new version string
+ */
+declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
+/**
+ * Update info json
+ */
+type UpdateInfo = {
+    /**
+     * Update Asar signature
+     */
+    signature: string;
+    /**
+     * Minimum version
+     */
+    minimumVersion: string;
+    /**
+     * Target version
+     */
+    version: string;
+};
+/**
+ * {@link UpdateInfo} with beta
+ */
+type UpdateJSON = UpdateInfo & {
+    /**
+     * Beta update info
+     */
+    beta: UpdateInfo;
+};
+/**
+ * Check is `UpdateJSON`
+ * @param json any variable
+ */
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+/**
+ * Default function to generate `UpdateJSON`
+ * @param existingJson exising update json
+ * @param signature sigature
+ * @param version target version
+ * @param minimumVersion minimum version
+ */
+declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
 
 type UpdateInfoWithURL = UpdateInfo & {
     url: string;
 };
-type OnDownloading = (progress: DownloadingInfo) => void;
 interface DownloadingInfo {
     /**
      * Download buffer delta
@@ -77,4 +148,4 @@ interface IProvider<T extends UpdateInfoWithURL = UpdateInfoWithURL> {
 }
 type URLHandler = (url: URL) => Promisable<URL | string | undefined | null>;
 
-export type { DownloadingInfo as D, IProvider as I, OnDownloading as O, UpdateJSONWithURL as U, UpdateInfoWithURL as a, URLHandler as b };
+export { type DownloadingInfo as D, type IProvider as I, type UpdateInfo as U, type Version as V, type UpdateJSON as a, type UpdateJSONWithURL as b, defaultVersionJsonGenerator as c, defaultIsLowerVersion as d, type UpdateInfoWithURL as e, type URLHandler as f, isUpdateJSON as i, parseVersion as p };

package/dist/{types-CWtySwqA.d.cts → types-C5M2xRjF.d.ts}

@@ -1,11 +1,82 @@
 import { Promisable } from '@subframe7536/type-utils';
 import { URL } from 'node:url';
-import { U as UpdateInfo } from './version-Bl_0oO5f.cjs';
+
+interface Version {
+    /**
+     * `4` of `4.3.2-beta.1`
+     */
+    major: number;
+    /**
+     * `3` of `4.3.2-beta.1`
+     */
+    minor: number;
+    /**
+     * `2` of `4.3.2-beta.1`
+     */
+    patch: number;
+    /**
+     * `beta` of `4.3.2-beta.1`
+     */
+    stage: string;
+    /**
+     * `1` of `4.3.2-beta.1`
+     */
+    stageVersion: number;
+}
+/**
+ * Parse version string to {@link Version}, like `0.2.0-beta.1`
+ * @param version version string
+ */
+declare function parseVersion(version: string): Version;
+/**
+ * Default function to check the old version is less than new version
+ * @param oldVer old version string
+ * @param newVer new version string
+ */
+declare function defaultIsLowerVersion(oldVer: string, newVer: string): boolean;
+/**
+ * Update info json
+ */
+type UpdateInfo = {
+    /**
+     * Update Asar signature
+     */
+    signature: string;
+    /**
+     * Minimum version
+     */
+    minimumVersion: string;
+    /**
+     * Target version
+     */
+    version: string;
+};
+/**
+ * {@link UpdateInfo} with beta
+ */
+type UpdateJSON = UpdateInfo & {
+    /**
+     * Beta update info
+     */
+    beta: UpdateInfo;
+};
+/**
+ * Check is `UpdateJSON`
+ * @param json any variable
+ */
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+/**
+ * Default function to generate `UpdateJSON`
+ * @param existingJson exising update json
+ * @param signature sigature
+ * @param version target version
+ * @param minimumVersion minimum version
+ */
+declare function defaultVersionJsonGenerator(existingJson: UpdateJSON, signature: string, version: string, minimumVersion: string): UpdateJSON;
 
 type UpdateInfoWithURL = UpdateInfo & {
     url: string;
 };
-type OnDownloading = (progress: DownloadingInfo) => void;
 interface DownloadingInfo {
     /**
      * Download buffer delta
@@ -77,4 +148,4 @@ interface IProvider<T extends UpdateInfoWithURL = UpdateInfoWithURL> {
 }
 type URLHandler = (url: URL) => Promisable<URL | string | undefined | null>;
 
-export type { DownloadingInfo as D, IProvider as I, OnDownloading as O, UpdateJSONWithURL as U, UpdateInfoWithURL as a, URLHandler as b };
+export { type DownloadingInfo as D, type IProvider as I, type UpdateInfo as U, type Version as V, type UpdateJSON as a, type UpdateJSONWithURL as b, defaultVersionJsonGenerator as c, defaultIsLowerVersion as d, type UpdateInfoWithURL as e, type URLHandler as f, isUpdateJSON as i, parseVersion as p };