electron-incremental-update 2.4.2 → 3.0.0-beta.2

package/dist/types-BM9Jfu7q.d.cts

@@ -0,0 +1,154 @@
+//#region node_modules/@subframe7536/type-utils/index.d.ts
+type Promisable<T> = T | Promise<T>;
+type Arrayable<T> = T | T[];
+//#endregion
+//#region src/utils/version.d.ts
+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
+*/
+interface 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;
+//#endregion
+//#region src/provider/types.d.ts
+type UpdateInfoWithURL = UpdateInfo & {
+  url: string;
+};
+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;
+}
+type UpdateJSONWithURL = UpdateInfoWithURL & {
+  beta: UpdateInfoWithURL;
+};
+interface IProvider {
+  /**
+  * Provider name
+  */
+  name: string;
+  /**
+  * Download update json
+  * @param name app name
+  * @param versionPath normalized version path in project
+  * @param signal abort signal
+  */
+  downloadJSON: (name: string, versionPath: string, signal: AbortSignal) => Promise<UpdateJSONWithURL>;
+  /**
+  * Download update asar buffer
+  * @param updateInfo existing update info
+  * @param signal abort signal
+  * @param onDownloading hook for on downloading
+  */
+  downloadAsar: (updateInfo: UpdateInfoWithURL, 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>;
+}
+type URLHandler = (url: URL) => Promisable<URL | string | undefined | null>;
+//#endregion
+export { UpdateJSONWithURL as a, Version as c, isUpdateJSON as d, parseVersion as f, UpdateInfoWithURL as i, defaultIsLowerVersion as l, Promisable as m, IProvider as n, UpdateInfo as o, Arrayable as p, URLHandler as r, UpdateJSON as s, DownloadingInfo as t, defaultVersionJsonGenerator as u };

package/dist/types-DASqEPXE.d.mts

@@ -0,0 +1,154 @@
+//#region node_modules/@subframe7536/type-utils/index.d.ts
+type Promisable<T> = T | Promise<T>;
+type Arrayable<T> = T | T[];
+//#endregion
+//#region src/utils/version.d.ts
+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
+*/
+interface 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;
+//#endregion
+//#region src/provider/types.d.ts
+type UpdateInfoWithURL = UpdateInfo & {
+  url: string;
+};
+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;
+}
+type UpdateJSONWithURL = UpdateInfoWithURL & {
+  beta: UpdateInfoWithURL;
+};
+interface IProvider {
+  /**
+  * Provider name
+  */
+  name: string;
+  /**
+  * Download update json
+  * @param name app name
+  * @param versionPath normalized version path in project
+  * @param signal abort signal
+  */
+  downloadJSON: (name: string, versionPath: string, signal: AbortSignal) => Promise<UpdateJSONWithURL>;
+  /**
+  * Download update asar buffer
+  * @param updateInfo existing update info
+  * @param signal abort signal
+  * @param onDownloading hook for on downloading
+  */
+  downloadAsar: (updateInfo: UpdateInfoWithURL, 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>;
+}
+type URLHandler = (url: URL) => Promisable<URL | string | undefined | null>;
+//#endregion
+export { UpdateJSONWithURL as a, Version as c, isUpdateJSON as d, parseVersion as f, UpdateInfoWithURL as i, defaultIsLowerVersion as l, Promisable as m, IProvider as n, UpdateInfo as o, Arrayable as p, URLHandler as r, UpdateJSON as s, DownloadingInfo as t, defaultVersionJsonGenerator as u };