electron-incremental-update 0.6.1 → 0.6.3

package/README.md

@@ -82,14 +82,16 @@ To utilize the electron `net` module for requesting update information, the `che
 
 However, you have the option to customize the download function when creating the updater.
 
+**NOTE: There can only be one function and should be default export in the entry file**
+
 ```ts
 // electron/main/index.ts
-import type { Updater } from 'electron-incremental-update'
+import type { StartupWithUpdater, Updater } from 'electron-incremental-update'
 import { getEntryVersion, getProductAsarPath, getProductVersion } from 'electron-incremental-update'
 import { app } from 'electron'
 import { name } from '../../package.json'
 
-export default function (updater: Updater) {
+const startup: StartupWithUpdater = (updater: Updater) => {
   await app.whenReady()
   console.log('\ncurrent:')
   console.log(`\tasar path: ${getProductAsarPath(name)}`)
@@ -117,6 +119,7 @@ export default function (updater: Updater) {
     }
   })
 }
+export default startup
 ```
 
 ### use native modules
@@ -186,6 +189,15 @@ export default defineConfig(({ command }) => {
 })
 ```
 
+### modify package.json
+
+```json
+{
+  // ...
+  "main": "app.js" // <- app entry file
+}
+```
+
 ### electron-builder config
 
 ```js

package/dist/{chunk-VADH6AZA.mjs → chunk-XQ4Z2OVN.mjs}

@@ -3,7 +3,7 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
 }) : x)(function(x) {
   if (typeof require !== "undefined")
     return require.apply(this, arguments);
-  throw new Error('Dynamic require of "' + x + '" is not supported');
+  throw Error('Dynamic require of "' + x + '" is not supported');
 });
 
 // src/crypto.ts
@@ -26,15 +26,15 @@ function key(data, length) {
   const hash = createHash("SHA256").update(data).digest("binary");
   return Buffer2.from(hash).subarray(0, length);
 }
-function signature(buffer, privateKey, cert, version) {
+var signature = (buffer, privateKey, cert, version) => {
   const sig = createSign("RSA-SHA256").update(buffer).sign({
     key: privateKey,
     padding: constants.RSA_PKCS1_PADDING,
     saltLength: constants.RSA_PSS_SALTLEN_DIGEST
   }, "base64");
   return encrypt(`${sig}%${version}`, key(cert, 32), key(buffer, 16));
-}
-function verify(buffer, signature2, cert) {
+};
+var verify = (buffer, signature2, cert) => {
   try {
     const [sig, version] = decrypt(signature2, key(cert, 32), key(buffer, 16)).split("%");
     const result = createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
@@ -42,7 +42,7 @@ function verify(buffer, signature2, cert) {
   } catch (error) {
     return false;
   }
-}
+};
 
 export {
   __require,

package/dist/index.cjs

@@ -59,7 +59,7 @@ function key(data, length) {
   const hash = (0, import_node_crypto.createHash)("SHA256").update(data).digest("binary");
   return import_node_buffer.Buffer.from(hash).subarray(0, length);
 }
-function verify(buffer, signature, cert) {
+var verify = (buffer, signature, cert) => {
   try {
     const [sig, version] = decrypt(signature, key(cert, 32), key(buffer, 16)).split("%");
     const result = (0, import_node_crypto.createVerify)("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
@@ -67,7 +67,7 @@ function verify(buffer, signature, cert) {
   } catch (error) {
     return false;
   }
-}
+};
 
 // src/updater/defaultFunctions.ts
 var import_node_buffer2 = require("buffer");
@@ -200,7 +200,7 @@ async function downloadBufferDefault(url, updater, headers) {
     request.end();
   });
 }
-function compareVersionDefault(oldVersion, newVersion) {
+var compareVersionDefault = (oldVersion, newVersion) => {
   if (!oldVersion || !newVersion) {
     throw new TypeError("invalid version");
   }
@@ -221,7 +221,7 @@ function compareVersionDefault(oldVersion, newVersion) {
     return true;
   }
   return false;
-}
+};
 
 // src/updater/index.ts
 function createUpdater({
@@ -231,15 +231,19 @@ function createUpdater({
   releaseAsarURL: _release,
   updateJsonURL: _update,
   debug = false,
-  downloadConfig,
-  compareVersion
+  downloadConfig: { extraHeader, userAgent } = {},
+  overrideFunctions: {
+    compareVersion,
+    verifySignaure,
+    downloadBuffer,
+    downloadJSON
+  } = {}
 }) {
   const updater = new import_node_events.EventEmitter();
   let signature = "";
   const asarPath = getProductAsarPath(productName);
   const gzipPath = `${asarPath}.gz`;
   const tmpFilePath = gzipPath.replace(".asar.gz", ".tmp.asar");
-  const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
   function log(msg) {
     debug && updater.emit("debug", msg);
   }
@@ -323,6 +327,7 @@ function createUpdater({
       throw new Error(`invalid type at format '${format}': ${data}`);
     }
   }
+  updater.setDebug = (isDebug) => debug = isDebug;
   updater.checkUpdate = async (data) => {
     try {
       const { signature: _sig, size, version } = await parseData("json", data);
@@ -348,7 +353,8 @@ function createUpdater({
       }
       const buffer = await parseData("buffer", data);
       log("verify start");
-      const version = verify(buffer, _sig, SIGNATURE_CERT);
+      const _verify = verifySignaure ?? verify;
+      const version = _verify(buffer, _sig, SIGNATURE_CERT);
       if (!version) {
         throw new Error("verify failed, invalid signature");
       }

package/dist/index.d.cts

@@ -0,0 +1,237 @@
+import { Buffer } from 'node:buffer';
+
+type CheckResultType = Omit<UpdateJSON, 'signature'> | undefined | Error;
+type InstallResult = true | Error;
+type UpdateEvents = {
+    downloading: [progress: number];
+    debug: [msg: string | Error];
+};
+type UpdateJSON = {
+    signature: string;
+    version: string;
+    size: number;
+};
+declare function isUpdateJSON(json: any): json is UpdateJSON;
+type MaybeArray<T> = T extends undefined | null | never ? [] : T extends any[] ? T['length'] extends 1 ? [data: T[0]] : T : [data: T];
+interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event extends Exclude<keyof T, number> = Exclude<keyof T, number>> {
+    removeAllListeners<E extends Event>(event?: E): this;
+    listeners<E extends Event>(eventName: E): Function[];
+    eventNames(): (Event)[];
+    on<E extends Event>(eventName: E, listener: (...data: MaybeArray<T[E]>) => void): this;
+    once<E extends Event>(eventName: E, listener: (...data: MaybeArray<T[E]>) => void): this;
+    emit<E extends Event>(eventName: E, ...args: MaybeArray<T[E]>): boolean;
+    off<E extends Event>(eventName: E, listener: (...args: MaybeArray<T[E]>) => void): this;
+    /**
+     * check update info
+     * @param data update json url
+     * @returns
+     * - `{size: number, version: string}`: available
+     * - `false`: unavailable
+     * - `Error`: fail
+     */
+    checkUpdate(data?: string | UpdateJSON): Promise<CheckResultType>;
+    /**
+     * download update and install
+     *
+     * if you want to update **offline**, you can set both `src` and `sig` to verify and install
+     * @param data asar download url or buffer
+     * @param sig signature
+     * @returns
+     * - `true`: success
+     * - `Error`: fail
+     */
+    downloadAndInstall(data?: string | Buffer, sig?: string): Promise<InstallResult>;
+    setDebug(debug: boolean): void;
+}
+type FunctionVerifySignature = (buffer: Buffer, signature: string, cert: string) => string | false;
+type FunctionCompareVersion = (oldVersion: string, newVersion: string) => boolean;
+type Updater = TypedUpdater<UpdateEvents>;
+interface UpdaterOption {
+    /**
+     * public key of signature
+     *
+     * it will be auto generated by plugin
+     * @example
+     * ```ts
+     * // auto filled by plugin
+     * const SIGNATURE_CERT = ''
+     *
+     * const updater = createUpdater({
+     *   SIGNATURE_CERT,
+     *   ...
+     * })
+     * ```
+     */
+    SIGNATURE_CERT: string;
+    /**
+     * name of your application
+     *
+     * you can use the `name` in `package.json`
+     */
+    productName: string;
+    /**
+     * repository url, e.g. `https://github.com/electron/electron`
+     *
+     * you can use the `repository` in `package.json`
+     *
+     * if `updateJsonURL` or `releaseAsarURL` are absent,
+     * `repository` will be used to determine the url
+     */
+    repository?: string;
+    /**
+     * URL of version info json
+     * @default `${repository.replace('github.com', 'raw.githubusercontent.com')}/master/version.json`
+     * @throws if `updateJsonURL` and `repository` are all not set
+     */
+    updateJsonURL?: string;
+    /**
+     * URL of release asar.gz
+     * @default `${repository}/releases/download/latest/${productName}.asar.gz`
+     * @throws if `releaseAsarURL` and `repository` are all not set
+     */
+    releaseAsarURL?: string;
+    /**
+     * whether to enable debug listener
+     */
+    debug?: boolean;
+    overrideFunctions?: {
+        /**
+         * custom version compare function {@link FunctionCompareVersion}
+         * @param oldVersion old version string
+         * @param newVersion new version string
+         * @returns whether to update
+         */
+        compareVersion?: FunctionCompareVersion;
+        /**
+         * custom verify signature function {@link FunctionVerifySignature}
+         * @param buffer file buffer
+         * @param signature signature
+         * @param cert certificate
+         */
+        verifySignaure?: FunctionVerifySignature;
+        /**
+         * custom download JSON function
+         * @param url download url
+         * @param updater updater, to trigger events
+         * @param header download header
+         * @returns `UpdateJSON`
+         */
+        downloadJSON?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
+        /**
+         * custom download buffer function
+         * @param url download url
+         * @param updater updater, to trigger events
+         * @param header download header
+         * @returns `Buffer`
+         */
+        downloadBuffer?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
+    };
+    downloadConfig?: {
+        /**
+         * download user agent
+         * @default 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36'
+         */
+        userAgent?: string;
+        /**
+         * extra download header, `accept` and `user-agent` is set by default
+         */
+        extraHeader?: Record<string, string>;
+    };
+}
+
+/**
+ * get the application asar absolute path
+ * @param name The name of the application
+ */
+declare function getProductAsarPath(name: string): string;
+/**
+ * get the version of entry (app.asar)
+ */
+declare function getEntryVersion(): string;
+/**
+ * get the version of application (name.asar)
+ * @param name - The name of the application
+ */
+declare function getProductVersion(name: string): string;
+/**
+ * require native package from app.asar
+ * @param packageName native package name
+ */
+declare function requireNative<T = any>(packageName: string): T;
+/**
+ * get github version.json CDN URL for accelerating the speed of downloading version info
+ */
+declare function parseGithubCdnURL(repository: string, cdnPrefix: string, relativeFilePath: string): string;
+/**
+ * get group of github release CDN prefix for accelerating the speed of downloading release
+ */
+declare function getGithubReleaseCdnGroup(): {
+    cdnPrefix: string;
+    maintainer: string;
+}[];
+declare function restartApp(): void;
+declare function waitAppReady(duration?: number): Promise<unknown>;
+
+declare function createUpdater({ SIGNATURE_CERT, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, debug, downloadConfig: { extraHeader, userAgent }, overrideFunctions: { compareVersion, verifySignaure, downloadBuffer, downloadJSON, }, }: UpdaterOption): Updater;
+
+type AppOption = {
+    /**
+     * name of your application
+    *
+     * you can use the `name` in `package.json`
+    */
+    name: string;
+    /**
+     * path of electron output dist
+     * @default 'dist-electron'
+    */
+    electronDistPath?: string;
+    /**
+     * relative path of main entry in electron dist
+     * @default 'main/index.js'
+    */
+    mainPath?: string;
+};
+type OptionalProperty<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type InitUpdaterOptions = OptionalProperty<UpdaterOption, 'productName'>;
+type StartupWithUpdater = (updater: Updater) => void;
+/**
+ * create updater manually
+ * @example
+ * ```ts
+ * import { createUpdater, getGithubReleaseCdnGroup, initApp, parseGithubCdnURL } from 'electron-incremental-update'
+ * import { name, repository } from '../package.json'
+ *
+ * const SIGNATURE_CERT = '' // auto generate
+ *
+ * const { cdnPrefix } = getGithubReleaseCdnGroup()[0]
+ * const updater = createUpdater({
+ *   SIGNATURE_CERT,
+ *   productName: name,
+ *   repository,
+ *   updateJsonURL: parseGithubCdnURL(repository, 'fastly.jsdelivr.net/gh', 'version.json'),
+ *   releaseAsarURL: parseGithubCdnURL(repository, cdnPrefix, `download/latest/${name}.asar.gz`),
+ *   debug: true,
+ * })
+ * initApp({ name }).setUpdater(updater)
+ * ```
+ */
+declare function initApp(appOptions: AppOption): {
+    setUpdater: (updater: Updater) => void;
+};
+/**
+ * create updater when init, no need to set productName
+ *
+ * @example
+ * ```ts
+ * import { initApp } from 'electron-incremental-update'
+ * import { name, repository } from '../package.json'
+ *
+ * const SIGNATURE_CERT = '' // auto generate
+ *
+ * initApp({ name }, { SIGNATURE_CERT, repository })
+ * ```
+ */
+declare function initApp(appOptions: AppOption, updaterOptions: InitUpdaterOptions): undefined;
+
+export { AppOption, CheckResultType, FunctionCompareVersion, FunctionVerifySignature, InitUpdaterOptions, InstallResult, StartupWithUpdater, UpdateJSON, Updater, UpdaterOption, createUpdater, getEntryVersion, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, initApp, isUpdateJSON, parseGithubCdnURL, requireNative, restartApp, waitAppReady };

