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

package/dist/index.cjs

@@ -1,14 +1,14 @@
 'use strict';
 
-var path = require('path');
 var fs3 = require('fs');
-var electron = require('electron');
 var events = require('events');
+var electron = require('electron');
+var path = require('path');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
-var path__default = /*#__PURE__*/_interopDefault(path);
 var fs3__default = /*#__PURE__*/_interopDefault(fs3);
+var path__default = /*#__PURE__*/_interopDefault(path);
 
 var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
   get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
@@ -40,7 +40,7 @@ function restartApp() {
   electron.app.quit();
 }
 
-// src/updater/types.ts
+// src/entry/types.ts
 var ErrorInfo = {
   download: "Download failed",
   validate: "Validate failed",
@@ -55,7 +55,7 @@ var UpdaterError = class extends Error {
   }
 };
 
-// src/updater/core.ts
+// src/entry/updater.ts
 var Updater = class extends events.EventEmitter {
   CERT = __EIU_SIGNATURE_CERT__;
   info;
@@ -74,19 +74,14 @@ var Updater = class extends events.EventEmitter {
   forceUpdate;
   /**
    * initialize incremental updater
-   * @param provider update provider
-   * @param option UpdaterOption
+   * @param options UpdaterOption
    */
-  constructor(provider, option = {}) {
+  constructor(options = {}) {
     super();
-    this.provider = provider;
-    this.receiveBeta = option.receiveBeta;
-    if (option.SIGNATURE_CERT) {
-      this.CERT = option.SIGNATURE_CERT;
-    }
-    if (option.logger) {
-      this.logger = option.logger;
-    }
+    this.provider = options.provider;
+    this.receiveBeta = options.receiveBeta;
+    this.CERT = options.SIGNATURE_CERT || __EIU_SIGNATURE_CERT__;
+    this.logger = options.logger;
     if (isDev && !this.logger) {
       this.logger = {
         info: (...args) => console.log("[EIU-INFO ]", ...args),
@@ -96,6 +91,14 @@ var Updater = class extends events.EventEmitter {
       };
       this.logger.info("no logger set, enable dev-only logger");
     }
+    if (!this.provider) {
+      this.logger?.debug("No update provider, please setup provider before checking update");
+    }
+  }
+  checkProvider() {
+    if (!this.provider) {
+      throw new UpdaterError("param", "missing update provider");
+    }
   }
   async fetch(format, data) {
     if (typeof data === "object") {
@@ -124,6 +127,7 @@ var Updater = class extends events.EventEmitter {
     this.emit("error", err);
   }
   async checkUpdate(data) {
+    this.checkProvider();
     const emitUnavailable = (msg) => {
       this.logger?.info(msg);
       this.emit("update-unavailable", msg);
@@ -159,6 +163,7 @@ var Updater = class extends events.EventEmitter {
     return true;
   }
   async downloadUpdate(data, info) {
+    this.checkProvider();
     const _sig = info?.signature ?? this.info?.signature;
     const _version = info?.version ?? this.info?.version;
     if (!_sig || !_version) {
@@ -196,23 +201,12 @@ var Updater = class extends events.EventEmitter {
     this.logger?.info("quit and install");
     restartApp();
   }
-  /**
-   * setup provider URL handler
-   *
-   * @example
-   * updater.setURLHandler((url, isDownloadingAsar) => {
-   *   if (isDownloadingAsar) {
-   *     url.hostname = 'https://cdn.jsdelivr.net/gh'
-   *     return url
-   *   }
-   * })
-   */
-  setURLHandler(handler) {
-    this.provider.urlHandler = handler;
-  }
 };
-
-// src/entry.ts
+async function autoUpdate(updater) {
+  if (await updater.checkUpdate() && await updater.downloadUpdate()) {
+    updater.quitAndInstall();
+  }
+}
 function startupWithUpdater(fn) {
   return fn;
 }
@@ -222,7 +216,6 @@ var defaultOnInstall = (install, _, __, logger) => {
 };
 async function initApp(appOptions) {
   const {
-    provider,
     updater,
     onInstall = defaultOnInstall,
     beforeStart,
@@ -230,19 +223,11 @@ async function initApp(appOptions) {
   } = appOptions;
   let updaterInstance;
   if (typeof updater === "object" || !updater) {
-    updaterInstance = new Updater(provider, updater);
+    updaterInstance = new Updater(updater);
   } else {
     updaterInstance = await updater();
   }
-  let logger = updaterInstance.logger;
-  if (isDev && !logger) {
-    logger = {
-      info: (...args) => console.log("[EIU-INFO ]", ...args),
-      debug: (...args) => console.log("[EIU-DEBUG]", ...args),
-      warn: (...args) => console.log("[EIU-WARN ]", ...args),
-      error: (...args) => console.error("[EIU-ERROR]", ...args)
-    };
-  }
+  const logger = updaterInstance.logger;
   try {
     const appNameAsarPath = getPathFromAppNameAsar();
     const tempAsarPath = `${appNameAsarPath}.tmp`;
@@ -267,5 +252,6 @@ async function initApp(appOptions) {
 exports.ErrorInfo = ErrorInfo;
 exports.Updater = Updater;
 exports.UpdaterError = UpdaterError;
+exports.autoUpdate = autoUpdate;
 exports.initApp = initApp;
 exports.startupWithUpdater = startupWithUpdater;

package/dist/index.d.cts

@@ -1,9 +1,134 @@
-import { U as Updater, a as UpdaterOption, L as Logger } from './core-ZUlLHadf.cjs';
-export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-ZUlLHadf.cjs';
-import { I as IProvider } from './types-CItP6bL-.cjs';
-import 'node:events';
+import { EventEmitter } from 'node:events';
+import { U as UpdateJSON, a as UpdateInfo } from './version-DgfjJQUx.cjs';
+import { I as IProvider, D as DownloadingInfo } from './types-mEfMjnlV.cjs';
 import '@subframe7536/type-utils';
 
+declare const ErrorInfo: {
+    readonly download: "Download failed";
+    readonly validate: "Validate failed";
+    readonly param: "Missing params";
+    readonly network: "Network error";
+};
+declare class UpdaterError extends Error {
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, info: string);
+}
+type CheckResult<T extends UpdateJSON> = {
+    success: true;
+    data: Omit<T, 'beta'>;
+} | {
+    success: false;
+    /**
+     * minimal version that can update
+     */
+    data: string;
+} | {
+    success: false;
+    data: UpdaterError;
+};
+type DownloadResult = {
+    success: true;
+} | {
+    success: false;
+    data: UpdaterError;
+};
+interface Logger {
+    info: (msg: string) => void;
+    debug: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string, e?: unknown) => void;
+}
+interface UpdaterOption {
+    /**
+     * update provider
+     */
+    provider?: IProvider;
+    /**
+     * public key of signature, which will be auto generated by plugin,
+     * generate by `selfsigned` if not set
+     */
+    SIGNATURE_CERT?: string;
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    logger?: Logger;
+}
+
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-unavailable': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+}> {
+    private CERT;
+    private info?;
+    provider?: IProvider;
+    /**
+     * updater logger
+     */
+    logger?: Logger;
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    /**
+     * whether force update in DEV
+     */
+    forceUpdate?: boolean;
+    /**
+     * initialize incremental updater
+     * @param options UpdaterOption
+     */
+    constructor(options?: UpdaterOption);
+    private checkProvider;
+    /**
+     * this function is used to parse download data.
+     * - if format is `'json'`
+     *   - if data is `UpdateJSON`, return it
+     *   - if data is string or absent, download URL data and return it
+     * - if format is `'buffer'`
+     *   - if data is `Buffer`, return it
+     *   - if data is string or absent, download URL data and return it
+     * @param format 'json' or 'buffer'
+     * @param data download URL or update json or buffer
+     */
+    private fetch;
+    /**
+     * handle error message and emit error event
+     */
+    private err;
+    /**
+     * check update info using default options
+     */
+    checkUpdate(): Promise<boolean>;
+    /**
+     * check update info using existing update json
+     * @param data existing update json
+     */
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
+    /**
+     * download update using default options
+     */
+    downloadUpdate(): Promise<boolean>;
+    /**
+     * download update using existing `asar.gz` buffer and signature
+     * @param data existing `asar.gz` buffer
+     * @param info update info
+     */
+    downloadUpdate(data: Uint8Array, info: Omit<UpdateInfo, 'minimumVersion'>): Promise<boolean>;
+    /**
+     * quit App and install
+     */
+    quitAndInstall(): void;
+}
+/**
+ * auto check update, download and install
+ */
+declare function autoUpdate(updater: Updater): Promise<void>;
+
 type Promisable<T> = T | Promise<T>;
 /**
  * hooks on rename temp asar path to `${app.name}.asar`
@@ -15,10 +140,6 @@ type Promisable<T> = T | Promise<T>;
  */
 type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
-    /**
-     * update provider
-     */
-    provider: IProvider;
     /**
      * updater options
      */
@@ -75,4 +196,4 @@ declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>):
  */
 declare function initApp(appOptions: AppOption): Promise<void>;
 
-export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, initApp, startupWithUpdater };

package/dist/index.d.ts

@@ -1,9 +1,134 @@
-import { U as Updater, a as UpdaterOption, L as Logger } from './core-DJdvtwvU.js';
-export { C as CheckResult, D as DownloadResult, E as ErrorInfo, b as UpdaterError } from './core-DJdvtwvU.js';
-import { I as IProvider } from './types-CItP6bL-.js';
-import 'node:events';
+import { EventEmitter } from 'node:events';
+import { U as UpdateJSON, a as UpdateInfo } from './version-DgfjJQUx.js';
+import { I as IProvider, D as DownloadingInfo } from './types-D7OK98ln.js';
 import '@subframe7536/type-utils';
 
+declare const ErrorInfo: {
+    readonly download: "Download failed";
+    readonly validate: "Validate failed";
+    readonly param: "Missing params";
+    readonly network: "Network error";
+};
+declare class UpdaterError extends Error {
+    code: keyof typeof ErrorInfo;
+    constructor(msg: keyof typeof ErrorInfo, info: string);
+}
+type CheckResult<T extends UpdateJSON> = {
+    success: true;
+    data: Omit<T, 'beta'>;
+} | {
+    success: false;
+    /**
+     * minimal version that can update
+     */
+    data: string;
+} | {
+    success: false;
+    data: UpdaterError;
+};
+type DownloadResult = {
+    success: true;
+} | {
+    success: false;
+    data: UpdaterError;
+};
+interface Logger {
+    info: (msg: string) => void;
+    debug: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string, e?: unknown) => void;
+}
+interface UpdaterOption {
+    /**
+     * update provider
+     */
+    provider?: IProvider;
+    /**
+     * public key of signature, which will be auto generated by plugin,
+     * generate by `selfsigned` if not set
+     */
+    SIGNATURE_CERT?: string;
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    logger?: Logger;
+}
+
+declare class Updater extends EventEmitter<{
+    'checking': any;
+    'update-available': [data: UpdateInfo];
+    'update-unavailable': [reason: string];
+    'error': [error: UpdaterError];
+    'download-progress': [info: DownloadingInfo];
+    'update-downloaded': any;
+}> {
+    private CERT;
+    private info?;
+    provider?: IProvider;
+    /**
+     * updater logger
+     */
+    logger?: Logger;
+    /**
+     * whether to receive beta update
+     */
+    receiveBeta?: boolean;
+    /**
+     * whether force update in DEV
+     */
+    forceUpdate?: boolean;
+    /**
+     * initialize incremental updater
+     * @param options UpdaterOption
+     */
+    constructor(options?: UpdaterOption);
+    private checkProvider;
+    /**
+     * this function is used to parse download data.
+     * - if format is `'json'`
+     *   - if data is `UpdateJSON`, return it
+     *   - if data is string or absent, download URL data and return it
+     * - if format is `'buffer'`
+     *   - if data is `Buffer`, return it
+     *   - if data is string or absent, download URL data and return it
+     * @param format 'json' or 'buffer'
+     * @param data download URL or update json or buffer
+     */
+    private fetch;
+    /**
+     * handle error message and emit error event
+     */
+    private err;
+    /**
+     * check update info using default options
+     */
+    checkUpdate(): Promise<boolean>;
+    /**
+     * check update info using existing update json
+     * @param data existing update json
+     */
+    checkUpdate(data: UpdateJSON): Promise<boolean>;
+    /**
+     * download update using default options
+     */
+    downloadUpdate(): Promise<boolean>;
+    /**
+     * download update using existing `asar.gz` buffer and signature
+     * @param data existing `asar.gz` buffer
+     * @param info update info
+     */
+    downloadUpdate(data: Uint8Array, info: Omit<UpdateInfo, 'minimumVersion'>): Promise<boolean>;
+    /**
+     * quit App and install
+     */
+    quitAndInstall(): void;
+}
+/**
+ * auto check update, download and install
+ */
+declare function autoUpdate(updater: Updater): Promise<void>;
+
 type Promisable<T> = T | Promise<T>;
 /**
  * hooks on rename temp asar path to `${app.name}.asar`
@@ -15,10 +140,6 @@ type Promisable<T> = T | Promise<T>;
  */
 type OnInstallFunction = (install: VoidFunction, tempAsarPath: string, appNameAsarPath: string, logger?: Logger) => Promisable<void>;
 interface AppOption {
-    /**
-     * update provider
-     */
-    provider: IProvider;
     /**
      * updater options
      */
@@ -75,4 +196,4 @@ declare function startupWithUpdater(fn: (updater: Updater) => Promisable<void>):
  */
 declare function initApp(appOptions: AppOption): Promise<void>;
 
-export { type AppOption, Logger, Updater, UpdaterOption, initApp, startupWithUpdater };
+export { type AppOption, type CheckResult, type DownloadResult, ErrorInfo, type Logger, Updater, UpdaterError, type UpdaterOption, autoUpdate, initApp, startupWithUpdater };

package/dist/index.js

@@ -1,11 +1,11 @@
 import { isDev, getEntryVersion, getAppVersion, getPathFromAppNameAsar, restartApp } from './chunk-4MH6ZXCY.js';
 import { isUpdateJSON, __require } from './chunk-72ZAJ7AF.js';
-import path from 'node:path';
 import fs2 from 'node:fs';
-import { app } from 'electron';
 import { EventEmitter } from 'node:events';
+import { app } from 'electron';
+import path from 'node:path';
 
-// src/updater/types.ts
+// src/entry/types.ts
 var ErrorInfo = {
   download: "Download failed",
   validate: "Validate failed",
@@ -20,7 +20,7 @@ var UpdaterError = class extends Error {
   }
 };
 
-// src/updater/core.ts
+// src/entry/updater.ts
 var Updater = class extends EventEmitter {
   CERT = __EIU_SIGNATURE_CERT__;
   info;
@@ -39,19 +39,14 @@ var Updater = class extends EventEmitter {
   forceUpdate;
   /**
    * initialize incremental updater
-   * @param provider update provider
-   * @param option UpdaterOption
+   * @param options UpdaterOption
    */
-  constructor(provider, option = {}) {
+  constructor(options = {}) {
     super();
-    this.provider = provider;
-    this.receiveBeta = option.receiveBeta;
-    if (option.SIGNATURE_CERT) {
-      this.CERT = option.SIGNATURE_CERT;
-    }
-    if (option.logger) {
-      this.logger = option.logger;
-    }
+    this.provider = options.provider;
+    this.receiveBeta = options.receiveBeta;
+    this.CERT = options.SIGNATURE_CERT || __EIU_SIGNATURE_CERT__;
+    this.logger = options.logger;
     if (isDev && !this.logger) {
       this.logger = {
         info: (...args) => console.log("[EIU-INFO ]", ...args),
@@ -61,6 +56,14 @@ var Updater = class extends EventEmitter {
       };
       this.logger.info("no logger set, enable dev-only logger");
     }
+    if (!this.provider) {
+      this.logger?.debug("No update provider, please setup provider before checking update");
+    }
+  }
+  checkProvider() {
+    if (!this.provider) {
+      throw new UpdaterError("param", "missing update provider");
+    }
   }
   async fetch(format, data) {
     if (typeof data === "object") {
@@ -89,6 +92,7 @@ var Updater = class extends EventEmitter {
     this.emit("error", err);
   }
   async checkUpdate(data) {
+    this.checkProvider();
     const emitUnavailable = (msg) => {
       this.logger?.info(msg);
       this.emit("update-unavailable", msg);
@@ -124,6 +128,7 @@ var Updater = class extends EventEmitter {
     return true;
   }
   async downloadUpdate(data, info) {
+    this.checkProvider();
     const _sig = info?.signature ?? this.info?.signature;
     const _version = info?.version ?? this.info?.version;
     if (!_sig || !_version) {
@@ -161,23 +166,12 @@ var Updater = class extends EventEmitter {
     this.logger?.info("quit and install");
     restartApp();
   }
-  /**
-   * setup provider URL handler
-   *
-   * @example
-   * updater.setURLHandler((url, isDownloadingAsar) => {
-   *   if (isDownloadingAsar) {
-   *     url.hostname = 'https://cdn.jsdelivr.net/gh'
-   *     return url
-   *   }
-   * })
-   */
-  setURLHandler(handler) {
-    this.provider.urlHandler = handler;
-  }
 };
-
-// src/entry.ts
+async function autoUpdate(updater) {
+  if (await updater.checkUpdate() && await updater.downloadUpdate()) {
+    updater.quitAndInstall();
+  }
+}
 function startupWithUpdater(fn) {
   return fn;
 }
@@ -187,7 +181,6 @@ var defaultOnInstall = (install, _, __, logger) => {
 };
 async function initApp(appOptions) {
   const {
-    provider,
     updater,
     onInstall = defaultOnInstall,
     beforeStart,
@@ -195,19 +188,11 @@ async function initApp(appOptions) {
   } = appOptions;
   let updaterInstance;
   if (typeof updater === "object" || !updater) {
-    updaterInstance = new Updater(provider, updater);
+    updaterInstance = new Updater(updater);
   } else {
     updaterInstance = await updater();
   }
-  let logger = updaterInstance.logger;
-  if (isDev && !logger) {
-    logger = {
-      info: (...args) => console.log("[EIU-INFO ]", ...args),
-      debug: (...args) => console.log("[EIU-DEBUG]", ...args),
-      warn: (...args) => console.log("[EIU-WARN ]", ...args),
-      error: (...args) => console.error("[EIU-ERROR]", ...args)
-    };
-  }
+  const logger = updaterInstance.logger;
   try {
     const appNameAsarPath = getPathFromAppNameAsar();
     const tempAsarPath = `${appNameAsarPath}.tmp`;
@@ -229,4 +214,4 @@ async function initApp(appOptions) {
   }
 }
 
-export { ErrorInfo, Updater, UpdaterError, initApp, startupWithUpdater };
+export { ErrorInfo, Updater, UpdaterError, autoUpdate, initApp, startupWithUpdater };

package/dist/provider.cjs

@@ -73,8 +73,7 @@ function getHeader(response, headerKey) {
 async function downloadFn(url, headers, onResponse) {
   await electron.app.whenReady();
   return new Promise((resolve, reject) => {
-    const request = electron.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 });
     request.on("response", (resp) => {
       resp.on("aborted", () => reject(new Error("aborted")));
       resp.on("error", () => reject(new Error("download error")));
@@ -159,8 +158,17 @@ async function defaultUnzipFile(buffer) {
 // src/provider/base.ts
 var BaseProvider = class {
   name = "BaseProvider";
+  /**
+   * @inheritdoc
+   */
   isLowerVersion = defaultIsLowerVersion;
+  /**
+   * @inheritdoc
+   */
   verifySignaure = defaultVerifySignature;
+  /**
+   * @inheritdoc
+   */
   unzipFile = defaultUnzipFile;
 };
 
@@ -179,6 +187,9 @@ var GitHubProvider = class extends BaseProvider {
   constructor(options) {
     super();
     this.options = options;
+    if (!options.branch) {
+      this.options.branch = "HEAD";
+    }
   }
   get urlHandler() {
     return this.options.urlHandler;
@@ -195,14 +206,14 @@ var GitHubProvider = class extends BaseProvider {
   }
   async downloadJSON(versionPath) {
     return await defaultDownloadUpdateJSON(
-      await this.parseURL(false, `${this.options.branch ?? "HEAD"}/${versionPath}`),
-      { accept: "application/json", ...this.options.extraHeaders }
+      await this.parseURL(false, `${this.options.branch}/${versionPath}`),
+      { Accept: "application/json", ...this.options.extraHeaders }
     );
   }
   async downloadAsar(name, info, 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 },
+      { Accept: "application/octet-stream", ...this.options.extraHeaders },
       onDownloading
     );
   }

package/dist/provider.d.cts

@@ -1,13 +1,29 @@
-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 { d as defaultIsLowerVersion, U as UpdateJSON, a as UpdateInfo } from './version-DgfjJQUx.cjs';
+import { I as IProvider, D as DownloadingInfo, U as URLHandler, O as OnDownloading } from './types-mEfMjnlV.cjs';
 import { f as defaultVerifySignature, a as defaultUnzipFile } from './zip-DPF5IFkK.cjs';
 import { Arrayable } from '@subframe7536/type-utils';
 
 declare abstract class BaseProvider implements IProvider {
     name: string;
+    /**
+     * @inheritdoc
+     */
     isLowerVersion: typeof defaultIsLowerVersion;
+    /**
+     * @inheritdoc
+     */
     verifySignaure: typeof defaultVerifySignature;
+    /**
+     * @inheritdoc
+     */
     unzipFile: typeof defaultUnzipFile;
+    /**
+     * @inheritdoc
+     */
     abstract downloadJSON(versionPath: string): Promise<UpdateJSON>;
+    /**
+     * @inheritdoc
+     */
     abstract downloadAsar(name: string, info: UpdateInfo, onDownloading?: (info: DownloadingInfo) => void): Promise<Buffer>;
 }