electron-incremental-update 0.6.2 → 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-KMBSE4OO.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

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

@@ -194,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
@@ -233,4 +234,4 @@ declare function initApp(appOptions: AppOption): {
  */
 declare function initApp(appOptions: AppOption, updaterOptions: InitUpdaterOptions): undefined;
 
-export { AppOption, CheckResultType, FunctionCompareVersion, FunctionVerifySignature, 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-KMBSE4OO.mjs";
+} from "./chunk-XQ4Z2OVN.mjs";
 
 // src/index.ts
 import { resolve as resolve2 } from "node:path";

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.mjs

@@ -1,6 +1,6 @@
 import {
   signature
-} from "./chunk-KMBSE4OO.mjs";
+} from "./chunk-XQ4Z2OVN.mjs";
 
 // src/vite.ts
 import { createLogger } from "vite";

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "electron-incremental-update",
-  "version": "0.6.2",
+  "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"
   },