package/dist/index.d.ts

@@ -41,7 +41,10 @@ interface TypedUpdater<T extends Record<string | symbol, MaybeArray<any>>, Event
      * - `Error`: fail
      */
     downloadAndInstall(data?: string | Buffer, sig?: string): Promise<InstallResult>;
+    setDebug(debug: boolean): void;
 }
+type FunctionVerifySignature = (buffer: Buffer, signature: string, cert: string) => string | false;
+type FunctionCompareVersion = (oldVersion: string, newVersion: string) => boolean;
 type Updater = TypedUpdater<UpdateEvents>;
 interface UpdaterOption {
     /**
@@ -91,25 +94,23 @@ interface UpdaterOption {
      * whether to enable debug listener
      */
     debug?: boolean;
-    /**
-     * custom version compare function
-     * @param oldVersion old version string
-     * @param newVersion new version string
-     * @returns whether to update
-     */
-    compareVersion?: (oldVersion: string, newVersion: string) => boolean;
-    downloadConfig?: {
+    overrideFunctions?: {
         /**
-         * download user agent
-       * @default 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36'
-        */
-        userAgent?: string;
+         * custom version compare function {@link FunctionCompareVersion}
+         * @param oldVersion old version string
+         * @param newVersion new version string
+         * @returns whether to update
+         */
+        compareVersion?: FunctionCompareVersion;
         /**
-        * extra download header, `accept` and `user-agent` is set by default
-       */
-        extraHeader?: Record<string, string>;
+         * custom verify signature function {@link FunctionVerifySignature}
+         * @param buffer file buffer
+         * @param signature signature
+         * @param cert certificate
+         */
+        verifySignaure?: FunctionVerifySignature;
         /**
-         * download JSON function
+         * custom download JSON function
          * @param url download url
          * @param updater updater, to trigger events
          * @param header download header
@@ -117,7 +118,7 @@ interface UpdaterOption {
          */
         downloadJSON?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<UpdateJSON>;
         /**
-         * download buffer function
+         * custom download buffer function
          * @param url download url
          * @param updater updater, to trigger events
          * @param header download header
@@ -125,6 +126,17 @@ interface UpdaterOption {
          */
         downloadBuffer?: (url: string, updater: Updater, headers: Record<string, any>) => Promise<Buffer>;
     };
+    downloadConfig?: {
+        /**
+         * download user agent
+         * @default 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36'
+         */
+        userAgent?: string;
+        /**
+         * extra download header, `accept` and `user-agent` is set by default
+         */
+        extraHeader?: Record<string, string>;
+    };
 }
 
 /**
@@ -160,7 +172,7 @@ declare function getGithubReleaseCdnGroup(): {
 declare function restartApp(): void;
 declare function waitAppReady(duration?: number): Promise<unknown>;
 
-declare function createUpdater({ SIGNATURE_CERT, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, debug, downloadConfig, compareVersion, }: UpdaterOption): Updater;
+declare function createUpdater({ SIGNATURE_CERT, repository, productName, releaseAsarURL: _release, updateJsonURL: _update, debug, downloadConfig: { extraHeader, userAgent }, overrideFunctions: { compareVersion, verifySignaure, downloadBuffer, downloadJSON, }, }: UpdaterOption): Updater;
 
 type AppOption = {
     /**
@@ -182,6 +194,7 @@ type AppOption = {
 };
 type OptionalProperty<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type InitUpdaterOptions = OptionalProperty<UpdaterOption, 'productName'>;
+type StartupWithUpdater = (updater: Updater) => void;
 /**
  * create updater manually
  * @example
@@ -221,4 +234,4 @@ declare function initApp(appOptions: AppOption): {
  */
 declare function initApp(appOptions: AppOption, updaterOptions: InitUpdaterOptions): undefined;
 
-export { AppOption, CheckResultType, InitUpdaterOptions, InstallResult, UpdateJSON, Updater, UpdaterOption, createUpdater, getEntryVersion, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, initApp, isUpdateJSON, parseGithubCdnURL, requireNative, restartApp, waitAppReady };
+export { AppOption, CheckResultType, FunctionCompareVersion, FunctionVerifySignature, InitUpdaterOptions, InstallResult, StartupWithUpdater, UpdateJSON, Updater, UpdaterOption, createUpdater, getEntryVersion, getGithubReleaseCdnGroup, getProductAsarPath, getProductVersion, initApp, isUpdateJSON, parseGithubCdnURL, requireNative, restartApp, waitAppReady };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import {
   __require,
   verify
-} from "./chunk-VADH6AZA.mjs";
+} from "./chunk-XQ4Z2OVN.mjs";
 
 // src/index.ts
 import { resolve as resolve2 } from "node:path";
@@ -147,7 +147,7 @@ async function downloadBufferDefault(url, updater, headers) {
     request.end();
   });
 }
-function compareVersionDefault(oldVersion, newVersion) {
+var compareVersionDefault = (oldVersion, newVersion) => {
   if (!oldVersion || !newVersion) {
     throw new TypeError("invalid version");
   }
@@ -168,7 +168,7 @@ function compareVersionDefault(oldVersion, newVersion) {
     return true;
   }
   return false;
-}
+};
 
 // src/updater/index.ts
 function createUpdater({
@@ -178,15 +178,19 @@ function createUpdater({
   releaseAsarURL: _release,
   updateJsonURL: _update,
   debug = false,
-  downloadConfig,
-  compareVersion
+  downloadConfig: { extraHeader, userAgent } = {},
+  overrideFunctions: {
+    compareVersion,
+    verifySignaure,
+    downloadBuffer,
+    downloadJSON
+  } = {}
 }) {
   const updater = new EventEmitter();
   let signature = "";
   const asarPath = getProductAsarPath(productName);
   const gzipPath = `${asarPath}.gz`;
   const tmpFilePath = gzipPath.replace(".asar.gz", ".tmp.asar");
-  const { downloadBuffer, downloadJSON, extraHeader, userAgent } = downloadConfig || {};
   function log(msg) {
     debug && updater.emit("debug", msg);
   }
@@ -270,6 +274,7 @@ function createUpdater({
       throw new Error(`invalid type at format '${format}': ${data}`);
     }
   }
+  updater.setDebug = (isDebug) => debug = isDebug;
   updater.checkUpdate = async (data) => {
     try {
       const { signature: _sig, size, version } = await parseData("json", data);
@@ -295,7 +300,8 @@ function createUpdater({
       }
       const buffer = await parseData("buffer", data);
       log("verify start");
-      const version = verify(buffer, _sig, SIGNATURE_CERT);
+      const _verify = verifySignaure ?? verify;
+      const version = _verify(buffer, _sig, SIGNATURE_CERT);
       if (!version) {
         throw new Error("verify failed, invalid signature");
       }

package/dist/vite.cjs

@@ -55,14 +55,14 @@ function key(data, length) {
   const hash = (0, import_node_crypto.createHash)("SHA256").update(data).digest("binary");
   return import_node_buffer.Buffer.from(hash).subarray(0, length);
 }
-function signature(buffer, privateKey, cert, version) {
+var signature = (buffer, privateKey, cert, version) => {
   const sig = (0, import_node_crypto.createSign)("RSA-SHA256").update(buffer).sign({
     key: privateKey,
     padding: import_node_crypto.constants.RSA_PKCS1_PADDING,
     saltLength: import_node_crypto.constants.RSA_PSS_SALTLEN_DIGEST
   }, "base64");
   return encrypt(`${sig}%${version}`, key(cert, 32), key(buffer, 16));
-}
+};
 
 // src/build-plugins/build.ts
 function gzipFile(filePath) {
@@ -106,11 +106,13 @@ async function buildVersion({
   versionPath,
   privateKey,
   cert,
-  version
+  version,
+  generateSignature
 }) {
   const buffer = await (0, import_promises.readFile)(`${asarOutputPath}.gz`);
+  const _func = generateSignature ?? signature;
   await (0, import_promises.writeFile)(versionPath, JSON.stringify({
-    signature: signature(buffer, privateKey, cert, version),
+    signature: _func(buffer, privateKey, cert, version),
     version,
     size: buffer.length
   }, null, 2));
@@ -136,23 +138,13 @@ var import_node_path = require("path");
 var import_node_os = require("os");
 var import_node_crypto2 = require("crypto");
 var import_jscert = require("@cyyynthia/jscert");
-function generateCert(privateKey) {
-  const dn = {
-    country: "zh-CN",
-    state: "zj",
-    locality: "hz",
-    organization: "test",
-    organizationalUnit: "test unit",
-    commonName: "test.test",
-    emailAddress: "test@example.com"
-  };
+function generateCert(privateKey, dn, expires) {
   const csr = new import_jscert.CertificateSigningRequest(dn, privateKey, { digest: "sha256" });
-  const expiry = new Date(Date.now() + 365 * 864e5);
-  return csr.createSelfSignedCertificate(expiry).toPem();
+  return csr.createSelfSignedCertificate(expires).toPem();
 }
-function generateKeys(length = 2048) {
+function generateKeyPairDefault(length, subjects, expires) {
   const { privateKey: _key } = (0, import_node_crypto2.generateKeyPairSync)("rsa", { modulusLength: length });
-  const cert = generateCert(_key);
+  const cert = generateCert(_key, subjects, expires);
   const privateKey = _key.export({ type: "pkcs1", format: "pem" });
   return {
     privateKey,
@@ -188,13 +180,17 @@ function getKeys({
   keyLength,
   privateKeyPath,
   certPath,
-  entryPath
+  entryPath,
+  subject,
+  expires,
+  generateKeyPair
 }) {
   const keysDir = (0, import_node_path.dirname)(privateKeyPath);
   !(0, import_node_fs2.existsSync)(keysDir) && (0, import_node_fs2.mkdirSync)(keysDir);
   let privateKey, cert;
   if (!(0, import_node_fs2.existsSync)(privateKeyPath) || !(0, import_node_fs2.existsSync)(certPath)) {
-    const keys = generateKeys(keyLength);
+    const _func = generateKeyPair ?? generateKeyPairDefault;
+    const keys = _func(keyLength, subject, expires);
     privateKey = keys.privateKey;
     cert = keys.cert;
     (0, import_node_fs2.writeFileSync)(privateKeyPath, privateKey);
@@ -213,28 +209,38 @@ function getKeys({
 // src/build-plugins/option.ts
 var import_ci_info = require("ci-info");
 function parseOptions(options) {
-  const { isBuild, productName, version, minify = false, paths = {}, keys = {} } = options;
   const {
-    entryPath = "electron/app.ts",
-    entryOutputPath = "app.js",
-    asarOutputPath = `release/${productName}-${version}.asar`,
-    electronDistPath = "dist-electron",
-    rendererDistPath = "dist",
-    versionPath = "version.json"
-  } = paths;
+    isBuild,
+    productName,
+    version,
+    minify = false,
+    paths: {
+      entryPath = "electron/app.ts",
+      entryOutputPath = "app.js",
+      asarOutputPath = `release/${productName}-${version}.asar`,
+      electronDistPath = "dist-electron",
+      rendererDistPath = "dist",
+      versionPath = "version.json"
+    } = {},
+    keys: {
+      privateKeyPath = "keys/private.pem",
+      certPath = "keys/cert.pem",
+      keyLength = 2048,
+      certInfo = {},
+      overrideFunctions = {}
+    } = {}
+  } = options;
   const {
-    privateKeyPath = "keys/private.pem",
-    certPath = "keys/cert.pem",
-    keyLength = 2048,
-    certInfo
-  } = keys;
+    generateKeyPair,
+    generateSignature
+  } = overrideFunctions;
   let {
     subject = {
       commonName: productName,
       organization: `org.${productName}`
     },
     expires = Date.now() + 365 * 864e5
-  } = certInfo || {};
+  } = certInfo;
   const buildAsarOption = {
     version,
     asarOutputPath,
@@ -257,14 +263,16 @@ function parseOptions(options) {
       certPath,
       entryPath,
       subject,
-      expires
+      expires,
+      generateKeyPair
     });
     buildVersionOption = {
       version,
       asarOutputPath,
       privateKey,
       cert,
-      versionPath
+      versionPath,
+      generateSignature
     };
   }
   return { isBuild, buildAsarOption, buildEntryOption, buildVersionOption };

package/dist/vite.d.cts

@@ -0,0 +1,129 @@
+import { Plugin } from 'vite';
+import { Buffer } from 'node:buffer';
+import { DistinguishedName } from '@cyyynthia/jscert';
+
+type FunctionGenerateKeyPair = (keyLength: number, subject: DistinguishedName, expires: Date) => {
+    privateKey: string;
+    cert: string;
+};
+type FunctionGenerateSignature = (buffer: Buffer, privateKey: string, cert: string, version: string) => string;
+type Options = {
+    /**
+     * whether is in build mode
+     */
+    isBuild: boolean;
+    /**
+     * the name of you application
+     *
+     * you can set as 'name' in `package.json`
+    */
+    productName: string;
+    /**
+     * the version of you application
+     *
+     * you can set as 'version' in `package.json`
+     */
+    version: string;
+    /**
+     * Whether to minify entry file
+     */
+    minify?: boolean;
+    /**
+     * paths config
+     */
+    paths?: {
+        /**
+         * Path to app entry file
+         * @default 'electron/app.ts'
+         */
+        entryPath?: string;
+        /**
+         * Path to app entry output file
+         * @default 'app.js'
+         */
+        entryOutputPath?: string;
+        /**
+         * Path to asar file
+         * @default `release/${productName}.asar`
+         */
+        asarOutputPath?: string;
+        /**
+         * Path to electron build output
+         * @default `dist-electron`
+         */
+        electronDistPath?: string;
+        /**
+         * Path to renderer build output
+         * @default `dist`
+         */
+        rendererDistPath?: string;
+        /**
+         * Path to version info output
+         * @default `version.json`
+         */
+        versionPath?: string;
+    };
+    /**
+     * signature config
+     */
+    keys?: {
+        /**
+         * Path to the pem file that contains private key
+         * if not ended with .pem, it will be appended
+         * @default 'keys/private.pem'
+         */
+        privateKeyPath?: string;
+        /**
+         * Path to the pem file that contains public key
+         * if not ended with .pem, it will be appended
+         * @default 'keys/cert.pem'
+         */
+        certPath?: string;
+        /**
+         * Length of the key
+         * @default 2048
+         */
+        keyLength?: number;
+        /**
+         * X509 certificate info
+         *
+         * only generate simple **self-signed** certificate **without extensions**
+         */
+        certInfo?: {
+            /**
+             * the subject of the certificate
+             *
+             * @default { commonName: productName, organization: `org.${productName}` }
+             */
+            subject?: DistinguishedName;
+            /**
+             * expires of the certificate
+             * - `Date`: expire date
+             * - `number`: expire duration in seconds
+             *
+             * @default Date.now() + 365 * 864e5 (1 year)
+             */
+            expires?: Date | number;
+        };
+        overrideFunctions?: {
+            /**
+             * custom key pair generate function {@link FunctionGenerateKeyPair}
+             * @param keyLength key length
+             * @param subject subject info
+             * @param expires expire date
+             */
+            generateKeyPair?: FunctionGenerateKeyPair;
+            /**
+             * custom signature generate function {@link FunctionGenerateSignature}
+             * @param buffer file buffer
+             * @param privateKey private key
+             * @param cert certificate
+             */
+            generateSignature?: FunctionGenerateSignature;
+        };
+    };
+};
+
+declare function export_default(options: Options): Plugin;
+
+export { export_default as default };

package/dist/vite.d.ts

@@ -1,6 +1,12 @@
 import { Plugin } from 'vite';
+import { Buffer } from 'node:buffer';
 import { DistinguishedName } from '@cyyynthia/jscert';
 
+type FunctionGenerateKeyPair = (keyLength: number, subject: DistinguishedName, expires: Date) => {
+    privateKey: string;
+    cert: string;
+};
+type FunctionGenerateSignature = (buffer: Buffer, privateKey: string, cert: string, version: string) => string;
 type Options = {
     /**
      * whether is in build mode
@@ -99,6 +105,22 @@ type Options = {
              */
             expires?: Date | number;
         };
+        overrideFunctions?: {
+            /**
+             * custom key pair generate function {@link FunctionGenerateKeyPair}
+             * @param keyLength key length
+             * @param subject subject info
+             * @param expires expire date
+             */
+            generateKeyPair?: FunctionGenerateKeyPair;
+            /**
+             * custom signature generate function {@link FunctionGenerateSignature}
+             * @param buffer file buffer
+             * @param privateKey private key
+             * @param cert certificate
+             */
+            generateSignature?: FunctionGenerateSignature;
+        };
     };
 };
 

package/dist/vite.mjs

@@ -1,6 +1,6 @@
 import {
   signature
-} from "./chunk-VADH6AZA.mjs";
+} from "./chunk-XQ4Z2OVN.mjs";
 
 // src/vite.ts
 import { createLogger } from "vite";
@@ -51,11 +51,13 @@ async function buildVersion({
   versionPath,
   privateKey,
   cert,
-  version
+  version,
+  generateSignature
 }) {
   const buffer = await readFile(`${asarOutputPath}.gz`);
+  const _func = generateSignature ?? signature;
   await writeFile(versionPath, JSON.stringify({
-    signature: signature(buffer, privateKey, cert, version),
+    signature: _func(buffer, privateKey, cert, version),
     version,
     size: buffer.length
   }, null, 2));
@@ -81,23 +83,13 @@ import { dirname } from "node:path";
 import { EOL } from "node:os";
 import { generateKeyPairSync } from "node:crypto";
 import { CertificateSigningRequest } from "@cyyynthia/jscert";
-function generateCert(privateKey) {
-  const dn = {
-    country: "zh-CN",
-    state: "zj",
-    locality: "hz",
-    organization: "test",
-    organizationalUnit: "test unit",
-    commonName: "test.test",
-    emailAddress: "test@example.com"
-  };
+function generateCert(privateKey, dn, expires) {
   const csr = new CertificateSigningRequest(dn, privateKey, { digest: "sha256" });
-  const expiry = new Date(Date.now() + 365 * 864e5);
-  return csr.createSelfSignedCertificate(expiry).toPem();
+  return csr.createSelfSignedCertificate(expires).toPem();
 }
-function generateKeys(length = 2048) {
+function generateKeyPairDefault(length, subjects, expires) {
   const { privateKey: _key } = generateKeyPairSync("rsa", { modulusLength: length });
-  const cert = generateCert(_key);
+  const cert = generateCert(_key, subjects, expires);
   const privateKey = _key.export({ type: "pkcs1", format: "pem" });
   return {
     privateKey,
@@ -133,13 +125,17 @@ function getKeys({
   keyLength,
   privateKeyPath,
   certPath,
-  entryPath
+  entryPath,
+  subject,
+  expires,
+  generateKeyPair
 }) {
   const keysDir = dirname(privateKeyPath);
   !existsSync(keysDir) && mkdirSync(keysDir);
   let privateKey, cert;
   if (!existsSync(privateKeyPath) || !existsSync(certPath)) {
-    const keys = generateKeys(keyLength);
+    const _func = generateKeyPair ?? generateKeyPairDefault;
+    const keys = _func(keyLength, subject, expires);
     privateKey = keys.privateKey;
     cert = keys.cert;
     writeFileSync(privateKeyPath, privateKey);
@@ -158,28 +154,38 @@ function getKeys({
 // src/build-plugins/option.ts
 import { isCI } from "ci-info";
 function parseOptions(options) {
-  const { isBuild, productName, version, minify = false, paths = {}, keys = {} } = options;
   const {
-    entryPath = "electron/app.ts",
-    entryOutputPath = "app.js",
-    asarOutputPath = `release/${productName}-${version}.asar`,
-    electronDistPath = "dist-electron",
-    rendererDistPath = "dist",
-    versionPath = "version.json"
-  } = paths;
+    isBuild,
+    productName,
+    version,
+    minify = false,
+    paths: {
+      entryPath = "electron/app.ts",
+      entryOutputPath = "app.js",
+      asarOutputPath = `release/${productName}-${version}.asar`,
+      electronDistPath = "dist-electron",
+      rendererDistPath = "dist",
+      versionPath = "version.json"
+    } = {},
+    keys: {
+      privateKeyPath = "keys/private.pem",
+      certPath = "keys/cert.pem",
+      keyLength = 2048,
+      certInfo = {},
+      overrideFunctions = {}
+    } = {}
+  } = options;
   const {
-    privateKeyPath = "keys/private.pem",
-    certPath = "keys/cert.pem",
-    keyLength = 2048,
-    certInfo
-  } = keys;
+    generateKeyPair,
+    generateSignature
+  } = overrideFunctions;
   let {
     subject = {
       commonName: productName,
       organization: `org.${productName}`
     },
     expires = Date.now() + 365 * 864e5
-  } = certInfo || {};
+  } = certInfo;
   const buildAsarOption = {
     version,
     asarOutputPath,
@@ -202,14 +208,16 @@ function parseOptions(options) {
       certPath,
       entryPath,
       subject,
-      expires
+      expires,
+      generateKeyPair
     });
     buildVersionOption = {
       version,
       asarOutputPath,
       privateKey,
       cert,
-      versionPath
+      versionPath,
+      generateSignature
     };
   }
   return { isBuild, buildAsarOption, buildEntryOption, buildVersionOption };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "electron-incremental-update",
-  "version": "0.6.1",
+  "author": "subframe7536",
+  "version": "0.6.3",
   "description": "electron incremental update tools, powered by vite",
   "scripts": {
     "build": "tsup",
-    "release": "pnpm test && pnpm run build && bumpp && npm publish",
+    "release": "pnpm test && pnpm run build && bumpp --all && npm publish",
     "test": "vitest --run"
   },
   "publishConfig": {
@@ -22,22 +23,24 @@
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs"
+      "import": {
+        "default": "./dist/index.mjs",
+        "types": "./dist/index.d.mts"
+      },
+      "require": {
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.ts"
+      }
     },
     "./vite": {
-      "require": "./dist/vite.cjs",
-      "import": "./dist/vite.mjs"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      ".": [
-        "dist/updater.d.ts"
-      ],
-      "vite": [
-        "dist/vite.d.ts"
-      ]
+      "import": {
+        "default": "./dist/index.mjs",
+        "types": "./dist/index.d.mts"
+      },
+      "require": {
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.ts"
+      }
     }
   },
   "keywords": [
@@ -45,18 +48,17 @@
     "incremental update",
     "updater"
   ],
-  "author": "",
   "devDependencies": {
     "@electron/asar": "^3.2.4",
     "@subframe7536/eslint-config": "^0.1.9",
-    "@types/node": "^20.2.5",
+    "@types/node": "^20.3.2",
     "asar": "^3.2.0",
     "bumpp": "^9.1.1",
-    "electron": "^25.0.1",
-    "eslint": "^8.42.0",
+    "electron": "^25.2.0",
+    "eslint": "^8.43.0",
     "fs-jetpack": "^5.1.0",
-    "tsup": "^6.7.0",
-    "typescript": "^5.1.3",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.5",
     "vite": "^4.3.9",
     "vitest": "^0.32.2"
   },